db_impl.cc 231.7 KB
Newer Older
1
//  Copyright (c) 2011-present, Facebook, Inc.  All rights reserved.
2 3 4 5
//  This source code is licensed under the BSD-style license found in the
//  LICENSE file in the root directory of this source tree. An additional grant
//  of patent rights can be found in the PATENTS file in the same directory.
//
J
jorlow@chromium.org 已提交
6 7 8 9 10
// Copyright (c) 2011 The LevelDB Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file. See the AUTHORS file for names of contributors.
#include "db/db_impl.h"

L
liuhuahang 已提交
11
#ifndef __STDC_FORMAT_MACROS
I
Igor Canadi 已提交
12
#define __STDC_FORMAT_MACROS
L
liuhuahang 已提交
13
#endif
I
Igor Canadi 已提交
14
#include <inttypes.h>
15
#include <stdint.h>
D
David Bernard 已提交
16
#ifdef OS_SOLARIS
D
David Bernard 已提交
17
#include <alloca.h>
D
David Bernard 已提交
18
#endif
19 20 21
#ifdef ROCKSDB_JEMALLOC
#include "jemalloc/jemalloc.h"
#endif
22

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

J
jorlow@chromium.org 已提交
212 213 214
  return result;
}

215 216
namespace {

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

230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
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 已提交
258
  if (db_options.allow_mmap_reads && db_options.use_direct_reads) {
259 260 261
    // Protect against assert in PosixMMapReadableFile constructor
    return Status::NotSupported(
        "If memory mapped reads (allow_mmap_reads) are enabled "
A
Aaron Gao 已提交
262 263 264 265 266 267 268
        "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. ");
269 270
  }

271 272 273 274
  if (db_options.keep_log_file_num == 0) {
    return Status::InvalidArgument("keep_log_file_num must be greater than 0");
  }

275 276 277
  return Status::OK();
}

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

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

308
}  // namespace
309

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

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

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

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

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

387 388 389
  Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
      "Shutdown: canceling all background work");

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

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

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

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

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

479 480 481
  for (auto l : logs_to_free_) {
    delete l;
  }
482 483 484
  for (auto& log : logs_) {
    log.ClearWriter();
  }
485
  logs_.clear();
486

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

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

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

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

525 526
  Status s;

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

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

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

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

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

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

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

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

  const uint64_t now_micros = env_->NowMicros();

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

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

666
    PrintStatistics();
667 668 669
  }
}

670
uint64_t DBImpl::FindMinPrepLogReferencedByMemTable() {
671 672 673 674
  if (!allow_2pc()) {
    return 0;
  }

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

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

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

752 753 754 755 756 757 758 759 760 761
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();
  }
}

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

803
  // if deletion is disabled, do nothing
804
  if (disable_delete_obsolete_files_ > 0) {
805 806 807
    return;
  }

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

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

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

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

850
  job_context->prev_log_number = versions_->prev_log_number();
I
Igor Canadi 已提交
851

I
Igor Canadi 已提交
852
  versions_->AddLiveFiles(&job_context->sst_live);
853 854 855 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
  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);
      }
    }
  }
888

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

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

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

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

I
Igor Canadi 已提交
991 992 993 994
  // 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 已提交
995 996
    return;
  }
997

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

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

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

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

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

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

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

    if (keep) {
      continue;
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

J
jorlow@chromium.org 已提交
1387 1388 1389
  return s;
}

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

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

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

1442 1443
    immutable_db_options_.wal_filter->ColumnFamilyLogNumberMap(cf_lognumber_map,
                                                               cf_name_id_map);
1444 1445 1446
  }
#endif

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

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

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

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

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

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

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

1544
#ifndef ROCKSDB_LITE
1545
      if (immutable_db_options_.wal_filter != nullptr) {
1546 1547 1548
        WriteBatch new_batch;
        bool batch_changed = false;

1549
        WalFilter::WalProcessingOption wal_processing_option =
1550 1551
            immutable_db_options_.wal_filter->LogRecordFound(
                log_number, fname, batch, &new_batch, &batch_changed);
1552

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

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

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

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

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

          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
1660
                                 *next_sequence);
1661
        }
J
jorlow@chromium.org 已提交
1662 1663 1664
      }
    }

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

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

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

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

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

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

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

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

1767 1768 1769
  event_logger_.Log() << "job" << job_id << "event"
                      << "recovery_finished";

J
jorlow@chromium.org 已提交
1770 1771 1772
  return status;
}

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

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

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

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

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

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

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

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

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

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

1912
  FileMetaData file_meta;
1913

1914 1915 1916 1917
  flush_job.PickMemTable();

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

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

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

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

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

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

2031 2032
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
2033
  bool exclusive = options.exclusive_manual_compaction;
I
Igor Canadi 已提交
2034 2035

  Status s = FlushMemTable(cfd, FlushOptions());
L
Lei Jin 已提交
2036
  if (!s.ok()) {
2037
    LogFlush(immutable_db_options_.info_log);
L
Lei Jin 已提交
2038 2039 2040
    return s;
  }

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

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

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

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

L
Lei Jin 已提交
2130
  return s;
2131 2132
}

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

  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  assert(cfd);
2148 2149 2150 2151

  Status s;
  JobContext job_context(0, true);
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL,
2152
                       immutable_db_options_.info_log.get());
2153 2154

  // Perform CompactFiles
2155
  SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
2156 2157 2158
  {
    InstrumentedMutexLock l(&mutex_);

2159
    // This call will unlock/lock the mutex to wait for current running
2160 2161
    // IngestExternalFile() calls to finish.
    WaitForIngestFile();
2162

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

  // 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());
2182
  }  // release the mutex
2183 2184 2185 2186 2187 2188 2189 2190 2191 2192

  // 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()) {
2193
      // no mutex is locked here.  No need to Unlock() and Lock() here.
2194 2195 2196 2197 2198
      PurgeObsoleteFiles(job_context);
    }
    job_context.Clean();
  }

2199
  return s;
I
Igor Canadi 已提交
2200
#endif  // ROCKSDB_LITE
2201 2202
}

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

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

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

2275 2276 2277
  auto pending_outputs_inserted_elem =
      CaptureCurrentFileNumberInPendingOutputs();

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

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

2307 2308 2309
  compaction_job.Prepare();

  mutex_.Unlock();
2310 2311
  TEST_SYNC_POINT("CompactFilesImpl:0");
  TEST_SYNC_POINT("CompactFilesImpl:1");
2312
  compaction_job.Run();
2313 2314
  TEST_SYNC_POINT("CompactFilesImpl:2");
  TEST_SYNC_POINT("CompactFilesImpl:3");
2315
  mutex_.Lock();
2316

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

2324
  ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);
2325 2326 2327 2328 2329 2330

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

2340 2341
  c.reset();

2342
  bg_compaction_scheduled_--;
2343 2344 2345
  if (bg_compaction_scheduled_ == 0) {
    bg_cv_.SignalAll();
  }
2346 2347 2348

  return status;
}
I
Igor Canadi 已提交
2349
#endif  // ROCKSDB_LITE
2350

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

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

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

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

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

2466
      persist_options_status = PersistOptions();
2467 2468
    }
  }
L
Lei Jin 已提交
2469

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

2525 2526
      write_controller_.set_max_delayed_write_rate(new_options.delayed_write_rate);

2527 2528
      mutable_db_options_ = new_options;

2529
      if (total_log_size_ > GetMaxTotalWalSize()) {
2530
        MaybeFlushColumnFamilies();
2531 2532
      }

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

2565 2566 2567 2568 2569 2570 2571 2572 2573
Status DBImpl::PersistOptions() {
  mutex_.AssertHeld();
  WriteThread::Writer w;
  write_thread_.EnterUnbatched(&w, &mutex_);
  Status s = WriteOptionsFile();
  write_thread_.ExitUnbatched(&w);
  return s;
}

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

    minimum_level = i;
  }
  return minimum_level;
}

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

2601 2602 2603 2604
  std::unique_ptr<SuperVersion> superversion_to_free;
  std::unique_ptr<SuperVersion> new_superversion(new SuperVersion());

  Status status;
I
Igor Canadi 已提交
2605

I
Islam AbdelRahman 已提交
2606
  InstrumentedMutexLock guard_lock(&mutex_);
2607 2608 2609

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

2616
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
2617
  // move to a smaller level
2618 2619
  int to_level = target_level;
  if (target_level < 0) {
2620
    to_level = FindMinimumEmptyLevelFitting(cfd, mutable_cf_options, level);
2621
  }
2622

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

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

2655 2656
    status = versions_->LogAndApply(cfd, mutable_cf_options, &edit, &mutex_,
                                    directories_.GetDbDir());
2657 2658
    superversion_to_free.reset(InstallSuperVersionAndScheduleWork(
        cfd, new_superversion.release(), mutable_cf_options));
2659

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

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

  refitting_level_ = false;
I
Igor Canadi 已提交
2672

L
Lei Jin 已提交
2673
  return status;
G
Gabor Cselle 已提交
2674 2675
}

2676 2677 2678
int DBImpl::NumberLevels(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->NumberLevels();
2679 2680
}

2681
int DBImpl::MaxMemCompactionLevel(ColumnFamilyHandle* column_family) {
2682
  return 0;
2683 2684
}

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

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

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

    need_log_dir_sync = !log_dir_synced_;
  }

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

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

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

2782
SequenceNumber DBImpl::GetLatestSequenceNumber() const {
2783 2784 2785
  return versions_->LastSequence();
}

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

G
Gabor Cselle 已提交
2793
  InternalKey begin_storage, end_storage;
2794
  CompactionArg* ca;
G
Gabor Cselle 已提交
2795

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

2827 2828
  TEST_SYNC_POINT("DBImpl::RunManualCompaction:0");
  TEST_SYNC_POINT("DBImpl::RunManualCompaction:1");
2829
  InstrumentedMutexLock l(&mutex_);
2830

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

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

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

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

2902
  assert(!manual.in_progress);
2903 2904
  assert(HasPendingManualCompaction());
  RemoveManualCompaction(&manual);
2905
  bg_cv_.SignalAll();
L
Lei Jin 已提交
2906
  return manual.status;
J
jorlow@chromium.org 已提交
2907 2908
}

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

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

2936
    if (cfd->imm()->NumNotFlushed() == 0 && cfd->mem()->IsEmpty()) {
2937 2938 2939 2940
      // Nothing to flush
      return Status::OK();
    }

2941
    WriteThread::Writer w;
2942 2943 2944
    if (!writes_stopped) {
      write_thread_.EnterUnbatched(&w, &mutex_);
    }
S
Stanislau Hlebik 已提交
2945

I
Igor Canadi 已提交
2946
    // SwitchMemtable() will release and reacquire mutex
S
Stanislau Hlebik 已提交
2947
    // during execution
I
Igor Canadi 已提交
2948
    s = SwitchMemtable(cfd, &context);
2949 2950 2951 2952

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

S
Stanislau Hlebik 已提交
2954 2955
    cfd->imm()->FlushRequested();

