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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

J
jorlow@chromium.org 已提交
215 216 217
  return result;
}

218 219
namespace {

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

233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
static Status ValidateOptions(
    const DBOptions& db_options,
    const std::vector<ColumnFamilyDescriptor>& column_families) {
  Status s;

  for (auto& cfd : column_families) {
    s = CheckCompressionSupported(cfd.options);
    if (s.ok() && db_options.allow_concurrent_memtable_write) {
      s = CheckConcurrentWritesSupported(cfd.options);
    }
    if (!s.ok()) {
      return s;
    }
    if (db_options.db_paths.size() > 1) {
      if ((cfd.options.compaction_style != kCompactionStyleUniversal) &&
          (cfd.options.compaction_style != kCompactionStyleLevel)) {
        return Status::NotSupported(
            "More than one DB paths are only supported in "
            "universal and level compaction styles. ");
      }
    }
  }

  if (db_options.db_paths.size() > 4) {
    return Status::NotSupported(
        "More than four DB paths are not supported yet. ");
  }

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

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

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

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

A
Aaron Gao 已提交
281 282 283
CompressionType GetCompressionFlush(
    const ImmutableCFOptions& ioptions,
    const MutableCFOptions& mutable_cf_options) {
284 285 286
  // Compressing memtable flushes might not help unless the sequential load
  // optimization is used for leveled compaction. Otherwise the CPU and
  // latency overhead is not offset by saving much space.
287
  if (ioptions.compaction_style == kCompactionStyleUniversal) {
288 289 290 291 292 293 294 295
    if (ioptions.compaction_options_universal.compression_size_percent < 0) {
      return mutable_cf_options.compression;
    } else {
      return kNoCompression;
    }
  } else if (!ioptions.compression_per_level.empty()) {
    // For leveled compress when min_level_to_compress != 0.
    return ioptions.compression_per_level[0];
296
  } else {
A
Aaron Gao 已提交
297
    return mutable_cf_options.compression;
298 299
  }
}
I
Igor Canadi 已提交
300

301
void DumpSupportInfo(Logger* logger) {
302 303 304 305 306 307 308 309
  ROCKS_LOG_HEADER(logger, "Compression algorithms supported:");
  ROCKS_LOG_HEADER(logger, "\tSnappy supported: %d", Snappy_Supported());
  ROCKS_LOG_HEADER(logger, "\tZlib supported: %d", Zlib_Supported());
  ROCKS_LOG_HEADER(logger, "\tBzip supported: %d", BZip2_Supported());
  ROCKS_LOG_HEADER(logger, "\tLZ4 supported: %d", LZ4_Supported());
  ROCKS_LOG_HEADER(logger, "\tZSTD supported: %d", ZSTD_Supported());
  ROCKS_LOG_HEADER(logger, "Fast CRC32 supported: %d",
                   crc32c::IsFastCrc32Supported());
I
Igor Canadi 已提交
310 311
}

312
}  // namespace
313

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

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

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

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

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

391 392
  ROCKS_LOG_INFO(immutable_db_options_.info_log,
                 "Shutdown: canceling all background work");
393

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

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

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

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

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

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

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

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

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

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

528 529
  Status s;

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

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

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

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

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

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

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

620
void DBImpl::MaybeDumpStats() {
621 622 623 624 625
  mutex_.Lock();
  unsigned int stats_dump_period_sec =
      mutable_db_options_.stats_dump_period_sec;
  mutex_.Unlock();
  if (stats_dump_period_sec == 0) return;
H
Haobo Xu 已提交
626 627 628

  const uint64_t now_micros = env_->NowMicros();

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

637
#ifndef ROCKSDB_LITE
638 639 640 641 642 643 644
    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 已提交
645
    std::string stats;
646
    {
647
      InstrumentedMutexLock l(&mutex_);
648
      for (auto cfd : *versions_->GetColumnFamilySet()) {
649 650
        cfd->internal_stats()->GetStringProperty(
            *cf_property_info, DB::Properties::kCFStats, &stats);
651
      }
652 653
      default_cf_internal_stats_->GetStringProperty(
          *db_property_info, DB::Properties::kDBStats, &stats);
654
    }
655 656 657
    ROCKS_LOG_WARN(immutable_db_options_.info_log,
                   "------- DUMPING STATS -------");
    ROCKS_LOG_WARN(immutable_db_options_.info_log, "%s", stats.c_str());
S
Siying Dong 已提交
658 659 660 661
    if (immutable_db_options_.dump_malloc_stats) {
      stats.clear();
      DumpMallocStats(&stats);
      if (!stats.empty()) {
662 663 664
        ROCKS_LOG_WARN(immutable_db_options_.info_log,
                       "------- Malloc STATS -------");
        ROCKS_LOG_WARN(immutable_db_options_.info_log, "%s", stats.c_str());
S
Siying Dong 已提交
665 666
      }
    }
667
#endif  // !ROCKSDB_LITE
668

669
    PrintStatistics();
670 671 672
  }
}

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

678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721
  uint64_t min_log = 0;

  // we must look through the memtables for two phase transactions
  // that have been committed but not yet flushed
  for (auto loop_cfd : *versions_->GetColumnFamilySet()) {
    if (loop_cfd->IsDropped()) {
      continue;
    }

    auto log = loop_cfd->imm()->GetMinLogContainingPrepSection();

    if (log > 0 && (min_log == 0 || log < min_log)) {
      min_log = log;
    }

    log = loop_cfd->mem()->GetMinLogContainingPrepSection();

    if (log > 0 && (min_log == 0 || log < min_log)) {
      min_log = log;
    }
  }

  return min_log;
}

void DBImpl::MarkLogAsHavingPrepSectionFlushed(uint64_t log) {
  assert(log != 0);
  std::lock_guard<std::mutex> lock(prep_heap_mutex_);
  auto it = prepared_section_completed_.find(log);
  assert(it != prepared_section_completed_.end());
  it->second += 1;
}

void DBImpl::MarkLogAsContainingPrepSection(uint64_t log) {
  assert(log != 0);
  std::lock_guard<std::mutex> lock(prep_heap_mutex_);
  min_log_with_prep_.push(log);
  auto it = prepared_section_completed_.find(log);
  if (it == prepared_section_completed_.end()) {
    prepared_section_completed_[log] = 0;
  }
}

uint64_t DBImpl::FindMinLogContainingOutstandingPrep() {
722 723 724 725 726

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

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

  // first we look in the prepared heap where we keep
  // track of transactions that have been prepared (written to WAL)
  // but not yet committed.
  while (!min_log_with_prep_.empty()) {
    min_log = min_log_with_prep_.top();

    auto it = prepared_section_completed_.find(min_log);

    // value was marked as 'deleted' from heap
    if (it != prepared_section_completed_.end() && it->second > 0) {
      it->second -= 1;
      min_log_with_prep_.pop();

      // back to squere one...
      min_log = 0;
      continue;
    } else {
      // found a valid value
      break;
    }
  }

  return min_log;
}

755 756 757 758 759 760 761 762 763 764
void DBImpl::ScheduleBgLogWriterClose(JobContext* job_context) {
  if (!job_context->logs_to_free.empty()) {
    for (auto l : job_context->logs_to_free) {
      AddToLogsToFreeQueue(l);
    }
    job_context->logs_to_free.clear();
    SchedulePurge();
  }
}

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

  if (allow_2pc()) {
    // if are 2pc we must consider logs containing prepared
    // sections of outstanding transactions.
    //
    // We must check min logs with outstanding prep before we check
    // logs referneces by memtables because a log referenced by the
    // first data structure could transition to the second under us.
    //
    // TODO(horuff): iterating over all column families under db mutex.
    // should find more optimial solution
    auto min_log_in_prep_heap = FindMinLogContainingOutstandingPrep();

    if (min_log_in_prep_heap != 0 && min_log_in_prep_heap < log_number) {
      log_number = min_log_in_prep_heap;
    }

    auto min_log_refed_by_mem = FindMinPrepLogReferencedByMemTable();

    if (min_log_refed_by_mem != 0 && min_log_refed_by_mem < log_number) {
      log_number = min_log_refed_by_mem;
    }
  }
  return log_number;
}

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

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

811 812 813 814 815
  bool doing_the_full_scan = false;

  // logic for figurint out if we're doing the full scan
  if (no_full_scan) {
    doing_the_full_scan = false;
816
  } else if (force ||
817
             mutable_db_options_.delete_obsolete_files_period_micros == 0) {
818 819 820
    doing_the_full_scan = true;
  } else {
    const uint64_t now_micros = env_->NowMicros();
821 822 823
    if ((delete_obsolete_files_last_run_ +
         mutable_db_options_.delete_obsolete_files_period_micros) <
        now_micros) {
824
      doing_the_full_scan = true;
825
      delete_obsolete_files_last_run_ = now_micros;
826 827 828
    }
  }

I
Igor Canadi 已提交
829 830
  // don't delete files that might be currently written to from compaction
  // threads
831 832 833
  // Since job_context->min_pending_output is set, until file scan finishes,
  // mutex_ cannot be released. Otherwise, we might see no min_pending_output
  // here but later find newer generated unfinalized files while scannint.
I
Igor Canadi 已提交
834 835 836 837 838 839 840
  if (!pending_outputs_.empty()) {
    job_context->min_pending_output = *pending_outputs_.begin();
  } else {
    // delete all of them
    job_context->min_pending_output = std::numeric_limits<uint64_t>::max();
  }

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

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

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

I
Igor Canadi 已提交
855
  versions_->AddLiveFiles(&job_context->sst_live);
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890
  if (doing_the_full_scan) {
    for (size_t path_id = 0; path_id < immutable_db_options_.db_paths.size();
         path_id++) {
      // set of all files in the directory. We'll exclude files that are still
      // alive in the subsequent processings.
      std::vector<std::string> files;
      env_->GetChildren(immutable_db_options_.db_paths[path_id].path,
                        &files);  // Ignore errors
      for (std::string file : files) {
        // TODO(icanadi) clean up this mess to avoid having one-off "/" prefixes
        job_context->full_scan_candidate_files.emplace_back(
            "/" + file, static_cast<uint32_t>(path_id));
      }
    }

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

892 893 894
  // logs_ is empty when called during recovery, in which case there can't yet
  // be any tracked obsolete logs
  if (!alive_log_files_.empty() && !logs_.empty()) {
895
    uint64_t min_log_number = job_context->log_number;
S
sdong 已提交
896
    size_t num_alive_log_files = alive_log_files_.size();
897 898 899
    // find newly obsoleted log files
    while (alive_log_files_.begin()->number < min_log_number) {
      auto& earliest = *alive_log_files_.begin();
900 901
      if (immutable_db_options_.recycle_log_file_num >
          log_recycle_files.size()) {
902 903 904
        ROCKS_LOG_INFO(immutable_db_options_.info_log,
                       "adding log %" PRIu64 " to recycle list\n",
                       earliest.number);
S
Sage Weil 已提交
905 906 907 908
        log_recycle_files.push_back(earliest.number);
      } else {
        job_context->log_delete_files.push_back(earliest.number);
      }
S
sdong 已提交
909 910 911 912 913
      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;
914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936
      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 已提交
937 938
  job_context->log_recycle_files.assign(log_recycle_files.begin(),
                                        log_recycle_files.end());
939
  logs_to_free_.clear();
940 941
}

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

955 956 957 958 959
// 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) {
960 961
    file_deletion_status =
        DeleteSSTFile(&immutable_db_options_, fname, path_id);
962 963 964 965
  } else {
    file_deletion_status = env_->DeleteFile(fname);
  }
  if (file_deletion_status.ok()) {
966 967 968 969
    ROCKS_LOG_DEBUG(immutable_db_options_.info_log,
                    "[JOB %d] Delete %s type=%d #%" PRIu64 " -- %s\n", job_id,
                    fname.c_str(), type, number,
                    file_deletion_status.ToString().c_str());
970
  } else if (env_->FileExists(fname).IsNotFound()) {
971 972
    ROCKS_LOG_INFO(
        immutable_db_options_.info_log,
973 974 975 976 977
        "[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 {
978 979 980 981
    ROCKS_LOG_ERROR(immutable_db_options_.info_log,
                    "[JOB %d] Failed to delete %s type=%d #%" PRIu64 " -- %s\n",
                    job_id, fname.c_str(), type, number,
                    file_deletion_status.ToString().c_str());
982 983 984 985
  }
  if (type == kTableFile) {
    EventHelpers::LogAndNotifyTableFileDeletion(
        &event_logger_, job_id, number, fname, file_deletion_status, GetName(),
986
        immutable_db_options_.listeners);
987 988 989
  }
}

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

I
Igor Canadi 已提交
998 999 1000 1001
  // 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 已提交
1002 1003
    return;
  }
1004

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

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

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

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

S
sdong 已提交
1044
  if (state.prev_total_log_size > 0) {
1045 1046 1047 1048 1049 1050
    ROCKS_LOG_INFO(immutable_db_options_.info_log,
                   "[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);
S
sdong 已提交
1051 1052
  }

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

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

    if (keep) {
      continue;
    }

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

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

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

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

void DBImpl::DeleteObsoleteFiles() {
  mutex_.AssertHeld();
1187
  JobContext job_context(next_job_id_.fetch_add(1));
I
Igor Canadi 已提交
1188
  FindObsoleteFiles(&job_context, true);
1189 1190

  mutex_.Unlock();
I
Igor Canadi 已提交
1191 1192
  if (job_context.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(job_context);
1193
  }
I
Igor Canadi 已提交
1194
  job_context.Clean();
1195
  mutex_.Lock();
1196 1197
}

1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
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 已提交
1214

1215 1216 1217 1218 1219 1220 1221 1222 1223
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_);
1224 1225 1226
    if (!s.ok()) {
      return s;
    }
1227
  }
1228

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

1262 1263 1264
  bool is_new_db = false;
  assert(db_lock_ == nullptr);
  if (!read_only) {
1265 1266 1267
    Status s = directories_.SetDirectories(env_, dbname_,
                                           immutable_db_options_.wal_dir,
                                           immutable_db_options_.db_paths);
1268 1269 1270 1271
    if (!s.ok()) {
      return s;
    }

1272
    s = env_->LockFile(LockFileName(dbname_), &db_lock_);
1273 1274 1275
    if (!s.ok()) {
      return s;
    }
J
jorlow@chromium.org 已提交
1276

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

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

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

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

1353 1354 1355 1356 1357 1358 1359
    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) {
1360
          std::string fname = LogFileName(immutable_db_options_.wal_dir, log);
1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
          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 已提交
1372 1373
    }

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

L
Lei Jin 已提交
1388 1389
  // Initial value
  max_total_in_memory_state_ = 0;
I
Igor Canadi 已提交
1390
  for (auto cfd : *versions_->GetColumnFamilySet()) {
L
Lei Jin 已提交
1391 1392 1393
    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 已提交
1394 1395
  }

J
jorlow@chromium.org 已提交
1396 1397 1398
  return s;
}

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

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

1439
#ifndef ROCKSDB_LITE
1440
  if (immutable_db_options_.wal_filter != nullptr) {
1441 1442 1443 1444 1445 1446 1447 1448 1449
    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()));
    }

1450 1451
    immutable_db_options_.wal_filter->ColumnFamilyLogNumberMap(cf_lognumber_map,
                                                               cf_name_id_map);
1452 1453 1454
  }
#endif

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

1466 1467 1468
    ROCKS_LOG_INFO(immutable_db_options_.info_log,
                   "Recovering log #%" PRIu64 " mode %d", log_number,
                   immutable_db_options_.wal_recovery_mode);
1469 1470 1471
    auto logFileDropped = [this, &fname]() {
      uint64_t bytes;
      if (env_->GetFileSize(fname, &bytes).ok()) {
1472
        auto info_log = immutable_db_options_.info_log.get();
1473 1474
        ROCKS_LOG_WARN(info_log, "%s: dropping %d bytes", fname.c_str(),
                       static_cast<int>(bytes));
1475 1476 1477 1478 1479 1480 1481
      }
    };
    if (stop_replay_by_wal_filter) {
      logFileDropped();
      continue;
    }

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

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

    // Determine if we should tolerate incomplete records at the tail end of the
S
Stanislau Hlebik 已提交
1520 1521 1522 1523
    // Read all the records and add to a memtable
    std::string scratch;
    Slice record;
    WriteBatch batch;
K
krad 已提交
1524

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

1537
      if (immutable_db_options_.wal_recovery_mode ==
1538
          WALRecoveryMode::kPointInTimeRecovery) {
1539 1540 1541 1542 1543
        // 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) {
1544 1545 1546 1547 1548 1549 1550 1551
          stop_replay_for_corruption = false;
        }
        if (stop_replay_for_corruption) {
          logFileDropped();
          break;
        }
      }

1552
#ifndef ROCKSDB_LITE
1553
      if (immutable_db_options_.wal_filter != nullptr) {
1554 1555 1556
        WriteBatch new_batch;
        bool batch_changed = false;

1557
        WalFilter::WalProcessingOption wal_processing_option =
1558 1559
            immutable_db_options_.wal_filter->LogRecordFound(
                log_number, fname, batch, &new_batch, &batch_changed);
1560

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

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

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

S
sdong 已提交
1647
      if (has_valid_writes && !read_only) {
I
Igor Canadi 已提交
1648 1649 1650 1651
        // 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;

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

          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
1669
                                 *next_sequence);
1670
        }
J
jorlow@chromium.org 已提交
1671 1672 1673
      }
    }

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

I
Igor Canadi 已提交
1697
    flush_scheduler_.Clear();
1698 1699 1700 1701
    auto last_sequence = *next_sequence - 1;
    if ((*next_sequence != kMaxSequenceNumber) &&
        (versions_->LastSequence() <= last_sequence)) {
      versions_->SetLastSequence(last_sequence);
S
Stanislau Hlebik 已提交
1702
    }
1703 1704
  }

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

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

      // flush the final memtable (if non-empty)
      if (cfd->mem()->GetFirstSequenceNumber() != 0) {
1729 1730 1731
        // 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.
1732
        if (flushed || !immutable_db_options_.avoid_flush_during_recovery) {
1733 1734 1735 1736 1737 1738
          status = WriteLevel0TableForRecovery(job_id, cfd, cfd->mem(), edit);
          if (!status.ok()) {
            // Recovery failed
            break;
          }
          flushed = true;
A
agiardullo 已提交
1739

1740
          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
1741
                                 versions_->LastSequence());
1742
        }
A
Andrew Kryczka 已提交
1743
        data_seen = true;
1744
      }
J
jorlow@chromium.org 已提交
1745

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

A
Andrew Kryczka 已提交
1769
  if (data_seen && !flushed) {
1770 1771 1772 1773 1774 1775 1776
    // 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));
    }
  }

1777 1778 1779
  event_logger_.Log() << "job" << job_id << "event"
                      << "recovery_finished";

J
jorlow@chromium.org 已提交
1780 1781 1782
  return status;
}

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

A
Aaron Gao 已提交
1803 1804 1805
    // Get the latest mutable cf options while the mutex is still locked
    const MutableCFOptions mutable_cf_options =
        *cfd->GetLatestMutableCFOptions();
1806 1807
    bool paranoid_file_checks =
        cfd->GetLatestMutableCFOptions()->paranoid_file_checks;
1808 1809
    {
      mutex_.Unlock();
1810 1811 1812 1813 1814

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

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

  // Note that if file_size is zero, the file has been deleted and
  // should not be added to the manifest.
  int level = 0;
1840
  if (s.ok() && meta.fd.GetFileSize() > 0) {
1841 1842
    edit->AddFile(level, meta.fd.GetNumber(), meta.fd.GetPathId(),
                  meta.fd.GetFileSize(), meta.smallest, meta.largest,
1843 1844
                  meta.smallest_seqno, meta.largest_seqno,
                  meta.marked_for_compaction);
1845 1846
  }

L
Lei Jin 已提交
1847
  InternalStats::CompactionStats stats(1);
1848
  stats.micros = env_->NowMicros() - start_micros;
1849
  stats.bytes_written = meta.fd.GetFileSize();
1850
  stats.num_output_files = 1;
1851
  cfd->internal_stats()->AddCompactionStats(level, stats);
1852 1853
  cfd->internal_stats()->AddCFStats(
      InternalStats::BYTES_FLUSHED, meta.fd.GetFileSize());
L
Lei Jin 已提交
1854
  RecordTick(stats_, COMPACT_WRITE_BYTES, meta.fd.GetFileSize());
J
jorlow@chromium.org 已提交
1855 1856 1857
  return s;
}

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

1903 1904
Status DBImpl::FlushMemTableToOutputFile(
    ColumnFamilyData* cfd, const MutableCFOptions& mutable_cf_options,
1905
    bool* made_progress, JobContext* job_context, LogBuffer* log_buffer) {
1906
  mutex_.AssertHeld();
1907
  assert(cfd->imm()->NumNotFlushed() != 0);
1908
  assert(cfd->imm()->IsFlushPending());
1909

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

A
Aaron Gao 已提交
1914
  FlushJob flush_job(
1915
      dbname_, cfd, immutable_db_options_, mutable_cf_options, env_options_,
A
Aaron Gao 已提交
1916 1917 1918 1919 1920
      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);
1921

1922
  FileMetaData file_meta;
1923

1924 1925 1926 1927
  flush_job.PickMemTable();

  Status s;
  if (logfile_number_ > 0 &&
S
Sagar Vemuri 已提交
1928
      versions_->GetColumnFamilySet()->NumberOfColumnFamilies() > 0) {
1929 1930 1931 1932 1933 1934 1935 1936 1937
    // 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);
  }

1938 1939 1940 1941 1942 1943
  // 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.
1944 1945
  if (s.ok()) {
    s = flush_job.Run(&file_meta);
1946 1947
  } else {
    flush_job.Cancel();
1948
  }
J
jorlow@chromium.org 已提交
1949 1950

  if (s.ok()) {
I
Igor Canadi 已提交
1951 1952
    InstallSuperVersionAndScheduleWorkWrapper(cfd, job_context,
                                              mutable_cf_options);
1953 1954
    if (made_progress) {
      *made_progress = 1;
1955
    }
S
sdong 已提交
1956
    VersionStorageInfo::LevelSummaryStorage tmp;
1957 1958 1959
    ROCKS_LOG_BUFFER(log_buffer, "[%s] Level summary: %s\n",
                     cfd->GetName().c_str(),
                     cfd->current()->storage_info()->LevelSummary(&tmp));
J
jorlow@chromium.org 已提交
1960
  }
1961

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

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

2036 2037 2038
Status DBImpl::CompactRange(const CompactRangeOptions& options,
                            ColumnFamilyHandle* column_family,
                            const Slice* begin, const Slice* end) {
2039
  if (options.target_path_id >= immutable_db_options_.db_paths.size()) {
2040 2041 2042
    return Status::InvalidArgument("Invalid target path ID");
  }

2043 2044
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
2045
  bool exclusive = options.exclusive_manual_compaction;
I
Igor Canadi 已提交
2046 2047

  Status s = FlushMemTable(cfd, FlushOptions());
L
Lei Jin 已提交
2048
  if (!s.ok()) {
2049
    LogFlush(immutable_db_options_.info_log);
L
Lei Jin 已提交
2050 2051 2052
    return s;
  }

I
Igor Canadi 已提交
2053
  int max_level_with_files = 0;
G
Gabor Cselle 已提交
2054
  {
2055
    InstrumentedMutexLock l(&mutex_);
I
Igor Canadi 已提交
2056
    Version* base = cfd->current();
2057 2058
    for (int level = 1; level < base->storage_info()->num_non_empty_levels();
         level++) {
S
sdong 已提交
2059
      if (base->storage_info()->OverlapInLevel(level, begin, end)) {
G
Gabor Cselle 已提交
2060 2061 2062 2063
        max_level_with_files = level;
      }
    }
  }
2064

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

2124
  if (options.change_level) {
2125 2126
    ROCKS_LOG_INFO(immutable_db_options_.info_log,
                   "[RefitLevel] waiting for background threads to stop");
2127 2128 2129 2130 2131
    s = PauseBackgroundWork();
    if (s.ok()) {
      s = ReFitLevel(cfd, final_output_level, options.target_level);
    }
    ContinueBackgroundWork();
2132
  }
2133
  LogFlush(immutable_db_options_.info_log);
L
Lei Jin 已提交
2134

2135
  {
2136
    InstrumentedMutexLock l(&mutex_);
2137 2138 2139 2140 2141
    // an automatic compaction that has been scheduled might have been
    // preempted by the manual compactions. Need to schedule it back.
    MaybeScheduleFlushOrCompaction();
  }

L
Lei Jin 已提交
2142
  return s;
2143 2144
}

2145 2146 2147 2148 2149
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 已提交
2150 2151 2152 2153
#ifdef ROCKSDB_LITE
    // not supported in lite version
  return Status::NotSupported("Not supported in ROCKSDB LITE");
#else
2154 2155 2156 2157 2158 2159
  if (column_family == nullptr) {
    return Status::InvalidArgument("ColumnFamilyHandle must be non-null.");
  }

  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  assert(cfd);
2160 2161 2162 2163

  Status s;
  JobContext job_context(0, true);
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL,
2164
                       immutable_db_options_.info_log.get());
2165 2166

  // Perform CompactFiles
2167
  SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
2168 2169 2170
  {
    InstrumentedMutexLock l(&mutex_);

2171
    // This call will unlock/lock the mutex to wait for current running
2172 2173
    // IngestExternalFile() calls to finish.
    WaitForIngestFile();
2174

2175 2176 2177 2178
    s = CompactFilesImpl(compact_options, cfd, sv->current,
                         input_file_names, output_level,
                         output_path_id, &job_context, &log_buffer);
  }
2179 2180 2181 2182 2183 2184
  if (sv->Unref()) {
    mutex_.Lock();
    sv->Cleanup();
    mutex_.Unlock();
    delete sv;
  }
2185 2186 2187 2188 2189 2190 2191 2192 2193

  // 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());
2194
  }  // release the mutex
2195 2196 2197 2198 2199 2200 2201 2202 2203 2204

  // 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()) {
2205
      // no mutex is locked here.  No need to Unlock() and Lock() here.
2206 2207 2208 2209 2210
      PurgeObsoleteFiles(job_context);
    }
    job_context.Clean();
  }

2211
  return s;
I
Igor Canadi 已提交
2212
#endif  // ROCKSDB_LITE
2213 2214
}

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

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

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

2287 2288 2289
  auto pending_outputs_inserted_elem =
      CaptureCurrentFileNumberInPendingOutputs();

I
Igor Canadi 已提交
2290
  assert(is_snapshot_supported_ || snapshots_.empty());
2291
  CompactionJob compaction_job(
2292 2293
      job_context->job_id, c.get(), immutable_db_options_, env_options_,
      versions_.get(), &shutting_down_, log_buffer, directories_.GetDbDir(),
2294 2295 2296
      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,
2297
      c->mutable_cf_options()->report_bg_io_stats, dbname_,
2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310
      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.
2311 2312 2313 2314 2315

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

2319 2320 2321
  compaction_job.Prepare();

  mutex_.Unlock();
2322 2323
  TEST_SYNC_POINT("CompactFilesImpl:0");
  TEST_SYNC_POINT("CompactFilesImpl:1");
2324
  compaction_job.Run();
2325 2326
  TEST_SYNC_POINT("CompactFilesImpl:2");
  TEST_SYNC_POINT("CompactFilesImpl:3");
2327
  mutex_.Lock();
2328

2329
  Status status = compaction_job.Install(*c->mutable_cf_options());
2330
  if (status.ok()) {
I
Igor Canadi 已提交
2331 2332
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
2333 2334 2335
  }
  c->ReleaseCompactionFiles(s);

2336
  ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);
2337 2338 2339 2340 2341 2342

  if (status.ok()) {
    // Done
  } else if (status.IsShutdownInProgress()) {
    // Ignore compaction errors found during shutting down
  } else {
2343 2344 2345 2346
    ROCKS_LOG_WARN(immutable_db_options_.info_log,
                   "[%s] [JOB %d] Compaction error: %s",
                   c->column_family_data()->GetName().c_str(),
                   job_context->job_id, status.ToString().c_str());
2347
    if (immutable_db_options_.paranoid_checks && bg_error_.ok()) {
2348 2349 2350 2351
      bg_error_ = status;
    }
  }

2352 2353
  c.reset();

2354
  bg_compaction_scheduled_--;
2355 2356 2357
  if (bg_compaction_scheduled_ == 0) {
    bg_cv_.SignalAll();
  }
2358 2359 2360

  return status;
}
I
Igor Canadi 已提交
2361
#endif  // ROCKSDB_LITE
2362

2363 2364
Status DBImpl::PauseBackgroundWork() {
  InstrumentedMutexLock guard_lock(&mutex_);
2365
  bg_compaction_paused_++;
2366 2367 2368
  while (bg_compaction_scheduled_ > 0 || bg_flush_scheduled_ > 0) {
    bg_cv_.Wait();
  }
2369
  bg_work_paused_++;
2370 2371 2372 2373 2374
  return Status::OK();
}

Status DBImpl::ContinueBackgroundWork() {
  InstrumentedMutexLock guard_lock(&mutex_);
2375 2376 2377
  if (bg_work_paused_ == 0) {
    return Status::InvalidArgument();
  }
2378
  assert(bg_work_paused_ > 0);
2379 2380
  assert(bg_compaction_paused_ > 0);
  bg_compaction_paused_--;
2381
  bg_work_paused_--;
2382 2383
  // It's sufficient to check just bg_work_paused_ here since
  // bg_work_paused_ is always no greater than bg_compaction_paused_
2384 2385 2386 2387 2388 2389
  if (bg_work_paused_ == 0) {
    MaybeScheduleFlushOrCompaction();
  }
  return Status::OK();
}

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

2446
Status DBImpl::SetOptions(ColumnFamilyHandle* column_family,
2447
    const std::unordered_map<std::string, std::string>& options_map) {
I
Igor Canadi 已提交
2448 2449 2450
#ifdef ROCKSDB_LITE
  return Status::NotSupported("Not supported in ROCKSDB LITE");
#else
L
Lei Jin 已提交
2451 2452
  auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  if (options_map.empty()) {
2453 2454 2455
    ROCKS_LOG_WARN(immutable_db_options_.info_log,
                   "SetOptions() on column family [%s], empty input",
                   cfd->GetName().c_str());
2456
    return Status::InvalidArgument("empty input");
L
Lei Jin 已提交
2457 2458 2459
  }

  MutableCFOptions new_options;
2460
  Status s;
2461
  Status persist_options_status;
L
Lei Jin 已提交
2462
  {
2463
    InstrumentedMutexLock l(&mutex_);
2464 2465
    s = cfd->SetOptions(options_map);
    if (s.ok()) {
L
Lei Jin 已提交
2466
      new_options = *cfd->GetLatestMutableCFOptions();
2467 2468 2469 2470
      // Append new version to recompute compaction score.
      VersionEdit dummy_edit;
      versions_->LogAndApply(cfd, new_options, &dummy_edit, &mutex_,
                             directories_.GetDbDir());
2471 2472 2473 2474 2475 2476
      // 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;
2477

2478
      persist_options_status = PersistOptions();
2479 2480
    }
  }
L
Lei Jin 已提交
2481

2482 2483 2484
  ROCKS_LOG_INFO(immutable_db_options_.info_log,
                 "SetOptions() on column family [%s], inputs:",
                 cfd->GetName().c_str());
L
Lei Jin 已提交
2485
  for (const auto& o : options_map) {
2486 2487
    ROCKS_LOG_INFO(immutable_db_options_.info_log, "%s: %s\n", o.first.c_str(),
                   o.second.c_str());
L
Lei Jin 已提交
2488
  }
2489
  if (s.ok()) {
2490 2491
    ROCKS_LOG_INFO(immutable_db_options_.info_log,
                   "[%s] SetOptions() succeeded", cfd->GetName().c_str());
2492
    new_options.Dump(immutable_db_options_.info_log.get());
2493
    if (!persist_options_status.ok()) {
2494
      if (immutable_db_options_.fail_if_options_file_error) {
2495
        s = Status::IOError(
2496
            "SetOptions() succeeded, but unable to persist options",
2497 2498
            persist_options_status.ToString());
      }
2499 2500 2501
      ROCKS_LOG_WARN(immutable_db_options_.info_log,
                     "Unable to persist options in SetOptions() -- %s",
                     persist_options_status.ToString().c_str());
2502
    }
L
Lei Jin 已提交
2503
  } else {
2504 2505
    ROCKS_LOG_WARN(immutable_db_options_.info_log, "[%s] SetOptions() failed",
                   cfd->GetName().c_str());
2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517
  }
  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()) {
2518 2519
    ROCKS_LOG_WARN(immutable_db_options_.info_log,
                   "SetDBOptions(), empty input.");
2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537
    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();
      }

2538 2539
      write_controller_.set_max_delayed_write_rate(new_options.delayed_write_rate);

2540 2541
      mutable_db_options_ = new_options;

2542
      if (total_log_size_ > GetMaxTotalWalSize()) {
2543
        MaybeFlushColumnFamilies();
2544 2545
      }

2546 2547 2548
      persist_options_status = PersistOptions();
    }
  }
2549
  ROCKS_LOG_INFO(immutable_db_options_.info_log, "SetDBOptions(), inputs:");
2550
  for (const auto& o : options_map) {
2551 2552
    ROCKS_LOG_INFO(immutable_db_options_.info_log, "%s: %s\n", o.first.c_str(),
                   o.second.c_str());
2553 2554
  }
  if (s.ok()) {
2555
    ROCKS_LOG_INFO(immutable_db_options_.info_log, "SetDBOptions() succeeded");
2556 2557 2558 2559 2560 2561 2562
    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());
      }
2563 2564 2565
      ROCKS_LOG_WARN(immutable_db_options_.info_log,
                     "Unable to persist options in SetDBOptions() -- %s",
                     persist_options_status.ToString().c_str());
2566 2567
    }
  } else {
2568
    ROCKS_LOG_WARN(immutable_db_options_.info_log, "SetDBOptions failed");
L
Lei Jin 已提交
2569
  }
2570
  LogFlush(immutable_db_options_.info_log);
2571
  return s;
I
Igor Canadi 已提交
2572
#endif  // ROCKSDB_LITE
2573 2574
}

2575 2576 2577 2578 2579 2580 2581 2582 2583
Status DBImpl::PersistOptions() {
  mutex_.AssertHeld();
  WriteThread::Writer w;
  write_thread_.EnterUnbatched(&w, &mutex_);
  Status s = WriteOptionsFile();
  write_thread_.ExitUnbatched(&w);
  return s;
}

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

    minimum_level = i;
  }
  return minimum_level;
}

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

2611 2612 2613 2614
  std::unique_ptr<SuperVersion> superversion_to_free;
  std::unique_ptr<SuperVersion> new_superversion(new SuperVersion());

  Status status;
I
Igor Canadi 已提交
2615

I
Islam AbdelRahman 已提交
2616
  InstrumentedMutexLock guard_lock(&mutex_);
2617 2618 2619

  // only allow one thread refitting
  if (refitting_level_) {
2620 2621
    ROCKS_LOG_INFO(immutable_db_options_.info_log,
                   "[ReFitLevel] another thread is refitting");
L
Lei Jin 已提交
2622
    return Status::NotSupported("another thread is refitting");
2623 2624 2625
  }
  refitting_level_ = true;

2626
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
2627
  // move to a smaller level
2628 2629
  int to_level = target_level;
  if (target_level < 0) {
2630
    to_level = FindMinimumEmptyLevelFitting(cfd, mutable_cf_options, level);
2631
  }
2632