2956 2957 2958
    // schedule flush
    SchedulePendingFlush(cfd);
    MaybeScheduleFlushOrCompaction();
S
Stanislau Hlebik 已提交
2959
  }
S
Stanislau Hlebik 已提交
2960

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

2968
Status DBImpl::WaitForFlushMemTable(ColumnFamilyData* cfd) {
2969 2970
  Status s;
  // Wait until the compaction completes
2971
  InstrumentedMutexLock l(&mutex_);
2972
  while (cfd->imm()->NumNotFlushed() > 0 && bg_error_.ok()) {
2973 2974 2975
    if (shutting_down_.load(std::memory_order_acquire)) {
      return Status::ShutdownInProgress();
    }
2976 2977 2978 2979 2980 2981
    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");
    }
2982 2983
    bg_cv_.Wait();
  }
2984
  if (!bg_error_.ok()) {
2985 2986 2987
    s = bg_error_;
  }
  return s;
H
heyongqiang 已提交
2988 2989
}

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

  return s;
}

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

3018
  while (unscheduled_flushes_ > 0 &&
3019
         bg_flush_scheduled_ < immutable_db_options_.max_background_flushes) {
3020 3021
    unscheduled_flushes_--;
    bg_flush_scheduled_++;
3022
    env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::HIGH, this);
3023 3024
  }

3025 3026
  auto bg_compactions_allowed = BGCompactionsAllowed();

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

3039 3040 3041 3042 3043
  if (bg_compaction_paused_ > 0) {
    // we paused the background compaction
    return;
  }

3044
  if (HasExclusiveManualCompaction()) {
3045 3046 3047 3048 3049
    // only manual compactions are allowed to run. don't schedule automatic
    // compactions
    return;
  }

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

3062 3063 3064 3065 3066 3067 3068 3069 3070
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);
}

3071
int DBImpl::BGCompactionsAllowed() const {
3072
  mutex_.AssertHeld();
3073
  if (write_controller_.NeedSpeedupCompaction()) {
3074
    return mutable_db_options_.max_background_compactions;
3075
  } else {
3076
    return mutable_db_options_.base_background_compactions;
3077 3078 3079
  }
}

3080 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
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_;
3123 3124 3125
  }
}

3126 3127 3128 3129 3130 3131 3132 3133
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));
}

3134
void DBImpl::BGWorkFlush(void* db) {
3135
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
3136
  TEST_SYNC_POINT("DBImpl::BGWorkFlush");
3137
  reinterpret_cast<DBImpl*>(db)->BackgroundCallFlush();
3138
  TEST_SYNC_POINT("DBImpl::BGWorkFlush:done");
3139 3140
}

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

3149 3150
void DBImpl::BGWorkPurge(void* db) {
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
3151
  TEST_SYNC_POINT("DBImpl::BGWorkPurge:start");
3152
  reinterpret_cast<DBImpl*>(db)->BackgroundCallPurge();
3153
  TEST_SYNC_POINT("DBImpl::BGWorkPurge:end");
3154 3155
}

3156 3157 3158 3159 3160 3161 3162
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");
3163 3164
}

3165 3166 3167
void DBImpl::BackgroundCallPurge() {
  mutex_.Lock();

3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179
  // 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();
3180

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

3205
Status DBImpl::BackgroundFlush(bool* made_progress, JobContext* job_context,
H
Haobo Xu 已提交
3206
                               LogBuffer* log_buffer) {
3207
  mutex_.AssertHeld();
3208

3209 3210 3211 3212 3213 3214 3215
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

  if (!status.ok()) {
    return status;
3216 3217
  }

3218 3219 3220
  ColumnFamilyData* cfd = nullptr;
  while (!flush_queue_.empty()) {
    // This cfd is already referenced
I
Igor Canadi 已提交
3221
    auto first_cfd = PopFirstFromFlushQueue();
3222

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

    // found a flush!
I
Igor Canadi 已提交
3232
    cfd = first_cfd;
3233 3234 3235 3236 3237 3238 3239 3240 3241
    break;
  }

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

3255
void DBImpl::BackgroundCallFlush() {
3256
  bool made_progress = false;
3257
  JobContext job_context(next_job_id_.fetch_add(1), true);
3258 3259
  assert(bg_flush_scheduled_);

3260 3261
  TEST_SYNC_POINT("DBImpl::BackgroundCallFlush:start");

3262 3263
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL,
                       immutable_db_options_.info_log.get());
H
Haobo Xu 已提交
3264
  {
3265
    InstrumentedMutexLock l(&mutex_);
3266
    num_running_flushes_++;
H
Haobo Xu 已提交
3267

I
Igor Canadi 已提交
3268 3269 3270
    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

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

I
Igor Canadi 已提交
3291 3292
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

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

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

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

    // This call will unlock/lock the mutex to wait for current running
3337 3338
    // IngestExternalFile() calls to finish.
    WaitForIngestFile();
3339

3340
    num_running_compactions_++;
I
Igor Canadi 已提交
3341 3342 3343 3344

    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

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

I
Igor Canadi 已提交
3368 3369
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

3370 3371 3372 3373
    // 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());
3374 3375

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

3391 3392
    assert(num_running_compactions_ > 0);
    num_running_compactions_--;
3393
    bg_compaction_scheduled_--;
J
jorlow@chromium.org 已提交
3394

3395 3396
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();

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

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

3425 3426 3427 3428 3429
  bool is_manual = (manual_compaction != nullptr);

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

3431
  CompactionJobStats compaction_job_stats;
3432 3433 3434 3435 3436 3437
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

  if (!status.ok()) {
3438
    if (is_manual) {
3439 3440 3441 3442 3443
      manual_compaction->status = status;
      manual_compaction->done = true;
      manual_compaction->in_progress = false;
      delete manual_compaction->compaction;
      manual_compaction = nullptr;
3444
    }
3445
    return status;
3446 3447
  }

3448 3449
  if (is_manual) {
    // another thread cannot pick up the same work
3450
    manual_compaction->in_progress = true;
3451 3452 3453
  }

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

3495 3496 3497 3498 3499 3500
    if (HaveManualCompaction(cfd)) {
      // Can't compact right now, but try again later
      TEST_SYNC_POINT("DBImpl::BackgroundCompaction()::Conflict");
      return Status::OK();
    }

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

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

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

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

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

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

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

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

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

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

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

I
Igor Canadi 已提交
3648
    mutex_.Unlock();
3649
    compaction_job.Run();
3650
    TEST_SYNC_POINT("DBImpl::BackgroundCompaction:NonTrivial:AfterRun");
I
Igor Canadi 已提交
3651
    mutex_.Lock();
3652

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

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

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

3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744
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;
}

3745
bool DBImpl::ShouldntRunManualCompaction(ManualCompaction* m) {
3746 3747
  if (num_running_ingest_file_ > 0) {
    // We need to wait for other IngestExternalFile() calls to finish
3748 3749 3750
    // before running a manual compaction.
    return true;
  }
3751 3752
  if (m->exclusive) {
    return (bg_compaction_scheduled_ > 0);
3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 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
  }
  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;
}

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

  return bsize;
}

3834 3835
namespace {
struct IterState {
3836
  IterState(DBImpl* _db, InstrumentedMutex* _mu, SuperVersion* _super_version,
3837
            bool _background_purge)
3838 3839 3840
      : db(_db),
        mu(_mu),
        super_version(_super_version),
3841
        background_purge(_background_purge) {}
3842 3843

  DBImpl* db;
3844
  InstrumentedMutex* mu;
3845
  SuperVersion* super_version;
3846
  bool background_purge;
3847 3848 3849 3850
};

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

3852
  if (state->super_version->Unref()) {
3853 3854 3855
    // Job id == 0 means that this is not our background process, but rather
    // user thread
    JobContext job_context(0);
3856

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

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

3882 3883
  delete state;
}
H
Hans Wennborg 已提交
3884
}  // namespace
3885

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

3931 3932 3933 3934
ColumnFamilyHandle* DBImpl::DefaultColumnFamily() const {
  return default_cf_handle_;
}

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

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

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

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

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

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

3999 4000 4001
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

4002 4003 4004 4005 4006 4007
  // Acquire SuperVersion
  SuperVersion* sv = GetAndRefSuperVersion(cfd);

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

4008
  SequenceNumber snapshot;
L
Lei Jin 已提交
4009 4010 4011
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
4012
  } else {
4013 4014 4015 4016 4017 4018 4019 4020 4021 4022
    // 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.
4023
    snapshot = versions_->LastSequence();
J
jorlow@chromium.org 已提交
4024
  }
4025 4026
  TEST_SYNC_POINT("DBImpl::GetImpl:3");
  TEST_SYNC_POINT("DBImpl::GetImpl:4");
4027

4028
  // Prepare to store a list of merge operations if merge occurs.
4029
  MergeContext merge_context;
4030
  RangeDelAggregator range_del_agg(cfd->internal_comparator(), snapshot);
4031

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

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

4064 4065
  {
    PERF_TIMER_GUARD(get_post_process_time);
4066

4067
    ReturnAndCleanupSuperVersion(cfd, sv);
4068

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

4076
std::vector<Status> DBImpl::MultiGet(
L
Lei Jin 已提交
4077
    const ReadOptions& read_options,
4078
    const std::vector<ColumnFamilyHandle*>& column_family,
4079
    const std::vector<Slice>& keys, std::vector<std::string>* values) {
4080

L
Lei Jin 已提交
4081
  StopWatch sw(env_, stats_, DB_MULTIGET);
4082
  PERF_TIMER_GUARD(get_snapshot_time);
K
Kai Liu 已提交
4083

4084
  SequenceNumber snapshot;
4085

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

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

4115 4116
  // Contain a list of merge operations if merge occurs.
  MergeContext merge_context;
4117

4118
  // Note: this always resizes the values array
4119 4120 4121
  size_t num_keys = keys.size();
  std::vector<Status> stat_list(num_keys);
  values->resize(num_keys);
4122 4123

  // Keep track of bytes that we read for statistics-recording later
4124
  uint64_t bytes_read = 0;
L
Lei Jin 已提交
4125
  PERF_TIMER_STOP(get_snapshot_time);
4126 4127 4128 4129

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

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

    if (s.ok()) {
M
Maysam Yabandeh 已提交
4166
      bytes_read += value->size();
4167 4168 4169 4170
    }
  }

  // Post processing (decrement reference counts and record statistics)
4171
  PERF_TIMER_GUARD(get_post_process_time);
4172 4173
  autovector<SuperVersion*> superversions_to_delete;

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

  for (auto td : superversions_to_delete) {
    delete td;
  }
  for (auto mgd : multiget_cf_data) {
    delete mgd.second;
4190
  }
4191

L
Lei Jin 已提交
4192 4193 4194
  RecordTick(stats_, NUMBER_MULTIGET_CALLS);
  RecordTick(stats_, NUMBER_MULTIGET_KEYS_READ, num_keys);
  RecordTick(stats_, NUMBER_MULTIGET_BYTES_READ, bytes_read);
4195
  MeasureTime(stats_, BYTES_PER_MULTIGET, bytes_read);
L
Lei Jin 已提交
4196
  PERF_TIMER_STOP(get_post_process_time);
4197

4198
  return stat_list;
4199 4200
}

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

  s = CheckCompressionSupported(cf_options);