2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647
  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) {
2648 2649 2650
    ROCKS_LOG_DEBUG(immutable_db_options_.info_log,
                    "[%s] Before refitting:\n%s", cfd->GetName().c_str(),
                    cfd->current()->DebugString().data());
2651

2652
    VersionEdit edit;
I
Igor Canadi 已提交
2653
    edit.SetColumnFamily(cfd->GetID());
2654
    for (const auto& f : vstorage->LevelFiles(level)) {
2655
      edit.DeleteFile(level, f->fd.GetNumber());
2656 2657
      edit.AddFile(to_level, f->fd.GetNumber(), f->fd.GetPathId(),
                   f->fd.GetFileSize(), f->smallest, f->largest,
2658 2659
                   f->smallest_seqno, f->largest_seqno,
                   f->marked_for_compaction);
2660
    }
2661 2662 2663
    ROCKS_LOG_DEBUG(immutable_db_options_.info_log,
                    "[%s] Apply version edit:\n%s", cfd->GetName().c_str(),
                    edit.DebugString().data());
2664

2665 2666
    status = versions_->LogAndApply(cfd, mutable_cf_options, &edit, &mutex_,
                                    directories_.GetDbDir());
2667 2668
    superversion_to_free.reset(InstallSuperVersionAndScheduleWork(
        cfd, new_superversion.release(), mutable_cf_options));
2669

2670 2671
    ROCKS_LOG_DEBUG(immutable_db_options_.info_log, "[%s] LogAndApply: %s\n",
                    cfd->GetName().c_str(), status.ToString().data());
2672 2673

    if (status.ok()) {
2674 2675 2676
      ROCKS_LOG_DEBUG(immutable_db_options_.info_log,
                      "[%s] After refitting:\n%s", cfd->GetName().c_str(),
                      cfd->current()->DebugString().data());
2677 2678 2679 2680
    }
  }

  refitting_level_ = false;
I
Igor Canadi 已提交
2681

L
Lei Jin 已提交
2682
  return status;
G
Gabor Cselle 已提交
2683 2684
}

2685 2686 2687
int DBImpl::NumberLevels(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->NumberLevels();
2688 2689
}

2690
int DBImpl::MaxMemCompactionLevel(ColumnFamilyHandle* column_family) {
2691
  return 0;
2692 2693
}

2694 2695
int DBImpl::Level0StopWriteTrigger(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
2696
  InstrumentedMutexLock l(&mutex_);
L
Lei Jin 已提交
2697 2698
  return cfh->cfd()->GetSuperVersion()->
      mutable_cf_options.level0_stop_writes_trigger;
2699 2700
}

L
Lei Jin 已提交
2701
Status DBImpl::Flush(const FlushOptions& flush_options,
2702 2703
                     ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
L
Lei Jin 已提交
2704
  return FlushMemTable(cfh->cfd(), flush_options);
H
heyongqiang 已提交
2705 2706
}

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

    need_log_dir_sync = !log_dir_synced_;
  }

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

2757
  TEST_SYNC_POINT("DBImpl::SyncWAL:BeforeMarkLogsSynced:1");
2758 2759 2760 2761
  {
    InstrumentedMutexLock l(&mutex_);
    MarkLogsSynced(current_log_number, need_log_dir_sync, status);
  }
2762
  TEST_SYNC_POINT("DBImpl::SyncWAL:BeforeMarkLogsSynced:2");
2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778

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

2791
SequenceNumber DBImpl::GetLatestSequenceNumber() const {
2792 2793 2794
  return versions_->LastSequence();
}

I
Igor Canadi 已提交
2795
Status DBImpl::RunManualCompaction(ColumnFamilyData* cfd, int input_level,
2796
                                   int output_level, uint32_t output_path_id,
2797
                                   const Slice* begin, const Slice* end,
2798
                                   bool exclusive, bool disallow_trivial_move) {
2799 2800
  assert(input_level == ColumnFamilyData::kCompactAllLevels ||
         input_level >= 0);
2801

G
Gabor Cselle 已提交
2802
  InternalKey begin_storage, end_storage;
2803
  CompactionArg* ca;
G
Gabor Cselle 已提交
2804

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

2836 2837
  TEST_SYNC_POINT("DBImpl::RunManualCompaction:0");
  TEST_SYNC_POINT("DBImpl::RunManualCompaction:1");
2838
  InstrumentedMutexLock l(&mutex_);
2839

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

2854 2855 2856 2857
  AddManualCompaction(&manual);
  TEST_SYNC_POINT_CALLBACK("DBImpl::RunManualCompaction:NotScheduled", &mutex_);
  if (exclusive) {
    while (bg_compaction_scheduled_ > 0) {
2858 2859
      ROCKS_LOG_INFO(
          immutable_db_options_.info_log,
2860 2861 2862 2863 2864
          "[%s] Manual compaction waiting for all other scheduled background "
          "compactions to finish",
          cfd->GetName().c_str());
      bg_cv_.Wait();
    }
2865
  }
2866

2867 2868
  ROCKS_LOG_INFO(immutable_db_options_.info_log,
                 "[%s] Manual compaction starting", cfd->GetName().c_str());
2869

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

2912
  assert(!manual.in_progress);
2913 2914
  assert(HasPendingManualCompaction());
  RemoveManualCompaction(&manual);
2915
  bg_cv_.SignalAll();
L
Lei Jin 已提交
2916
  return manual.status;
J
jorlow@chromium.org 已提交
2917 2918
}

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

2938
Status DBImpl::FlushMemTable(ColumnFamilyData* cfd,
2939 2940
                             const FlushOptions& flush_options,
                             bool writes_stopped) {
S
Stanislau Hlebik 已提交
2941 2942 2943
  Status s;
  {
    WriteContext context;
2944
    InstrumentedMutexLock guard_lock(&mutex_);
2945

2946
    if (cfd->imm()->NumNotFlushed() == 0 && cfd->mem()->IsEmpty()) {
2947 2948 2949 2950
      // Nothing to flush
      return Status::OK();
    }

2951
    WriteThread::Writer w;
2952 2953 2954
    if (!writes_stopped) {
      write_thread_.EnterUnbatched(&w, &mutex_);
    }
S
Stanislau Hlebik 已提交
2955

I
Igor Canadi 已提交
2956
    // SwitchMemtable() will release and reacquire mutex
S
Stanislau Hlebik 已提交
2957
    // during execution
I
Igor Canadi 已提交
2958
    s = SwitchMemtable(cfd, &context);
2959 2960 2961 2962

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

S
Stanislau Hlebik 已提交
2964 2965
    cfd->imm()->FlushRequested();

2966 2967 2968
    // schedule flush
    SchedulePendingFlush(cfd);
    MaybeScheduleFlushOrCompaction();
S
Stanislau Hlebik 已提交
2969
  }
S
Stanislau Hlebik 已提交
2970

L
Lei Jin 已提交
2971
  if (s.ok() && flush_options.wait) {
2972
    // Wait until the compaction completes
2973
    s = WaitForFlushMemTable(cfd);
2974 2975
  }
  return s;
J
jorlow@chromium.org 已提交
2976 2977
}

2978
Status DBImpl::WaitForFlushMemTable(ColumnFamilyData* cfd) {
2979 2980
  Status s;
  // Wait until the compaction completes
2981
  InstrumentedMutexLock l(&mutex_);
2982
  while (cfd->imm()->NumNotFlushed() > 0 && bg_error_.ok()) {
2983 2984 2985
    if (shutting_down_.load(std::memory_order_acquire)) {
      return Status::ShutdownInProgress();
    }
2986 2987 2988 2989 2990 2991
    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");
    }
2992 2993
    bg_cv_.Wait();
  }
2994
  if (!bg_error_.ok()) {
2995 2996 2997
    s = bg_error_;
  }
  return s;
H
heyongqiang 已提交
2998 2999
}

3000 3001 3002 3003
Status DBImpl::EnableAutoCompaction(
    const std::vector<ColumnFamilyHandle*>& column_family_handles) {
  Status s;
  for (auto cf_ptr : column_family_handles) {
3004 3005
    Status status =
        this->SetOptions(cf_ptr, {{"disable_auto_compactions", "false"}});
3006
    if (!status.ok()) {
3007
      s = status;
3008 3009 3010 3011 3012 3013
    }
  }

  return s;
}

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

3028
  while (unscheduled_flushes_ > 0 &&
3029
         bg_flush_scheduled_ < immutable_db_options_.max_background_flushes) {
3030 3031
    unscheduled_flushes_--;
    bg_flush_scheduled_++;
3032
    env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::HIGH, this);
3033 3034
  }

3035 3036
  auto bg_compactions_allowed = BGCompactionsAllowed();

3037 3038
  // special case -- if max_background_flushes == 0, then schedule flush on a
  // compaction thread
3039
  if (immutable_db_options_.max_background_flushes == 0) {
3040 3041
    while (unscheduled_flushes_ > 0 &&
           bg_flush_scheduled_ + bg_compaction_scheduled_ <
3042
               bg_compactions_allowed) {
3043 3044 3045 3046 3047 3048
      unscheduled_flushes_--;
      bg_flush_scheduled_++;
      env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::LOW, this);
    }
  }

3049 3050 3051 3052 3053
  if (bg_compaction_paused_ > 0) {
    // we paused the background compaction
    return;
  }

3054
  if (HasExclusiveManualCompaction()) {
3055 3056 3057 3058 3059
    // only manual compactions are allowed to run. don't schedule automatic
    // compactions
    return;
  }

3060
  while (bg_compaction_scheduled_ < bg_compactions_allowed &&
3061
         unscheduled_compactions_ > 0) {
3062 3063 3064
    CompactionArg* ca = new CompactionArg;
    ca->db = this;
    ca->m = nullptr;
3065 3066
    bg_compaction_scheduled_++;
    unscheduled_compactions_--;
3067 3068
    env_->Schedule(&DBImpl::BGWorkCompaction, ca, Env::Priority::LOW, this,
                   &DBImpl::UnscheduleCallback);
3069 3070 3071
  }
}

3072 3073 3074 3075 3076 3077 3078 3079 3080
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);
}

3081
int DBImpl::BGCompactionsAllowed() const {
3082
  mutex_.AssertHeld();
3083
  if (write_controller_.NeedSpeedupCompaction()) {
3084
    return mutable_db_options_.max_background_compactions;
3085
  } else {
3086
    return mutable_db_options_.base_background_compactions;
3087 3088 3089
  }
}

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

3136 3137 3138 3139 3140 3141 3142 3143
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));
}

3144
void DBImpl::BGWorkFlush(void* db) {
3145
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
3146
  TEST_SYNC_POINT("DBImpl::BGWorkFlush");
3147
  reinterpret_cast<DBImpl*>(db)->BackgroundCallFlush();
3148
  TEST_SYNC_POINT("DBImpl::BGWorkFlush:done");
3149 3150
}

3151 3152 3153
void DBImpl::BGWorkCompaction(void* arg) {
  CompactionArg ca = *(reinterpret_cast<CompactionArg*>(arg));
  delete reinterpret_cast<CompactionArg*>(arg);
3154
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::LOW);
3155
  TEST_SYNC_POINT("DBImpl::BGWorkCompaction");
3156 3157 3158
  reinterpret_cast<DBImpl*>(ca.db)->BackgroundCallCompaction(ca.m);
}

3159 3160
void DBImpl::BGWorkPurge(void* db) {
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
3161
  TEST_SYNC_POINT("DBImpl::BGWorkPurge:start");
3162
  reinterpret_cast<DBImpl*>(db)->BackgroundCallPurge();
3163
  TEST_SYNC_POINT("DBImpl::BGWorkPurge:end");
3164 3165
}

3166 3167 3168 3169 3170 3171 3172
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");
3173 3174
}

3175 3176 3177
void DBImpl::BackgroundCallPurge() {
  mutex_.Lock();

3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189
  // 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();
3190

3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203
      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();
    }
3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214
  }
  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();
}

3215
Status DBImpl::BackgroundFlush(bool* made_progress, JobContext* job_context,
H
Haobo Xu 已提交
3216
                               LogBuffer* log_buffer) {
3217
  mutex_.AssertHeld();
3218

3219 3220 3221 3222 3223 3224 3225
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

  if (!status.ok()) {
    return status;
3226 3227
  }

3228 3229 3230
  ColumnFamilyData* cfd = nullptr;
  while (!flush_queue_.empty()) {
    // This cfd is already referenced
I
Igor Canadi 已提交
3231
    auto first_cfd = PopFirstFromFlushQueue();
3232

I
Igor Canadi 已提交
3233
    if (first_cfd->IsDropped() || !first_cfd->imm()->IsFlushPending()) {
3234
      // can't flush this CF, try next one
I
Igor Canadi 已提交
3235 3236
      if (first_cfd->Unref()) {
        delete first_cfd;
3237 3238
      }
      continue;
3239
    }
3240 3241

    // found a flush!
I
Igor Canadi 已提交
3242
    cfd = first_cfd;
3243 3244 3245 3246 3247 3248
    break;
  }

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

3265
void DBImpl::BackgroundCallFlush() {
3266
  bool made_progress = false;
3267
  JobContext job_context(next_job_id_.fetch_add(1), true);
3268 3269
  assert(bg_flush_scheduled_);

3270 3271
  TEST_SYNC_POINT("DBImpl::BackgroundCallFlush:start");

3272 3273
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL,
                       immutable_db_options_.info_log.get());
H
Haobo Xu 已提交
3274
  {
3275
    InstrumentedMutexLock l(&mutex_);
3276
    num_running_flushes_++;
H
Haobo Xu 已提交
3277

I
Igor Canadi 已提交
3278 3279 3280
    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

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

I
Igor Canadi 已提交
3301 3302
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

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

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

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

    // This call will unlock/lock the mutex to wait for current running
3347 3348
    // IngestExternalFile() calls to finish.
    WaitForIngestFile();
3349

3350
    num_running_compactions_++;
I
Igor Canadi 已提交
3351 3352 3353 3354

    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

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

I
Igor Canadi 已提交
3378 3379
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

3380 3381 3382 3383
    // 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());
3384 3385

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

3401 3402
    assert(num_running_compactions_ > 0);
    num_running_compactions_--;
3403
    bg_compaction_scheduled_--;
J
jorlow@chromium.org 已提交
3404

3405 3406
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();

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

3426 3427
Status DBImpl::BackgroundCompaction(bool* made_progress,
                                    JobContext* job_context,
3428 3429 3430
                                    LogBuffer* log_buffer, void* arg) {
  ManualCompaction* manual_compaction =
      reinterpret_cast<ManualCompaction*>(arg);
3431
  *made_progress = false;
J
jorlow@chromium.org 已提交
3432
  mutex_.AssertHeld();
3433
  TEST_SYNC_POINT("DBImpl::BackgroundCompaction:Start");
3434

3435 3436 3437 3438 3439
  bool is_manual = (manual_compaction != nullptr);

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

3441
  CompactionJobStats compaction_job_stats;
3442 3443 3444 3445 3446 3447
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

  if (!status.ok()) {
3448
    if (is_manual) {
3449 3450 3451 3452 3453
      manual_compaction->status = status;
      manual_compaction->done = true;
      manual_compaction->in_progress = false;
      delete manual_compaction->compaction;
      manual_compaction = nullptr;
3454
    }
3455
    return status;
3456 3457
  }

3458 3459
  if (is_manual) {
    // another thread cannot pick up the same work
3460
    manual_compaction->in_progress = true;
3461 3462 3463
  }

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

3506 3507 3508 3509 3510 3511
    if (HaveManualCompaction(cfd)) {
      // Can't compact right now, but try again later
      TEST_SYNC_POINT("DBImpl::BackgroundCompaction()::Conflict");
      return Status::OK();
    }

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

3551
  if (!c) {
H
hans@chromium.org 已提交
3552
    // Nothing to do
3553
    ROCKS_LOG_BUFFER(log_buffer, "Compaction nothing to do");
3554
  } else if (c->deletion_compaction()) {
I
Igor Canadi 已提交
3555 3556 3557 3558
    // 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);
3559
    assert(c->column_family_data()->ioptions()->compaction_style ==
I
Igor Canadi 已提交
3560
           kCompactionStyleFIFO);
3561 3562 3563

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

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

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

3587 3588 3589
    // Move files to next level
    int32_t moved_files = 0;
    int64_t moved_bytes = 0;
3590
    for (unsigned int l = 0; l < c->num_input_levels(); l++) {
3591
      if (c->level(l) == c->output_level()) {
3592 3593 3594 3595
        continue;
      }
      for (size_t i = 0; i < c->num_input_files(l); i++) {
        FileMetaData* f = c->input(l, i);
3596
        c->edit()->DeleteFile(c->level(l), f->fd.GetNumber());
3597 3598 3599 3600 3601
        c->edit()->AddFile(c->output_level(), f->fd.GetNumber(),
                           f->fd.GetPathId(), f->fd.GetFileSize(), f->smallest,
                           f->largest, f->smallest_seqno, f->largest_seqno,
                           f->marked_for_compaction);

3602 3603 3604 3605 3606
        ROCKS_LOG_BUFFER(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());
3607 3608 3609
        ++moved_files;
        moved_bytes += f->fd.GetFileSize();
      }
3610
    }
3611

3612
    status = versions_->LogAndApply(c->column_family_data(),
3613 3614
                                    *c->mutable_cf_options(), c->edit(),
                                    &mutex_, directories_.GetDbDir());
3615
    // Use latest MutableCFOptions
I
Igor Canadi 已提交
3616 3617
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
3618

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

    // Clear Instrument
    ThreadStatusUtil::ResetThreadStatus();
J
jorlow@chromium.org 已提交
3639
  } else {
3640 3641 3642
    int output_level  __attribute__((unused)) = c->output_level();
    TEST_SYNC_POINT_CALLBACK("DBImpl::BackgroundCompaction:NonTrivial",
                             &output_level);
3643 3644 3645 3646 3647

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

I
Igor Canadi 已提交
3648
    assert(is_snapshot_supported_ || snapshots_.empty());
3649
    CompactionJob compaction_job(
3650
        job_context->job_id, c.get(), immutable_db_options_, env_options_,
I
Igor Canadi 已提交
3651
        versions_.get(), &shutting_down_, log_buffer, directories_.GetDbDir(),
3652 3653 3654
        directories_.GetDataDir(c->output_path_id()), stats_, &mutex_,
        &bg_error_, snapshot_seqs, earliest_write_conflict_snapshot,
        table_cache_, &event_logger_,
3655
        c->mutable_cf_options()->paranoid_file_checks,
3656
        c->mutable_cf_options()->report_bg_io_stats, dbname_,
S
sdong 已提交
3657
        &compaction_job_stats);
I
Igor Canadi 已提交
3658
    compaction_job.Prepare();
3659

I
Igor Canadi 已提交
3660
    mutex_.Unlock();
3661
    compaction_job.Run();
3662
    TEST_SYNC_POINT("DBImpl::BackgroundCompaction:NonTrivial:AfterRun");
I
Igor Canadi 已提交
3663
    mutex_.Lock();
3664

3665
    status = compaction_job.Install(*c->mutable_cf_options());
I
Igor Canadi 已提交
3666
    if (status.ok()) {
I
Igor Canadi 已提交
3667 3668
      InstallSuperVersionAndScheduleWorkWrapper(
          c->column_family_data(), job_context, *c->mutable_cf_options());
I
Igor Canadi 已提交
3669
    }
3670
    *made_progress = true;
O
Ori Bernstein 已提交
3671 3672
  }
  if (c != nullptr) {
3673 3674
    c->ReleaseCompactionFiles(status);
    *made_progress = true;
3675 3676 3677
    NotifyOnCompactionCompleted(
        c->column_family_data(), c.get(), status,
        compaction_job_stats, job_context->job_id);
J
jorlow@chromium.org 已提交
3678
  }
3679
  // this will unref its input_version and column_family_data
3680
  c.reset();
J
jorlow@chromium.org 已提交
3681 3682 3683

  if (status.ok()) {
    // Done
F
Feng Zhu 已提交
3684
  } else if (status.IsShutdownInProgress()) {
J
jorlow@chromium.org 已提交
3685 3686
    // Ignore compaction errors found during shutting down
  } else {
3687 3688
    ROCKS_LOG_WARN(immutable_db_options_.info_log, "Compaction error: %s",
                   status.ToString().c_str());
3689
    if (immutable_db_options_.paranoid_checks && bg_error_.ok()) {
J
jorlow@chromium.org 已提交
3690 3691 3692
      bg_error_ = status;
    }
  }
H
hans@chromium.org 已提交
3693 3694

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

3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756
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;
}

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

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

  return bsize;
}

3846 3847
namespace {
struct IterState {
3848
  IterState(DBImpl* _db, InstrumentedMutex* _mu, SuperVersion* _super_version,
3849
            bool _background_purge)
3850 3851 3852
      : db(_db),
        mu(_mu),
        super_version(_super_version),
3853
        background_purge(_background_purge) {}
3854 3855

  DBImpl* db;
3856
  InstrumentedMutex* mu;
3857
  SuperVersion* super_version;
3858
  bool background_purge;
3859 3860 3861 3862
};

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

3864
  if (state->super_version->Unref()) {
3865 3866 3867
    // Job id == 0 means that this is not our background process, but rather
    // user thread
    JobContext job_context(0);
3868

3869 3870
    state->mu->Lock();
    state->super_version->Cleanup();
I
Igor Canadi 已提交
3871
    state->db->FindObsoleteFiles(&job_context, false, true);
3872 3873 3874
    if (state->background_purge) {
      state->db->ScheduleBgLogWriterClose(&job_context);
    }
3875 3876 3877
    state->mu->Unlock();

    delete state->super_version;
I
Igor Canadi 已提交
3878
    if (job_context.HaveSomethingToDelete()) {
3879
      if (state->background_purge) {
3880 3881 3882 3883 3884 3885 3886 3887 3888 3889
        // 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);
      }
3890
    }
I
Igor Canadi 已提交
3891
    job_context.Clean();
I
Igor Canadi 已提交
3892
  }
T
Tomislav Novak 已提交
3893

3894 3895
  delete state;
}
H
Hans Wennborg 已提交
3896
}  // namespace
3897

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