4209
  if (s.ok() && immutable_db_options_.allow_concurrent_memtable_write) {
4210 4211
    s = CheckConcurrentWritesSupported(cf_options);
  }
4212 4213 4214 4215
  if (!s.ok()) {
    return s;
  }

Y
Yueh-Hsuan Chiang 已提交
4216
  {
4217
    InstrumentedMutexLock l(&mutex_);
I
Igor Canadi 已提交
4218

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

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

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

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

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

4290 4291 4292 4293
Status DBImpl::DropColumnFamily(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
  if (cfd->GetID() == 0) {
4294 4295
    return Status::InvalidArgument("Can't drop default column family");
  }
4296

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

I
Igor Canadi 已提交
4299 4300
  VersionEdit edit;
  edit.DropColumnFamily();
4301 4302
  edit.SetColumnFamily(cfd->GetID());

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

    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()) {
4329
        if (!c->IsDropped() && !c->mem()->IsSnapshotSupported()) {
S
sdong 已提交
4330 4331 4332 4333 4334 4335
          new_is_snapshot_supported = false;
          break;
        }
      }
      is_snapshot_supported_ = new_is_snapshot_supported;
    }
4336
  }
4337

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

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

4367
  return s;
4368 4369
}

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

4381
  // If block_cache is enabled and the index block of the table didn't
K
Kai Liu 已提交
4382 4383 4384
  // 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();
4385 4386
}

4387
Iterator* DBImpl::NewIterator(const ReadOptions& read_options,
4388
                              ColumnFamilyHandle* column_family) {
4389 4390 4391 4392
  if (read_options.read_tier == kPersistedTier) {
    return NewErrorIterator(Status::NotSupported(
        "ReadTier::kPersistedData is not yet supported in iterators."));
  }
4393 4394
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
T
Tomislav Novak 已提交
4395

V
Venkatesh Radhakrishnan 已提交
4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413
  XFUNC_TEST("", "managed_new", managed_new1, xf_manage_new,
             reinterpret_cast<DBImpl*>(this),
             const_cast<ReadOptions*>(&read_options), is_snapshot_supported_);
  if (read_options.managed) {
#ifdef ROCKSDB_LITE
    // not supported in lite version
    return NewErrorIterator(Status::InvalidArgument(
        "Managed Iterators not supported in RocksDBLite."));
#else
    if ((read_options.tailing) || (read_options.snapshot != nullptr) ||
        (is_snapshot_supported_)) {
      return new ManagedIterator(this, read_options, cfd);
    }
    // Managed iter not supported
    return NewErrorIterator(Status::InvalidArgument(
        "Managed Iterators not supported without snapshots."));
#endif
  } else if (read_options.tailing) {
I
Igor Canadi 已提交
4414 4415 4416 4417
#ifdef ROCKSDB_LITE
    // not supported in lite version
    return nullptr;
#else
4418 4419
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
    auto iter = new ForwardIterator(this, read_options, cfd, sv);
4420 4421
    return NewDBIterator(
        env_, *cfd->ioptions(), cfd->user_comparator(), iter,
4422 4423
        kMaxSequenceNumber,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
4424 4425
        sv->version_number, read_options.iterate_upper_bound,
        read_options.prefix_same_as_start, read_options.pin_data);
I
Igor Canadi 已提交
4426
#endif
T
Tomislav Novak 已提交
4427
  } else {
4428
    SequenceNumber latest_snapshot = versions_->LastSequence();
4429
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
4430

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

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
    // 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         | <----+
    // |       |   +-------------------+
    // |       |                       |
    // +-------+-----------------------+
    //
4473 4474
    // ArenaWrappedDBIter inlines an arena area where all the iterators in
    // the iterator tree are allocated in the order of being accessed when
4475 4476 4477 4478 4479
    // 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(
4480 4481
        env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
4482
        sv->version_number, read_options.iterate_upper_bound,
4483 4484
        read_options.prefix_same_as_start, read_options.pin_data,
        read_options.total_order_seek);
4485

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

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

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

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

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

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

  return Status::OK();
4569 4570
}

4571 4572
const Snapshot* DBImpl::GetSnapshot() { return GetSnapshotImpl(false); }

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

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

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

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

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

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

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

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

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

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

Status DBImpl::WriteImpl(const WriteOptions& write_options,
4643 4644 4645
                         WriteBatch* my_batch, WriteCallback* callback,
                         uint64_t* log_used, uint64_t log_ref,
                         bool disable_memtable) {
S
Stanislau Hlebik 已提交
4646 4647 4648
  if (my_batch == nullptr) {
    return Status::Corruption("Batch is nullptr!");
  }
4649 4650 4651
  if (write_options.timeout_hint_us != 0) {
    return Status::InvalidArgument("timeout_hint_us is deprecated");
  }
A
agiardullo 已提交
4652 4653

  Status status;
A
agiardullo 已提交
4654

A
agiardullo 已提交
4655 4656 4657
  bool xfunc_attempted_write = false;
  XFUNC_TEST("transaction", "transaction_xftest_write_impl",
             xf_transaction_write1, xf_transaction_write, write_options,
4658
             immutable_db_options_, my_batch, callback, this, &status,
A
agiardullo 已提交
4659 4660 4661 4662 4663 4664
             &xfunc_attempted_write);
  if (xfunc_attempted_write) {
    // Test already did the write
    return status;
  }

4665
  PERF_TIMER_GUARD(write_pre_and_post_process_time);
4666
  WriteThread::Writer w;
S
Stanislau Hlebik 已提交
4667
  w.batch = my_batch;
L
Lei Jin 已提交
4668 4669
  w.sync = write_options.sync;
  w.disableWAL = write_options.disableWAL;
4670
  w.disable_memtable = disable_memtable;
S
Stanislau Hlebik 已提交
4671
  w.in_batch_group = false;
4672
  w.callback = callback;
4673
  w.log_ref = log_ref;
S
Stanislau Hlebik 已提交
4674

L
Lei Jin 已提交
4675
  if (!write_options.disableWAL) {
S
Stanislau Hlebik 已提交
4676 4677 4678
    RecordTick(stats_, WRITE_WITH_WAL);
  }

4679
  StopWatch write_sw(env_, immutable_db_options_.statistics.get(), DB_WRITE);
4680

4681
  write_thread_.JoinBatchGroup(&w);
4682 4683 4684 4685
  if (w.state == WriteThread::STATE_PARALLEL_FOLLOWER) {
    // we are a non-leader in a parallel group
    PERF_TIMER_GUARD(write_memtable_time);

4686 4687 4688 4689 4690
    if (log_used != nullptr) {
      *log_used = w.log_used;
    }

    if (w.ShouldWriteToMemtable()) {
4691 4692 4693 4694
      ColumnFamilyMemTablesImpl column_family_memtables(
          versions_->GetColumnFamilySet());
      WriteBatchInternal::SetSequence(w.batch, w.sequence);
      w.status = WriteBatchInternal::InsertInto(
4695
          &w, &column_family_memtables, &flush_scheduler_,
4696
          write_options.ignore_missing_column_families, 0 /*log_number*/, this,
S
sdong 已提交
4697
          true /*concurrent_memtable_writes*/);
4698
    }
4699 4700 4701

    if (write_thread_.CompleteParallelWorker(&w)) {
      // we're responsible for early exit
4702
      auto last_sequence = w.parallel_group->last_sequence;
4703 4704 4705 4706 4707
      versions_->SetLastSequence(last_sequence);
      write_thread_.EarlyExitParallelGroup(&w);
    }
    assert(w.state == WriteThread::STATE_COMPLETED);
    // STATE_COMPLETED conditional below handles exit
4708 4709

    status = w.FinalStatus();
4710 4711
  }
  if (w.state == WriteThread::STATE_COMPLETED) {
4712 4713 4714
    if (log_used != nullptr) {
      *log_used = w.log_used;
    }
4715
    // write is complete and leader has updated sequence
4716
    RecordTick(stats_, WRITE_DONE_BY_OTHER);
4717
    return w.FinalStatus();
4718 4719
  }
  // else we are the leader of the write batch group
4720
  assert(w.state == WriteThread::STATE_GROUP_LEADER);
4721

S
Stanislau Hlebik 已提交
4722 4723
  WriteContext context;
  mutex_.Lock();
I
Igor Canadi 已提交
4724 4725 4726 4727 4728

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

S
Stanislau Hlebik 已提交
4729 4730
  RecordTick(stats_, WRITE_DONE_BY_SELF);
  default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_DONE_BY_SELF, 1);
4731

4732 4733 4734 4735
  // 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.
4736 4737 4738
  assert(!single_column_family_mode_ ||
         versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1);

4739
  if (UNLIKELY(!single_column_family_mode_ &&
4740
               total_log_size_ > GetMaxTotalWalSize())) {
4741
    MaybeFlushColumnFamilies();
4742 4743 4744 4745 4746 4747
  } else if (UNLIKELY(write_buffer_manager_->ShouldFlush())) {
    // Before a new memtable is added in SwitchMemtable(),
    // write_buffer_manager_->ShouldFlush() will keep returning true. If another
    // thread is writing to another DB with the same write buffer, they may also
    // be flushed. We may end up with flushing much more DBs than needed. It's
    // suboptimal but still correct.
4748
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
4749 4750
        "Flushing column family with largest mem table size. Write buffer is "
        "using %" PRIu64 " bytes out of a total of %" PRIu64 ".",
4751 4752
        write_buffer_manager_->memory_usage(),
        write_buffer_manager_->buffer_size());
4753 4754
    // no need to refcount because drop is happening in write thread, so can't
    // happen while we're in the write thread
4755 4756 4757
    ColumnFamilyData* largest_cfd = nullptr;
    size_t largest_cfd_size = 0;

4758
    for (auto cfd : *versions_->GetColumnFamilySet()) {
4759 4760 4761
      if (cfd->IsDropped()) {
        continue;
      }
4762
      if (!cfd->mem()->IsEmpty()) {
4763 4764 4765 4766 4767 4768
        // 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;
4769 4770 4771
        }
      }
    }
4772 4773 4774 4775 4776 4777 4778 4779
    if (largest_cfd != nullptr) {
      status = SwitchMemtable(largest_cfd, &context);
      if (status.ok()) {
        largest_cfd->imm()->FlushRequested();
        SchedulePendingFlush(largest_cfd);
        MaybeScheduleFlushOrCompaction();
      }
    }
I
Igor Canadi 已提交
4780 4781 4782 4783 4784 4785 4786 4787 4788 4789
  }

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

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

4790 4791
  if (UNLIKELY(status.ok() && (write_controller_.IsStopped() ||
                               write_controller_.NeedsDelay()))) {
4792 4793
    PERF_TIMER_STOP(write_pre_and_post_process_time);
    PERF_TIMER_GUARD(write_delay_time);
S
sdong 已提交
4794 4795 4796 4797
    // 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 已提交
4798
    status = DelayWrite(last_batch_group_size_, write_options);
4799
    PERF_TIMER_START(write_pre_and_post_process_time);
I
Igor Canadi 已提交
4800 4801
  }

D
dgrogan@chromium.org 已提交
4802
  uint64_t last_sequence = versions_->LastSequence();
I
Igor Canadi 已提交
4803
  WriteThread::Writer* last_writer = &w;
4804
  autovector<WriteThread::Writer*> write_group;
4805 4806
  bool need_log_sync = !write_options.disableWAL && write_options.sync;
  bool need_log_dir_sync = need_log_sync && !log_dir_synced_;
A
agiardullo 已提交
4807

M
Maysam Yabandeh 已提交
4808
  bool logs_getting_synced = false;
S
Stanislau Hlebik 已提交
4809
  if (status.ok()) {
4810
    if (need_log_sync) {
4811 4812 4813 4814 4815 4816 4817
      while (logs_.front().getting_synced) {
        log_sync_cv_.Wait();
      }
      for (auto& log : logs_) {
        assert(!log.getting_synced);
        log.getting_synced = true;
      }
M
Maysam Yabandeh 已提交
4818
      logs_getting_synced = true;
4819 4820
    }

4821 4822 4823
    // 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
4824
    // into memtables
A
agiardullo 已提交
4825
  }
S
sdong 已提交
4826
  log::Writer* cur_log_writer = logs_.back().writer;
A
agiardullo 已提交
4827

4828 4829
  mutex_.Unlock();

A
agiardullo 已提交
4830 4831
  // At this point the mutex is unlocked

4832
  bool exit_completed_early = false;
4833 4834
  last_batch_group_size_ =
      write_thread_.EnterAsBatchGroupLeader(&w, &last_writer, &write_group);
4835

A
agiardullo 已提交
4836
  if (status.ok()) {
4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849
    // 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.
4850 4851
    bool parallel = immutable_db_options_.allow_concurrent_memtable_write &&
                    write_group.size() > 1;
4852 4853
    int total_count = 0;
    uint64_t total_byte_size = 0;
4854 4855
    for (auto writer : write_group) {
      if (writer->CheckCallback(this)) {
4856 4857 4858 4859 4860 4861 4862 4863 4864
        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));
        }
4865
      }
4866 4867 4868 4869 4870 4871 4872 4873
    }

    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);
4874
    MeasureTime(stats_, BYTES_PER_WRITE, total_byte_size);
4875
    PERF_TIMER_STOP(write_pre_and_post_process_time);
4876

4877
    if (write_options.disableWAL) {
4878
      has_unpersisted_data_ = true;
4879
    }
4880

4881 4882 4883
    uint64_t log_size = 0;
    if (!write_options.disableWAL) {
      PERF_TIMER_GUARD(write_wal_time);
4884

4885
      WriteBatch* merged_batch = nullptr;
4886 4887 4888 4889 4890
      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
4891
        merged_batch = write_group[0]->batch;
4892
        write_group[0]->log_used = logfile_number_;
4893 4894 4895 4896 4897
      } 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_;
4898
        for (auto writer : write_group) {
4899
          if (writer->ShouldWriteToWAL()) {
4900 4901
            WriteBatchInternal::Append(merged_batch, writer->batch,
                                       /*WAL_only*/ true);
4902
          }
4903
          writer->log_used = logfile_number_;
4904 4905 4906
        }
      }

4907 4908 4909 4910 4911
      if (log_used != nullptr) {
        *log_used = logfile_number_;
      }

      WriteBatchInternal::SetSequence(merged_batch, current_sequence);
4912 4913

      Slice log_entry = WriteBatchInternal::Contents(merged_batch);
S
sdong 已提交
4914
      status = cur_log_writer->AddRecord(log_entry);
4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930
      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_) {
4931
          status = log.writer->file()->Sync(immutable_db_options_.use_fsync);
4932 4933 4934 4935 4936 4937 4938 4939 4940 4941
          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();
        }
4942 4943
      }

4944 4945 4946 4947 4948 4949
      if (merged_batch == &tmp_batch_) {
        tmp_batch_.Clear();
      }
    }
    if (status.ok()) {
      PERF_TIMER_GUARD(write_memtable_time);
4950

4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962
      {
        // 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);
4963
          }
4964
          stats->AddDBStats(InternalStats::WAL_FILE_BYTES, log_size);
4965
        }
4966
        uint64_t for_other = write_group.size() - 1;
4967 4968 4969 4970
        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);
4971
          }
H
heyongqiang 已提交
4972
        }
4973
      }
Y
Yueh-Hsuan Chiang 已提交
4974

4975
      if (!parallel) {
4976
        status = WriteBatchInternal::InsertInto(
4977
            write_group, current_sequence, column_family_memtables_.get(),
4978
            &flush_scheduler_, write_options.ignore_missing_column_families,
S
sdong 已提交
4979
            0 /*log_number*/, this);
4980 4981 4982 4983 4984 4985 4986

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

4987
      } else {
4988
        WriteThread::ParallelGroup pg;
4989 4990
        pg.leader = &w;
        pg.last_writer = last_writer;
4991
        pg.last_sequence = last_sequence;
4992
        pg.early_exit_allowed = !need_log_sync;
4993
        pg.running.store(static_cast<uint32_t>(write_group.size()),
4994
                         std::memory_order_relaxed);
4995 4996
        write_thread_.LaunchParallelFollowers(&pg, current_sequence);

4997
        if (w.ShouldWriteToMemtable()) {
4998 4999 5000 5001 5002 5003
          // do leader write
          ColumnFamilyMemTablesImpl column_family_memtables(
              versions_->GetColumnFamilySet());
          assert(w.sequence == current_sequence);
          WriteBatchInternal::SetSequence(w.batch, w.sequence);
          w.status = WriteBatchInternal::InsertInto(
5004
              &w, &column_family_memtables, &flush_scheduler_,
5005
              write_options.ignore_missing_column_families, 0 /*log_number*/,
S
sdong 已提交
5006
              this, true /*concurrent_memtable_writes*/);
5007 5008
        }

5009 5010 5011
        // CompleteParallelWorker returns true if this thread should
        // handle exit, false means somebody else did
        exit_completed_early = !write_thread_.CompleteParallelWorker(&w);
5012
        status = w.FinalStatus();
5013
      }
A
agiardullo 已提交
5014

5015
      if (!exit_completed_early && w.status.ok()) {
5016 5017
        versions_->SetLastSequence(last_sequence);
        if (!need_log_sync) {
5018
          write_thread_.ExitAsBatchGroupLeader(&w, last_writer, w.status);
5019
          exit_completed_early = true;
5020
        }
5021
      }
5022 5023 5024 5025 5026 5027 5028 5029 5030

      // 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.
5031
      if (!status.ok() && bg_error_.ok() && !w.CallbackFailed()) {
5032
        bg_error_ = status;
5033
      }
5034
    }
5035
  }
5036
  PERF_TIMER_START(write_pre_and_post_process_time);
A
agiardullo 已提交
5037

5038
  if (immutable_db_options_.paranoid_checks && !status.ok() &&
M
Maysam Yabandeh 已提交
5039
      !w.CallbackFailed() && !status.IsBusy() && !status.IsIncomplete()) {
5040 5041 5042 5043 5044
    mutex_.Lock();
    if (bg_error_.ok()) {
      bg_error_ = status;  // stop compaction & fail any further writes
    }
    mutex_.Unlock();
I
Igor Canadi 已提交
5045
  }
5046

M
Maysam Yabandeh 已提交
5047
  if (logs_getting_synced) {
5048
    mutex_.Lock();
5049
    MarkLogsSynced(logfile_number_, need_log_dir_sync, status);
5050
    mutex_.Unlock();
5051 5052
  }

5053
  if (!exit_completed_early) {
5054
    write_thread_.ExitAsBatchGroupLeader(&w, last_writer, w.status);
5055
  }
5056

J
jorlow@chromium.org 已提交
5057 5058 5059
  return status;
}

5060
void DBImpl::MaybeFlushColumnFamilies() {
5061 5062 5063 5064 5065 5066
  mutex_.AssertHeld();

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

5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082
  auto oldest_alive_log = alive_log_files_.begin()->number;
  auto oldest_log_with_uncommited_prep = FindMinLogContainingOutstandingPrep();

  if (allow_2pc() &&
      unable_to_flush_oldest_log_ &&
      oldest_log_with_uncommited_prep > 0 &&
      oldest_log_with_uncommited_prep <= oldest_alive_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;
  }

  WriteContext context;

5083 5084 5085
  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,
5086
      oldest_alive_log, total_log_size_, GetMaxTotalWalSize());
5087 5088 5089 5090 5091 5092
  // 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;
    }
5093
    if (cfd->OldestLogToKeep() <= oldest_alive_log) {
5094 5095 5096 5097 5098 5099 5100 5101 5102
      auto status = SwitchMemtable(cfd, &context);
      if (!status.ok()) {
        break;
      }
      cfd->imm()->FlushRequested();
      SchedulePendingFlush(cfd);
    }
  }
  MaybeScheduleFlushOrCompaction();
5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122

  // we only mark this log as getting flushed if we have successfully
  // flushed all data in this log. If this log contains outstanding prepred
  // transactions then we cannot flush this log until those transactions are commited.

  unable_to_flush_oldest_log_ = false;

  if (allow_2pc()) {
    if (oldest_log_with_uncommited_prep == 0 ||
        oldest_log_with_uncommited_prep > oldest_alive_log) {
      // this log contains no outstanding prepared transactions
      alive_log_files_.begin()->getting_flushed = true;
    } 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 {
    alive_log_files_.begin()->getting_flushed = true;
  }
5123 5124 5125 5126 5127 5128 5129 5130 5131
}

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

5132 5133
// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
M
Maysam Yabandeh 已提交
5134 5135
Status DBImpl::DelayWrite(uint64_t num_bytes,
                          const WriteOptions& write_options) {
S
sdong 已提交
5136 5137 5138 5139
  uint64_t time_delayed = 0;
  bool delayed = false;
  {
    StopWatch sw(env_, stats_, WRITE_STALL, &time_delayed);
S
sdong 已提交
5140 5141
    auto delay = write_controller_.GetDelay(env_, num_bytes);
    if (delay > 0) {
M
Maysam Yabandeh 已提交
5142 5143 5144
      if (write_options.no_slowdown) {
        return Status::Incomplete();
      }
S
sdong 已提交
5145 5146
      mutex_.Unlock();
      delayed = true;
S
sdong 已提交
5147
      TEST_SYNC_POINT("DBImpl::DelayWrite:Sleep");
5148 5149
      // hopefully we don't have to sleep more than 2 billion microseconds
      env_->SleepForMicroseconds(static_cast<int>(delay));
S
sdong 已提交
5150 5151
      mutex_.Lock();
    }
5152

5153
    while (bg_error_.ok() && write_controller_.IsStopped()) {
M
Maysam Yabandeh 已提交
5154 5155 5156
      if (write_options.no_slowdown) {
        return Status::Incomplete();
      }
S
sdong 已提交
5157
      delayed = true;
5158 5159
      TEST_SYNC_POINT("DBImpl::DelayWrite:Wait");
      bg_cv_.Wait();
5160 5161
    }
  }
M
Maysam Yabandeh 已提交
5162
  assert(!delayed || !write_options.no_slowdown);
S
sdong 已提交
5163 5164 5165 5166 5167
  if (delayed) {
    default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_STALL_MICROS,
                                           time_delayed);
    RecordTick(stats_, STALL_MICROS, time_delayed);
  }