3945 3946 3947 3948
ColumnFamilyHandle* DBImpl::DefaultColumnFamily() const {
  return default_cf_handle_;
}

L
Lei Jin 已提交
3949
Status DBImpl::Get(const ReadOptions& read_options,
3950
                   ColumnFamilyHandle* column_family, const Slice& key,
M
Maysam Yabandeh 已提交
3951
                   PinnableSlice* value) {
M
Maysam Yabandeh 已提交
3952
  return GetImpl(read_options, column_family, key, value);
3953 3954
}

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

I
Igor Canadi 已提交
3977
SuperVersion* DBImpl::InstallSuperVersionAndScheduleWork(
L
Lei Jin 已提交
3978
    ColumnFamilyData* cfd, SuperVersion* new_sv,
I
Igor Canadi 已提交
3979
    const MutableCFOptions& mutable_cf_options) {
L
Lei Jin 已提交
3980
  mutex_.AssertHeld();
3981 3982 3983 3984 3985 3986 3987 3988 3989

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

3993
  // Whenever we install new SuperVersion, we might need to issue new flushes or
I
Igor Canadi 已提交
3994 3995 3996 3997
  // compactions.
  SchedulePendingFlush(cfd);
  SchedulePendingCompaction(cfd);
  MaybeScheduleFlushOrCompaction();
L
Lei Jin 已提交
3998 3999 4000 4001 4002 4003 4004 4005 4006 4007

  // 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,
4008
                       ColumnFamilyHandle* column_family, const Slice& key,
M
Maysam Yabandeh 已提交
4009 4010
                       PinnableSlice* pinnable_val, bool* value_found) {
  assert(pinnable_val != nullptr);
L
Lei Jin 已提交
4011
  StopWatch sw(env_, stats_, DB_GET);
4012
  PERF_TIMER_GUARD(get_snapshot_time);
4013

4014 4015 4016
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

4017 4018 4019 4020 4021 4022
  // Acquire SuperVersion
  SuperVersion* sv = GetAndRefSuperVersion(cfd);

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

4023
  SequenceNumber snapshot;
L
Lei Jin 已提交
4024 4025 4026
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
4027
  } else {
4028 4029 4030 4031 4032 4033 4034 4035 4036 4037
    // 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.
4038
    snapshot = versions_->LastSequence();
J
jorlow@chromium.org 已提交
4039
  }
4040 4041
  TEST_SYNC_POINT("DBImpl::GetImpl:3");
  TEST_SYNC_POINT("DBImpl::GetImpl:4");
4042

4043
  // Prepare to store a list of merge operations if merge occurs.
4044
  MergeContext merge_context;
4045
  RangeDelAggregator range_del_agg(cfd->internal_comparator(), snapshot);
4046

4047
  Status s;
4048
  // First look in the memtable, then in the immutable memtable (if any).
4049
  // s is both in/out. When in, s could either be OK or MergeInProgress.
4050
  // merge_operands will contain the sequence of merges in the latter case.
4051
  LookupKey lkey(key, snapshot);
L
Lei Jin 已提交
4052
  PERF_TIMER_STOP(get_snapshot_time);
4053

4054 4055
  bool skip_memtable = (read_options.read_tier == kPersistedTier &&
                        has_unpersisted_data_.load(std::memory_order_relaxed));
4056 4057
  bool done = false;
  if (!skip_memtable) {
M
Maysam Yabandeh 已提交
4058 4059
    if (sv->mem->Get(lkey, pinnable_val->GetSelf(), &s, &merge_context,
                     &range_del_agg, read_options)) {
4060
      done = true;
M
Maysam Yabandeh 已提交
4061
      pinnable_val->PinSelf();
4062
      RecordTick(stats_, MEMTABLE_HIT);
A
Andrew Kryczka 已提交
4063
    } else if ((s.ok() || s.IsMergeInProgress()) &&
M
Maysam Yabandeh 已提交
4064 4065
               sv->imm->Get(lkey, pinnable_val->GetSelf(), &s, &merge_context,
                            &range_del_agg, read_options)) {
4066
      done = true;
M
Maysam Yabandeh 已提交
4067
      pinnable_val->PinSelf();
4068 4069
      RecordTick(stats_, MEMTABLE_HIT);
    }
A
Andrew Kryczka 已提交
4070 4071 4072
    if (!done && !s.ok() && !s.IsMergeInProgress()) {
      return s;
    }
4073 4074
  }
  if (!done) {
4075
    PERF_TIMER_GUARD(get_from_output_files_time);
M
Maysam Yabandeh 已提交
4076
    sv->current->Get(read_options, lkey, pinnable_val, &s, &merge_context,
A
Andrew Kryczka 已提交
4077
                     &range_del_agg, value_found);
L
Lei Jin 已提交
4078
    RecordTick(stats_, MEMTABLE_MISS);
4079
  }
4080

4081 4082
  {
    PERF_TIMER_GUARD(get_post_process_time);
4083

4084
    ReturnAndCleanupSuperVersion(cfd, sv);
4085

4086
    RecordTick(stats_, NUMBER_KEYS_READ);
M
Maysam Yabandeh 已提交
4087 4088 4089
    size_t size = pinnable_val->size();
    RecordTick(stats_, BYTES_READ, size);
    MeasureTime(stats_, BYTES_PER_READ, size);
4090
  }
4091
  return s;
J
jorlow@chromium.org 已提交
4092 4093
}

4094
std::vector<Status> DBImpl::MultiGet(
L
Lei Jin 已提交
4095
    const ReadOptions& read_options,
4096
    const std::vector<ColumnFamilyHandle*>& column_family,
4097
    const std::vector<Slice>& keys, std::vector<std::string>* values) {
4098

L
Lei Jin 已提交
4099
  StopWatch sw(env_, stats_, DB_MULTIGET);
4100
  PERF_TIMER_GUARD(get_snapshot_time);
K
Kai Liu 已提交
4101

4102
  SequenceNumber snapshot;
4103

4104
  struct MultiGetColumnFamilyData {
I
Igor Canadi 已提交
4105
    ColumnFamilyData* cfd;
4106 4107 4108 4109 4110
    SuperVersion* super_version;
  };
  std::unordered_map<uint32_t, MultiGetColumnFamilyData*> multiget_cf_data;
  // fill up and allocate outside of mutex
  for (auto cf : column_family) {
4111 4112 4113 4114 4115 4116
    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});
4117 4118 4119
    }
  }

4120
  mutex_.Lock();
L
Lei Jin 已提交
4121 4122 4123
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
4124 4125 4126
  } else {
    snapshot = versions_->LastSequence();
  }
4127
  for (auto mgd_iter : multiget_cf_data) {
4128 4129
    mgd_iter.second->super_version =
        mgd_iter.second->cfd->GetSuperVersion()->Ref();
4130
  }
4131
  mutex_.Unlock();
4132

4133 4134
  // Contain a list of merge operations if merge occurs.
  MergeContext merge_context;
4135

4136
  // Note: this always resizes the values array
4137 4138 4139
  size_t num_keys = keys.size();
  std::vector<Status> stat_list(num_keys);
  values->resize(num_keys);
4140 4141

  // Keep track of bytes that we read for statistics-recording later
4142
  uint64_t bytes_read = 0;
L
Lei Jin 已提交
4143
  PERF_TIMER_STOP(get_snapshot_time);
4144 4145 4146 4147

  // 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.
4148
  // merge_operands will contain the sequence of merges in the latter case.
4149
  for (size_t i = 0; i < num_keys; ++i) {
4150
    merge_context.Clear();
4151
    Status& s = stat_list[i];
4152 4153 4154
    std::string* value = &(*values)[i];

    LookupKey lkey(keys[i], snapshot);
4155
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family[i]);
A
Andrew Kryczka 已提交
4156
    RangeDelAggregator range_del_agg(cfh->cfd()->internal_comparator(),
4157
                                     snapshot);
4158
    auto mgd_iter = multiget_cf_data.find(cfh->cfd()->GetID());
4159 4160 4161
    assert(mgd_iter != multiget_cf_data.end());
    auto mgd = mgd_iter->second;
    auto super_version = mgd->super_version;
4162
    bool skip_memtable =
4163 4164
        (read_options.read_tier == kPersistedTier &&
         has_unpersisted_data_.load(std::memory_order_relaxed));
4165 4166
    bool done = false;
    if (!skip_memtable) {
M
Maysam Yabandeh 已提交
4167
      if (super_version->mem->Get(lkey, value, &s, &merge_context,
A
Andrew Kryczka 已提交
4168
                                  &range_del_agg, read_options)) {
4169 4170
        done = true;
        // TODO(?): RecordTick(stats_, MEMTABLE_HIT)?
M
Maysam Yabandeh 已提交
4171
      } else if (super_version->imm->Get(lkey, value, &s, &merge_context,
A
Andrew Kryczka 已提交
4172
                                         &range_del_agg, read_options)) {
4173 4174 4175 4176 4177
        done = true;
        // TODO(?): RecordTick(stats_, MEMTABLE_HIT)?
      }
    }
    if (!done) {
M
Maysam Yabandeh 已提交
4178
      PinnableSlice pinnable_val;
4179
      PERF_TIMER_GUARD(get_from_output_files_time);
M
Maysam Yabandeh 已提交
4180 4181 4182
      super_version->current->Get(read_options, lkey, &pinnable_val, &s,
                                  &merge_context, &range_del_agg);
      value->assign(pinnable_val.data(), pinnable_val.size());
4183
      // TODO(?): RecordTick(stats_, MEMTABLE_MISS)?
4184 4185 4186
    }

    if (s.ok()) {
M
Maysam Yabandeh 已提交
4187
      bytes_read += value->size();
4188 4189 4190 4191
    }
  }

  // Post processing (decrement reference counts and record statistics)
4192
  PERF_TIMER_GUARD(get_post_process_time);
4193 4194
  autovector<SuperVersion*> superversions_to_delete;

I
Igor Canadi 已提交
4195
  // TODO(icanadi) do we need lock here or just around Cleanup()?
4196 4197 4198 4199 4200 4201
  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);
4202 4203
    }
  }
4204 4205 4206 4207 4208 4209 4210
  mutex_.Unlock();

  for (auto td : superversions_to_delete) {
    delete td;
  }
  for (auto mgd : multiget_cf_data) {
    delete mgd.second;
4211
  }
4212

L
Lei Jin 已提交
4213 4214 4215
  RecordTick(stats_, NUMBER_MULTIGET_CALLS);
  RecordTick(stats_, NUMBER_MULTIGET_KEYS_READ, num_keys);
  RecordTick(stats_, NUMBER_MULTIGET_BYTES_READ, bytes_read);
4216
  MeasureTime(stats_, BYTES_PER_MULTIGET, bytes_read);
L
Lei Jin 已提交
4217
  PERF_TIMER_STOP(get_post_process_time);
4218

4219
  return stat_list;
4220 4221
}

L
Lei Jin 已提交
4222
Status DBImpl::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
4223
                                  const std::string& column_family_name,
4224
                                  ColumnFamilyHandle** handle) {
Y
Yueh-Hsuan Chiang 已提交
4225
  Status s;
4226
  Status persist_options_status;
I
Igor Canadi 已提交
4227
  *handle = nullptr;
4228 4229

  s = CheckCompressionSupported(cf_options);
4230
  if (s.ok() && immutable_db_options_.allow_concurrent_memtable_write) {
4231 4232
    s = CheckConcurrentWritesSupported(cf_options);
  }
4233 4234 4235 4236
  if (!s.ok()) {
    return s;
  }

Y
Yueh-Hsuan Chiang 已提交
4237
  {
4238
    InstrumentedMutexLock l(&mutex_);
I
Igor Canadi 已提交
4239

Y
Yueh-Hsuan Chiang 已提交
4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252
    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 已提交
4253
    {  // write thread
4254 4255
      WriteThread::Writer w;
      write_thread_.EnterUnbatched(&w, &mutex_);
I
Igor Canadi 已提交
4256 4257
      // LogAndApply will both write the creation in MANIFEST and create
      // ColumnFamilyData object
4258 4259 4260
      s = versions_->LogAndApply(nullptr, MutableCFOptions(cf_options), &edit,
                                 &mutex_, directories_.GetDbDir(), false,
                                 &cf_options);
4261 4262 4263 4264 4265 4266

      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();
      }
4267
      write_thread_.ExitUnbatched(&w);
I
Igor Canadi 已提交
4268
    }
Y
Yueh-Hsuan Chiang 已提交
4269 4270 4271 4272 4273
    if (s.ok()) {
      single_column_family_mode_ = false;
      auto* cfd =
          versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name);
      assert(cfd != nullptr);
I
Igor Canadi 已提交
4274
      delete InstallSuperVersionAndScheduleWork(
Y
Yueh-Hsuan Chiang 已提交
4275
          cfd, nullptr, *cfd->GetLatestMutableCFOptions());
S
sdong 已提交
4276 4277 4278 4279 4280

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

Y
Yueh-Hsuan Chiang 已提交
4281
      *handle = new ColumnFamilyHandleImpl(cfd, this, &mutex_);
4282 4283 4284
      ROCKS_LOG_INFO(immutable_db_options_.info_log,
                     "Created column family [%s] (ID %u)",
                     column_family_name.c_str(), (unsigned)cfd->GetID());
Y
Yueh-Hsuan Chiang 已提交
4285
    } else {
4286 4287 4288
      ROCKS_LOG_ERROR(immutable_db_options_.info_log,
                      "Creating column family [%s] FAILED -- %s",
                      column_family_name.c_str(), s.ToString().c_str());
Y
Yueh-Hsuan Chiang 已提交
4289
    }
4290
  }  // InstrumentedMutexLock l(&mutex_)
Y
Yueh-Hsuan Chiang 已提交
4291 4292

  // this is outside the mutex
4293
  if (s.ok()) {
4294 4295
    NewThreadStatusCfInfo(
        reinterpret_cast<ColumnFamilyHandleImpl*>(*handle)->cfd());
4296
    if (!persist_options_status.ok()) {
4297
      if (immutable_db_options_.fail_if_options_file_error) {
4298 4299 4300 4301 4302
        s = Status::IOError(
            "ColumnFamily has been created, but unable to persist"
            "options in CreateColumnFamily()",
            persist_options_status.ToString().c_str());
      }
4303 4304 4305
      ROCKS_LOG_WARN(immutable_db_options_.info_log,
                     "Unable to persist options in CreateColumnFamily() -- %s",
                     persist_options_status.ToString().c_str());
4306
    }
4307
  }
4308
  return s;
4309 4310
}

4311 4312 4313 4314
Status DBImpl::DropColumnFamily(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
  if (cfd->GetID() == 0) {
4315 4316
    return Status::InvalidArgument("Can't drop default column family");
  }
4317

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

I
Igor Canadi 已提交
4320 4321
  VersionEdit edit;
  edit.DropColumnFamily();
4322 4323
  edit.SetColumnFamily(cfd->GetID());

4324
  Status s;
4325
  Status options_persist_status;
4326
  {
4327
    InstrumentedMutexLock l(&mutex_);
4328 4329 4330 4331
    if (cfd->IsDropped()) {
      s = Status::InvalidArgument("Column family already dropped!\n");
    }
    if (s.ok()) {
4332
      // we drop column family from a single write thread
4333 4334
      WriteThread::Writer w;
      write_thread_.EnterUnbatched(&w, &mutex_);
4335 4336
      s = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                 &edit, &mutex_);
4337 4338 4339 4340 4341
      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();
      }
4342
      write_thread_.ExitUnbatched(&w);
4343
    }
S
sdong 已提交
4344 4345 4346 4347 4348 4349

    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()) {
4350
        if (!c->IsDropped() && !c->mem()->IsSnapshotSupported()) {
S
sdong 已提交
4351 4352 4353 4354 4355 4356
          new_is_snapshot_supported = false;
          break;
        }
      }
      is_snapshot_supported_ = new_is_snapshot_supported;
    }
4357
  }
4358

4359
  if (s.ok()) {
Y
Yueh-Hsuan Chiang 已提交
4360 4361 4362 4363
    // 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 已提交
4364
    assert(cfd->IsDropped());
L
Lei Jin 已提交
4365 4366 4367
    auto* mutable_cf_options = cfd->GetLatestMutableCFOptions();
    max_total_in_memory_state_ -= mutable_cf_options->write_buffer_size *
                                  mutable_cf_options->max_write_buffer_number;
4368 4369
    ROCKS_LOG_INFO(immutable_db_options_.info_log,
                   "Dropped column family with id %u\n", cfd->GetID());
4370

4371
    if (!options_persist_status.ok()) {
4372
      if (immutable_db_options_.fail_if_options_file_error) {
4373 4374 4375 4376 4377
        s = Status::IOError(
            "ColumnFamily has been dropped, but unable to persist "
            "options in DropColumnFamily()",
            options_persist_status.ToString().c_str());
      }
4378 4379 4380
      ROCKS_LOG_WARN(immutable_db_options_.info_log,
                     "Unable to persist options in DropColumnFamily() -- %s",
                     options_persist_status.ToString().c_str());
4381
    }
4382
  } else {
4383 4384 4385
    ROCKS_LOG_ERROR(immutable_db_options_.info_log,
                    "Dropping column family with id %u FAILED -- %s\n",
                    cfd->GetID(), s.ToString().c_str());
4386 4387
  }

4388
  return s;
4389 4390
}

L
Lei Jin 已提交
4391
bool DBImpl::KeyMayExist(const ReadOptions& read_options,
4392 4393
                         ColumnFamilyHandle* column_family, const Slice& key,
                         std::string* value, bool* value_found) {
M
Maysam Yabandeh 已提交
4394
  assert(value != nullptr);
4395
  if (value_found != nullptr) {
K
Kai Liu 已提交
4396 4397
    // falsify later if key-may-exist but can't fetch value
    *value_found = true;
4398
  }
L
Lei Jin 已提交
4399
  ReadOptions roptions = read_options;
4400
  roptions.read_tier = kBlockCacheTier; // read from block cache only
M
Maysam Yabandeh 已提交
4401 4402 4403
  PinnableSlice pinnable_val;
  auto s = GetImpl(roptions, column_family, key, &pinnable_val, value_found);
  value->assign(pinnable_val.data(), pinnable_val.size());
K
Kai Liu 已提交
4404

4405
  // If block_cache is enabled and the index block of the table didn't
K
Kai Liu 已提交
4406 4407 4408
  // 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();
4409 4410
}

4411
Iterator* DBImpl::NewIterator(const ReadOptions& read_options,
4412
                              ColumnFamilyHandle* column_family) {
4413 4414 4415 4416
  if (read_options.read_tier == kPersistedTier) {
    return NewErrorIterator(Status::NotSupported(
        "ReadTier::kPersistedData is not yet supported in iterators."));
  }
4417 4418
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
V
Venkatesh Radhakrishnan 已提交
4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433
  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 已提交
4434 4435 4436 4437
#ifdef ROCKSDB_LITE
    // not supported in lite version
    return nullptr;
#else
4438 4439
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
    auto iter = new ForwardIterator(this, read_options, cfd, sv);
4440 4441
    return NewDBIterator(
        env_, *cfd->ioptions(), cfd->user_comparator(), iter,
4442 4443
        kMaxSequenceNumber,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
4444 4445
        sv->version_number, read_options.iterate_upper_bound,
        read_options.prefix_same_as_start, read_options.pin_data);
I
Igor Canadi 已提交
4446
#endif
T
Tomislav Novak 已提交
4447
  } else {
4448
    SequenceNumber latest_snapshot = versions_->LastSequence();
4449
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
4450

I
Igor Canadi 已提交
4451
    auto snapshot =
4452 4453 4454
        read_options.snapshot != nullptr
            ? reinterpret_cast<const SnapshotImpl*>(
                read_options.snapshot)->number_
I
Igor Canadi 已提交
4455
            : latest_snapshot;
T
Tomislav Novak 已提交
4456

4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492
    // 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         | <----+
    // |       |   +-------------------+
    // |       |                       |
    // +-------+-----------------------+
    //
4493 4494
    // ArenaWrappedDBIter inlines an arena area where all the iterators in
    // the iterator tree are allocated in the order of being accessed when
4495 4496 4497 4498 4499
    // 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(
4500 4501
        env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
4502
        sv->version_number, read_options.iterate_upper_bound,
4503 4504
        read_options.prefix_same_as_start, read_options.pin_data,
        read_options.total_order_seek);
4505

S
sdong 已提交
4506
    InternalIterator* internal_iter =
A
Andrew Kryczka 已提交
4507 4508
        NewInternalIterator(read_options, cfd, sv, db_iter->GetArena(),
                            db_iter->GetRangeDelAggregator());
4509 4510 4511 4512
    db_iter->SetIterUnderDBIter(internal_iter);

    return db_iter;
  }
4513 4514
  // To stop compiler from complaining
  return nullptr;
J
jorlow@chromium.org 已提交
4515 4516
}

4517
Status DBImpl::NewIterators(
4518
    const ReadOptions& read_options,
I
Igor Canadi 已提交
4519
    const std::vector<ColumnFamilyHandle*>& column_families,
4520
    std::vector<Iterator*>* iterators) {
4521 4522 4523 4524
  if (read_options.read_tier == kPersistedTier) {
    return Status::NotSupported(
        "ReadTier::kPersistedData is not yet supported in iterators.");
  }
I
Igor Canadi 已提交
4525 4526
  iterators->clear();
  iterators->reserve(column_families.size());
V
Venkatesh Radhakrishnan 已提交
4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543
  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 已提交
4544 4545 4546 4547
#ifdef ROCKSDB_LITE
    return Status::InvalidArgument(
        "Tailing interator not supported in RocksDB lite");
#else
I
Igor Canadi 已提交
4548 4549
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
4550 4551
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
      auto iter = new ForwardIterator(this, read_options, cfd, sv);
4552 4553 4554
      iterators->push_back(NewDBIterator(
          env_, *cfd->ioptions(), cfd->user_comparator(), iter,
          kMaxSequenceNumber,
4555 4556
          sv->mutable_cf_options.max_sequential_skip_in_iterations,
          sv->version_number, nullptr, false, read_options.pin_data));
I
Igor Canadi 已提交
4557
    }
I
Igor Canadi 已提交
4558
#endif
I
Igor Canadi 已提交
4559
  } else {
4560 4561
    SequenceNumber latest_snapshot = versions_->LastSequence();

I
Igor Canadi 已提交
4562
    for (size_t i = 0; i < column_families.size(); ++i) {
4563 4564 4565
      auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(
          column_families[i])->cfd();
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
I
Igor Canadi 已提交
4566 4567

      auto snapshot =
4568 4569 4570
          read_options.snapshot != nullptr
              ? reinterpret_cast<const SnapshotImpl*>(
                  read_options.snapshot)->number_
I
Igor Canadi 已提交
4571 4572
              : latest_snapshot;

4573
      ArenaWrappedDBIter* db_iter = NewArenaWrappedDbIterator(
4574
          env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
4575 4576
          sv->mutable_cf_options.max_sequential_skip_in_iterations,
          sv->version_number, nullptr, false, read_options.pin_data);
S
sdong 已提交
4577
      InternalIterator* internal_iter =
A
Andrew Kryczka 已提交
4578 4579
          NewInternalIterator(read_options, cfd, sv, db_iter->GetArena(),
                              db_iter->GetRangeDelAggregator());
4580 4581
      db_iter->SetIterUnderDBIter(internal_iter);
      iterators->push_back(db_iter);
I
Igor Canadi 已提交
4582 4583 4584 4585
    }
  }

  return Status::OK();
4586 4587
}

4588 4589
const Snapshot* DBImpl::GetSnapshot() { return GetSnapshotImpl(false); }

4590
#ifndef ROCKSDB_LITE
4591 4592 4593
const Snapshot* DBImpl::GetSnapshotForWriteConflictBoundary() {
  return GetSnapshotImpl(true);
}
4594
#endif  // ROCKSDB_LITE
4595 4596

const Snapshot* DBImpl::GetSnapshotImpl(bool is_write_conflict_boundary) {
4597 4598
  int64_t unix_time = 0;
  env_->GetCurrentTime(&unix_time);  // Ignore error
4599
  SnapshotImpl* s = new SnapshotImpl;
4600

4601
  InstrumentedMutexLock l(&mutex_);
4602
  // returns null if the underlying memtable does not support snapshot.
4603 4604 4605 4606
  if (!is_snapshot_supported_) {
    delete s;
    return nullptr;
  }
4607 4608
  return snapshots_.New(s, versions_->LastSequence(), unix_time,
                        is_write_conflict_boundary);
J
jorlow@chromium.org 已提交
4609 4610 4611
}

void DBImpl::ReleaseSnapshot(const Snapshot* s) {
4612 4613 4614 4615 4616 4617
  const SnapshotImpl* casted_s = reinterpret_cast<const SnapshotImpl*>(s);
  {
    InstrumentedMutexLock l(&mutex_);
    snapshots_.Delete(casted_s);
  }
  delete casted_s;
J
jorlow@chromium.org 已提交
4618 4619 4620
}

// Convenience methods
4621 4622
Status DBImpl::Put(const WriteOptions& o, ColumnFamilyHandle* column_family,
                   const Slice& key, const Slice& val) {
4623
  return DB::Put(o, column_family, key, val);
J
jorlow@chromium.org 已提交
4624 4625
}

4626 4627 4628
Status DBImpl::Merge(const WriteOptions& o, ColumnFamilyHandle* column_family,
                     const Slice& key, const Slice& val) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
4629
  if (!cfh->cfd()->ioptions()->merge_operator) {
4630 4631
    return Status::NotSupported("Provide a merge_operator when opening DB");
  } else {
4632
    return DB::Merge(o, column_family, key, val);
4633 4634 4635
  }
}

L
Lei Jin 已提交
4636
Status DBImpl::Delete(const WriteOptions& write_options,
4637
                      ColumnFamilyHandle* column_family, const Slice& key) {
L
Lei Jin 已提交
4638
  return DB::Delete(write_options, column_family, key);
J
jorlow@chromium.org 已提交
4639 4640
}

A
Andres Noetzli 已提交
4641 4642 4643 4644 4645 4646
Status DBImpl::SingleDelete(const WriteOptions& write_options,
                            ColumnFamilyHandle* column_family,
                            const Slice& key) {
  return DB::SingleDelete(write_options, column_family, key);
}

L
Lei Jin 已提交
4647
Status DBImpl::Write(const WriteOptions& write_options, WriteBatch* my_batch) {
4648
  return WriteImpl(write_options, my_batch, nullptr, nullptr);
A
agiardullo 已提交
4649 4650
}

A
agiardullo 已提交
4651
#ifndef ROCKSDB_LITE
A
agiardullo 已提交
4652 4653 4654
Status DBImpl::WriteWithCallback(const WriteOptions& write_options,
                                 WriteBatch* my_batch,
                                 WriteCallback* callback) {
4655
  return WriteImpl(write_options, my_batch, callback, nullptr);
A
agiardullo 已提交
4656
}
A
agiardullo 已提交
4657
#endif  // ROCKSDB_LITE
A
agiardullo 已提交
4658 4659

Status DBImpl::WriteImpl(const WriteOptions& write_options,
4660 4661 4662
                         WriteBatch* my_batch, WriteCallback* callback,
                         uint64_t* log_used, uint64_t log_ref,
                         bool disable_memtable) {
S
Stanislau Hlebik 已提交
4663 4664
  if (my_batch == nullptr) {
    return Status::Corruption("Batch is nullptr!");
4665
  }
A
agiardullo 已提交
4666 4667

  Status status;
A
agiardullo 已提交
4668

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

L
Lei Jin 已提交
4679
  if (!write_options.disableWAL) {
S
Stanislau Hlebik 已提交
4680 4681 4682
    RecordTick(stats_, WRITE_WITH_WAL);
  }

4683
  StopWatch write_sw(env_, immutable_db_options_.statistics.get(), DB_WRITE);
4684

4685
  write_thread_.JoinBatchGroup(&w);
4686 4687 4688 4689
  if (w.state == WriteThread::STATE_PARALLEL_FOLLOWER) {
    // we are a non-leader in a parallel group
    PERF_TIMER_GUARD(write_memtable_time);

4690 4691 4692 4693 4694
    if (log_used != nullptr) {
      *log_used = w.log_used;
    }

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

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

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

S
Stanislau Hlebik 已提交
4726 4727
  WriteContext context;
  mutex_.Lock();
I
Igor Canadi 已提交
4728 4729 4730 4731 4732

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

S
Stanislau Hlebik 已提交
4733 4734
  RecordTick(stats_, WRITE_DONE_BY_SELF);
  default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_DONE_BY_SELF, 1);
4735

4736 4737 4738 4739
  // 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.
4740 4741 4742
  assert(!single_column_family_mode_ ||
         versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1);

4743
  if (UNLIKELY(!single_column_family_mode_ &&
4744
               total_log_size_ > GetMaxTotalWalSize())) {
4745
    MaybeFlushColumnFamilies();
4746 4747
  }
  if (UNLIKELY(write_buffer_manager_->ShouldFlush())) {
4748 4749 4750 4751 4752
    // 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.
4753 4754
    ROCKS_LOG_INFO(
        immutable_db_options_.info_log,
4755 4756
        "Flushing column family with largest mem table size. Write buffer is "
        "using %" PRIu64 " bytes out of a total of %" PRIu64 ".",
4757 4758
        write_buffer_manager_->memory_usage(),
        write_buffer_manager_->buffer_size());
4759 4760
    // no need to refcount because drop is happening in write thread, so can't
    // happen while we're in the write thread
4761 4762
    ColumnFamilyData* cfd_picked = nullptr;
    SequenceNumber seq_num_for_cf_picked = kMaxSequenceNumber;
4763

4764
    for (auto cfd : *versions_->GetColumnFamilySet()) {
4765 4766 4767
      if (cfd->IsDropped()) {
        continue;
      }
4768
      if (!cfd->mem()->IsEmpty()) {
4769 4770
        // We only consider active mem table, hoping immutable memtable is
        // already in the process of flushing.
4771 4772 4773 4774
        uint64_t seq = cfd->mem()->GetCreationSeq();
        if (cfd_picked == nullptr || seq < seq_num_for_cf_picked) {
          cfd_picked = cfd;
          seq_num_for_cf_picked = seq;
4775 4776 4777
        }
      }
    }
4778 4779
    if (cfd_picked != nullptr) {
      status = SwitchMemtable(cfd_picked, &context);
4780
      if (status.ok()) {
4781 4782
        cfd_picked->imm()->FlushRequested();
        SchedulePendingFlush(cfd_picked);
4783 4784 4785
        MaybeScheduleFlushOrCompaction();
      }
    }
I
Igor Canadi 已提交
4786 4787 4788 4789 4790 4791 4792 4793 4794 4795
  }

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

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

4796 4797
  if (UNLIKELY(status.ok() && (write_controller_.IsStopped() ||
                               write_controller_.NeedsDelay()))) {
4798 4799
    PERF_TIMER_STOP(write_pre_and_post_process_time);
    PERF_TIMER_GUARD(write_delay_time);
S
sdong 已提交
4800 4801 4802 4803
    // 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 已提交
4804
    status = DelayWrite(last_batch_group_size_, write_options);
4805
    PERF_TIMER_START(write_pre_and_post_process_time);
I
Igor Canadi 已提交
4806 4807
  }

D
dgrogan@chromium.org 已提交
4808
  uint64_t last_sequence = versions_->LastSequence();
I
Igor Canadi 已提交
4809
  WriteThread::Writer* last_writer = &w;
4810
  autovector<WriteThread::Writer*> write_group;
4811 4812
  bool need_log_sync = !write_options.disableWAL && write_options.sync;
  bool need_log_dir_sync = need_log_sync && !log_dir_synced_;
A
agiardullo 已提交
4813

M
Maysam Yabandeh 已提交
4814
  bool logs_getting_synced = false;
S
Stanislau Hlebik 已提交
4815
  if (status.ok()) {
4816
    if (need_log_sync) {
4817 4818 4819 4820 4821 4822 4823
      while (logs_.front().getting_synced) {
        log_sync_cv_.Wait();
      }
      for (auto& log : logs_) {
        assert(!log.getting_synced);
        log.getting_synced = true;
      }
M
Maysam Yabandeh 已提交
4824
      logs_getting_synced = true;
4825 4826
    }

4827 4828 4829
    // 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
4830
    // into memtables
A
agiardullo 已提交
4831
  }
S
sdong 已提交
4832
  log::Writer* cur_log_writer = logs_.back().writer;
A
agiardullo 已提交
4833

4834 4835
  mutex_.Unlock();

A
agiardullo 已提交
4836 4837
  // At this point the mutex is unlocked

4838
  bool exit_completed_early = false;
4839 4840
  last_batch_group_size_ =
      write_thread_.EnterAsBatchGroupLeader(&w, &last_writer, &write_group);
4841

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

    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);