I
Igor Canadi 已提交
5168 5169

  return bg_error_;
5170 5171
}

I
Igor Canadi 已提交
5172 5173
Status DBImpl::ScheduleFlushes(WriteContext* context) {
  ColumnFamilyData* cfd;
5174
  while ((cfd = flush_scheduler_.TakeNextColumnFamily()) != nullptr) {
I
Igor Canadi 已提交
5175
    auto status = SwitchMemtable(cfd, context);
I
Igor Canadi 已提交
5176 5177 5178 5179 5180
    if (cfd->Unref()) {
      delete cfd;
    }
    if (!status.ok()) {
      return status;
S
Stanislau Hlebik 已提交
5181 5182
    }
  }
I
Igor Canadi 已提交
5183
  return Status::OK();
S
Stanislau Hlebik 已提交
5184 5185
}

5186 5187 5188
#ifndef ROCKSDB_LITE
void DBImpl::NotifyOnMemTableSealed(ColumnFamilyData* cfd,
                                    const MemTableInfo& mem_table_info) {
5189
  if (immutable_db_options_.listeners.size() == 0U) {
5190 5191 5192 5193 5194 5195
    return;
  }
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }

5196
  for (auto listener : immutable_db_options_.listeners) {
5197
    listener->OnMemTableSealed(mem_table_info);
5198
  }
5199 5200 5201
}
#endif  // ROCKSDB_LITE

S
Stanislau Hlebik 已提交
5202 5203
// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
I
Igor Canadi 已提交
5204
Status DBImpl::SwitchMemtable(ColumnFamilyData* cfd, WriteContext* context) {
S
Stanislau Hlebik 已提交
5205 5206 5207 5208 5209 5210 5211
  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.
5212
  assert(versions_->prev_log_number() == 0);
S
Stanislau Hlebik 已提交
5213
  bool creating_new_log = !log_empty_;
S
Sage Weil 已提交
5214
  uint64_t recycle_log_number = 0;
5215
  if (creating_new_log && immutable_db_options_.recycle_log_file_num &&
S
Sage Weil 已提交
5216 5217 5218 5219
      !log_recycle_files.empty()) {
    recycle_log_number = log_recycle_files.front();
    log_recycle_files.pop_front();
  }
S
Stanislau Hlebik 已提交
5220 5221 5222
  uint64_t new_log_number =
      creating_new_log ? versions_->NewFileNumber() : logfile_number_;
  SuperVersion* new_superversion = nullptr;
5223
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
5224 5225 5226 5227 5228 5229 5230 5231 5232 5233

  // 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
5234 5235 5236
  // 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();
5237 5238
  DBOptions db_options =
      BuildDBOptions(immutable_db_options_, mutable_db_options_);
5239 5240
  const auto preallocate_block_size =
    GetWalPreallocateBlockSize(mutable_cf_options.write_buffer_size);
S
Stanislau Hlebik 已提交
5241 5242 5243 5244
  mutex_.Unlock();
  Status s;
  {
    if (creating_new_log) {
5245
      EnvOptions opt_env_opt =
5246
          env_->OptimizeForLogWrite(env_options_, db_options);
S
Sage Weil 已提交
5247
      if (recycle_log_number) {
5248
        Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
S
Sage Weil 已提交
5249 5250
            "reusing log %" PRIu64 " from recycle list\n", recycle_log_number);
        s = env_->ReuseWritableFile(
5251 5252 5253
            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 已提交
5254
      } else {
5255 5256 5257
        s = NewWritableFile(
            env_, LogFileName(immutable_db_options_.wal_dir, new_log_number),
            &lfile, opt_env_opt);
S
Sage Weil 已提交
5258
      }
S
Stanislau Hlebik 已提交
5259 5260 5261
      if (s.ok()) {
        // Our final size should be less than write_buffer_size
        // (compression, etc) but err on the side of caution.
5262 5263 5264 5265

        // use preallocate_block_size instead
        // of calling GetWalPreallocateBlockSize()
        lfile->SetPreallocationBlockSize(preallocate_block_size);
5266 5267
        unique_ptr<WritableFileWriter> file_writer(
            new WritableFileWriter(std::move(lfile), opt_env_opt));
5268 5269 5270
        new_log =
            new log::Writer(std::move(file_writer), new_log_number,
                            immutable_db_options_.recycle_log_file_num > 0);
I
Igor Canadi 已提交
5271
      }
S
Stanislau Hlebik 已提交
5272 5273 5274
    }

    if (s.ok()) {
A
agiardullo 已提交
5275 5276
      SequenceNumber seq = versions_->LastSequence();
      new_mem = cfd->ConstructNewMemtable(mutable_cf_options, seq);
S
Stanislau Hlebik 已提交
5277 5278
      new_superversion = new SuperVersion();
    }
5279 5280 5281 5282 5283 5284 5285

#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 已提交
5286
  }
5287
  Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
5288 5289
      "[%s] New memtable created with log file: #%" PRIu64
      ". Immutable memtables: %d.\n",
5290
      cfd->GetName().c_str(), new_log_number, num_imm_unflushed);
S
Stanislau Hlebik 已提交
5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302
  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;
5303
    log_dir_synced_ = false;
5304
    logs_.emplace_back(logfile_number_, new_log);
S
Stanislau Hlebik 已提交
5305
    alive_log_files_.push_back(LogFileNumberSize(logfile_number_));
I
Igor Canadi 已提交
5306
    for (auto loop_cfd : *versions_->GetColumnFamilySet()) {
S
Stanislau Hlebik 已提交
5307 5308 5309 5310
      // 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 已提交
5311
      if (loop_cfd->mem()->GetFirstSequenceNumber() == 0 &&
5312
          loop_cfd->imm()->NumNotFlushed() == 0) {
I
Igor Canadi 已提交
5313
        loop_cfd->SetLogNumber(logfile_number_);
5314
      }
5315 5316
    }
  }
S
Stanislau Hlebik 已提交
5317
  cfd->mem()->SetNextLogNumber(logfile_number_);
5318
  cfd->imm()->Add(cfd->mem(), &context->memtables_to_free_);
S
Stanislau Hlebik 已提交
5319 5320
  new_mem->Ref();
  cfd->SetMemtable(new_mem);
I
Igor Canadi 已提交
5321 5322
  context->superversions_to_free_.push_back(InstallSuperVersionAndScheduleWork(
      cfd, new_superversion, mutable_cf_options));
5323 5324 5325
  return s;
}

I
Igor Canadi 已提交
5326
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
5327 5328 5329 5330 5331
Status DBImpl::GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                        TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

5332 5333
  // Increment the ref count
  mutex_.Lock();
I
Igor Canadi 已提交
5334
  auto version = cfd->current();
5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfAllTables(props);

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

  return s;
}
5347 5348

Status DBImpl::GetPropertiesOfTablesInRange(ColumnFamilyHandle* column_family,
5349
                                            const Range* range, std::size_t n,
5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369
                                            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 已提交
5370
#endif  // ROCKSDB_LITE
5371

I
Igor Canadi 已提交
5372 5373 5374 5375
const std::string& DBImpl::GetName() const {
  return dbname_;
}

5376 5377 5378 5379
Env* DBImpl::GetEnv() const {
  return env_;
}

5380 5381
Options DBImpl::GetOptions(ColumnFamilyHandle* column_family) const {
  InstrumentedMutexLock l(&mutex_);
5382
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
5383 5384
  return Options(BuildDBOptions(immutable_db_options_, mutable_db_options_),
                 cfh->cfd()->GetLatestCFOptions());
I
Igor Canadi 已提交
5385 5386
}

5387 5388 5389 5390
DBOptions DBImpl::GetDBOptions() const {
  InstrumentedMutexLock l(&mutex_);
  return BuildDBOptions(immutable_db_options_, mutable_db_options_);
}
5391

5392
bool DBImpl::GetProperty(ColumnFamilyHandle* column_family,
5393
                         const Slice& property, std::string* value) {
5394
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
5395
  value->clear();
5396
  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
5397 5398 5399
  if (property_info == nullptr) {
    return false;
  } else if (property_info->handle_int) {
5400
    uint64_t int_value;
5401 5402
    bool ret_value =
        GetIntPropertyInternal(cfd, *property_info, false, &int_value);
5403
    if (ret_value) {
5404
      *value = ToString(int_value);
5405 5406
    }
    return ret_value;
5407
  } else if (property_info->handle_string) {
5408
    InstrumentedMutexLock l(&mutex_);
5409
    return cfd->internal_stats()->GetStringProperty(*property_info, property,
5410 5411
                                                    value);
  }
5412 5413 5414 5415
  // 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 已提交
5416 5417
}

5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435
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;
}

5436 5437
bool DBImpl::GetIntProperty(ColumnFamilyHandle* column_family,
                            const Slice& property, uint64_t* value) {
5438 5439
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
  if (property_info == nullptr || property_info->handle_int == nullptr) {
5440 5441
    return false;
  }
5442
  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
5443
  return GetIntPropertyInternal(cfd, *property_info, false, value);
5444 5445
}

5446
bool DBImpl::GetIntPropertyInternal(ColumnFamilyData* cfd,
5447 5448 5449 5450
                                    const DBPropertyInfo& property_info,
                                    bool is_locked, uint64_t* value) {
  assert(property_info.handle_int != nullptr);
  if (!property_info.need_out_of_mutex) {
5451 5452
    if (is_locked) {
      mutex_.AssertHeld();
5453
      return cfd->internal_stats()->GetIntProperty(property_info, value, this);
5454 5455
    } else {
      InstrumentedMutexLock l(&mutex_);
5456
      return cfd->internal_stats()->GetIntProperty(property_info, value, this);
5457
    }
5458
  } else {
5459 5460 5461 5462 5463 5464
    SuperVersion* sv = nullptr;
    if (!is_locked) {
      sv = GetAndRefSuperVersion(cfd);
    } else {
      sv = cfd->GetSuperVersion();
    }
5465 5466

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

5469 5470 5471
    if (!is_locked) {
      ReturnAndCleanupSuperVersion(cfd, sv);
    }
5472 5473 5474 5475 5476

    return ret;
  }
}

5477 5478
bool DBImpl::GetAggregatedIntProperty(const Slice& property,
                                      uint64_t* aggregated_value) {
5479 5480
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
  if (property_info == nullptr || property_info->handle_int == nullptr) {
5481 5482 5483 5484 5485 5486 5487 5488 5489
    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()) {
5490
      if (GetIntPropertyInternal(cfd, *property_info, true, &value)) {
5491 5492 5493 5494 5495 5496 5497 5498 5499 5500
        sum += value;
      } else {
        return false;
      }
    }
  }
  *aggregated_value = sum;
  return true;
}

5501 5502
SuperVersion* DBImpl::GetAndRefSuperVersion(ColumnFamilyData* cfd) {
  // TODO(ljin): consider using GetReferencedSuperVersion() directly
I
Igor Canadi 已提交
5503
  return cfd->GetThreadLocalSuperVersion(&mutex_);
5504 5505
}

A
agiardullo 已提交
5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517
// 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);
}

5518 5519
void DBImpl::ReturnAndCleanupSuperVersion(ColumnFamilyData* cfd,
                                          SuperVersion* sv) {
I
Igor Canadi 已提交
5520
  bool unref_sv = !cfd->ReturnThreadLocalSuperVersion(sv);
5521 5522 5523 5524 5525

  if (unref_sv) {
    // Release SuperVersion
    if (sv->Unref()) {
      {
5526
        InstrumentedMutexLock l(&mutex_);
5527 5528 5529 5530 5531 5532 5533
        sv->Cleanup();
      }
      delete sv;
      RecordTick(stats_, NUMBER_SUPERVERSION_CLEANUPS);
    }
    RecordTick(stats_, NUMBER_SUPERVERSION_RELEASES);
  }
5534 5535
}

A
agiardullo 已提交
5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559
// 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();
}

5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581
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);
}

5582
void DBImpl::GetApproximateSizes(ColumnFamilyHandle* column_family,
5583
                                 const Range* range, int n, uint64_t* sizes,
5584 5585 5586
                                 uint8_t include_flags) {
  assert(include_flags & DB::SizeApproximationFlags::INCLUDE_FILES ||
         include_flags & DB::SizeApproximationFlags::INCLUDE_MEMTABLES);
J
jorlow@chromium.org 已提交
5587
  Version* v;
5588 5589
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
5590 5591
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
  v = sv->current;
J
jorlow@chromium.org 已提交
5592 5593 5594

  for (int i = 0; i < n; i++) {
    // Convert user_key into a corresponding internal key.
5595 5596
    InternalKey k1(range[i].start, kMaxSequenceNumber, kValueTypeForSeek);
    InternalKey k2(range[i].limit, kMaxSequenceNumber, kValueTypeForSeek);
V
Vitaliy Liptchinsky 已提交
5597
    sizes[i] = 0;
5598
    if (include_flags & DB::SizeApproximationFlags::INCLUDE_FILES) {
V
Vitaliy Liptchinsky 已提交
5599
      sizes[i] += versions_->ApproximateSize(v, k1.Encode(), k2.Encode());
5600 5601
    }
    if (include_flags & DB::SizeApproximationFlags::INCLUDE_MEMTABLES) {
5602 5603
      sizes[i] += sv->mem->ApproximateStats(k1.Encode(), k2.Encode()).size;
      sizes[i] += sv->imm->ApproximateStats(k1.Encode(), k2.Encode()).size;
5604
    }
J
jorlow@chromium.org 已提交
5605 5606
  }

5607
  ReturnAndCleanupSuperVersion(cfd, sv);
J
jorlow@chromium.org 已提交
5608 5609
}

I
Igor Canadi 已提交
5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625
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 已提交
5626 5627 5628 5629 5630
#ifndef ROCKSDB_LITE
Status DBImpl::GetUpdatesSince(
    SequenceNumber seq, unique_ptr<TransactionLogIterator>* iter,
    const TransactionLogIterator::ReadOptions& read_options) {

L
Lei Jin 已提交
5631
  RecordTick(stats_, GET_UPDATES_SINCE_CALLS);
I
Igor Canadi 已提交
5632 5633 5634
  if (seq > versions_->LastSequence()) {
    return Status::NotFound("Requested sequence not yet written in the db");
  }
I
Igor Canadi 已提交
5635
  return wal_manager_.GetUpdatesSince(seq, iter, read_options, versions_.get());
I
Igor Canadi 已提交
5636 5637
}

5638 5639 5640
Status DBImpl::DeleteFile(std::string name) {
  uint64_t number;
  FileType type;
5641 5642 5643
  WalFileType log_type;
  if (!ParseFileName(name, &number, &type, &log_type) ||
      (type != kTableFile && type != kLogFile)) {
5644
    Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
5645
        "DeleteFile %s failed.\n", name.c_str());
5646 5647 5648
    return Status::InvalidArgument("Invalid file name");
  }

5649 5650 5651 5652
  Status status;
  if (type == kLogFile) {
    // Only allow deleting archived log files
    if (log_type != kArchivedLogFile) {
5653 5654
      Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
          "DeleteFile %s failed - not archived log.\n", name.c_str());
5655 5656
      return Status::NotSupported("Delete only supported for archived logs");
    }
5657 5658
    status =
        env_->DeleteFile(immutable_db_options_.wal_dir + "/" + name.c_str());
5659
    if (!status.ok()) {
5660 5661 5662
      Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
          "DeleteFile %s failed -- %s.\n", name.c_str(),
          status.ToString().c_str());
5663 5664 5665 5666
    }
    return status;
  }

5667
  int level;
I
Igor Canadi 已提交
5668
  FileMetaData* metadata;
5669
  ColumnFamilyData* cfd;
5670
  VersionEdit edit;
5671
  JobContext job_context(next_job_id_.fetch_add(1), true);
D
Dhruba Borthakur 已提交
5672
  {
5673
    InstrumentedMutexLock l(&mutex_);
5674
    status = versions_->GetMetadataForFile(number, &level, &metadata, &cfd);
D
Dhruba Borthakur 已提交
5675
    if (!status.ok()) {
5676
      Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
5677
          "DeleteFile %s failed. File not found\n", name.c_str());
I
Igor Canadi 已提交
5678
      job_context.Clean();
D
Dhruba Borthakur 已提交
5679 5680
      return Status::InvalidArgument("File not found");
    }
5681
    assert(level < cfd->NumberLevels());
5682

D
Dhruba Borthakur 已提交
5683
    // If the file is being compacted no need to delete.
5684
    if (metadata->being_compacted) {
5685
      Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
5686
          "DeleteFile %s Skipped. File about to be compacted\n", name.c_str());
I
Igor Canadi 已提交
5687
      job_context.Clean();
D
Dhruba Borthakur 已提交
5688
      return Status::OK();
5689 5690
    }

D
Dhruba Borthakur 已提交
5691 5692 5693
    // 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 已提交
5694
    auto* vstoreage = cfd->current()->storage_info();
I
Igor Canadi 已提交
5695
    for (int i = level + 1; i < cfd->NumberLevels(); i++) {
S
sdong 已提交
5696
      if (vstoreage->NumLevelFiles(i) != 0) {
5697
        Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
5698
            "DeleteFile %s FAILED. File not in last level\n", name.c_str());
I
Igor Canadi 已提交
5699
        job_context.Clean();
D
Dhruba Borthakur 已提交
5700 5701 5702
        return Status::InvalidArgument("File not in last level");
      }
    }
5703
    // if level == 0, it has to be the oldest file
S
sdong 已提交
5704 5705
    if (level == 0 &&
        vstoreage->LevelFiles(0).back()->fd.GetNumber() != number) {
5706
      Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
5707
          "DeleteFile %s failed ---"
5708 5709
          " target file in level 0 must be the oldest.",
          name.c_str());
I
Igor Canadi 已提交
5710
      job_context.Clean();
5711 5712 5713
      return Status::InvalidArgument("File in level 0, but not oldest");
    }
    edit.SetColumnFamily(cfd->GetID());
D
Dhruba Borthakur 已提交
5714
    edit.DeleteFile(level, number);
5715
    status = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
5716
                                    &edit, &mutex_, directories_.GetDbDir());
I
Igor Canadi 已提交
5717
    if (status.ok()) {
I
Igor Canadi 已提交
5718 5719
      InstallSuperVersionAndScheduleWorkWrapper(
          cfd, &job_context, *cfd->GetLatestMutableCFOptions());
I
Igor Canadi 已提交
5720
    }
I
Igor Canadi 已提交
5721 5722
    FindObsoleteFiles(&job_context, false);
  }  // lock released here
5723

5724
  LogFlush(immutable_db_options_.info_log);
5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739
  // 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;
5740
  std::vector<FileMetaData*> deleted_files;
5741 5742 5743
  JobContext job_context(next_job_id_.fetch_add(1), true);
  {
    InstrumentedMutexLock l(&mutex_);
5744
    Version* input_version = cfd->current();
5745

5746 5747
    auto* vstorage = input_version->storage_info();
    for (int i = 1; i < cfd->NumberLevels(); i++) {
5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768
      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);
5769 5770 5771
      FileMetaData* level_file;
      for (uint32_t j = 0; j < level_files.size(); j++) {
        level_file = level_files[j];
5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782
        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());
5783 5784
          deleted_files.push_back(level_file);
          level_file->being_compacted = true;
5785 5786 5787 5788
        }
      }
    }
    if (edit.GetDeletedFiles().empty()) {
5789
      job_context.Clean();
5790 5791
      return Status::OK();
    }
5792
    input_version->Ref();
5793 5794 5795 5796 5797 5798
    status = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                    &edit, &mutex_, directories_.GetDbDir());
    if (status.ok()) {
      InstallSuperVersionAndScheduleWorkWrapper(
          cfd, &job_context, *cfd->GetLatestMutableCFOptions());
    }
5799 5800 5801 5802
    for (auto* deleted_file : deleted_files) {
      deleted_file->being_compacted = false;
    }
    input_version->Unref();
5803 5804 5805
    FindObsoleteFiles(&job_context, false);
  }  // lock released here

5806
  LogFlush(immutable_db_options_.info_log);
I
Igor Canadi 已提交
5807
  // remove files outside the db-lock
I
Igor Canadi 已提交
5808
  if (job_context.HaveSomethingToDelete()) {
5809
    // Call PurgeObsoleteFiles() without holding mutex.
I
Igor Canadi 已提交
5810
    PurgeObsoleteFiles(job_context);
5811
  }
I
Igor Canadi 已提交
5812
  job_context.Clean();
5813 5814 5815
  return status;
}

5816
void DBImpl::GetLiveFilesMetaData(std::vector<LiveFileMetaData>* metadata) {
5817
  InstrumentedMutexLock l(&mutex_);
5818
  versions_->GetLiveFilesMetaData(metadata);
5819
}
5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830

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 已提交
5831
#endif  // ROCKSDB_LITE
5832