4880
    MeasureTime(stats_, BYTES_PER_WRITE, total_byte_size);
4881
    PERF_TIMER_STOP(write_pre_and_post_process_time);
4882

4883
    if (write_options.disableWAL) {
4884
      has_unpersisted_data_.store(true, std::memory_order_relaxed);
4885
    }
4886

4887 4888 4889
    uint64_t log_size = 0;
    if (!write_options.disableWAL) {
      PERF_TIMER_GUARD(write_wal_time);
4890

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

4913 4914 4915 4916 4917
      if (log_used != nullptr) {
        *log_used = logfile_number_;
      }

      WriteBatchInternal::SetSequence(merged_batch, current_sequence);
4918 4919

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

4950 4951 4952 4953 4954 4955
      if (merged_batch == &tmp_batch_) {
        tmp_batch_.Clear();
      }
    }
    if (status.ok()) {
      PERF_TIMER_GUARD(write_memtable_time);
4956

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

4981
      if (!parallel) {
4982
        status = WriteBatchInternal::InsertInto(
4983
            write_group, current_sequence, column_family_memtables_.get(),
4984
            &flush_scheduler_, write_options.ignore_missing_column_families,
S
sdong 已提交
4985
            0 /*log_number*/, this);
4986 4987 4988 4989 4990 4991 4992

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

4993
      } else {
4994
        WriteThread::ParallelGroup pg;
4995 4996
        pg.leader = &w;
        pg.last_writer = last_writer;
4997
        pg.last_sequence = last_sequence;
4998
        pg.early_exit_allowed = !need_log_sync;
4999
        pg.running.store(static_cast<uint32_t>(write_group.size()),
5000
                         std::memory_order_relaxed);
5001 5002
        write_thread_.LaunchParallelFollowers(&pg, current_sequence);

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

5015 5016 5017
        // CompleteParallelWorker returns true if this thread should
        // handle exit, false means somebody else did
        exit_completed_early = !write_thread_.CompleteParallelWorker(&w);
5018
        status = w.FinalStatus();
5019
      }
A
agiardullo 已提交
5020

5021
      if (!exit_completed_early && w.status.ok()) {
5022 5023
        versions_->SetLastSequence(last_sequence);
        if (!need_log_sync) {
5024
          write_thread_.ExitAsBatchGroupLeader(&w, last_writer, w.status);
5025
          exit_completed_early = true;
5026
        }
5027
      }
5028 5029 5030 5031 5032 5033 5034 5035 5036

      // 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.
5037
      if (!status.ok() && bg_error_.ok() && !w.CallbackFailed()) {
5038
        bg_error_ = status;
5039
      }
5040
    }
5041
  }
5042
  PERF_TIMER_START(write_pre_and_post_process_time);
A
agiardullo 已提交
5043

5044
  if (immutable_db_options_.paranoid_checks && !status.ok() &&
M
Maysam Yabandeh 已提交
5045
      !w.CallbackFailed() && !status.IsBusy() && !status.IsIncomplete()) {
5046 5047 5048 5049 5050
    mutex_.Lock();
    if (bg_error_.ok()) {
      bg_error_ = status;  // stop compaction & fail any further writes
    }
    mutex_.Unlock();
I
Igor Canadi 已提交
5051
  }
5052

M
Maysam Yabandeh 已提交
5053
  if (logs_getting_synced) {
5054
    mutex_.Lock();
5055
    MarkLogsSynced(logfile_number_, need_log_dir_sync, status);
5056
    mutex_.Unlock();
5057 5058
  }

5059
  if (!exit_completed_early) {
5060
    write_thread_.ExitAsBatchGroupLeader(&w, last_writer, w.status);
5061
  }
5062

J
jorlow@chromium.org 已提交
5063 5064 5065
  return status;
}

5066
void DBImpl::MaybeFlushColumnFamilies() {
5067 5068 5069 5070 5071 5072
  mutex_.AssertHeld();

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

5073 5074 5075 5076 5077 5078
  auto oldest_alive_log = alive_log_files_.begin()->number;
  auto oldest_log_with_uncommited_prep = FindMinLogContainingOutstandingPrep();

  if (allow_2pc() &&
      oldest_log_with_uncommited_prep > 0 &&
      oldest_log_with_uncommited_prep <= oldest_alive_log) {
5079 5080 5081 5082 5083 5084 5085
    if (unable_to_flush_oldest_log_) {
        // we already attempted to flush all column families dependent on
        // the oldest alive log but the log still contained uncommited transactions.
        // the oldest alive log STILL contains uncommited transaction so there
        // is still nothing that we can do.
        return;
    } else {
5086 5087
      ROCKS_LOG_WARN(
          immutable_db_options_.info_log,
5088 5089 5090 5091 5092 5093 5094 5095 5096
          "Unable to release oldest log due to uncommited transaction");
      unable_to_flush_oldest_log_ = true;
    }
  } else {
    // we only mark this log as getting flushed if we have successfully
    // flushed all data in this log. If this log contains outstanding prepared
    // transactions then we cannot flush this log until those transactions are commited.
    unable_to_flush_oldest_log_ = false;
    alive_log_files_.begin()->getting_flushed = true;
5097 5098 5099 5100
  }

  WriteContext context;

5101 5102 5103 5104 5105
  ROCKS_LOG_INFO(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,
                 oldest_alive_log, total_log_size_, GetMaxTotalWalSize());
5106 5107 5108 5109 5110 5111
  // 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;
    }
5112
    if (cfd->OldestLogToKeep() <= oldest_alive_log) {
5113 5114 5115 5116 5117 5118 5119 5120 5121
      auto status = SwitchMemtable(cfd, &context);
      if (!status.ok()) {
        break;
      }
      cfd->imm()->FlushRequested();
      SchedulePendingFlush(cfd);
    }
  }
  MaybeScheduleFlushOrCompaction();
5122

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);
5140
    uint64_t delay = write_controller_.GetDelay(env_, num_bytes);
S
sdong 已提交
5141
    if (delay > 0) {
M
Maysam Yabandeh 已提交
5142 5143 5144
      if (write_options.no_slowdown) {
        return Status::Incomplete();
      }
S
sdong 已提交
5145
      TEST_SYNC_POINT("DBImpl::DelayWrite:Sleep");
5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161

      mutex_.Unlock();
      // We will delay the write until we have slept for delay ms or
      // we don't need a delay anymore
      const uint64_t kDelayInterval = 1000;
      uint64_t stall_end = sw.start_time() + delay;
      while (write_controller_.NeedsDelay()) {
        if (env_->NowMicros() >= stall_end) {
          // We already delayed this write `delay` microseconds
          break;
        }

        delayed = true;
        // Sleep for 0.001 seconds
        env_->SleepForMicroseconds(kDelayInterval);
      }
S
sdong 已提交
5162
      mutex_.Lock();
5163

S
sdong 已提交
5164
    }
5165

5166
    while (bg_error_.ok() && write_controller_.IsStopped()) {
M
Maysam Yabandeh 已提交
5167 5168 5169
      if (write_options.no_slowdown) {
        return Status::Incomplete();
      }
S
sdong 已提交
5170
      delayed = true;
5171 5172
      TEST_SYNC_POINT("DBImpl::DelayWrite:Wait");
      bg_cv_.Wait();
5173 5174
    }
  }
M
Maysam Yabandeh 已提交
5175
  assert(!delayed || !write_options.no_slowdown);
S
sdong 已提交
5176 5177 5178 5179 5180
  if (delayed) {
    default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_STALL_MICROS,
                                           time_delayed);
    RecordTick(stats_, STALL_MICROS, time_delayed);
  }
I
Igor Canadi 已提交
5181 5182

  return bg_error_;
5183 5184
}

I
Igor Canadi 已提交
5185 5186
Status DBImpl::ScheduleFlushes(WriteContext* context) {
  ColumnFamilyData* cfd;
5187
  while ((cfd = flush_scheduler_.TakeNextColumnFamily()) != nullptr) {
I
Igor Canadi 已提交
5188
    auto status = SwitchMemtable(cfd, context);
I
Igor Canadi 已提交
5189 5190 5191 5192 5193
    if (cfd->Unref()) {
      delete cfd;
    }
    if (!status.ok()) {
      return status;
S
Stanislau Hlebik 已提交
5194 5195
    }
  }
I
Igor Canadi 已提交
5196
  return Status::OK();
S
Stanislau Hlebik 已提交
5197 5198
}

5199 5200 5201
#ifndef ROCKSDB_LITE
void DBImpl::NotifyOnMemTableSealed(ColumnFamilyData* cfd,
                                    const MemTableInfo& mem_table_info) {
5202
  if (immutable_db_options_.listeners.size() == 0U) {
5203 5204 5205 5206 5207 5208
    return;
  }
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }

5209
  for (auto listener : immutable_db_options_.listeners) {
5210
    listener->OnMemTableSealed(mem_table_info);
5211
  }
5212 5213 5214
}
#endif  // ROCKSDB_LITE

S
Stanislau Hlebik 已提交
5215 5216
// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
I
Igor Canadi 已提交
5217
Status DBImpl::SwitchMemtable(ColumnFamilyData* cfd, WriteContext* context) {
S
Stanislau Hlebik 已提交
5218 5219 5220 5221 5222 5223 5224
  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.
5225
  assert(versions_->prev_log_number() == 0);
S
Stanislau Hlebik 已提交
5226
  bool creating_new_log = !log_empty_;
S
Sage Weil 已提交
5227
  uint64_t recycle_log_number = 0;
5228
  if (creating_new_log && immutable_db_options_.recycle_log_file_num &&
S
Sage Weil 已提交
5229 5230 5231 5232
      !log_recycle_files.empty()) {
    recycle_log_number = log_recycle_files.front();
    log_recycle_files.pop_front();
  }
S
Stanislau Hlebik 已提交
5233 5234 5235
  uint64_t new_log_number =
      creating_new_log ? versions_->NewFileNumber() : logfile_number_;
  SuperVersion* new_superversion = nullptr;
5236
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
5237 5238 5239 5240 5241 5242 5243 5244 5245 5246

  // 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
5247 5248 5249
  // 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();
5250 5251
  DBOptions db_options =
      BuildDBOptions(immutable_db_options_, mutable_db_options_);
5252 5253
  const auto preallocate_block_size =
    GetWalPreallocateBlockSize(mutable_cf_options.write_buffer_size);
S
Stanislau Hlebik 已提交
5254 5255 5256 5257
  mutex_.Unlock();
  Status s;
  {
    if (creating_new_log) {
5258
      EnvOptions opt_env_opt =
5259
          env_->OptimizeForLogWrite(env_options_, db_options);
S
Sage Weil 已提交
5260
      if (recycle_log_number) {
5261 5262 5263
        ROCKS_LOG_INFO(immutable_db_options_.info_log,
                       "reusing log %" PRIu64 " from recycle list\n",
                       recycle_log_number);
S
Sage Weil 已提交
5264
        s = env_->ReuseWritableFile(
5265 5266 5267
            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 已提交
5268
      } else {
5269 5270 5271
        s = NewWritableFile(
            env_, LogFileName(immutable_db_options_.wal_dir, new_log_number),
            &lfile, opt_env_opt);
S
Sage Weil 已提交
5272
      }
S
Stanislau Hlebik 已提交
5273 5274 5275
      if (s.ok()) {
        // Our final size should be less than write_buffer_size
        // (compression, etc) but err on the side of caution.
5276 5277 5278 5279

        // use preallocate_block_size instead
        // of calling GetWalPreallocateBlockSize()
        lfile->SetPreallocationBlockSize(preallocate_block_size);
5280 5281
        unique_ptr<WritableFileWriter> file_writer(
            new WritableFileWriter(std::move(lfile), opt_env_opt));
5282 5283 5284
        new_log =
            new log::Writer(std::move(file_writer), new_log_number,
                            immutable_db_options_.recycle_log_file_num > 0);
I
Igor Canadi 已提交
5285
      }
S
Stanislau Hlebik 已提交
5286 5287 5288
    }

    if (s.ok()) {
A
agiardullo 已提交
5289 5290
      SequenceNumber seq = versions_->LastSequence();
      new_mem = cfd->ConstructNewMemtable(mutable_cf_options, seq);
S
Stanislau Hlebik 已提交
5291 5292
      new_superversion = new SuperVersion();
    }
5293 5294 5295 5296 5297 5298 5299

#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 已提交
5300
  }
5301 5302 5303 5304
  ROCKS_LOG_INFO(immutable_db_options_.info_log,
                 "[%s] New memtable created with log file: #%" PRIu64
                 ". Immutable memtables: %d.\n",
                 cfd->GetName().c_str(), new_log_number, num_imm_unflushed);
S
Stanislau Hlebik 已提交
5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316
  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;
5317
    log_dir_synced_ = false;
5318
    logs_.emplace_back(logfile_number_, new_log);
S
Stanislau Hlebik 已提交
5319
    alive_log_files_.push_back(LogFileNumberSize(logfile_number_));
5320 5321 5322 5323 5324 5325 5326 5327 5328
  }
  for (auto loop_cfd : *versions_->GetColumnFamilySet()) {
    // 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
    if (loop_cfd->mem()->GetFirstSequenceNumber() == 0 &&
        loop_cfd->imm()->NumNotFlushed() == 0) {
      if (creating_new_log) {
I
Igor Canadi 已提交
5329
        loop_cfd->SetLogNumber(logfile_number_);
5330
      }
5331
      loop_cfd->mem()->SetCreationSeq(versions_->LastSequence());
5332 5333
    }
  }
5334

S
Stanislau Hlebik 已提交
5335
  cfd->mem()->SetNextLogNumber(logfile_number_);
5336
  cfd->imm()->Add(cfd->mem(), &context->memtables_to_free_);
S
Stanislau Hlebik 已提交
5337 5338
  new_mem->Ref();
  cfd->SetMemtable(new_mem);
I
Igor Canadi 已提交
5339 5340
  context->superversions_to_free_.push_back(InstallSuperVersionAndScheduleWork(
      cfd, new_superversion, mutable_cf_options));
5341 5342 5343
  return s;
}

I
Igor Canadi 已提交
5344
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
5345 5346 5347 5348 5349
Status DBImpl::GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                        TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

5350 5351
  // Increment the ref count
  mutex_.Lock();
I
Igor Canadi 已提交
5352
  auto version = cfd->current();
5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfAllTables(props);

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

  return s;
}
5365 5366

Status DBImpl::GetPropertiesOfTablesInRange(ColumnFamilyHandle* column_family,
5367
                                            const Range* range, std::size_t n,
5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387
                                            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 已提交
5388
#endif  // ROCKSDB_LITE
5389

I
Igor Canadi 已提交
5390 5391 5392 5393
const std::string& DBImpl::GetName() const {
  return dbname_;
}

5394 5395 5396 5397
Env* DBImpl::GetEnv() const {
  return env_;
}

5398 5399
Options DBImpl::GetOptions(ColumnFamilyHandle* column_family) const {
  InstrumentedMutexLock l(&mutex_);
5400
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
5401 5402
  return Options(BuildDBOptions(immutable_db_options_, mutable_db_options_),
                 cfh->cfd()->GetLatestCFOptions());
I
Igor Canadi 已提交
5403 5404
}

5405 5406 5407 5408
DBOptions DBImpl::GetDBOptions() const {
  InstrumentedMutexLock l(&mutex_);
  return BuildDBOptions(immutable_db_options_, mutable_db_options_);
}
5409

5410
bool DBImpl::GetProperty(ColumnFamilyHandle* column_family,
5411
                         const Slice& property, std::string* value) {
5412
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
5413
  value->clear();
5414
  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
5415 5416 5417
  if (property_info == nullptr) {
    return false;
  } else if (property_info->handle_int) {
5418
    uint64_t int_value;
5419 5420
    bool ret_value =
        GetIntPropertyInternal(cfd, *property_info, false, &int_value);
5421
    if (ret_value) {
5422
      *value = ToString(int_value);
5423 5424
    }
    return ret_value;
5425
  } else if (property_info->handle_string) {
5426
    InstrumentedMutexLock l(&mutex_);
5427
    return cfd->internal_stats()->GetStringProperty(*property_info, property,
5428 5429
                                                    value);
  }
5430 5431 5432 5433
  // 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 已提交
5434 5435
}

5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453
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;
}

5454 5455
bool DBImpl::GetIntProperty(ColumnFamilyHandle* column_family,
                            const Slice& property, uint64_t* value) {
5456 5457
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
  if (property_info == nullptr || property_info->handle_int == nullptr) {
5458 5459
    return false;
  }
5460
  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
5461
  return GetIntPropertyInternal(cfd, *property_info, false, value);
5462 5463
}