I
Igor Canadi 已提交
5833 5834 5835 5836 5837 5838 5839
Status DBImpl::CheckConsistency() {
  mutex_.AssertHeld();
  std::vector<LiveFileMetaData> metadata;
  versions_->GetLiveFilesMetaData(&metadata);

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

I
Igor Canadi 已提交
5843 5844
    uint64_t fsize = 0;
    Status s = env_->GetFileSize(file_path, &fsize);
D
dyniusz 已提交
5845 5846 5847 5848
    if (!s.ok() &&
        env_->GetFileSize(Rocks2LevelTableFileName(file_path), &fsize).ok()) {
      s = Status::OK();
    }
I
Igor Canadi 已提交
5849 5850 5851 5852
    if (!s.ok()) {
      corruption_messages +=
          "Can't access " + md.name + ": " + s.ToString() + "\n";
    } else if (fsize != md.size) {
5853
      corruption_messages += "Sst file size mismatch: " + file_path +
I
Igor Canadi 已提交
5854
                             ". Size recorded in manifest " +
5855 5856
                             ToString(md.size) + ", actual size " +
                             ToString(fsize) + "\n";
I
Igor Canadi 已提交
5857 5858 5859 5860 5861 5862 5863 5864 5865
    }
  }
  if (corruption_messages.size() == 0) {
    return Status::OK();
  } else {
    return Status::Corruption(corruption_messages);
  }
}

5866
Status DBImpl::GetDbIdentity(std::string& identity) const {
5867 5868
  std::string idfilename = IdentityFileName(dbname_);
  const EnvOptions soptions;
5869 5870 5871 5872 5873 5874 5875 5876 5877
  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)));
5878
  }
5879

5880 5881 5882 5883 5884
  uint64_t file_size;
  s = env_->GetFileSize(idfilename, &file_size);
  if (!s.ok()) {
    return s;
  }
D
Dmitri Smirnov 已提交
5885
  char* buffer = reinterpret_cast<char*>(alloca(file_size));
5886
  Slice id;
5887
  s = id_file_reader->Read(static_cast<size_t>(file_size), &id, buffer);
5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898
  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 已提交
5899 5900
// Default implementations of convenience methods that subclasses of DB
// can call if they wish
5901
Status DB::Put(const WriteOptions& opt, ColumnFamilyHandle* column_family,
5902
               const Slice& key, const Slice& value) {
5903 5904 5905 5906
  // 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);
5907
  batch.Put(column_family, key, value);
J
jorlow@chromium.org 已提交
5908 5909 5910
  return Write(opt, &batch);
}

5911 5912
Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
J
jorlow@chromium.org 已提交
5913
  WriteBatch batch;
5914
  batch.Delete(column_family, key);
J
jorlow@chromium.org 已提交
5915 5916 5917
  return Write(opt, &batch);
}

A
Andres Noetzli 已提交
5918 5919 5920 5921 5922 5923 5924
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 已提交
5925 5926 5927 5928 5929 5930 5931 5932
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);
}

5933 5934
Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
5935
  WriteBatch batch;
5936
  batch.Merge(column_family, key, value);
5937 5938 5939
  return Write(opt, &batch);
}

5940
// Default implementation -- returns not supported status
L
Lei Jin 已提交
5941
Status DB::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
5942
                              const std::string& column_family_name,
5943
                              ColumnFamilyHandle** handle) {
5944
  return Status::NotSupported("");
5945
}
5946
Status DB::DropColumnFamily(ColumnFamilyHandle* column_family) {
5947
  return Status::NotSupported("");
5948
}
5949 5950 5951 5952
Status DB::DestroyColumnFamilyHandle(ColumnFamilyHandle* column_family) {
  delete column_family;
  return Status::OK();
}
5953

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

J
Jim Paton 已提交
5956
Status DB::Open(const Options& options, const std::string& dbname, DB** dbptr) {
5957 5958 5959 5960
  DBOptions db_options(options);
  ColumnFamilyOptions cf_options(options);
  std::vector<ColumnFamilyDescriptor> column_families;
  column_families.push_back(
5961
      ColumnFamilyDescriptor(kDefaultColumnFamilyName, cf_options));
5962
  std::vector<ColumnFamilyHandle*> handles;
5963
  Status s = DB::Open(db_options, dbname, column_families, &handles, dbptr);
5964 5965 5966 5967 5968 5969 5970
  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;
5971 5972
}

5973 5974
Status DB::Open(const DBOptions& db_options, const std::string& dbname,
                const std::vector<ColumnFamilyDescriptor>& column_families,
5975
                std::vector<ColumnFamilyHandle*>* handles, DB** dbptr) {
5976
  Status s = SanitizeOptionsByTable(db_options, column_families);
5977 5978 5979
  if (!s.ok()) {
    return s;
  }
5980

5981 5982 5983
  s = ValidateOptions(db_options, column_families);
  if (!s.ok()) {
    return s;
5984 5985
  }

5986
  *dbptr = nullptr;
5987
  handles->clear();
J
jorlow@chromium.org 已提交
5988

I
Igor Canadi 已提交
5989 5990 5991 5992
  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);
5993
  }
5994

I
Igor Canadi 已提交
5995
  DBImpl* impl = new DBImpl(db_options, dbname);
5996
  s = impl->env_->CreateDirIfMissing(impl->immutable_db_options_.wal_dir);
5997
  if (s.ok()) {
5998
    for (auto db_path : impl->immutable_db_options_.db_paths) {
5999
      s = impl->env_->CreateDirIfMissing(db_path.path);
6000 6001 6002 6003 6004 6005
      if (!s.ok()) {
        break;
      }
    }
  }

6006 6007 6008 6009 6010 6011
  if (!s.ok()) {
    delete impl;
    return s;
  }

  s = impl->CreateArchivalDirectory();
6012 6013 6014 6015
  if (!s.ok()) {
    delete impl;
    return s;
  }
J
jorlow@chromium.org 已提交
6016
  impl->mutex_.Lock();
6017 6018
  // Handles create_if_missing, error_if_exists
  s = impl->Recover(column_families);
J
jorlow@chromium.org 已提交
6019
  if (s.ok()) {
6020
    uint64_t new_log_number = impl->versions_->NewFileNumber();
6021
    unique_ptr<WritableFile> lfile;
6022
    EnvOptions soptions(db_options);
6023
    EnvOptions opt_env_options =
6024 6025 6026 6027 6028 6029 6030
        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 已提交
6031
    if (s.ok()) {
6032 6033
      lfile->SetPreallocationBlockSize(
          impl->GetWalPreallocateBlockSize(max_write_buffer_size));
6034
      impl->logfile_number_ = new_log_number;
6035 6036
      unique_ptr<WritableFileWriter> file_writer(
          new WritableFileWriter(std::move(lfile), opt_env_options));
6037 6038
      impl->logs_.emplace_back(
          new_log_number,
6039 6040 6041
          new log::Writer(
              std::move(file_writer), new_log_number,
              impl->immutable_db_options_.recycle_log_file_num > 0));
I
Igor Canadi 已提交
6042

6043 6044
      // set column family handles
      for (auto cf : column_families) {
I
Igor Canadi 已提交
6045 6046
        auto cfd =
            impl->versions_->GetColumnFamilySet()->GetColumnFamily(cf.name);
I
Igor Canadi 已提交
6047 6048 6049
        if (cfd != nullptr) {
          handles->push_back(
              new ColumnFamilyHandleImpl(cfd, impl, &impl->mutex_));
6050
          impl->NewThreadStatusCfInfo(cfd);
I
Igor Canadi 已提交
6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066
        } 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 已提交
6067
        }
6068
      }
I
Igor Canadi 已提交
6069 6070
    }
    if (s.ok()) {
6071
      for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
6072
        delete impl->InstallSuperVersionAndScheduleWork(
L
Lei Jin 已提交
6073
            cfd, nullptr, *cfd->GetLatestMutableCFOptions());
6074
      }
I
Igor Canadi 已提交
6075 6076
      impl->alive_log_files_.push_back(
          DBImpl::LogFileNumberSize(impl->logfile_number_));
J
jorlow@chromium.org 已提交
6077
      impl->DeleteObsoleteFiles();
6078
      s = impl->directories_.GetDbDir()->Fsync();
J
jorlow@chromium.org 已提交
6079 6080
    }
  }
6081

I
Igor Canadi 已提交
6082 6083
  if (s.ok()) {
    for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
S
sdong 已提交
6084
      if (cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
S
sdong 已提交
6085
        auto* vstorage = cfd->current()->storage_info();
6086
        for (int i = 1; i < vstorage->num_levels(); ++i) {
S
sdong 已提交
6087
          int num_files = vstorage->NumLevelFiles(i);
I
Igor Canadi 已提交
6088
          if (num_files > 0) {
I
Igor Canadi 已提交
6089 6090
            s = Status::InvalidArgument(
                "Not all files are at level 0. Cannot "
S
sdong 已提交
6091
                "open with FIFO compaction style.");
I
Igor Canadi 已提交
6092 6093 6094 6095
            break;
          }
        }
      }
S
sdong 已提交
6096 6097 6098
      if (!cfd->mem()->IsSnapshotSupported()) {
        impl->is_snapshot_supported_ = false;
      }
6099
      if (cfd->ioptions()->merge_operator != nullptr &&
6100 6101 6102 6103 6104
          !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 已提交
6105
      if (!s.ok()) {
6106 6107 6108 6109
        break;
      }
    }
  }
6110
  TEST_SYNC_POINT("DBImpl::Open:Opened");
6111
  Status persist_options_status;
6112
  if (s.ok()) {
6113 6114 6115 6116
    // Persist RocksDB Options before scheduling the compaction.
    // The WriteOptionsFile() will release and lock the mutex internally.
    persist_options_status = impl->WriteOptionsFile();

6117
    *dbptr = impl;
6118 6119 6120
    impl->opened_successfully_ = true;
    impl->MaybeScheduleFlushOrCompaction();
  }
6121 6122
  impl->mutex_.Unlock();

6123
#ifndef ROCKSDB_LITE
6124
  auto sfm = static_cast<SstFileManagerImpl*>(
6125
      impl->immutable_db_options_.sst_file_manager.get());
6126 6127 6128
  if (s.ok() && sfm) {
    // Notify SstFileManager about all sst files that already exist in
    // db_paths[0] when the DB is opened.
6129
    auto& db_path = impl->immutable_db_options_.db_paths[0];
6130
    std::vector<std::string> existing_files;
6131
    impl->immutable_db_options_.env->GetChildren(db_path.path, &existing_files);
6132 6133 6134 6135 6136 6137 6138 6139 6140 6141
    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);
      }
    }
  }
6142
#endif  // !ROCKSDB_LITE
6143

J
jorlow@chromium.org 已提交
6144
  if (s.ok()) {
6145 6146 6147
    Log(InfoLogLevel::INFO_LEVEL, impl->immutable_db_options_.info_log,
        "DB pointer %p", impl);
    LogFlush(impl->immutable_db_options_.info_log);
6148 6149 6150 6151 6152 6153
    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());
      }
6154
      Warn(impl->immutable_db_options_.info_log,
6155 6156 6157 6158
           "Unable to persist options in DB::Open() -- %s",
           persist_options_status.ToString().c_str());
    }
  }
6159
  if (!s.ok()) {
Y
Yueh-Hsuan Chiang 已提交
6160
    for (auto* h : *handles) {
6161 6162
      delete h;
    }
6163
    handles->clear();
J
jorlow@chromium.org 已提交
6164
    delete impl;
6165
    *dbptr = nullptr;
J
jorlow@chromium.org 已提交
6166 6167 6168 6169
  }
  return s;
}