5464
bool DBImpl::GetIntPropertyInternal(ColumnFamilyData* cfd,
5465 5466 5467 5468
                                    const DBPropertyInfo& property_info,
                                    bool is_locked, uint64_t* value) {
  assert(property_info.handle_int != nullptr);
  if (!property_info.need_out_of_mutex) {
5469 5470
    if (is_locked) {
      mutex_.AssertHeld();
5471
      return cfd->internal_stats()->GetIntProperty(property_info, value, this);
5472 5473
    } else {
      InstrumentedMutexLock l(&mutex_);
5474
      return cfd->internal_stats()->GetIntProperty(property_info, value, this);
5475
    }
5476
  } else {
5477 5478 5479 5480 5481 5482
    SuperVersion* sv = nullptr;
    if (!is_locked) {
      sv = GetAndRefSuperVersion(cfd);
    } else {
      sv = cfd->GetSuperVersion();
    }
5483 5484

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

5487 5488 5489
    if (!is_locked) {
      ReturnAndCleanupSuperVersion(cfd, sv);
    }
5490 5491 5492 5493 5494

    return ret;
  }
}

5495 5496
bool DBImpl::GetAggregatedIntProperty(const Slice& property,
                                      uint64_t* aggregated_value) {
5497 5498
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
  if (property_info == nullptr || property_info->handle_int == nullptr) {
5499 5500 5501 5502 5503 5504 5505 5506 5507
    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()) {
5508
      if (GetIntPropertyInternal(cfd, *property_info, true, &value)) {
5509 5510 5511 5512 5513 5514 5515 5516 5517 5518
        sum += value;
      } else {
        return false;
      }
    }
  }
  *aggregated_value = sum;
  return true;
}

5519 5520
SuperVersion* DBImpl::GetAndRefSuperVersion(ColumnFamilyData* cfd) {
  // TODO(ljin): consider using GetReferencedSuperVersion() directly
I
Igor Canadi 已提交
5521
  return cfd->GetThreadLocalSuperVersion(&mutex_);
5522 5523
}

A
agiardullo 已提交
5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535
// 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);
}

5536 5537
void DBImpl::ReturnAndCleanupSuperVersion(ColumnFamilyData* cfd,
                                          SuperVersion* sv) {
I
Igor Canadi 已提交
5538
  bool unref_sv = !cfd->ReturnThreadLocalSuperVersion(sv);
5539 5540 5541 5542 5543

  if (unref_sv) {
    // Release SuperVersion
    if (sv->Unref()) {
      {
5544
        InstrumentedMutexLock l(&mutex_);
5545 5546 5547 5548 5549 5550 5551
        sv->Cleanup();
      }
      delete sv;
      RecordTick(stats_, NUMBER_SUPERVERSION_CLEANUPS);
    }
    RecordTick(stats_, NUMBER_SUPERVERSION_RELEASES);
  }
5552 5553
}

A
agiardullo 已提交
5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577
// 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();
}

5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599
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);
}

5600
void DBImpl::GetApproximateSizes(ColumnFamilyHandle* column_family,
5601
                                 const Range* range, int n, uint64_t* sizes,
5602 5603 5604
                                 uint8_t include_flags) {
  assert(include_flags & DB::SizeApproximationFlags::INCLUDE_FILES ||
         include_flags & DB::SizeApproximationFlags::INCLUDE_MEMTABLES);
J
jorlow@chromium.org 已提交
5605
  Version* v;
5606 5607
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
5608 5609
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
  v = sv->current;
J
jorlow@chromium.org 已提交
5610 5611 5612

  for (int i = 0; i < n; i++) {
    // Convert user_key into a corresponding internal key.
5613 5614
    InternalKey k1(range[i].start, kMaxSequenceNumber, kValueTypeForSeek);
    InternalKey k2(range[i].limit, kMaxSequenceNumber, kValueTypeForSeek);
V
Vitaliy Liptchinsky 已提交
5615
    sizes[i] = 0;
5616
    if (include_flags & DB::SizeApproximationFlags::INCLUDE_FILES) {
V
Vitaliy Liptchinsky 已提交
5617
      sizes[i] += versions_->ApproximateSize(v, k1.Encode(), k2.Encode());
5618 5619
    }
    if (include_flags & DB::SizeApproximationFlags::INCLUDE_MEMTABLES) {
5620 5621
      sizes[i] += sv->mem->ApproximateStats(k1.Encode(), k2.Encode()).size;
      sizes[i] += sv->imm->ApproximateStats(k1.Encode(), k2.Encode()).size;
5622
    }
J
jorlow@chromium.org 已提交
5623 5624
  }

5625
  ReturnAndCleanupSuperVersion(cfd, sv);
J
jorlow@chromium.org 已提交
5626 5627
}

I
Igor Canadi 已提交
5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643
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 已提交
5644 5645 5646 5647 5648
#ifndef ROCKSDB_LITE
Status DBImpl::GetUpdatesSince(
    SequenceNumber seq, unique_ptr<TransactionLogIterator>* iter,
    const TransactionLogIterator::ReadOptions& read_options) {

L
Lei Jin 已提交
5649
  RecordTick(stats_, GET_UPDATES_SINCE_CALLS);
I
Igor Canadi 已提交
5650 5651 5652
  if (seq > versions_->LastSequence()) {
    return Status::NotFound("Requested sequence not yet written in the db");
  }
I
Igor Canadi 已提交
5653
  return wal_manager_.GetUpdatesSince(seq, iter, read_options, versions_.get());
I
Igor Canadi 已提交
5654 5655
}

5656 5657 5658
Status DBImpl::DeleteFile(std::string name) {
  uint64_t number;
  FileType type;
5659 5660 5661
  WalFileType log_type;
  if (!ParseFileName(name, &number, &type, &log_type) ||
      (type != kTableFile && type != kLogFile)) {
5662 5663
    ROCKS_LOG_ERROR(immutable_db_options_.info_log, "DeleteFile %s failed.\n",
                    name.c_str());
5664 5665 5666
    return Status::InvalidArgument("Invalid file name");
  }

5667 5668 5669 5670
  Status status;
  if (type == kLogFile) {
    // Only allow deleting archived log files
    if (log_type != kArchivedLogFile) {
5671 5672 5673
      ROCKS_LOG_ERROR(immutable_db_options_.info_log,
                      "DeleteFile %s failed - not archived log.\n",
                      name.c_str());
5674 5675
      return Status::NotSupported("Delete only supported for archived logs");
    }
5676 5677
    status =
        env_->DeleteFile(immutable_db_options_.wal_dir + "/" + name.c_str());
5678
    if (!status.ok()) {
5679 5680 5681
      ROCKS_LOG_ERROR(immutable_db_options_.info_log,
                      "DeleteFile %s failed -- %s.\n", name.c_str(),
                      status.ToString().c_str());
5682 5683 5684 5685
    }
    return status;
  }

5686
  int level;
I
Igor Canadi 已提交
5687
  FileMetaData* metadata;
5688
  ColumnFamilyData* cfd;
5689
  VersionEdit edit;
5690
  JobContext job_context(next_job_id_.fetch_add(1), true);
D
Dhruba Borthakur 已提交
5691
  {
5692
    InstrumentedMutexLock l(&mutex_);
5693
    status = versions_->GetMetadataForFile(number, &level, &metadata, &cfd);
D
Dhruba Borthakur 已提交
5694
    if (!status.ok()) {
5695 5696
      ROCKS_LOG_WARN(immutable_db_options_.info_log,
                     "DeleteFile %s failed. File not found\n", name.c_str());
I
Igor Canadi 已提交
5697
      job_context.Clean();
D
Dhruba Borthakur 已提交
5698 5699
      return Status::InvalidArgument("File not found");
    }
5700
    assert(level < cfd->NumberLevels());
5701

D
Dhruba Borthakur 已提交
5702
    // If the file is being compacted no need to delete.
5703
    if (metadata->being_compacted) {
5704 5705 5706
      ROCKS_LOG_INFO(immutable_db_options_.info_log,
                     "DeleteFile %s Skipped. File about to be compacted\n",
                     name.c_str());
I
Igor Canadi 已提交
5707
      job_context.Clean();
D
Dhruba Borthakur 已提交
5708
      return Status::OK();
5709 5710
    }

D
Dhruba Borthakur 已提交
5711 5712 5713
    // 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 已提交
5714
    auto* vstoreage = cfd->current()->storage_info();
I
Igor Canadi 已提交
5715
    for (int i = level + 1; i < cfd->NumberLevels(); i++) {
S
sdong 已提交
5716
      if (vstoreage->NumLevelFiles(i) != 0) {
5717 5718 5719
        ROCKS_LOG_WARN(immutable_db_options_.info_log,
                       "DeleteFile %s FAILED. File not in last level\n",
                       name.c_str());
I
Igor Canadi 已提交
5720
        job_context.Clean();
D
Dhruba Borthakur 已提交
5721 5722 5723
        return Status::InvalidArgument("File not in last level");
      }
    }
5724
    // if level == 0, it has to be the oldest file
S
sdong 已提交
5725 5726
    if (level == 0 &&
        vstoreage->LevelFiles(0).back()->fd.GetNumber() != number) {
5727 5728 5729 5730
      ROCKS_LOG_WARN(immutable_db_options_.info_log,
                     "DeleteFile %s failed ---"
                     " target file in level 0 must be the oldest.",
                     name.c_str());
I
Igor Canadi 已提交
5731
      job_context.Clean();
5732 5733 5734
      return Status::InvalidArgument("File in level 0, but not oldest");
    }
    edit.SetColumnFamily(cfd->GetID());
D
Dhruba Borthakur 已提交
5735
    edit.DeleteFile(level, number);
5736
    status = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
5737
                                    &edit, &mutex_, directories_.GetDbDir());
I
Igor Canadi 已提交
5738
    if (status.ok()) {
I
Igor Canadi 已提交
5739 5740
      InstallSuperVersionAndScheduleWorkWrapper(
          cfd, &job_context, *cfd->GetLatestMutableCFOptions());
I
Igor Canadi 已提交
5741
    }
I
Igor Canadi 已提交
5742 5743
    FindObsoleteFiles(&job_context, false);
  }  // lock released here
5744

5745
  LogFlush(immutable_db_options_.info_log);
5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760
  // 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;
5761
  std::vector<FileMetaData*> deleted_files;
5762 5763 5764
  JobContext job_context(next_job_id_.fetch_add(1), true);
  {
    InstrumentedMutexLock l(&mutex_);
5765
    Version* input_version = cfd->current();
5766

5767 5768
    auto* vstorage = input_version->storage_info();
    for (int i = 1; i < cfd->NumberLevels(); i++) {
5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789
      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);
5790 5791 5792
      FileMetaData* level_file;
      for (uint32_t j = 0; j < level_files.size(); j++) {
        level_file = level_files[j];
5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803
        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());
5804 5805
          deleted_files.push_back(level_file);
          level_file->being_compacted = true;
5806 5807 5808 5809
        }
      }
    }
    if (edit.GetDeletedFiles().empty()) {
5810
      job_context.Clean();
5811 5812
      return Status::OK();
    }
5813
    input_version->Ref();
5814 5815 5816 5817 5818 5819
    status = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                    &edit, &mutex_, directories_.GetDbDir());
    if (status.ok()) {
      InstallSuperVersionAndScheduleWorkWrapper(
          cfd, &job_context, *cfd->GetLatestMutableCFOptions());
    }
5820 5821 5822 5823
    for (auto* deleted_file : deleted_files) {
      deleted_file->being_compacted = false;
    }
    input_version->Unref();
5824 5825 5826
    FindObsoleteFiles(&job_context, false);
  }  // lock released here

5827
  LogFlush(immutable_db_options_.info_log);
I
Igor Canadi 已提交
5828
  // remove files outside the db-lock
I
Igor Canadi 已提交
5829
  if (job_context.HaveSomethingToDelete()) {
5830
    // Call PurgeObsoleteFiles() without holding mutex.
I
Igor Canadi 已提交
5831
    PurgeObsoleteFiles(job_context);
5832
  }
I
Igor Canadi 已提交
5833
  job_context.Clean();
5834 5835 5836
  return status;
}

5837
void DBImpl::GetLiveFilesMetaData(std::vector<LiveFileMetaData>* metadata) {
5838
  InstrumentedMutexLock l(&mutex_);
5839
  versions_->GetLiveFilesMetaData(metadata);
5840
}
5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851

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 已提交
5852
#endif  // ROCKSDB_LITE
5853

I
Igor Canadi 已提交
5854 5855 5856 5857 5858 5859 5860
Status DBImpl::CheckConsistency() {
  mutex_.AssertHeld();
  std::vector<LiveFileMetaData> metadata;
  versions_->GetLiveFilesMetaData(&metadata);

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

I
Igor Canadi 已提交
5864 5865
    uint64_t fsize = 0;
    Status s = env_->GetFileSize(file_path, &fsize);
D
dyniusz 已提交
5866 5867 5868 5869
    if (!s.ok() &&
        env_->GetFileSize(Rocks2LevelTableFileName(file_path), &fsize).ok()) {
      s = Status::OK();
    }
I
Igor Canadi 已提交
5870 5871 5872 5873
    if (!s.ok()) {
      corruption_messages +=
          "Can't access " + md.name + ": " + s.ToString() + "\n";
    } else if (fsize != md.size) {
5874
      corruption_messages += "Sst file size mismatch: " + file_path +
I
Igor Canadi 已提交
5875
                             ". Size recorded in manifest " +
5876 5877
                             ToString(md.size) + ", actual size " +
                             ToString(fsize) + "\n";
I
Igor Canadi 已提交
5878 5879 5880 5881 5882 5883 5884 5885 5886
    }
  }
  if (corruption_messages.size() == 0) {
    return Status::OK();
  } else {
    return Status::Corruption(corruption_messages);
  }
}

5887
Status DBImpl::GetDbIdentity(std::string& identity) const {
5888 5889
  std::string idfilename = IdentityFileName(dbname_);
  const EnvOptions soptions;
5890 5891 5892 5893 5894 5895 5896 5897 5898
  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)));
5899
  }
5900

5901 5902 5903 5904 5905
  uint64_t file_size;
  s = env_->GetFileSize(idfilename, &file_size);
  if (!s.ok()) {
    return s;
  }
D
Dmitri Smirnov 已提交
5906
  char* buffer = reinterpret_cast<char*>(alloca(file_size));
5907
  Slice id;
5908
  s = id_file_reader->Read(static_cast<size_t>(file_size), &id, buffer);
5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919
  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 已提交
5920 5921
// Default implementations of convenience methods that subclasses of DB
// can call if they wish
5922
Status DB::Put(const WriteOptions& opt, ColumnFamilyHandle* column_family,
5923
               const Slice& key, const Slice& value) {
5924 5925 5926 5927
  // 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);
5928
  batch.Put(column_family, key, value);
J
jorlow@chromium.org 已提交
5929 5930 5931
  return Write(opt, &batch);
}

5932 5933
Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
J
jorlow@chromium.org 已提交
5934
  WriteBatch batch;
5935
  batch.Delete(column_family, key);
J
jorlow@chromium.org 已提交
5936 5937 5938
  return Write(opt, &batch);
}

A
Andres Noetzli 已提交
5939 5940 5941 5942 5943 5944 5945
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 已提交
5946 5947 5948 5949 5950 5951 5952 5953
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);
}

5954 5955
Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
5956
  WriteBatch batch;
5957
  batch.Merge(column_family, key, value);
5958 5959 5960
  return Write(opt, &batch);
}

5961
// Default implementation -- returns not supported status
L
Lei Jin 已提交
5962
Status DB::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
5963
                              const std::string& column_family_name,
5964
                              ColumnFamilyHandle** handle) {
5965
  return Status::NotSupported("");
5966
}
5967
Status DB::DropColumnFamily(ColumnFamilyHandle* column_family) {
5968
  return Status::NotSupported("");
5969
}
5970 5971 5972 5973
Status DB::DestroyColumnFamilyHandle(ColumnFamilyHandle* column_family) {
  delete column_family;
  return Status::OK();
}
5974

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

J
Jim Paton 已提交
5977
Status DB::Open(const Options& options, const std::string& dbname, DB** dbptr) {
5978 5979 5980 5981
  DBOptions db_options(options);
  ColumnFamilyOptions cf_options(options);
  std::vector<ColumnFamilyDescriptor> column_families;
  column_families.push_back(
5982
      ColumnFamilyDescriptor(kDefaultColumnFamilyName, cf_options));
5983
  std::vector<ColumnFamilyHandle*> handles;
5984
  Status s = DB::Open(db_options, dbname, column_families, &handles, dbptr);
5985 5986 5987 5988 5989 5990 5991
  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;
5992 5993
}

5994 5995
Status DB::Open(const DBOptions& db_options, const std::string& dbname,
                const std::vector<ColumnFamilyDescriptor>& column_families,
5996
                std::vector<ColumnFamilyHandle*>* handles, DB** dbptr) {
5997
  Status s = SanitizeOptionsByTable(db_options, column_families);
5998 5999 6000
  if (!s.ok()) {
    return s;
  }
6001

6002 6003 6004
  s = ValidateOptions(db_options, column_families);
  if (!s.ok()) {
    return s;
6005 6006
  }

6007
  *dbptr = nullptr;
6008
  handles->clear();
J
jorlow@chromium.org 已提交
6009

I
Igor Canadi 已提交
6010 6011 6012 6013
  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);
6014
  }
6015

I
Igor Canadi 已提交
6016
  DBImpl* impl = new DBImpl(db_options, dbname);
6017
  s = impl->env_->CreateDirIfMissing(impl->immutable_db_options_.wal_dir);
6018
  if (s.ok()) {
6019
    for (auto db_path : impl->immutable_db_options_.db_paths) {
6020
      s = impl->env_->CreateDirIfMissing(db_path.path);
6021 6022 6023 6024 6025 6026
      if (!s.ok()) {
        break;
      }
    }
  }

6027 6028 6029 6030 6031 6032
  if (!s.ok()) {
    delete impl;
    return s;
  }

  s = impl->CreateArchivalDirectory();
6033 6034 6035 6036
  if (!s.ok()) {
    delete impl;
    return s;
  }
J
jorlow@chromium.org 已提交
6037
  impl->mutex_.Lock();
6038 6039
  // Handles create_if_missing, error_if_exists
  s = impl->Recover(column_families);
J
jorlow@chromium.org 已提交
6040
  if (s.ok()) {
6041
    uint64_t new_log_number = impl->versions_->NewFileNumber();
6042
    unique_ptr<WritableFile> lfile;
6043
    EnvOptions soptions(db_options);
6044
    EnvOptions opt_env_options =
6045 6046 6047 6048 6049 6050 6051
        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 已提交
6052
    if (s.ok()) {
6053 6054
      lfile->SetPreallocationBlockSize(
          impl->GetWalPreallocateBlockSize(max_write_buffer_size));
6055
      impl->logfile_number_ = new_log_number;
6056 6057
      unique_ptr<WritableFileWriter> file_writer(
          new WritableFileWriter(std::move(lfile), opt_env_options));
6058 6059
      impl->logs_.emplace_back(
          new_log_number,
6060 6061 6062
          new log::Writer(
              std::move(file_writer), new_log_number,
              impl->immutable_db_options_.recycle_log_file_num > 0));
I
Igor Canadi 已提交
6063

6064 6065
      // set column family handles
      for (auto cf : column_families) {
I
Igor Canadi 已提交
6066 6067
        auto cfd =
            impl->versions_->GetColumnFamilySet()->GetColumnFamily(cf.name);
I
Igor Canadi 已提交
6068 6069 6070
        if (cfd != nullptr) {
          handles->push_back(
              new ColumnFamilyHandleImpl(cfd, impl, &impl->mutex_));
6071
          impl->NewThreadStatusCfInfo(cfd);
I
Igor Canadi 已提交
6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087
        } 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 已提交
6088
        }
6089
      }
I
Igor Canadi 已提交
6090 6091
    }
    if (s.ok()) {
6092
      for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
6093
        delete impl->InstallSuperVersionAndScheduleWork(
L
Lei Jin 已提交
6094
            cfd, nullptr, *cfd->GetLatestMutableCFOptions());
6095
      }
I
Igor Canadi 已提交
6096 6097
      impl->alive_log_files_.push_back(
          DBImpl::LogFileNumberSize(impl->logfile_number_));
J
jorlow@chromium.org 已提交
6098
      impl->DeleteObsoleteFiles();
6099
      s = impl->directories_.GetDbDir()->Fsync();
J
jorlow@chromium.org 已提交
6100 6101
    }
  }
6102

I
Igor Canadi 已提交
6103 6104
  if (s.ok()) {
    for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
S
sdong 已提交
6105
      if (cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
S
sdong 已提交
6106
        auto* vstorage = cfd->current()->storage_info();
6107
        for (int i = 1; i < vstorage->num_levels(); ++i) {
S
sdong 已提交
6108
          int num_files = vstorage->NumLevelFiles(i);
I
Igor Canadi 已提交
6109
          if (num_files > 0) {
I
Igor Canadi 已提交
6110 6111
            s = Status::InvalidArgument(
                "Not all files are at level 0. Cannot "
S
sdong 已提交
6112
                "open with FIFO compaction style.");
I
Igor Canadi 已提交
6113 6114 6115 6116
            break;
          }
        }
      }
S
sdong 已提交
6117 6118 6119
      if (!cfd->mem()->IsSnapshotSupported()) {
        impl->is_snapshot_supported_ = false;
      }
6120
      if (cfd->ioptions()->merge_operator != nullptr &&
6121 6122 6123 6124 6125
          !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 已提交
6126
      if (!s.ok()) {
6127 6128 6129 6130
        break;
      }
    }
  }
6131
  TEST_SYNC_POINT("DBImpl::Open:Opened");
6132
  Status persist_options_status;
6133
  if (s.ok()) {
6134 6135 6136 6137
    // Persist RocksDB Options before scheduling the compaction.
    // The WriteOptionsFile() will release and lock the mutex internally.
    persist_options_status = impl->WriteOptionsFile();

6138
    *dbptr = impl;
6139 6140 6141
    impl->opened_successfully_ = true;
    impl->MaybeScheduleFlushOrCompaction();
  }
6142 6143
  impl->mutex_.Unlock();

6144
#ifndef ROCKSDB_LITE
6145
  auto sfm = static_cast<SstFileManagerImpl*>(
6146
      impl->immutable_db_options_.sst_file_manager.get());
6147 6148 6149
  if (s.ok() && sfm) {
    // Notify SstFileManager about all sst files that already exist in
    // db_paths[0] when the DB is opened.
6150
    auto& db_path = impl->immutable_db_options_.db_paths[0];
6151
    std::vector<std::string> existing_files;
6152
    impl->immutable_db_options_.env->GetChildren(db_path.path, &existing_files);
6153 6154 6155 6156 6157 6158 6159 6160 6161 6162
    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);
      }
    }
  }
6163
#endif  // !ROCKSDB_LITE
6164

J
jorlow@chromium.org 已提交
6165
  if (s.ok()) {
6166
    ROCKS_LOG_INFO(impl->immutable_db_options_.info_log, "DB pointer %p", impl);
6167
    LogFlush(impl->immutable_db_options_.info_log);
6168 6169 6170 6171 6172 6173
    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());
      }
6174 6175 6176
      ROCKS_LOG_WARN(impl->immutable_db_options_.info_log,
                     "Unable to persist options in DB::Open() -- %s",
                     persist_options_status.ToString().c_str());
6177 6178
    }
  }
6179
  if (!s.ok()) {
Y
Yueh-Hsuan Chiang 已提交
6180
    for (auto* h : *handles) {
6181 6182
      delete h;
    }
6183
    handles->clear();
J
jorlow@chromium.org 已提交
6184
    delete impl;
6185
    *dbptr = nullptr;
J
jorlow@chromium.org 已提交
6186 6187 6188 6189
  }
  return s;
}

6190 6191 6192
Status DB::ListColumnFamilies(const DBOptions& db_options,
                              const std::string& name,
                              std::vector<std::string>* column_families) {
I
Igor Canadi 已提交
6193
  return VersionSet::ListColumnFamilies(column_families, name, db_options.env);
6194 6195
}

6196 6197 6198
Snapshot::~Snapshot() {
}

J
jorlow@chromium.org 已提交
6199
Status DestroyDB(const std::string& dbname, const Options& options) {
6200
  const ImmutableDBOptions soptions(SanitizeOptions(dbname, options));
6201
  Env* env = soptions.env;
J
jorlow@chromium.org 已提交
6202
  std::vector<std::string> filenames;
6203

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

J
jorlow@chromium.org 已提交
6207
  FileLock* lock;
6208 6209
  const std::string lockname = LockFileName(dbname);
  Status result = env->LockFile(lockname, &lock);
J
jorlow@chromium.org 已提交
6210 6211 6212
  if (result.ok()) {
    uint64_t number;
    FileType type;
6213
    InfoLogPrefix info_log_prefix(!soptions.db_log_dir.empty(), dbname);
D
dgrogan@chromium.org 已提交
6214
    for (size_t i = 0; i < filenames.size(); i++) {
6215
      if (ParseFileName(filenames[i], &number, info_log_prefix.prefix, &type) &&
6216
          type != kDBLockFile) {  // Lock file will be deleted at end
K
Kosie van der Merwe 已提交
6217
        Status del;
6218
        std::string path_to_delete = dbname + "/" + filenames[i];
K
Kosie van der Merwe 已提交
6219
        if (type == kMetaDatabase) {
6220 6221
          del = DestroyDB(path_to_delete, options);
        } else if (type == kTableFile) {
6222
          del = DeleteSSTFile(&soptions, path_to_delete, 0);
K
Kosie van der Merwe 已提交
6223
        } else {
6224
          del = env->DeleteFile(path_to_delete);
K
Kosie van der Merwe 已提交
6225
        }
J
jorlow@chromium.org 已提交
6226 6227 6228 6229 6230
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
6231

6232 6233
    for (size_t path_id = 0; path_id < options.db_paths.size(); path_id++) {
      const auto& db_path = options.db_paths[path_id];
6234
      env->GetChildren(db_path.path, &filenames);
6235 6236 6237
      for (size_t i = 0; i < filenames.size(); i++) {
        if (ParseFileName(filenames[i], &number, &type) &&
            type == kTableFile) {  // Lock file will be deleted at end
6238
          std::string table_path = db_path.path + "/" + filenames[i];
6239
          Status del = DeleteSSTFile(&soptions, table_path,
6240
                                     static_cast<uint32_t>(path_id));
6241 6242 6243 6244 6245 6246 6247
          if (result.ok() && !del.ok()) {
            result = del;
          }
        }
      }
    }

I
Igor Canadi 已提交
6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265
    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;
6266
    env->GetChildren(archivedir, &archiveFiles);
6267 6268
    // Delete archival files.
    for (size_t i = 0; i < archiveFiles.size(); ++i) {
6269 6270
      if (ParseFileName(archiveFiles[i], &number, &type) &&
          type == kLogFile) {
6271
        Status del = env->DeleteFile(archivedir + "/" + archiveFiles[i]);
6272 6273 6274 6275 6276
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
6277

6278
    // ignore case where no archival directory is present.
6279
    env->DeleteDir(archivedir);
6280

J
jorlow@chromium.org 已提交
6281
    env->UnlockFile(lock);  // Ignore error since state is already gone
6282
    env->DeleteFile(lockname);
J
jorlow@chromium.org 已提交
6283
    env->DeleteDir(dbname);  // Ignore error in case dir contains other files
6284
    env->DeleteDir(soptions.wal_dir);
J
jorlow@chromium.org 已提交
6285 6286 6287 6288
  }
  return result;
}

6289 6290
Status DBImpl::WriteOptionsFile() {
#ifndef ROCKSDB_LITE
6291
  mutex_.AssertHeld();
6292 6293 6294

  std::vector<std::string> cf_names;
  std::vector<ColumnFamilyOptions> cf_opts;
6295 6296 6297 6298 6299

  // This part requires mutex to protect the column family options
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    if (cfd->IsDropped()) {
      continue;
6300
    }
6301
    cf_names.push_back(cfd->GetName());
6302
    cf_opts.push_back(cfd->GetLatestCFOptions());
6303 6304
  }

6305 6306
  // Unlock during expensive operations.  New writes cannot get here
  // because the single write thread ensures all new writes get queued.
6307 6308
  DBOptions db_options =
      BuildDBOptions(immutable_db_options_, mutable_db_options_);
6309 6310 6311 6312
  mutex_.Unlock();

  std::string file_name =
      TempOptionsFileName(GetName(), versions_->NewFileNumber());
6313 6314
  Status s =
      PersistRocksDBOptions(db_options, cf_names, cf_opts, file_name, GetEnv());
6315 6316 6317 6318 6319

  if (s.ok()) {
    s = RenameTempFileToOptionsFile(file_name);
  }
  mutex_.Lock();
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337
  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()) {
6338 6339
      ROCKS_LOG_WARN(info_log, "Unable to delete options file %s",
                     iter->second.c_str());
6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369
    }
  }
}
}  // 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,
6370
                           immutable_db_options_.info_log, GetEnv());
6371 6372 6373 6374 6375 6376 6377 6378 6379
  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 已提交
6380 6381

  versions_->options_file_number_ = versions_->NewFileNumber();
6382
  std::string options_file_name =
W
Wanning Jiang 已提交
6383
      OptionsFileName(GetName(), versions_->options_file_number_);
6384 6385 6386 6387 6388 6389 6390 6391 6392 6393
  // 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 已提交
6394
#ifdef ROCKSDB_USING_THREAD_STATUS
6395

Y
Yueh-Hsuan Chiang 已提交
6396 6397
void DBImpl::NewThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
6398
  if (immutable_db_options_.enable_thread_tracking) {
6399 6400
    ThreadStatusUtil::NewColumnFamilyInfo(this, cfd, cfd->GetName(),
                                          cfd->ioptions()->env);
6401
  }
Y
Yueh-Hsuan Chiang 已提交
6402 6403 6404 6405
}

void DBImpl::EraseThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
6406
  if (immutable_db_options_.enable_thread_tracking) {
6407
    ThreadStatusUtil::EraseColumnFamilyInfo(cfd);
6408
  }
Y
Yueh-Hsuan Chiang 已提交
6409 6410 6411
}

void DBImpl::EraseThreadStatusDbInfo() const {
6412
  if (immutable_db_options_.enable_thread_tracking) {
6413
    ThreadStatusUtil::EraseDatabaseInfo(this);
6414
  }
Y
Yueh-Hsuan Chiang 已提交
6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429
}

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

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

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

6430 6431
//
// A global method that can dump out the build version
I
Igor Canadi 已提交
6432
void DumpRocksDBBuildVersion(Logger * log) {
I
Igor Canadi 已提交
6433
#if !defined(IOS_CROSS_COMPILE)
I
Igor Canadi 已提交
6434 6435
  // if we compile with Xcode, we don't run build_detect_vesion, so we don't
  // generate util/build_version.cc
6436 6437 6438 6439
  ROCKS_LOG_HEADER(log, "RocksDB version: %d.%d.%d\n", ROCKSDB_MAJOR,
                   ROCKSDB_MINOR, ROCKSDB_PATCH);
  ROCKS_LOG_HEADER(log, "Git sha %s", rocksdb_build_git_sha);
  ROCKS_LOG_HEADER(log, "Compile date %s", rocksdb_build_compile_date);
I
Igor Canadi 已提交
6440
#endif
6441 6442
}

A
agiardullo 已提交
6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459
#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
6460 6461 6462
Status DBImpl::GetLatestSequenceForKey(SuperVersion* sv, const Slice& key,
                                       bool cache_only, SequenceNumber* seq,
                                       bool* found_record_for_key) {
A
agiardullo 已提交
6463 6464
  Status s;
  MergeContext merge_context;
6465 6466
  RangeDelAggregator range_del_agg(sv->mem->GetInternalKeyComparator(),
                                   kMaxSequenceNumber);
A
agiardullo 已提交
6467

A
Andrew Kryczka 已提交
6468
  ReadOptions read_options;
A
agiardullo 已提交
6469 6470 6471 6472
  SequenceNumber current_seq = versions_->LastSequence();
  LookupKey lkey(key, current_seq);

  *seq = kMaxSequenceNumber;
6473 6474
  *found_record_for_key = false;

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

  if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
    // unexpected error reading memtable.
6481 6482 6483
    ROCKS_LOG_ERROR(immutable_db_options_.info_log,
                    "Unexpected status returned from MemTable::Get: %s\n",
                    s.ToString().c_str());
A
agiardullo 已提交
6484 6485 6486 6487 6488 6489

    return s;
  }

  if (*seq != kMaxSequenceNumber) {
    // Found a sequence number, no need to check immutable memtables
6490
    *found_record_for_key = true;
A
agiardullo 已提交
6491 6492 6493 6494
    return Status::OK();
  }

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

  if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
    // unexpected error reading memtable.
6500 6501 6502
    ROCKS_LOG_ERROR(immutable_db_options_.info_log,
                    "Unexpected status returned from MemTableList::Get: %s\n",
                    s.ToString().c_str());
A
agiardullo 已提交
6503 6504 6505 6506 6507 6508

    return s;
  }

  if (*seq != kMaxSequenceNumber) {
    // Found a sequence number, no need to check memtable history
6509
    *found_record_for_key = true;
A
agiardullo 已提交
6510 6511 6512 6513
    return Status::OK();
  }

  // Check if there is a record for this key in the immutable memtables
A
Andrew Kryczka 已提交
6514 6515
  sv->imm->GetFromHistory(lkey, nullptr, &s, &merge_context, &range_del_agg,
                          seq, read_options);
A
agiardullo 已提交
6516 6517 6518

  if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
    // unexpected error reading memtable.
6519 6520
    ROCKS_LOG_ERROR(
        immutable_db_options_.info_log,
A
agiardullo 已提交
6521 6522 6523 6524 6525 6526
        "Unexpected status returned from MemTableList::GetFromHistory: %s\n",
        s.ToString().c_str());

    return s;
  }

6527 6528 6529 6530 6531 6532 6533 6534 6535 6536
  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 已提交
6537
    sv->current->Get(read_options, lkey, nullptr, &s, &merge_context,
A
Andrew Kryczka 已提交
6538 6539
                     &range_del_agg, nullptr /* value_found */,
                     found_record_for_key, seq);
6540 6541 6542

    if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
      // unexpected error reading SST files
6543 6544 6545
      ROCKS_LOG_ERROR(immutable_db_options_.info_log,
                      "Unexpected status returned from Version::Get: %s\n",
                      s.ToString().c_str());
6546 6547 6548 6549 6550

      return s;
    }
  }

A
agiardullo 已提交
6551 6552
  return Status::OK();
}
6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568

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

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

  std::list<uint64_t>::iterator pending_output_elem;
  {
    InstrumentedMutexLock l(&mutex_);
6569 6570 6571 6572 6573 6574
    if (!bg_error_.ok()) {
      // Don't ingest files when there is a bg_error
      return bg_error_;
    }

    // Make sure that bg cleanup wont delete the files that we are ingesting
6575 6576 6577 6578 6579 6580 6581 6582
    pending_output_elem = CaptureCurrentFileNumberInPendingOutputs();
  }

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

6583
  TEST_SYNC_POINT("DBImpl::AddFile:Start");
6584 6585 6586 6587 6588 6589 6590 6591 6592
  {
    // 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_);

6593 6594
    num_running_ingest_file_++;

6595 6596 6597 6598 6599 6600
    // We cannot ingest a file into a dropped CF
    if (cfd->IsDropped()) {
      status = Status::InvalidArgument(
          "Cannot ingest an external file into a dropped CF");
    }

6601
    // Figure out if we need to flush the memtable first
6602 6603 6604 6605 6606 6607 6608 6609 6610
    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();
      }
6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651
    }

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

6652 6653 6654 6655
  if (status.ok()) {
    NotifyOnExternalFileIngested(cfd, ingestion_job);
  }

6656 6657 6658
  return status;
}

6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680
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
}

6681 6682 6683 6684 6685 6686 6687
void DBImpl::WaitForIngestFile() {
  mutex_.AssertHeld();
  while (num_running_ingest_file_ > 0) {
    bg_cv_.Wait();
  }
}

A
agiardullo 已提交
6688 6689
#endif  // ROCKSDB_LITE

6690
}  // namespace rocksdb