6170 6171 6172
Status DB::ListColumnFamilies(const DBOptions& db_options,
                              const std::string& name,
                              std::vector<std::string>* column_families) {
I
Igor Canadi 已提交
6173
  return VersionSet::ListColumnFamilies(column_families, name, db_options.env);
6174 6175
}

6176 6177 6178
Snapshot::~Snapshot() {
}

J
jorlow@chromium.org 已提交
6179
Status DestroyDB(const std::string& dbname, const Options& options) {
6180
  const ImmutableDBOptions soptions(SanitizeOptions(dbname, options));
6181
  Env* env = soptions.env;
J
jorlow@chromium.org 已提交
6182
  std::vector<std::string> filenames;
6183

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

J
jorlow@chromium.org 已提交
6187
  FileLock* lock;
6188 6189
  const std::string lockname = LockFileName(dbname);
  Status result = env->LockFile(lockname, &lock);
J
jorlow@chromium.org 已提交
6190 6191 6192
  if (result.ok()) {
    uint64_t number;
    FileType type;
6193
    InfoLogPrefix info_log_prefix(!soptions.db_log_dir.empty(), dbname);
D
dgrogan@chromium.org 已提交
6194
    for (size_t i = 0; i < filenames.size(); i++) {
6195
      if (ParseFileName(filenames[i], &number, info_log_prefix.prefix, &type) &&
6196
          type != kDBLockFile) {  // Lock file will be deleted at end
K
Kosie van der Merwe 已提交
6197
        Status del;
6198
        std::string path_to_delete = dbname + "/" + filenames[i];
K
Kosie van der Merwe 已提交
6199
        if (type == kMetaDatabase) {
6200 6201
          del = DestroyDB(path_to_delete, options);
        } else if (type == kTableFile) {
6202
          del = DeleteSSTFile(&soptions, path_to_delete, 0);
K
Kosie van der Merwe 已提交
6203
        } else {
6204
          del = env->DeleteFile(path_to_delete);
K
Kosie van der Merwe 已提交
6205
        }
J
jorlow@chromium.org 已提交
6206 6207 6208 6209 6210
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
6211

6212 6213
    for (size_t path_id = 0; path_id < options.db_paths.size(); path_id++) {
      const auto& db_path = options.db_paths[path_id];
6214
      env->GetChildren(db_path.path, &filenames);
6215 6216 6217
      for (size_t i = 0; i < filenames.size(); i++) {
        if (ParseFileName(filenames[i], &number, &type) &&
            type == kTableFile) {  // Lock file will be deleted at end
6218
          std::string table_path = db_path.path + "/" + filenames[i];
6219
          Status del = DeleteSSTFile(&soptions, table_path,
6220
                                     static_cast<uint32_t>(path_id));
6221 6222 6223 6224 6225 6226 6227
          if (result.ok() && !del.ok()) {
            result = del;
          }
        }
      }
    }

I
Igor Canadi 已提交
6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245
    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;
6246
    env->GetChildren(archivedir, &archiveFiles);
6247 6248
    // Delete archival files.
    for (size_t i = 0; i < archiveFiles.size(); ++i) {
6249 6250
      if (ParseFileName(archiveFiles[i], &number, &type) &&
          type == kLogFile) {
6251
        Status del = env->DeleteFile(archivedir + "/" + archiveFiles[i]);
6252 6253 6254 6255 6256
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
6257

6258
    // ignore case where no archival directory is present.
6259
    env->DeleteDir(archivedir);
6260

J
jorlow@chromium.org 已提交
6261
    env->UnlockFile(lock);  // Ignore error since state is already gone
6262
    env->DeleteFile(lockname);
J
jorlow@chromium.org 已提交
6263
    env->DeleteDir(dbname);  // Ignore error in case dir contains other files
6264
    env->DeleteDir(soptions.wal_dir);
J
jorlow@chromium.org 已提交
6265 6266 6267 6268
  }
  return result;
}

6269 6270
Status DBImpl::WriteOptionsFile() {
#ifndef ROCKSDB_LITE
6271
  mutex_.AssertHeld();
6272 6273 6274

  std::vector<std::string> cf_names;
  std::vector<ColumnFamilyOptions> cf_opts;
6275 6276 6277 6278 6279

  // This part requires mutex to protect the column family options
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    if (cfd->IsDropped()) {
      continue;
6280
    }
6281
    cf_names.push_back(cfd->GetName());
6282
    cf_opts.push_back(cfd->GetLatestCFOptions());
6283 6284
  }

6285 6286
  // Unlock during expensive operations.  New writes cannot get here
  // because the single write thread ensures all new writes get queued.
6287 6288
  DBOptions db_options =
      BuildDBOptions(immutable_db_options_, mutable_db_options_);
6289 6290 6291 6292
  mutex_.Unlock();

  std::string file_name =
      TempOptionsFileName(GetName(), versions_->NewFileNumber());
6293 6294
  Status s =
      PersistRocksDBOptions(db_options, cf_names, cf_opts, file_name, GetEnv());
6295 6296 6297 6298 6299

  if (s.ok()) {
    s = RenameTempFileToOptionsFile(file_name);
  }
  mutex_.Lock();
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 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348
  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,
6349
                           immutable_db_options_.info_log, GetEnv());
6350 6351 6352 6353 6354 6355 6356 6357 6358
  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 已提交
6359 6360

  versions_->options_file_number_ = versions_->NewFileNumber();
6361
  std::string options_file_name =
W
Wanning Jiang 已提交
6362
      OptionsFileName(GetName(), versions_->options_file_number_);
6363 6364 6365 6366 6367 6368 6369 6370 6371 6372
  // 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 已提交
6373
#ifdef ROCKSDB_USING_THREAD_STATUS
6374

Y
Yueh-Hsuan Chiang 已提交
6375 6376
void DBImpl::NewThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
6377
  if (immutable_db_options_.enable_thread_tracking) {
6378 6379
    ThreadStatusUtil::NewColumnFamilyInfo(this, cfd, cfd->GetName(),
                                          cfd->ioptions()->env);
6380
  }
Y
Yueh-Hsuan Chiang 已提交
6381 6382 6383 6384
}

void DBImpl::EraseThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
6385
  if (immutable_db_options_.enable_thread_tracking) {
6386
    ThreadStatusUtil::EraseColumnFamilyInfo(cfd);
6387
  }
Y
Yueh-Hsuan Chiang 已提交
6388 6389 6390
}

void DBImpl::EraseThreadStatusDbInfo() const {
6391
  if (immutable_db_options_.enable_thread_tracking) {
6392
    ThreadStatusUtil::EraseDatabaseInfo(this);
6393
  }
Y
Yueh-Hsuan Chiang 已提交
6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408
}

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

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

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

6409 6410
//
// A global method that can dump out the build version
I
Igor Canadi 已提交
6411
void DumpRocksDBBuildVersion(Logger * log) {
I
Igor Canadi 已提交
6412
#if !defined(IOS_CROSS_COMPILE)
I
Igor Canadi 已提交
6413 6414
  // if we compile with Xcode, we don't run build_detect_vesion, so we don't
  // generate util/build_version.cc
6415 6416 6417 6418
  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 已提交
6419
#endif
6420 6421
}

A
agiardullo 已提交
6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438
#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
6439 6440 6441
Status DBImpl::GetLatestSequenceForKey(SuperVersion* sv, const Slice& key,
                                       bool cache_only, SequenceNumber* seq,
                                       bool* found_record_for_key) {
A
agiardullo 已提交
6442 6443
  Status s;
  MergeContext merge_context;
6444 6445
  RangeDelAggregator range_del_agg(sv->mem->GetInternalKeyComparator(),
                                   kMaxSequenceNumber);
A
agiardullo 已提交
6446

A
Andrew Kryczka 已提交
6447
  ReadOptions read_options;
A
agiardullo 已提交
6448 6449 6450 6451
  SequenceNumber current_seq = versions_->LastSequence();
  LookupKey lkey(key, current_seq);

  *seq = kMaxSequenceNumber;
6452 6453
  *found_record_for_key = false;

A
agiardullo 已提交
6454
  // Check if there is a record for this key in the latest memtable
M
Maysam Yabandeh 已提交
6455
  sv->mem->Get(lkey, nullptr, &s, &merge_context, &range_del_agg, seq,
A
Andrew Kryczka 已提交
6456
               read_options);
A
agiardullo 已提交
6457 6458 6459

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

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

  if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
    // unexpected error reading memtable.
6479
    Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
A
agiardullo 已提交
6480 6481 6482 6483 6484 6485 6486 6487
        "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
6488
    *found_record_for_key = true;
A
agiardullo 已提交
6489 6490 6491 6492
    return Status::OK();
  }

  // Check if there is a record for this key in the immutable memtables
A
Andrew Kryczka 已提交
6493 6494
  sv->imm->GetFromHistory(lkey, nullptr, &s, &merge_context, &range_del_agg,
                          seq, read_options);
A
agiardullo 已提交
6495 6496 6497

  if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
    // unexpected error reading memtable.
6498
    Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
A
agiardullo 已提交
6499 6500 6501 6502 6503 6504
        "Unexpected status returned from MemTableList::GetFromHistory: %s\n",
        s.ToString().c_str());

    return s;
  }

6505 6506 6507 6508 6509 6510 6511 6512 6513 6514
  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 已提交
6515
    sv->current->Get(read_options, lkey, nullptr, &s, &merge_context,
A
Andrew Kryczka 已提交
6516 6517
                     &range_del_agg, nullptr /* value_found */,
                     found_record_for_key, seq);
6518 6519 6520

    if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
      // unexpected error reading SST files
6521
      Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
6522 6523 6524 6525 6526 6527 6528
          "Unexpected status returned from Version::Get: %s\n",
          s.ToString().c_str());

      return s;
    }
  }

A
agiardullo 已提交
6529 6530
  return Status::OK();
}
6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555

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

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

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

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

6556
  TEST_SYNC_POINT("DBImpl::AddFile:Start");
6557 6558 6559 6560 6561 6562 6563 6564 6565
  {
    // 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_);

6566 6567
    num_running_ingest_file_++;

6568 6569 6570 6571 6572 6573
    // We cannot ingest a file into a dropped CF
    if (cfd->IsDropped()) {
      status = Status::InvalidArgument(
          "Cannot ingest an external file into a dropped CF");
    }

6574
    // Figure out if we need to flush the memtable first
6575 6576 6577 6578 6579 6580 6581 6582 6583
    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();
      }
6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624
    }

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

6625 6626 6627 6628
  if (status.ok()) {
    NotifyOnExternalFileIngested(cfd, ingestion_job);
  }

6629 6630 6631
  return status;
}

6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653
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
}

6654 6655 6656 6657 6658 6659 6660
void DBImpl::WaitForIngestFile() {
  mutex_.AssertHeld();
  while (num_running_ingest_file_ > 0) {
    bg_cv_.Wait();
  }
}

A
agiardullo 已提交
6661 6662
#endif  // ROCKSDB_LITE

6663
}  // namespace rocksdb