db_impl.cc 201.6 KB
Newer Older
1 2 3 4 5
//  Copyright (c) 2013, Facebook, Inc.  All rights reserved.
//  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 11
// 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 已提交
12
#ifndef __STDC_FORMAT_MACROS
I
Igor Canadi 已提交
13
#define __STDC_FORMAT_MACROS
L
liuhuahang 已提交
14 15
#endif

I
Igor Canadi 已提交
16
#include <inttypes.h>
17
#include <stdint.h>
D
David Bernard 已提交
18
#ifdef OS_SOLARIS
D
David Bernard 已提交
19
#include <alloca.h>
D
David Bernard 已提交
20
#endif
21

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

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

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

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

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

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

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

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

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

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

142
  if (result.info_log == nullptr) {
143
    Status s = CreateLoggerFromOptions(dbname, result, &result.info_log);
J
jorlow@chromium.org 已提交
144 145
    if (!s.ok()) {
      // No place suitable for logging
146
      result.info_log = nullptr;
J
jorlow@chromium.org 已提交
147 148
    }
  }
149 150 151 152 153 154
  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;
  }
155 156 157 158
  result.env->IncBackgroundThreadsIfNeeded(src.max_background_compactions,
                                           Env::Priority::LOW);
  result.env->IncBackgroundThreadsIfNeeded(src.max_background_flushes,
                                           Env::Priority::HIGH);
159

I
Igor Canadi 已提交
160
  if (result.rate_limiter.get() != nullptr) {
161 162 163 164 165
    if (result.bytes_per_sync == 0) {
      result.bytes_per_sync = 1024 * 1024;
    }
  }

166 167 168 169
  if (result.WAL_ttl_seconds > 0 || result.WAL_size_limit_MB > 0) {
    result.recycle_log_file_num = false;
  }

170 171 172 173
  if (result.wal_dir.empty()) {
    // Use dbname as default
    result.wal_dir = dbname;
  }
174
  if (result.wal_dir.back() == '/') {
I
Igor Canadi 已提交
175
    result.wal_dir = result.wal_dir.substr(0, result.wal_dir.size() - 1);
176
  }
177

178
  if (result.db_paths.size() == 0) {
179
    result.db_paths.emplace_back(dbname, std::numeric_limits<uint64_t>::max());
180 181
  }

182 183 184 185
  if (result.compaction_readahead_size > 0) {
    result.new_table_reader_for_compaction_inputs = true;
  }

J
jorlow@chromium.org 已提交
186 187 188
  return result;
}

189 190
namespace {

191 192
Status SanitizeOptionsByTable(
    const DBOptions& db_opts,
193 194 195
    const std::vector<ColumnFamilyDescriptor>& column_families) {
  Status s;
  for (auto cf : column_families) {
196
    s = cf.options.table_factory->SanitizeOptions(db_opts, cf.options);
197 198 199 200 201 202 203
    if (!s.ok()) {
      return s;
    }
  }
  return Status::OK();
}

204
CompressionType GetCompressionFlush(const ImmutableCFOptions& ioptions) {
205 206 207 208 209 210
  // Compressing memtable flushes might not help unless the sequential load
  // optimization is used for leveled compaction. Otherwise the CPU and
  // latency overhead is not offset by saving much space.

  bool can_compress;

211
  if (ioptions.compaction_style == kCompactionStyleUniversal) {
212
    can_compress =
213
        (ioptions.compaction_options_universal.compression_size_percent < 0);
214 215
  } else {
    // For leveled compress when min_level_to_compress == 0.
216 217
    can_compress = ioptions.compression_per_level.empty() ||
                   ioptions.compression_per_level[0] != kNoCompression;
218 219 220
  }

  if (can_compress) {
221
    return ioptions.compression;
222 223 224 225
  } else {
    return kNoCompression;
  }
}
I
Igor Canadi 已提交
226

227
void DumpSupportInfo(Logger* logger) {
I
Igor Canadi 已提交
228 229 230 231 232 233 234 235
  Log(InfoLogLevel::INFO_LEVEL, logger, "Compression algorithms supported:");
  Log(InfoLogLevel::INFO_LEVEL, logger, "\tSnappy supported: %d",
      Snappy_Supported());
  Log(InfoLogLevel::INFO_LEVEL, logger, "\tZlib supported: %d",
      Zlib_Supported());
  Log(InfoLogLevel::INFO_LEVEL, logger, "\tBzip supported: %d",
      BZip2_Supported());
  Log(InfoLogLevel::INFO_LEVEL, logger, "\tLZ4 supported: %d", LZ4_Supported());
236 237
  Log(InfoLogLevel::INFO_LEVEL, logger, "Fast CRC32 supported: %d",
      crc32c::IsFastCrc32Supported());
I
Igor Canadi 已提交
238 239
}

240
}  // namespace
241

I
Igor Canadi 已提交
242
DBImpl::DBImpl(const DBOptions& options, const std::string& dbname)
J
jorlow@chromium.org 已提交
243
    : env_(options.env),
H
heyongqiang 已提交
244
      dbname_(dbname),
245 246
      db_options_(SanitizeOptions(dbname, options)),
      stats_(db_options_.statistics.get()),
247
      db_lock_(nullptr),
I
Igor Canadi 已提交
248
      mutex_(stats_, env_, DB_MUTEX_WAIT_MICROS, options.use_adaptive_mutex),
I
Igor Canadi 已提交
249
      shutting_down_(false),
J
jorlow@chromium.org 已提交
250
      bg_cv_(&mutex_),
251
      logfile_number_(0),
252
      log_dir_synced_(false),
I
Igor Canadi 已提交
253
      log_empty_(true),
254
      default_cf_handle_(nullptr),
255
      log_sync_cv_(&mutex_),
I
Igor Canadi 已提交
256 257
      total_log_size_(0),
      max_total_in_memory_state_(0),
S
sdong 已提交
258
      is_snapshot_supported_(true),
259
      write_buffer_(options.db_write_buffer_size),
260 261 262 263
      write_thread_(options.enable_write_thread_adaptive_yield
                        ? options.write_thread_max_yield_usec
                        : 0,
                    options.write_thread_slow_yield_usec),
S
sdong 已提交
264 265
      write_controller_(options.delayed_write_rate),
      last_batch_group_size_(0),
266 267
      unscheduled_flushes_(0),
      unscheduled_compactions_(0),
268
      bg_compaction_scheduled_(0),
269
      num_running_compactions_(0),
270
      bg_flush_scheduled_(0),
271
      num_running_flushes_(0),
272
      disable_delete_obsolete_files_(0),
I
Igor Canadi 已提交
273 274 275
      delete_obsolete_files_next_run_(
          options.env->NowMicros() +
          db_options_.delete_obsolete_files_period_micros),
276
      last_stats_dump_time_microsec_(0),
277
      next_job_id_(1),
278
      flush_on_destroy_(false),
279
      env_options_(db_options_),
I
Igor Canadi 已提交
280 281 282
#ifndef ROCKSDB_LITE
      wal_manager_(db_options_, env_options_),
#endif  // ROCKSDB_LITE
I
Igor Canadi 已提交
283
      event_logger_(db_options_.info_log.get()),
284
      bg_work_paused_(0),
285
      refitting_level_(false),
286
      opened_successfully_(false) {
H
heyongqiang 已提交
287
  env_->GetAbsolutePath(dbname, &db_absolute_path_);
288

J
jorlow@chromium.org 已提交
289
  // Reserve ten files or so for other uses and give the rest to TableCache.
290
  // Give a large number for setting of "infinite" open files.
291 292
  const int table_cache_size = (db_options_.max_open_files == -1) ?
        4194304 : db_options_.max_open_files - 10;
293
  table_cache_ =
294
      NewLRUCache(table_cache_size, db_options_.table_cache_numshardbits);
295

296
  versions_.reset(new VersionSet(dbname_, &db_options_, env_options_,
297 298
                                 table_cache_.get(), &write_buffer_,
                                 &write_controller_));
299 300
  column_family_memtables_.reset(
      new ColumnFamilyMemTablesImpl(versions_->GetColumnFamilySet()));
301

I
Igor Canadi 已提交
302
  DumpRocksDBBuildVersion(db_options_.info_log.get());
303 304
  DumpDBFileSummary(db_options_, dbname_);
  db_options_.Dump(db_options_.info_log.get());
305
  DumpSupportInfo(db_options_.info_log.get());
J
jorlow@chromium.org 已提交
306 307
}

308
// Will lock the mutex_,  will wait for completion if wait is true
309
void DBImpl::CancelAllBackgroundWork(bool wait) {
310
  InstrumentedMutexLock l(&mutex_);
311
  shutting_down_.store(true, std::memory_order_release);
312
  bg_cv_.SignalAll();
313 314 315 316
  if (!wait) {
    return;
  }
  // Wait for background work to finish
317
  while (bg_compaction_scheduled_ || bg_flush_scheduled_) {
318 319
    bg_cv_.Wait();
  }
320 321
}

J
jorlow@chromium.org 已提交
322
DBImpl::~DBImpl() {
323
  mutex_.Lock();
324

325
  if (!shutting_down_.load(std::memory_order_acquire) && flush_on_destroy_) {
326
    for (auto cfd : *versions_->GetColumnFamilySet()) {
327
      if (!cfd->IsDropped() && !cfd->mem()->IsEmpty()) {
328 329 330 331
        cfd->Ref();
        mutex_.Unlock();
        FlushMemTable(cfd, FlushOptions());
        mutex_.Lock();
332
        cfd->Unref();
333 334
      }
    }
335
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
336
  }
337 338 339
  mutex_.Unlock();
  // CancelAllBackgroundWork called with false means we just set the shutdown
  // marker. After this we do a variant of the waiting and unschedule work
340 341
  // (to consider: moving all the waiting into CancelAllBackgroundWork(true))
  CancelAllBackgroundWork(false);
342 343 344 345 346 347 348
  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
349
  while (bg_compaction_scheduled_ || bg_flush_scheduled_) {
350 351
    bg_cv_.Wait();
  }
352
  EraseThreadStatusDbInfo();
I
Igor Canadi 已提交
353 354
  flush_scheduler_.Clear();

355 356 357 358 359 360 361 362 363 364 365 366 367
  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 已提交
368 369 370 371 372
  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();
373 374
  }

I
Igor Canadi 已提交
375 376 377 378 379 380 381 382 383 384
  // 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_) {
385
    JobContext job_context(next_job_id_.fetch_add(1));
I
Igor Canadi 已提交
386
    FindObsoleteFiles(&job_context, true);
387 388

    mutex_.Unlock();
I
Igor Canadi 已提交
389
    // manifest number starting from 2
I
Igor Canadi 已提交
390 391 392
    job_context.manifest_file_number = 1;
    if (job_context.HaveSomethingToDelete()) {
      PurgeObsoleteFiles(job_context);
393
    }
I
Igor Canadi 已提交
394
    job_context.Clean();
395
    mutex_.Lock();
396 397
  }

398 399 400
  for (auto l : logs_to_free_) {
    delete l;
  }
401 402 403
  for (auto& log : logs_) {
    log.ClearWriter();
  }
404
  logs_.clear();
405

406
  // versions need to be destroyed before table_cache since it can hold
407 408
  // references to table_cache.
  versions_.reset();
409
  mutex_.Unlock();
I
Igor Canadi 已提交
410 411 412
  if (db_lock_ != nullptr) {
    env_->UnlockFile(db_lock_);
  }
413

414
  LogFlush(db_options_.info_log);
J
jorlow@chromium.org 已提交
415 416 417
}

Status DBImpl::NewDB() {
418
  VersionEdit new_db;
419
  new_db.SetLogNumber(0);
J
jorlow@chromium.org 已提交
420 421 422
  new_db.SetNextFile(2);
  new_db.SetLastSequence(0);

423 424
  Status s;

425 426
  Log(InfoLogLevel::INFO_LEVEL,
      db_options_.info_log, "Creating manifest 1 \n");
J
jorlow@chromium.org 已提交
427 428
  const std::string manifest = DescriptorFileName(dbname_, 1);
  {
429 430
    unique_ptr<WritableFile> file;
    EnvOptions env_options = env_->OptimizeForManifestWrite(env_options_);
S
sdong 已提交
431
    s = NewWritableFile(env_, manifest, &file, env_options);
432 433 434 435 436 437
    if (!s.ok()) {
      return s;
    }
    file->SetPreallocationBlockSize(db_options_.manifest_preallocation_size);
    unique_ptr<WritableFileWriter> file_writer(
        new WritableFileWriter(std::move(file), env_options));
438
    log::Writer log(std::move(file_writer), 0, false);
J
jorlow@chromium.org 已提交
439 440 441
    std::string record;
    new_db.EncodeTo(&record);
    s = log.AddRecord(record);
S
sdong 已提交
442 443 444
    if (s.ok()) {
      s = SyncManifest(env_, &db_options_, log.file());
    }
J
jorlow@chromium.org 已提交
445 446 447
  }
  if (s.ok()) {
    // Make "CURRENT" file that points to the new manifest file.
448
    s = SetCurrentFile(env_, dbname_, 1, directories_.GetDbDir());
J
jorlow@chromium.org 已提交
449 450 451 452 453 454 455
  } else {
    env_->DeleteFile(manifest);
  }
  return s;
}

void DBImpl::MaybeIgnoreError(Status* s) const {
456
  if (s->ok() || db_options_.paranoid_checks) {
J
jorlow@chromium.org 已提交
457 458
    // No change needed
  } else {
459 460
    Log(InfoLogLevel::WARN_LEVEL,
        db_options_.info_log, "Ignoring error %s", s->ToString().c_str());
J
jorlow@chromium.org 已提交
461 462 463 464
    *s = Status::OK();
  }
}

465
const Status DBImpl::CreateArchivalDirectory() {
466 467
  if (db_options_.WAL_ttl_seconds > 0 || db_options_.WAL_size_limit_MB > 0) {
    std::string archivalPath = ArchivalDirectory(db_options_.wal_dir);
468 469 470 471 472
    return env_->CreateDirIfMissing(archivalPath);
  }
  return Status::OK();
}

473
void DBImpl::PrintStatistics() {
474
  auto dbstats = db_options_.statistics.get();
475
  if (dbstats) {
Y
Yueh-Hsuan Chiang 已提交
476
    Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
M
Mark Callaghan 已提交
477
        "STATISTICS:\n %s",
478
        dbstats->ToString().c_str());
479 480 481
  }
}

482
void DBImpl::MaybeDumpStats() {
483
  if (db_options_.stats_dump_period_sec == 0) return;
H
Haobo Xu 已提交
484 485 486 487

  const uint64_t now_micros = env_->NowMicros();

  if (last_stats_dump_time_microsec_ +
488
      db_options_.stats_dump_period_sec * 1000000
H
Haobo Xu 已提交
489 490 491 492 493 494
      <= now_micros) {
    // 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;
495

496
#ifndef ROCKSDB_LITE
497 498 499 500 501 502 503
    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 已提交
504
    std::string stats;
505
    {
506
      InstrumentedMutexLock l(&mutex_);
507
      for (auto cfd : *versions_->GetColumnFamilySet()) {
508 509
        cfd->internal_stats()->GetStringProperty(
            *cf_property_info, DB::Properties::kCFStats, &stats);
510
      }
511 512
      default_cf_internal_stats_->GetStringProperty(
          *db_property_info, DB::Properties::kDBStats, &stats);
513
    }
Y
Yueh-Hsuan Chiang 已提交
514
    Log(InfoLogLevel::WARN_LEVEL,
515
        db_options_.info_log, "------- DUMPING STATS -------");
Y
Yueh-Hsuan Chiang 已提交
516
    Log(InfoLogLevel::WARN_LEVEL,
517
        db_options_.info_log, "%s", stats.c_str());
518
#endif  // !ROCKSDB_LITE
519

520
    PrintStatistics();
521 522 523
  }
}

I
Igor Canadi 已提交
524
// * Returns the list of live files in 'sst_live'
I
Igor Canadi 已提交
525
// If it's doing full scan:
I
Igor Canadi 已提交
526 527
// * Returns the list of all files in the filesystem in
// 'full_scan_candidate_files'.
I
Igor Canadi 已提交
528
// Otherwise, gets obsolete files from VersionSet.
I
Igor Canadi 已提交
529 530
// no_full_scan = true -- never do the full scan using GetChildren()
// force = false -- don't force the full scan, except every
531
//  db_options_.delete_obsolete_files_period_micros
I
Igor Canadi 已提交
532
// force = true -- force the full scan
I
Igor Canadi 已提交
533
void DBImpl::FindObsoleteFiles(JobContext* job_context, bool force,
I
Igor Canadi 已提交
534
                               bool no_full_scan) {
D
Dhruba Borthakur 已提交
535 536
  mutex_.AssertHeld();

537
  // if deletion is disabled, do nothing
538
  if (disable_delete_obsolete_files_ > 0) {
539 540 541
    return;
  }

542 543 544 545 546
  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;
547
  } else if (force || db_options_.delete_obsolete_files_period_micros == 0) {
548 549 550
    doing_the_full_scan = true;
  } else {
    const uint64_t now_micros = env_->NowMicros();
I
Igor Canadi 已提交
551
    if (delete_obsolete_files_next_run_ < now_micros) {
552
      doing_the_full_scan = true;
I
Igor Canadi 已提交
553 554
      delete_obsolete_files_next_run_ =
          now_micros + db_options_.delete_obsolete_files_period_micros;
555 556 557
    }
  }

I
Igor Canadi 已提交
558 559
  // don't delete files that might be currently written to from compaction
  // threads
560 561 562
  // 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 已提交
563 564 565 566 567 568 569
  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();
  }

570 571
  // Get obsolete files.  This function will also update the list of
  // pending files in VersionSet().
I
Igor Canadi 已提交
572 573
  versions_->GetObsoleteFiles(&job_context->sst_delete_files,
                              job_context->min_pending_output);
I
Igor Canadi 已提交
574

I
Igor Canadi 已提交
575
  // store the current filenum, lognum, etc
576
  job_context->manifest_file_number = versions_->manifest_file_number();
I
Igor Canadi 已提交
577
  job_context->pending_manifest_file_number =
578
      versions_->pending_manifest_file_number();
I
Igor Canadi 已提交
579
  job_context->log_number = versions_->MinLogNumber();
580
  job_context->prev_log_number = versions_->prev_log_number();
I
Igor Canadi 已提交
581

I
Igor Canadi 已提交
582
  versions_->AddLiveFiles(&job_context->sst_live);
583
  if (doing_the_full_scan) {
584
    for (size_t path_id = 0; path_id < db_options_.db_paths.size(); path_id++) {
585 586 587
      // set of all files in the directory. We'll exclude files that are still
      // alive in the subsequent processings.
      std::vector<std::string> files;
588
      env_->GetChildren(db_options_.db_paths[path_id].path,
589
                        &files);  // Ignore errors
590
      for (std::string file : files) {
I
Igor Canadi 已提交
591
        // TODO(icanadi) clean up this mess to avoid having one-off "/" prefixes
S
Siying Dong 已提交
592 593
        job_context->full_scan_candidate_files.emplace_back(
            "/" + file, static_cast<uint32_t>(path_id));
594 595
      }
    }
596 597

    //Add log files in wal_dir
598
    if (db_options_.wal_dir != dbname_) {
599
      std::vector<std::string> log_files;
600
      env_->GetChildren(db_options_.wal_dir, &log_files);  // Ignore errors
601
      for (std::string log_file : log_files) {
I
Igor Canadi 已提交
602
        job_context->full_scan_candidate_files.emplace_back(log_file, 0);
603 604
      }
    }
605
    // Add info log files in db_log_dir
606
    if (!db_options_.db_log_dir.empty() && db_options_.db_log_dir != dbname_) {
607
      std::vector<std::string> info_log_files;
608 609
      // Ignore errors
      env_->GetChildren(db_options_.db_log_dir, &info_log_files);
610
      for (std::string log_file : info_log_files) {
I
Igor Canadi 已提交
611
        job_context->full_scan_candidate_files.emplace_back(log_file, 0);
612 613
      }
    }
614
  }
615 616 617 618 619 620

  if (!alive_log_files_.empty()) {
    uint64_t min_log_number = versions_->MinLogNumber();
    // find newly obsoleted log files
    while (alive_log_files_.begin()->number < min_log_number) {
      auto& earliest = *alive_log_files_.begin();
S
Sage Weil 已提交
621 622 623 624 625 626 627
      if (db_options_.recycle_log_file_num > log_recycle_files.size()) {
        Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
            "adding log %" PRIu64 " to recycle list\n", earliest.number);
        log_recycle_files.push_back(earliest.number);
      } else {
        job_context->log_delete_files.push_back(earliest.number);
      }
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
      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_;
  logs_to_free_.clear();
652 653
}

654
namespace {
I
Igor Canadi 已提交
655 656
bool CompareCandidateFile(const JobContext::CandidateFileInfo& first,
                          const JobContext::CandidateFileInfo& second) {
657 658 659 660 661
  if (first.file_name > second.file_name) {
    return true;
  } else if (first.file_name < second.file_name) {
    return false;
  } else {
662
    return (first.path_id > second.path_id);
663 664 665 666
  }
}
};  // namespace

D
Dhruba Borthakur 已提交
667
// Diffs the files listed in filenames and those that do not
I
Igor Canadi 已提交
668
// belong to live files are posibly removed. Also, removes all the
669
// files in sst_delete_files and log_delete_files.
670
// It is not necessary to hold the mutex when invoking this method.
I
Igor Canadi 已提交
671
void DBImpl::PurgeObsoleteFiles(const JobContext& state) {
672 673
  // we'd better have sth to delete
  assert(state.HaveSomethingToDelete());
674

I
Igor Canadi 已提交
675 676 677 678
  // 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 已提交
679 680
    return;
  }
681

682
  // Now, convert live list to an unordered map, WITHOUT mutex held;
683
  // set is slow.
684
  std::unordered_map<uint64_t, const FileDescriptor*> sst_live_map;
I
Igor Canadi 已提交
685
  for (const FileDescriptor& fd : state.sst_live) {
686 687
    sst_live_map[fd.GetNumber()] = &fd;
  }
I
Igor Canadi 已提交
688

I
Igor Canadi 已提交
689
  auto candidate_files = state.full_scan_candidate_files;
I
Igor Canadi 已提交
690 691 692
  candidate_files.reserve(candidate_files.size() +
                          state.sst_delete_files.size() +
                          state.log_delete_files.size());
K
kailiu 已提交
693 694
  // We may ignore the dbname when generating the file names.
  const char* kDumbDbName = "";
695
  for (auto file : state.sst_delete_files) {
696 697 698
    candidate_files.emplace_back(
        MakeTableFileName(kDumbDbName, file->fd.GetNumber()),
        file->fd.GetPathId());
699
    delete file;
I
Igor Canadi 已提交
700 701
  }

K
kailiu 已提交
702 703
  for (auto file_num : state.log_delete_files) {
    if (file_num > 0) {
704 705
      candidate_files.emplace_back(LogFileName(kDumbDbName, file_num).substr(1),
                                   0);
I
Igor Canadi 已提交
706 707
    }
  }
708

K
kailiu 已提交
709
  // dedup state.candidate_files so we don't try to delete the same
I
Igor Canadi 已提交
710
  // file twice
711
  sort(candidate_files.begin(), candidate_files.end(), CompareCandidateFile);
712 713
  candidate_files.erase(unique(candidate_files.begin(), candidate_files.end()),
                        candidate_files.end());
J
jorlow@chromium.org 已提交
714

715
  std::vector<std::string> old_info_log_files;
716
  InfoLogPrefix info_log_prefix(!db_options_.db_log_dir.empty(), dbname_);
717 718 719
  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 已提交
720 721 722
    uint64_t number;
    FileType type;
    // Ignore file if we cannot recognize it.
723
    if (!ParseFileName(to_delete, &number, info_log_prefix.prefix, &type)) {
K
kailiu 已提交
724 725
      continue;
    }
J
jorlow@chromium.org 已提交
726

K
kailiu 已提交
727 728 729 730 731 732 733 734
    bool keep = true;
    switch (type) {
      case kLogFile:
        keep = ((number >= state.log_number) ||
                (number == state.prev_log_number));
        break;
      case kDescriptorFile:
        // Keep my manifest file, and any newer incarnations'
735
        // (can happen during manifest roll)
K
kailiu 已提交
736 737 738
        keep = (number >= state.manifest_file_number);
        break;
      case kTableFile:
I
Igor Canadi 已提交
739 740 741 742
        // 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 已提交
743 744 745
        break;
      case kTempFile:
        // Any temp files that are currently being written to must
746 747 748 749
        // 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
750 751 752
        //
        // TODO(yhchiang): carefully modify the third condition to safely
        //                 remove the temp options files.
753
        keep = (sst_live_map.find(number) != sst_live_map.end()) ||
754 755
               (number == state.pending_manifest_file_number) ||
               (to_delete.find(kOptionsFileNamePrefix) != std::string::npos);
K
kailiu 已提交
756 757 758 759
        break;
      case kInfoLogFile:
        keep = true;
        if (number != 0) {
760
          old_info_log_files.push_back(to_delete);
J
jorlow@chromium.org 已提交
761
        }
K
kailiu 已提交
762 763 764 765 766
        break;
      case kCurrentFile:
      case kDBLockFile:
      case kIdentityFile:
      case kMetaDatabase:
767
      case kOptionsFile:
K
kailiu 已提交
768 769 770 771 772 773 774 775
        keep = true;
        break;
    }

    if (keep) {
      continue;
    }

776
    std::string fname;
K
kailiu 已提交
777 778
    if (type == kTableFile) {
      // evict from cache
779
      TableCache::Evict(table_cache_.get(), number);
780
      fname = TableFileName(db_options_.db_paths, number, path_id);
781
    } else {
782 783
      fname = ((type == kLogFile) ?
          db_options_.wal_dir : dbname_) + "/" + to_delete;
K
kailiu 已提交
784
    }
785

786
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
787
    if (type == kLogFile && (db_options_.WAL_ttl_seconds > 0 ||
788
                              db_options_.WAL_size_limit_MB > 0)) {
I
Igor Canadi 已提交
789
      wal_manager_.ArchiveWALFile(fname, number);
790 791 792
      continue;
    }
#endif  // !ROCKSDB_LITE
I
Islam AbdelRahman 已提交
793
    Status file_deletion_status;
794 795
    if (type == kTableFile) {
      file_deletion_status = DeleteSSTFile(&db_options_, fname, path_id);
I
Islam AbdelRahman 已提交
796 797 798
    } else {
      file_deletion_status = env_->DeleteFile(fname);
    }
799
    if (file_deletion_status.ok()) {
800
      Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
801
          "[JOB %d] Delete %s type=%d #%" PRIu64 " -- %s\n", state.job_id,
802 803
          fname.c_str(), type, number,
          file_deletion_status.ToString().c_str());
804 805 806 807 808 809
    } else if (env_->FileExists(fname).IsNotFound()) {
      Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
          "[JOB %d] Tried to delete a non-existing file %s type=%d #%" PRIu64
          " -- %s\n",
          state.job_id, fname.c_str(), type, number,
          file_deletion_status.ToString().c_str());
810 811 812 813 814 815 816
    } else {
      Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
          "[JOB %d] Failed to delete %s type=%d #%" PRIu64 " -- %s\n",
          state.job_id, fname.c_str(), type, number,
          file_deletion_status.ToString().c_str());
    }
    if (type == kTableFile) {
817 818 819 820
      EventHelpers::LogAndNotifyTableFileDeletion(
          &event_logger_, state.job_id, number, fname,
          file_deletion_status, GetName(),
          db_options_.listeners);
J
jorlow@chromium.org 已提交
821 822
    }
  }
H
heyongqiang 已提交
823

824
  // Delete old info log files.
825
  size_t old_info_log_file_count = old_info_log_files.size();
826
  if (old_info_log_file_count >= db_options_.keep_log_file_num) {
827
    std::sort(old_info_log_files.begin(), old_info_log_files.end());
828
    size_t end = old_info_log_file_count - db_options_.keep_log_file_num;
829
    for (unsigned int i = 0; i <= end; i++) {
830
      std::string& to_delete = old_info_log_files.at(i);
831 832
      std::string full_path_to_delete = (db_options_.db_log_dir.empty() ?
           dbname_ : db_options_.db_log_dir) + "/" + to_delete;
833
      Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
834
          "[JOB %d] Delete info log file %s\n", state.job_id,
835 836
          full_path_to_delete.c_str());
      Status s = env_->DeleteFile(full_path_to_delete);
837
      if (!s.ok()) {
838 839 840 841 842 843 844 845 846 847
        if (env_->FileExists(full_path_to_delete).IsNotFound()) {
          Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
              "[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 {
          Log(InfoLogLevel::ERROR_LEVEL, 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());
        }
848
      }
H
heyongqiang 已提交
849 850
    }
  }
I
Igor Canadi 已提交
851 852 853
#ifndef ROCKSDB_LITE
  wal_manager_.PurgeObsoleteWALFiles();
#endif  // ROCKSDB_LITE
854
  LogFlush(db_options_.info_log);
D
Dhruba Borthakur 已提交
855 856 857 858
}

void DBImpl::DeleteObsoleteFiles() {
  mutex_.AssertHeld();
859
  JobContext job_context(next_job_id_.fetch_add(1));
I
Igor Canadi 已提交
860
  FindObsoleteFiles(&job_context, true);
861 862

  mutex_.Unlock();
I
Igor Canadi 已提交
863 864
  if (job_context.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(job_context);
865
  }
I
Igor Canadi 已提交
866
  job_context.Clean();
867
  mutex_.Lock();
868 869
}

870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
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 已提交
886

887 888 889 890 891 892 893 894 895
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_);
896 897 898
    if (!s.ok()) {
      return s;
    }
899
  }
900

901 902 903 904 905 906 907 908
  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);
909 910 911
      if (!s.ok()) {
        return s;
      }
912
      data_dirs_.emplace_back(path_directory.release());
913
    }
914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
  }
  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,
    bool error_if_log_file_exist) {
  mutex_.AssertHeld();
933

934 935 936 937 938
  bool is_new_db = false;
  assert(db_lock_ == nullptr);
  if (!read_only) {
    Status s = directories_.SetDirectories(env_, dbname_, db_options_.wal_dir,
                                           db_options_.db_paths);
939 940 941 942
    if (!s.ok()) {
      return s;
    }

943
    s = env_->LockFile(LockFileName(dbname_), &db_lock_);
944 945 946
    if (!s.ok()) {
      return s;
    }
J
jorlow@chromium.org 已提交
947

A
agiardullo 已提交
948 949
    s = env_->FileExists(CurrentFileName(dbname_));
    if (s.IsNotFound()) {
950
      if (db_options_.create_if_missing) {
951
        s = NewDB();
952
        is_new_db = true;
953 954 955 956 957 958
        if (!s.ok()) {
          return s;
        }
      } else {
        return Status::InvalidArgument(
            dbname_, "does not exist (create_if_missing is false)");
J
jorlow@chromium.org 已提交
959
      }
A
agiardullo 已提交
960
    } else if (s.ok()) {
961
      if (db_options_.error_if_exists) {
962 963 964
        return Status::InvalidArgument(
            dbname_, "exists (error_if_exists is true)");
      }
A
agiardullo 已提交
965 966 967 968
    } else {
      // Unexpected error reading file
      assert(s.IsIOError());
      return s;
J
jorlow@chromium.org 已提交
969
    }
M
Mayank Agarwal 已提交
970
    // Check for the IDENTITY file and create it if not there
A
agiardullo 已提交
971 972
    s = env_->FileExists(IdentityFileName(dbname_));
    if (s.IsNotFound()) {
M
Mayank Agarwal 已提交
973 974 975 976
      s = SetIdentityFile(env_, dbname_);
      if (!s.ok()) {
        return s;
      }
A
agiardullo 已提交
977 978 979
    } else if (!s.ok()) {
      assert(s.IsIOError());
      return s;
M
Mayank Agarwal 已提交
980
    }
J
jorlow@chromium.org 已提交
981 982
  }

983
  Status s = versions_->Recover(column_families, read_only);
984
  if (db_options_.paranoid_checks && s.ok()) {
I
Igor Canadi 已提交
985 986
    s = CheckConsistency();
  }
J
jorlow@chromium.org 已提交
987
  if (s.ok()) {
A
agiardullo 已提交
988
    SequenceNumber max_sequence(kMaxSequenceNumber);
989 990
    default_cf_handle_ = new ColumnFamilyHandleImpl(
        versions_->GetColumnFamilySet()->GetDefault(), this, &mutex_);
991
    default_cf_internal_stats_ = default_cf_handle_->cfd()->internal_stats();
992 993
    single_column_family_mode_ =
        versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1;
994 995 996 997 998

    // 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).
    //
999
    // Note that prev_log_number() is no longer used, but we pay
1000
    // attention to it in case we are recovering a database
1001
    // produced by an older version of rocksdb.
1002
    const uint64_t min_log = versions_->MinLogNumber();
1003
    const uint64_t prev_log = versions_->prev_log_number();
1004
    std::vector<std::string> filenames;
1005
    s = env_->GetChildren(db_options_.wal_dir, &filenames);
1006 1007
    if (!s.ok()) {
      return s;
1008
    }
K
kailiu 已提交
1009

1010 1011
    std::vector<uint64_t> logs;
    for (size_t i = 0; i < filenames.size(); i++) {
K
kailiu 已提交
1012 1013
      uint64_t number;
      FileType type;
1014 1015 1016 1017 1018 1019 1020 1021 1022
      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]);
        } else if ((number >= min_log) || (number == prev_log)) {
          logs.push_back(number);
        }
1023
      }
J
jorlow@chromium.org 已提交
1024
    }
1025

H
heyongqiang 已提交
1026 1027 1028 1029 1030 1031
    if (logs.size() > 0 && 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");
    }

S
Stanislau Hlebik 已提交
1032 1033 1034 1035 1036 1037 1038
    if (!logs.empty()) {
      // Recover in the order in which the logs were generated
      std::sort(logs.begin(), logs.end());
      s = RecoverLogFiles(logs, &max_sequence, read_only);
      if (!s.ok()) {
        // Clear memtables if recovery failed
        for (auto cfd : *versions_->GetColumnFamilySet()) {
A
agiardullo 已提交
1039 1040
          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
                                 kMaxSequenceNumber);
S
Stanislau Hlebik 已提交
1041 1042
        }
      }
1043
    }
L
Lei Jin 已提交
1044
    SetTickerCount(stats_, SEQUENCE_NUMBER, versions_->LastSequence());
J
jorlow@chromium.org 已提交
1045 1046
  }

L
Lei Jin 已提交
1047 1048
  // Initial value
  max_total_in_memory_state_ = 0;
I
Igor Canadi 已提交
1049
  for (auto cfd : *versions_->GetColumnFamilySet()) {
L
Lei Jin 已提交
1050 1051 1052
    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 已提交
1053 1054
  }

J
jorlow@chromium.org 已提交
1055 1056 1057
  return s;
}

S
Stanislau Hlebik 已提交
1058 1059 1060
// REQUIRES: log_numbers are sorted in ascending order
Status DBImpl::RecoverLogFiles(const std::vector<uint64_t>& log_numbers,
                               SequenceNumber* max_sequence, bool read_only) {
J
jorlow@chromium.org 已提交
1061 1062
  struct LogReporter : public log::Reader::Reporter {
    Env* env;
1063
    Logger* info_log;
J
jorlow@chromium.org 已提交
1064
    const char* fname;
1065
    Status* status;  // nullptr if db_options_.paranoid_checks==false
I
Igor Sugak 已提交
1066
    virtual void Corruption(size_t bytes, const Status& s) override {
1067 1068
      Log(InfoLogLevel::WARN_LEVEL,
          info_log, "%s%s: dropping %d bytes; %s",
1069
          (this->status == nullptr ? "(ignoring error) " : ""),
J
jorlow@chromium.org 已提交
1070
          fname, static_cast<int>(bytes), s.ToString().c_str());
K
krad 已提交
1071 1072 1073
      if (this->status != nullptr && this->status->ok()) {
        *this->status = s;
      }
J
jorlow@chromium.org 已提交
1074 1075 1076 1077
    }
  };

  mutex_.AssertHeld();
S
Stanislau Hlebik 已提交
1078
  Status status;
1079
  std::unordered_map<int, VersionEdit> version_edits;
1080
  // no need to refcount because iteration is under mutex
1081 1082
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    VersionEdit edit;
1083 1084
    edit.SetColumnFamily(cfd->GetID());
    version_edits.insert({cfd->GetID(), edit});
1085
  }
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
  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 已提交
1098

K
krad 已提交
1099
  bool continue_replay_log = true;
S
Stanislau Hlebik 已提交
1100 1101 1102 1103
  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.
1104
    versions_->MarkFileNumberUsedDuringRecovery(log_number);
S
Stanislau Hlebik 已提交
1105 1106
    // Open the log file
    std::string fname = LogFileName(db_options_.wal_dir, log_number);
1107 1108 1109 1110
    unique_ptr<SequentialFileReader> file_reader;
    {
      unique_ptr<SequentialFile> file;
      status = env_->NewSequentialFile(fname, &file, env_options_);
S
Stanislau Hlebik 已提交
1111
      if (!status.ok()) {
1112 1113 1114 1115 1116 1117 1118 1119
        MaybeIgnoreError(&status);
        if (!status.ok()) {
          return status;
        } else {
          // Fail with one log file, but that's ok.
          // Try next one.
          continue;
        }
S
Stanislau Hlebik 已提交
1120
      }
1121
      file_reader.reset(new SequentialFileReader(std::move(file)));
J
jorlow@chromium.org 已提交
1122 1123
    }

S
Stanislau Hlebik 已提交
1124 1125 1126 1127 1128
    // Create the log reader.
    LogReporter reporter;
    reporter.env = env_;
    reporter.info_log = db_options_.info_log.get();
    reporter.fname = fname.c_str();
K
krad 已提交
1129 1130 1131 1132 1133 1134 1135
    if (!db_options_.paranoid_checks ||
        db_options_.wal_recovery_mode ==
            WALRecoveryMode::kSkipAnyCorruptedRecords) {
      reporter.status = nullptr;
    } else {
      reporter.status = &status;
    }
S
Stanislau Hlebik 已提交
1136 1137 1138 1139
    // 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).
1140 1141
    log::Reader reader(db_options_.info_log, std::move(file_reader), &reporter,
                       true /*checksum*/, 0 /*initial_offset*/, log_number);
K
krad 已提交
1142 1143 1144 1145 1146
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
        "Recovering log #%" PRIu64 " mode %d skip-recovery %d", log_number,
        db_options_.wal_recovery_mode, !continue_replay_log);

    // Determine if we should tolerate incomplete records at the tail end of the
S
Stanislau Hlebik 已提交
1147 1148 1149 1150
    // Read all the records and add to a memtable
    std::string scratch;
    Slice record;
    WriteBatch batch;
K
krad 已提交
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160

    if (!continue_replay_log) {
      uint64_t bytes;
      if (env_->GetFileSize(fname, &bytes).ok()) {
        auto info_log = db_options_.info_log.get();
        Log(InfoLogLevel::WARN_LEVEL, info_log, "%s: dropping %d bytes",
            fname.c_str(), static_cast<int>(bytes));
      }
    }

1161 1162 1163 1164
    while (
        continue_replay_log &&
        reader.ReadRecord(&record, &scratch, db_options_.wal_recovery_mode) &&
        status.ok()) {
S
Stanislau Hlebik 已提交
1165 1166 1167 1168 1169 1170 1171
      if (record.size() < 12) {
        reporter.Corruption(record.size(),
                            Status::Corruption("log record too small"));
        continue;
      }
      WriteBatchInternal::SetContents(&batch, record);

1172
#ifndef ROCKSDB_LITE
1173
      if (db_options_.wal_filter != nullptr) {
1174 1175 1176
        WriteBatch new_batch;
        bool batch_changed = false;

1177
        WalFilter::WalProcessingOption wal_processing_option =
S
sdong 已提交
1178 1179
            db_options_.wal_filter->LogRecord(batch, &new_batch,
                                              &batch_changed);
1180

1181
        switch (wal_processing_option) {
S
sdong 已提交
1182 1183 1184 1185 1186
          case WalFilter::WalProcessingOption::kContinueProcessing:
            // do nothing, proceeed normally
            break;
          case WalFilter::WalProcessingOption::kIgnoreCurrentRecord:
            // skip current record
1187
            continue;
S
sdong 已提交
1188 1189 1190
          case WalFilter::WalProcessingOption::kStopReplay:
            // skip current record and stop replay
            continue_replay_log = false;
1191
            continue;
S
sdong 已提交
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214
          case WalFilter::WalProcessingOption::kCorruptedRecord: {
            status = Status::Corruption("Corruption reported by Wal Filter ",
                                        db_options_.wal_filter->Name());
            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 ",
                db_options_.wal_filter->Name());
            MaybeIgnoreError(&status);
            if (!status.ok()) {
              return status;
            } else {
              // Ignore the error with current record processing.
              continue;
            }
1215 1216 1217 1218 1219 1220 1221 1222 1223
          }
        }

        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) {
1224
            Log(InfoLogLevel::FATAL_LEVEL, db_options_.info_log,
S
sdong 已提交
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
                "Recovering log #%" PRIu64
                " mode %d log filter %s returned "
                "more records (%d) than original (%d) which is not allowed. "
                "Aborting recovery.",
                log_number, db_options_.wal_recovery_mode,
                db_options_.wal_filter->Name(), new_count, original_count);
            status = Status::NotSupported(
                "More than original # of records "
                "returned by Wal Filter ",
                db_options_.wal_filter->Name());
1235
            return status;
1236 1237 1238
          }
          // Set the same sequence number in the new_batch
          // as the original batch.
S
sdong 已提交
1239 1240
          WriteBatchInternal::SetSequence(&new_batch,
                                          WriteBatchInternal::Sequence(&batch));
1241
          batch = new_batch;
1242 1243
        }
      }
S
sdong 已提交
1244
#endif  // ROCKSDB_LITE
1245

S
Stanislau Hlebik 已提交
1246 1247 1248 1249 1250
      // 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
1251 1252 1253
      status =
          WriteBatchInternal::InsertInto(&batch, column_family_memtables_.get(),
                                         &flush_scheduler_, true, log_number);
S
Stanislau Hlebik 已提交
1254 1255 1256

      MaybeIgnoreError(&status);
      if (!status.ok()) {
1257 1258 1259 1260
        // 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 已提交
1261
      }
1262

S
Stanislau Hlebik 已提交
1263 1264
      const SequenceNumber last_seq = WriteBatchInternal::Sequence(&batch) +
                                      WriteBatchInternal::Count(&batch) - 1;
A
agiardullo 已提交
1265
      if ((*max_sequence == kMaxSequenceNumber) || (last_seq > *max_sequence)) {
S
Stanislau Hlebik 已提交
1266 1267 1268 1269
        *max_sequence = last_seq;
      }

      if (!read_only) {
I
Igor Canadi 已提交
1270 1271 1272 1273
        // 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;

1274
        while ((cfd = flush_scheduler_.TakeNextColumnFamily()) != nullptr) {
I
Igor Canadi 已提交
1275 1276 1277 1278 1279 1280 1281
          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;
1282
          status = WriteLevel0TableForRecovery(job_id, cfd, cfd->mem(), edit);
I
Igor Canadi 已提交
1283 1284 1285 1286
          if (!status.ok()) {
            // Reflect errors immediately so that conditions like full
            // file-systems cause the DB::Open() to fail.
            return status;
1287
          }
A
agiardullo 已提交
1288 1289 1290

          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
                                 *max_sequence);
1291
        }
J
jorlow@chromium.org 已提交
1292 1293 1294
      }
    }

1295
    if (!status.ok()) {
K
krad 已提交
1296
      if (db_options_.wal_recovery_mode ==
1297 1298 1299 1300
             WALRecoveryMode::kSkipAnyCorruptedRecords) {
        // We should ignore all errors unconditionally
        status = Status::OK();
      } else if (db_options_.wal_recovery_mode ==
K
krad 已提交
1301 1302 1303 1304 1305 1306 1307 1308
                 WALRecoveryMode::kPointInTimeRecovery) {
        // We should ignore the error but not continue replaying
        status = Status::OK();
        continue_replay_log = false;

        Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
            "Point in time recovered to log #%" PRIu64 " seq #%" PRIu64,
            log_number, *max_sequence);
1309 1310 1311 1312 1313
      } else {
        assert(db_options_.wal_recovery_mode ==
                  WALRecoveryMode::kTolerateCorruptedTailRecords
               || db_options_.wal_recovery_mode ==
                  WALRecoveryMode::kAbsoluteConsistency);
K
krad 已提交
1314 1315
        return status;
      }
1316 1317
    }

I
Igor Canadi 已提交
1318
    flush_scheduler_.Clear();
A
agiardullo 已提交
1319 1320
    if ((*max_sequence != kMaxSequenceNumber) &&
        (versions_->LastSequence() < *max_sequence)) {
S
Stanislau Hlebik 已提交
1321 1322
      versions_->SetLastSequence(*max_sequence);
    }
1323 1324
  }

1325
  if (!read_only) {
1326 1327
    // 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 已提交
1328
    auto max_log_number = log_numbers.back();
1329
    for (auto cfd : *versions_->GetColumnFamilySet()) {
1330
      auto iter = version_edits.find(cfd->GetID());
1331 1332 1333
      assert(iter != version_edits.end());
      VersionEdit* edit = &iter->second;

S
Stanislau Hlebik 已提交
1334
      if (cfd->GetLogNumber() > max_log_number) {
1335
        // Column family cfd has already flushed the data
S
Stanislau Hlebik 已提交
1336
        // from all logs. Memtable has to be empty because
1337
        // we filter the updates based on log_number
1338
        // (in WriteBatch::InsertInto)
1339 1340 1341 1342 1343 1344 1345
        assert(cfd->mem()->GetFirstSequenceNumber() == 0);
        assert(edit->NumEntries() == 0);
        continue;
      }

      // flush the final memtable (if non-empty)
      if (cfd->mem()->GetFirstSequenceNumber() != 0) {
1346
        status = WriteLevel0TableForRecovery(job_id, cfd, cfd->mem(), edit);
S
Stanislau Hlebik 已提交
1347 1348 1349 1350
        if (!status.ok()) {
          // Recovery failed
          break;
        }
A
agiardullo 已提交
1351 1352 1353

        cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
                               *max_sequence);
1354
      }
J
jorlow@chromium.org 已提交
1355

1356
      // write MANIFEST with update
S
Stanislau Hlebik 已提交
1357
      // writing log_number in the manifest means that any log file
1358 1359
      // with number strongly less than (log_number + 1) is already
      // recovered and should be ignored on next reincarnation.
S
Stanislau Hlebik 已提交
1360 1361 1362
      // Since we already recovered max_log_number, we want all logs
      // with numbers `<= max_log_number` (includes this one) to be ignored
      edit->SetLogNumber(max_log_number + 1);
1363 1364 1365
      // 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 已提交
1366
      // log number
1367
      versions_->MarkFileNumberUsedDuringRecovery(max_log_number + 1);
1368 1369
      status = versions_->LogAndApply(
          cfd, *cfd->GetLatestMutableCFOptions(), edit, &mutex_);
1370
      if (!status.ok()) {
S
Stanislau Hlebik 已提交
1371 1372
        // Recovery failed
        break;
1373 1374
      }
    }
1375
  }
I
Igor Canadi 已提交
1376

1377 1378 1379
  event_logger_.Log() << "job" << job_id << "event"
                      << "recovery_finished";

J
jorlow@chromium.org 已提交
1380 1381 1382
  return status;
}

1383 1384
Status DBImpl::WriteLevel0TableForRecovery(int job_id, ColumnFamilyData* cfd,
                                           MemTable* mem, VersionEdit* edit) {
J
jorlow@chromium.org 已提交
1385
  mutex_.AssertHeld();
1386
  const uint64_t start_micros = env_->NowMicros();
J
jorlow@chromium.org 已提交
1387
  FileMetaData meta;
1388
  meta.fd = FileDescriptor(versions_->NewFileNumber(), 0, 0);
I
Igor Canadi 已提交
1389 1390
  auto pending_outputs_inserted_elem =
      CaptureCurrentFileNumberInPendingOutputs();
1391 1392
  ReadOptions ro;
  ro.total_order_seek = true;
1393
  Arena arena;
1394
  Status s;
1395
  TableProperties table_properties;
1396
  {
1397
    ScopedArenaIterator iter(mem->NewIterator(ro, &arena));
1398 1399 1400
    Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
        "[%s] [WriteLevel0TableForRecovery]"
        " Level-0 table #%" PRIu64 ": started",
1401
        cfd->GetName().c_str(), meta.fd.GetNumber());
1402

1403 1404
    bool paranoid_file_checks =
        cfd->GetLatestMutableCFOptions()->paranoid_file_checks;
1405 1406
    {
      mutex_.Unlock();
1407
      TableFileCreationInfo info;
1408 1409 1410 1411 1412

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

1413 1414
      s = BuildTable(
          dbname_, env_, *cfd->ioptions(), env_options_, cfd->table_cache(),
1415
          iter.get(), &meta, cfd->internal_comparator(),
1416 1417 1418
          cfd->int_tbl_prop_collector_factories(), cfd->GetID(), snapshot_seqs,
          earliest_write_conflict_snapshot,
          GetCompressionFlush(*cfd->ioptions()),
1419 1420
          cfd->ioptions()->compression_opts, paranoid_file_checks,
          cfd->internal_stats(), Env::IO_HIGH, &info.table_properties);
1421
      LogFlush(db_options_.info_log);
1422 1423 1424 1425 1426 1427 1428 1429
      Log(InfoLogLevel::DEBUG_LEVEL, 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());

      // output to event logger
      if (s.ok()) {
1430 1431 1432 1433 1434 1435 1436 1437 1438
        info.db_name = dbname_;
        info.cf_name = cfd->GetName();
        info.file_path = TableFileName(db_options_.db_paths,
                                       meta.fd.GetNumber(),
                                       meta.fd.GetPathId());
        info.file_size = meta.fd.GetFileSize();
        info.job_id = job_id;
        EventHelpers::LogAndNotifyTableFileCreation(
            &event_logger_, db_options_.listeners, meta.fd, info);
1439
      }
1440 1441
      mutex_.Lock();
    }
1442
  }
I
Igor Canadi 已提交
1443
  ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);
1444 1445 1446 1447

  // Note that if file_size is zero, the file has been deleted and
  // should not be added to the manifest.
  int level = 0;
1448
  if (s.ok() && meta.fd.GetFileSize() > 0) {
1449 1450
    edit->AddFile(level, meta.fd.GetNumber(), meta.fd.GetPathId(),
                  meta.fd.GetFileSize(), meta.smallest, meta.largest,
1451 1452
                  meta.smallest_seqno, meta.largest_seqno,
                  meta.marked_for_compaction);
1453 1454
  }

L
Lei Jin 已提交
1455
  InternalStats::CompactionStats stats(1);
1456
  stats.micros = env_->NowMicros() - start_micros;
1457
  stats.bytes_written = meta.fd.GetFileSize();
1458
  stats.num_output_files = 1;
1459
  cfd->internal_stats()->AddCompactionStats(level, stats);
1460 1461
  cfd->internal_stats()->AddCFStats(
      InternalStats::BYTES_FLUSHED, meta.fd.GetFileSize());
L
Lei Jin 已提交
1462
  RecordTick(stats_, COMPACT_WRITE_BYTES, meta.fd.GetFileSize());
J
jorlow@chromium.org 已提交
1463 1464 1465
  return s;
}

1466 1467
Status DBImpl::FlushMemTableToOutputFile(
    ColumnFamilyData* cfd, const MutableCFOptions& mutable_cf_options,
1468
    bool* made_progress, JobContext* job_context, LogBuffer* log_buffer) {
1469
  mutex_.AssertHeld();
1470
  assert(cfd->imm()->NumNotFlushed() != 0);
1471
  assert(cfd->imm()->IsFlushPending());
1472

1473 1474 1475 1476 1477 1478 1479 1480 1481 1482
  SequenceNumber earliest_write_conflict_snapshot;
  std::vector<SequenceNumber> snapshot_seqs =
      snapshots_.GetAll(&earliest_write_conflict_snapshot);

  FlushJob flush_job(
      dbname_, cfd, db_options_, mutable_cf_options, env_options_,
      versions_.get(), &mutex_, &shutting_down_, snapshot_seqs,
      earliest_write_conflict_snapshot, job_context, log_buffer,
      directories_.GetDbDir(), directories_.GetDataDir(0U),
      GetCompressionFlush(*cfd->ioptions()), stats_, &event_logger_);
1483

1484
  FileMetaData file_meta;
1485 1486 1487 1488 1489 1490 1491

  // 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.
1492
  Status s = flush_job.Run(&file_meta);
J
jorlow@chromium.org 已提交
1493 1494

  if (s.ok()) {
I
Igor Canadi 已提交
1495 1496
    InstallSuperVersionAndScheduleWorkWrapper(cfd, job_context,
                                              mutable_cf_options);
1497 1498
    if (made_progress) {
      *made_progress = 1;
1499
    }
S
sdong 已提交
1500
    VersionStorageInfo::LevelSummaryStorage tmp;
I
Igor Canadi 已提交
1501
    LogToBuffer(log_buffer, "[%s] Level summary: %s\n", cfd->GetName().c_str(),
S
sdong 已提交
1502
                cfd->current()->storage_info()->LevelSummary(&tmp));
J
jorlow@chromium.org 已提交
1503
  }
1504

1505
  if (!s.ok() && !s.IsShutdownInProgress() && db_options_.paranoid_checks &&
1506 1507 1508 1509 1510
      bg_error_.ok()) {
    // if a bad error happened (not ShutdownInProgress) and paranoid_checks is
    // true, mark DB read-only
    bg_error_ = s;
  }
1511
  RecordFlushIOStats();
1512 1513 1514
#ifndef ROCKSDB_LITE
  if (s.ok()) {
    // may temporarily unlock and lock the mutex.
1515
    NotifyOnFlushCompleted(cfd, &file_meta, mutable_cf_options,
1516
                           job_context->job_id, flush_job.GetTableProperties());
1517 1518 1519 1520 1521 1522 1523 1524
    auto sfm =
        static_cast<SstFileManagerImpl*>(db_options_.sst_file_manager.get());
    if (sfm) {
      // Notify sst_file_manager that a new file was added
      std::string file_path = MakeTableFileName(db_options_.db_paths[0].path,
                                                file_meta.fd.GetNumber());
      sfm->OnAddFile(file_path);
    }
1525 1526
  }
#endif  // ROCKSDB_LITE
J
jorlow@chromium.org 已提交
1527 1528 1529
  return s;
}

1530 1531 1532 1533
void DBImpl::NotifyOnFlushCompleted(ColumnFamilyData* cfd,
                                    FileMetaData* file_meta,
                                    const MutableCFOptions& mutable_cf_options,
                                    int job_id, TableProperties prop) {
1534
#ifndef ROCKSDB_LITE
1535
  if (db_options_.listeners.size() == 0U) {
1536 1537
    return;
  }
1538 1539 1540 1541
  mutex_.AssertHeld();
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }
1542
  bool triggered_writes_slowdown =
1543
      (cfd->current()->storage_info()->NumLevelFiles(0) >=
1544
       mutable_cf_options.level0_slowdown_writes_trigger);
1545
  bool triggered_writes_stop =
1546
      (cfd->current()->storage_info()->NumLevelFiles(0) >=
1547
       mutable_cf_options.level0_stop_writes_trigger);
1548 1549
  // release lock while notifying events
  mutex_.Unlock();
1550
  {
1551 1552 1553 1554 1555
    FlushJobInfo info;
    info.cf_name = cfd->GetName();
    // TODO(yhchiang): make db_paths dynamic in case flush does not
    //                 go to L0 in the future.
    info.file_path = MakeTableFileName(db_options_.db_paths[0].path,
1556
                                       file_meta->fd.GetNumber());
1557
    info.thread_id = env_->GetThreadID();
1558 1559 1560
    info.job_id = job_id;
    info.triggered_writes_slowdown = triggered_writes_slowdown;
    info.triggered_writes_stop = triggered_writes_stop;
1561 1562
    info.smallest_seqno = file_meta->smallest_seqno;
    info.largest_seqno = file_meta->largest_seqno;
1563
    info.table_properties = prop;
1564
    for (auto listener : db_options_.listeners) {
1565
      listener->OnFlushCompleted(this, info);
1566 1567
    }
  }
1568 1569 1570
  mutex_.Lock();
  // no need to signal bg_cv_ as it will be signaled at the end of the
  // flush process.
1571
#endif  // ROCKSDB_LITE
1572 1573
}

1574 1575 1576 1577
Status DBImpl::CompactRange(const CompactRangeOptions& options,
                            ColumnFamilyHandle* column_family,
                            const Slice* begin, const Slice* end) {
  if (options.target_path_id >= db_options_.db_paths.size()) {
1578 1579 1580
    return Status::InvalidArgument("Invalid target path ID");
  }

1581 1582
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
1583
  bool exclusive = options.exclusive_manual_compaction;
I
Igor Canadi 已提交
1584 1585

  Status s = FlushMemTable(cfd, FlushOptions());
L
Lei Jin 已提交
1586
  if (!s.ok()) {
1587
    LogFlush(db_options_.info_log);
L
Lei Jin 已提交
1588 1589 1590
    return s;
  }

I
Igor Canadi 已提交
1591
  int max_level_with_files = 0;
G
Gabor Cselle 已提交
1592
  {
1593
    InstrumentedMutexLock l(&mutex_);
I
Igor Canadi 已提交
1594
    Version* base = cfd->current();
1595 1596
    for (int level = 1; level < base->storage_info()->num_non_empty_levels();
         level++) {
S
sdong 已提交
1597
      if (base->storage_info()->OverlapInLevel(level, begin, end)) {
G
Gabor Cselle 已提交
1598 1599 1600 1601
        max_level_with_files = level;
      }
    }
  }
1602

1603
  int final_output_level = 0;
1604 1605 1606 1607
  if (cfd->ioptions()->compaction_style == kCompactionStyleUniversal &&
      cfd->NumberLevels() > 1) {
    // Always compact all files together.
    s = RunManualCompaction(cfd, ColumnFamilyData::kCompactAllLevels,
1608
                            cfd->NumberLevels() - 1, options.target_path_id,
1609
                            begin, end, exclusive);
1610
    final_output_level = cfd->NumberLevels() - 1;
1611 1612
  } else {
    for (int level = 0; level <= max_level_with_files; level++) {
1613
      int output_level;
A
Andres Notzli 已提交
1614
      // in case the compaction is universal or if we're compacting the
1615 1616 1617 1618
      // 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 ||
1619 1620 1621
          cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
        output_level = level;
      } else if (level == max_level_with_files && level > 0) {
1622 1623 1624 1625 1626 1627 1628
        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 已提交
1629
                   cfd->ioptions()->compaction_filter_factory == nullptr) {
A
Andres Notzli 已提交
1630 1631
          // Skip bottommost level compaction since we don't have a compaction
          // filter
1632 1633
          continue;
        }
1634
        output_level = level;
1635
      } else {
1636
        output_level = level + 1;
1637 1638 1639 1640 1641
        if (cfd->ioptions()->compaction_style == kCompactionStyleLevel &&
            cfd->ioptions()->level_compaction_dynamic_level_bytes &&
            level == 0) {
          output_level = ColumnFamilyData::kCompactToBaseLevel;
        }
1642
      }
1643
      s = RunManualCompaction(cfd, level, output_level, options.target_path_id,
1644
                              begin, end, exclusive);
1645 1646 1647
      if (!s.ok()) {
        break;
      }
1648 1649 1650 1651 1652
      if (output_level == ColumnFamilyData::kCompactToBaseLevel) {
        final_output_level = cfd->NumberLevels() - 1;
      } else if (output_level > final_output_level) {
        final_output_level = output_level;
      }
1653 1654
      TEST_SYNC_POINT("DBImpl::RunManualCompaction()::1");
      TEST_SYNC_POINT("DBImpl::RunManualCompaction()::2");
1655
    }
G
Gabor Cselle 已提交
1656
  }
1657 1658 1659 1660
  if (!s.ok()) {
    LogFlush(db_options_.info_log);
    return s;
  }
1661

1662
  if (options.change_level) {
1663 1664 1665 1666 1667 1668 1669
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
        "[RefitLevel] waiting for background threads to stop");
    s = PauseBackgroundWork();
    if (s.ok()) {
      s = ReFitLevel(cfd, final_output_level, options.target_level);
    }
    ContinueBackgroundWork();
1670
  }
1671
  LogFlush(db_options_.info_log);
L
Lei Jin 已提交
1672

1673
  {
1674
    InstrumentedMutexLock l(&mutex_);
1675 1676 1677 1678 1679
    // an automatic compaction that has been scheduled might have been
    // preempted by the manual compactions. Need to schedule it back.
    MaybeScheduleFlushOrCompaction();
  }

L
Lei Jin 已提交
1680
  return s;
1681 1682
}

1683 1684 1685 1686 1687
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 已提交
1688 1689 1690 1691
#ifdef ROCKSDB_LITE
    // not supported in lite version
  return Status::NotSupported("Not supported in ROCKSDB LITE");
#else
1692 1693 1694 1695 1696 1697
  if (column_family == nullptr) {
    return Status::InvalidArgument("ColumnFamilyHandle must be non-null.");
  }

  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  assert(cfd);
1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722

  Status s;
  JobContext job_context(0, true);
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL,
                       db_options_.info_log.get());

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

    s = CompactFilesImpl(compact_options, cfd, sv->current,
                         input_file_names, output_level,
                         output_path_id, &job_context, &log_buffer);
  }
  ReturnAndCleanupSuperVersion(cfd, sv);

  // Find and delete obsolete files
  {
    InstrumentedMutexLock l(&mutex_);
    // If !s.ok(), this means that Compaction failed. In that case, we want
    // to delete all obsolete files we might have created and we force
    // FindObsoleteFiles(). This is because job_context does not
    // catch all created files if compaction failed.
    FindObsoleteFiles(&job_context, !s.ok());
1723
  }  // release the mutex
1724 1725 1726 1727 1728 1729 1730 1731 1732 1733

  // 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()) {
1734
      // no mutex is locked here.  No need to Unlock() and Lock() here.
1735 1736 1737 1738 1739
      PurgeObsoleteFiles(job_context);
    }
    job_context.Clean();
  }

1740
  return s;
I
Igor Canadi 已提交
1741
#endif  // ROCKSDB_LITE
1742 1743
}

I
Igor Canadi 已提交
1744
#ifndef ROCKSDB_LITE
1745 1746 1747
Status DBImpl::CompactFilesImpl(
    const CompactionOptions& compact_options, ColumnFamilyData* cfd,
    Version* version, const std::vector<std::string>& input_file_names,
1748 1749
    const int output_level, int output_path_id, JobContext* job_context,
    LogBuffer* log_buffer) {
1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781
  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) {
    if (db_options_.db_paths.size() == 1U) {
      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;
  }

1782
  std::vector<CompactionInputFiles> input_files;
1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802
  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(
1803 1804
      compact_options, input_files, output_level, version->storage_info(),
      *cfd->GetLatestMutableCFOptions(), output_path_id));
1805 1806 1807
  if (!c) {
    return Status::Aborted("Another Level 0 compaction is running");
  }
1808 1809
  c->SetInputVersion(version);
  // deletion compaction currently not allowed in CompactFiles.
1810
  assert(!c->deletion_compaction());
1811

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

I
Igor Canadi 已提交
1816
  assert(is_snapshot_supported_ || snapshots_.empty());
1817
  CompactionJob compaction_job(
I
Igor Canadi 已提交
1818 1819
      job_context->job_id, c.get(), db_options_, env_options_, versions_.get(),
      &shutting_down_, log_buffer, directories_.GetDbDir(),
1820 1821
      directories_.GetDataDir(c->output_path_id()), stats_, snapshot_seqs,
      earliest_write_conflict_snapshot, table_cache_, &event_logger_,
1822 1823
      c->mutable_cf_options()->paranoid_file_checks,
      c->mutable_cf_options()->compaction_measure_io_stats, dbname_,
1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836
      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.
1837 1838 1839
  compaction_job.Prepare();

  mutex_.Unlock();
1840 1841
  TEST_SYNC_POINT("CompactFilesImpl:0");
  TEST_SYNC_POINT("CompactFilesImpl:1");
1842
  compaction_job.Run();
1843
  mutex_.Lock();
1844

1845
  Status status = compaction_job.Install(*c->mutable_cf_options(), &mutex_);
1846
  if (status.ok()) {
I
Igor Canadi 已提交
1847 1848
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
1849 1850 1851 1852 1853 1854 1855 1856 1857
  }
  c->ReleaseCompactionFiles(s);
  c.reset();

  if (status.ok()) {
    // Done
  } else if (status.IsShutdownInProgress()) {
    // Ignore compaction errors found during shutting down
  } else {
1858 1859
    Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
        "[%s] [JOB %d] Compaction error: %s",
1860
        c->column_family_data()->GetName().c_str(), job_context->job_id,
1861 1862 1863 1864 1865 1866 1867
        status.ToString().c_str());
    if (db_options_.paranoid_checks && bg_error_.ok()) {
      bg_error_ = status;
    }
  }

  bg_compaction_scheduled_--;
1868 1869 1870
  if (bg_compaction_scheduled_ == 0) {
    bg_cv_.SignalAll();
  }
1871 1872 1873

  return status;
}
I
Igor Canadi 已提交
1874
#endif  // ROCKSDB_LITE
1875

1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886
Status DBImpl::PauseBackgroundWork() {
  InstrumentedMutexLock guard_lock(&mutex_);
  bg_work_paused_++;
  while (bg_compaction_scheduled_ > 0 || bg_flush_scheduled_ > 0) {
    bg_cv_.Wait();
  }
  return Status::OK();
}

Status DBImpl::ContinueBackgroundWork() {
  InstrumentedMutexLock guard_lock(&mutex_);
1887 1888 1889
  if (bg_work_paused_ == 0) {
    return Status::InvalidArgument();
  }
1890 1891 1892 1893 1894 1895 1896 1897
  assert(bg_work_paused_ > 0);
  bg_work_paused_--;
  if (bg_work_paused_ == 0) {
    MaybeScheduleFlushOrCompaction();
  }
  return Status::OK();
}

O
Ori Bernstein 已提交
1898
void DBImpl::NotifyOnCompactionCompleted(
1899 1900
    ColumnFamilyData* cfd, Compaction *c, const Status &st,
    const CompactionJobStats& compaction_job_stats,
1901
    const int job_id) {
O
Ori Bernstein 已提交
1902
#ifndef ROCKSDB_LITE
1903
  if (db_options_.listeners.size() == 0U) {
O
Ori Bernstein 已提交
1904 1905 1906 1907 1908 1909 1910 1911
    return;
  }
  mutex_.AssertHeld();
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }
  // release lock while notifying events
  mutex_.Unlock();
1912 1913 1914 1915
  {
    CompactionJobInfo info;
    info.cf_name = cfd->GetName();
    info.status = st;
1916
    info.thread_id = env_->GetThreadID();
1917 1918
    info.job_id = job_id;
    info.base_input_level = c->start_level();
1919
    info.output_level = c->output_level();
1920
    info.stats = compaction_job_stats;
1921
    info.table_properties = c->GetOutputTableProperties();
1922
    info.compaction_reason = c->compaction_reason();
1923 1924
    for (size_t i = 0; i < c->num_input_levels(); ++i) {
      for (const auto fmd : *c->inputs(i)) {
1925 1926 1927 1928 1929
        auto fn = TableFileName(db_options_.db_paths, fmd->fd.GetNumber(),
                                fmd->fd.GetPathId());
        info.input_files.push_back(fn);
        if (info.table_properties.count(fn) == 0) {
          std::shared_ptr<const TableProperties> tp;
1930
          auto s = cfd->current()->GetTableProperties(&tp, fmd, &fn);
1931 1932 1933 1934
          if (s.ok()) {
            info.table_properties[fn] = tp;
          }
        }
1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946
      }
    }
    for (const auto newf : c->edit()->GetNewFiles()) {
      info.output_files.push_back(
          TableFileName(db_options_.db_paths,
                        newf.second.fd.GetNumber(),
                        newf.second.fd.GetPathId()));
    }
    for (auto listener : db_options_.listeners) {
      listener->OnCompactionCompleted(this, info);
    }
  }
O
Ori Bernstein 已提交
1947 1948 1949 1950 1951 1952
  mutex_.Lock();
  // no need to signal bg_cv_ as it will be signaled at the end of the
  // flush process.
#endif  // ROCKSDB_LITE
}

1953
Status DBImpl::SetOptions(ColumnFamilyHandle* column_family,
1954
    const std::unordered_map<std::string, std::string>& options_map) {
I
Igor Canadi 已提交
1955 1956 1957
#ifdef ROCKSDB_LITE
  return Status::NotSupported("Not supported in ROCKSDB LITE");
#else
L
Lei Jin 已提交
1958 1959
  auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  if (options_map.empty()) {
1960 1961
    Log(InfoLogLevel::WARN_LEVEL,
        db_options_.info_log, "SetOptions() on column family [%s], empty input",
L
Lei Jin 已提交
1962
        cfd->GetName().c_str());
1963
    return Status::InvalidArgument("empty input");
L
Lei Jin 已提交
1964 1965 1966
  }

  MutableCFOptions new_options;
1967
  Status s;
1968
  Status persist_options_status;
L
Lei Jin 已提交
1969
  {
1970
    InstrumentedMutexLock l(&mutex_);
1971 1972
    s = cfd->SetOptions(options_map);
    if (s.ok()) {
L
Lei Jin 已提交
1973 1974
      new_options = *cfd->GetLatestMutableCFOptions();
    }
1975 1976 1977 1978 1979 1980 1981 1982
    if (s.ok()) {
      // Persist RocksDB options under the single write thread
      WriteThread::Writer w;
      write_thread_.EnterUnbatched(&w, &mutex_);

      persist_options_status = WriteOptionsFile();

      write_thread_.ExitUnbatched(&w);
1983 1984
    }
  }
L
Lei Jin 已提交
1985

1986 1987
  Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
      "SetOptions() on column family [%s], inputs:",
L
Lei Jin 已提交
1988 1989
      cfd->GetName().c_str());
  for (const auto& o : options_map) {
1990 1991
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
        "%s: %s\n", o.first.c_str(), o.second.c_str());
L
Lei Jin 已提交
1992
  }
1993
  if (s.ok()) {
1994 1995
    Log(InfoLogLevel::INFO_LEVEL,
        db_options_.info_log, "[%s] SetOptions succeeded",
L
Lei Jin 已提交
1996 1997
        cfd->GetName().c_str());
    new_options.Dump(db_options_.info_log.get());
1998 1999 2000 2001 2002 2003 2004 2005 2006 2007
    if (!persist_options_status.ok()) {
      if (db_options_.fail_if_options_file_error) {
        s = Status::IOError(
            "SetOptions succeeded, but unable to persist options",
            persist_options_status.ToString());
      }
      Warn(db_options_.info_log,
           "Unable to persist options in SetOptions() -- %s",
           persist_options_status.ToString().c_str());
    }
L
Lei Jin 已提交
2008
  } else {
2009 2010
    Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
        "[%s] SetOptions failed", cfd->GetName().c_str());
L
Lei Jin 已提交
2011
  }
S
sdong 已提交
2012
  LogFlush(db_options_.info_log);
2013
  return s;
I
Igor Canadi 已提交
2014
#endif  // ROCKSDB_LITE
2015 2016
}

2017
// return the same level if it cannot be moved
2018 2019
int DBImpl::FindMinimumEmptyLevelFitting(ColumnFamilyData* cfd,
    const MutableCFOptions& mutable_cf_options, int level) {
2020
  mutex_.AssertHeld();
S
sdong 已提交
2021
  const auto* vstorage = cfd->current()->storage_info();
2022
  int minimum_level = level;
2023
  for (int i = level - 1; i > 0; --i) {
2024
    // stop if level i is not empty
S
sdong 已提交
2025
    if (vstorage->NumLevelFiles(i) > 0) break;
2026
    // stop if level i is too small (cannot fit the level files)
2027
    if (vstorage->MaxBytesForLevel(i) < vstorage->NumLevelBytes(level)) {
2028 2029
      break;
    }
2030 2031 2032 2033 2034 2035

    minimum_level = i;
  }
  return minimum_level;
}

2036 2037
// REQUIREMENT: block all background work by calling PauseBackgroundWork()
// before calling this function
I
Igor Canadi 已提交
2038 2039
Status DBImpl::ReFitLevel(ColumnFamilyData* cfd, int level, int target_level) {
  assert(level < cfd->NumberLevels());
2040 2041 2042
  if (target_level >= cfd->NumberLevels()) {
    return Status::InvalidArgument("Target level exceeds number of levels");
  }
2043

2044 2045 2046 2047
  std::unique_ptr<SuperVersion> superversion_to_free;
  std::unique_ptr<SuperVersion> new_superversion(new SuperVersion());

  Status status;
I
Igor Canadi 已提交
2048

I
Islam AbdelRahman 已提交
2049
  InstrumentedMutexLock guard_lock(&mutex_);
2050 2051 2052

  // only allow one thread refitting
  if (refitting_level_) {
2053 2054
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
        "[ReFitLevel] another thread is refitting");
L
Lei Jin 已提交
2055
    return Status::NotSupported("another thread is refitting");
2056 2057 2058
  }
  refitting_level_ = true;

2059
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
2060
  // move to a smaller level
2061 2062
  int to_level = target_level;
  if (target_level < 0) {
2063
    to_level = FindMinimumEmptyLevelFitting(cfd, mutable_cf_options, level);
2064
  }
2065

2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080
  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) {
2081
    Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
2082 2083
        "[%s] Before refitting:\n%s", cfd->GetName().c_str(),
        cfd->current()->DebugString().data());
2084

2085
    VersionEdit edit;
I
Igor Canadi 已提交
2086
    edit.SetColumnFamily(cfd->GetID());
2087
    for (const auto& f : vstorage->LevelFiles(level)) {
2088
      edit.DeleteFile(level, f->fd.GetNumber());
2089 2090
      edit.AddFile(to_level, f->fd.GetNumber(), f->fd.GetPathId(),
                   f->fd.GetFileSize(), f->smallest, f->largest,
2091 2092
                   f->smallest_seqno, f->largest_seqno,
                   f->marked_for_compaction);
2093
    }
2094
    Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
2095 2096
        "[%s] Apply version edit:\n%s", cfd->GetName().c_str(),
        edit.DebugString().data());
2097

2098 2099
    status = versions_->LogAndApply(cfd, mutable_cf_options, &edit, &mutex_,
                                    directories_.GetDbDir());
2100 2101
    superversion_to_free.reset(InstallSuperVersionAndScheduleWork(
        cfd, new_superversion.release(), mutable_cf_options));
2102

2103 2104
    Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
        "[%s] LogAndApply: %s\n", cfd->GetName().c_str(),
I
Igor Canadi 已提交
2105
        status.ToString().data());
2106 2107

    if (status.ok()) {
2108
      Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
2109 2110
          "[%s] After refitting:\n%s", cfd->GetName().c_str(),
          cfd->current()->DebugString().data());
2111 2112 2113 2114
    }
  }

  refitting_level_ = false;
I
Igor Canadi 已提交
2115

L
Lei Jin 已提交
2116
  return status;
G
Gabor Cselle 已提交
2117 2118
}

2119 2120 2121
int DBImpl::NumberLevels(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->NumberLevels();
2122 2123
}

2124
int DBImpl::MaxMemCompactionLevel(ColumnFamilyHandle* column_family) {
2125
  return 0;
2126 2127
}

2128 2129
int DBImpl::Level0StopWriteTrigger(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
2130
  InstrumentedMutexLock l(&mutex_);
L
Lei Jin 已提交
2131 2132
  return cfh->cfd()->GetSuperVersion()->
      mutable_cf_options.level0_stop_writes_trigger;
2133 2134
}

L
Lei Jin 已提交
2135
Status DBImpl::Flush(const FlushOptions& flush_options,
2136 2137
                     ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
L
Lei Jin 已提交
2138
  return FlushMemTable(cfh->cfd(), flush_options);
H
heyongqiang 已提交
2139 2140
}

2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172
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(
          "SyncWAL() is not supported for this implementation of WAL file",
          db_options_.allow_mmap_writes
            ? "try setting Options::allow_mmap_writes to false"
            : Slice());
      }
    }
    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;
2173
      logs_to_sync.push_back(log.writer);
2174 2175 2176 2177 2178
    }

    need_log_dir_sync = !log_dir_synced_;
  }

2179
  RecordTick(stats_, WAL_FILE_SYNCED);
2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210
  Status status;
  for (log::Writer* log : logs_to_sync) {
    status = log->file()->SyncWithoutFlush(db_options_.use_fsync);
    if (!status.ok()) {
      break;
    }
  }
  if (status.ok() && need_log_dir_sync) {
    status = directories_.GetWalDir()->Fsync();
  }

  {
    InstrumentedMutexLock l(&mutex_);
    MarkLogsSynced(current_log_number, need_log_dir_sync, status);
  }

  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) {
2211
      logs_to_free_.push_back(log.ReleaseWriter());
A
Andres Noetzli 已提交
2212
      it = logs_.erase(it);
2213 2214 2215 2216 2217
    } else {
      log.getting_synced = false;
      ++it;
    }
  }
A
Andres Noetzli 已提交
2218
  assert(logs_.empty() || (logs_.size() == 1 && !logs_[0].getting_synced));
2219 2220 2221
  log_sync_cv_.SignalAll();
}

2222
SequenceNumber DBImpl::GetLatestSequenceNumber() const {
2223 2224 2225
  return versions_->LastSequence();
}

I
Igor Canadi 已提交
2226
Status DBImpl::RunManualCompaction(ColumnFamilyData* cfd, int input_level,
2227
                                   int output_level, uint32_t output_path_id,
2228
                                   const Slice* begin, const Slice* end,
2229
                                   bool exclusive, bool disallow_trivial_move) {
2230 2231
  assert(input_level == ColumnFamilyData::kCompactAllLevels ||
         input_level >= 0);
2232

G
Gabor Cselle 已提交
2233
  InternalKey begin_storage, end_storage;
2234
  CompactionArg* ca;
G
Gabor Cselle 已提交
2235

2236 2237
  bool scheduled = false;
  bool manual_conflict = false;
H
hans@chromium.org 已提交
2238
  ManualCompaction manual;
I
Igor Canadi 已提交
2239
  manual.cfd = cfd;
2240 2241
  manual.input_level = input_level;
  manual.output_level = output_level;
2242
  manual.output_path_id = output_path_id;
G
Gabor Cselle 已提交
2243
  manual.done = false;
2244
  manual.in_progress = false;
2245 2246
  manual.incomplete = false;
  manual.exclusive = exclusive;
2247
  manual.disallow_trivial_move = disallow_trivial_move;
2248 2249 2250
  // For universal compaction, we enforce every manual compaction to compact
  // all files.
  if (begin == nullptr ||
2251 2252
      cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
      cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
2253
    manual.begin = nullptr;
G
Gabor Cselle 已提交
2254
  } else {
2255
    begin_storage.SetMaxPossibleForUserKey(*begin);
G
Gabor Cselle 已提交
2256 2257
    manual.begin = &begin_storage;
  }
2258
  if (end == nullptr ||
2259 2260
      cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
      cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
2261
    manual.end = nullptr;
G
Gabor Cselle 已提交
2262
  } else {
2263
    end_storage.SetMinPossibleForUserKey(*end);
G
Gabor Cselle 已提交
2264 2265 2266
    manual.end = &end_storage;
  }

2267
  InstrumentedMutexLock l(&mutex_);
2268

2269 2270 2271 2272 2273
  // 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.
  //
2274
  // HasPendingManualCompaction() is true when at least one thread is inside
2275
  // RunManualCompaction(), i.e. during that time no other compaction will
2276 2277 2278
  // get scheduled (see MaybeScheduleFlushOrCompaction).
  //
  // Note that the following loop doesn't stop more that one thread calling
2279
  // RunManualCompaction() from getting to the second while loop below.
2280 2281 2282
  // However, only one of them will actually schedule compaction, while
  // others will wait on a condition variable until it completes.

2283 2284 2285 2286 2287 2288 2289 2290 2291 2292
  AddManualCompaction(&manual);
  TEST_SYNC_POINT_CALLBACK("DBImpl::RunManualCompaction:NotScheduled", &mutex_);
  if (exclusive) {
    while (bg_compaction_scheduled_ > 0) {
      Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
          "[%s] Manual compaction waiting for all other scheduled background "
          "compactions to finish",
          cfd->GetName().c_str());
      bg_cv_.Wait();
    }
2293
  }
2294

2295 2296
  Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
      "[%s] Manual compaction starting",
I
Igor Canadi 已提交
2297
      cfd->GetName().c_str());
2298

2299 2300 2301 2302
  // 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) {
2303 2304
    assert(HasPendingManualCompaction());
    manual_conflict = false;
2305
    if (ShouldntRunManualCompaction(&manual) || (manual.in_progress == true) ||
2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316
        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);
2317
      // Running either this or some other manual compaction
G
Gabor Cselle 已提交
2318
      bg_cv_.Wait();
2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333
      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;
2334
      bg_compaction_scheduled_++;
2335 2336 2337
      env_->Schedule(&DBImpl::BGWorkCompaction, ca, Env::Priority::LOW, this,
                     &DBImpl::UnscheduleCallback);
      scheduled = true;
G
Gabor Cselle 已提交
2338
    }
H
hans@chromium.org 已提交
2339
  }
2340

2341
  assert(!manual.in_progress);
2342 2343
  assert(HasPendingManualCompaction());
  RemoveManualCompaction(&manual);
2344
  bg_cv_.SignalAll();
L
Lei Jin 已提交
2345
  return manual.status;
J
jorlow@chromium.org 已提交
2346 2347
}

2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364
InternalIterator* DBImpl::NewInternalIterator(
    Arena* arena, ColumnFamilyHandle* column_family) {
  ColumnFamilyData* cfd;
  if (column_family == nullptr) {
    cfd = default_cf_handle_->cfd();
  } else {
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
    cfd = cfh->cfd();
  }

  mutex_.Lock();
  SuperVersion* super_version = cfd->GetSuperVersion()->Ref();
  mutex_.Unlock();
  ReadOptions roptions;
  return NewInternalIterator(roptions, cfd, super_version, arena);
}

2365
Status DBImpl::FlushMemTable(ColumnFamilyData* cfd,
L
Lei Jin 已提交
2366
                             const FlushOptions& flush_options) {
S
Stanislau Hlebik 已提交
2367 2368 2369
  Status s;
  {
    WriteContext context;
2370
    InstrumentedMutexLock guard_lock(&mutex_);
2371

2372
    if (cfd->imm()->NumNotFlushed() == 0 && cfd->mem()->IsEmpty()) {
2373 2374 2375 2376
      // Nothing to flush
      return Status::OK();
    }

2377 2378
    WriteThread::Writer w;
    write_thread_.EnterUnbatched(&w, &mutex_);
S
Stanislau Hlebik 已提交
2379

I
Igor Canadi 已提交
2380
    // SwitchMemtable() will release and reacquire mutex
S
Stanislau Hlebik 已提交
2381
    // during execution
I
Igor Canadi 已提交
2382
    s = SwitchMemtable(cfd, &context);
2383
    write_thread_.ExitUnbatched(&w);
2384

S
Stanislau Hlebik 已提交
2385 2386
    cfd->imm()->FlushRequested();

2387 2388 2389
    // schedule flush
    SchedulePendingFlush(cfd);
    MaybeScheduleFlushOrCompaction();
S
Stanislau Hlebik 已提交
2390
  }
S
Stanislau Hlebik 已提交
2391

L
Lei Jin 已提交
2392
  if (s.ok() && flush_options.wait) {
2393
    // Wait until the compaction completes
2394
    s = WaitForFlushMemTable(cfd);
2395 2396
  }
  return s;
J
jorlow@chromium.org 已提交
2397 2398
}

2399
Status DBImpl::WaitForFlushMemTable(ColumnFamilyData* cfd) {
2400 2401
  Status s;
  // Wait until the compaction completes
2402
  InstrumentedMutexLock l(&mutex_);
2403
  while (cfd->imm()->NumNotFlushed() > 0 && bg_error_.ok()) {
2404 2405 2406
    if (shutting_down_.load(std::memory_order_acquire)) {
      return Status::ShutdownInProgress();
    }
2407 2408
    bg_cv_.Wait();
  }
2409
  if (!bg_error_.ok()) {
2410 2411 2412
    s = bg_error_;
  }
  return s;
H
heyongqiang 已提交
2413 2414
}

2415 2416 2417 2418
Status DBImpl::EnableAutoCompaction(
    const std::vector<ColumnFamilyHandle*>& column_family_handles) {
  Status s;
  for (auto cf_ptr : column_family_handles) {
2419 2420 2421 2422 2423 2424 2425 2426 2427 2428
    Status status =
        this->SetOptions(cf_ptr, {{"disable_auto_compactions", "false"}});
    if (status.ok()) {
      ColumnFamilyData* cfd =
          reinterpret_cast<ColumnFamilyHandleImpl*>(cf_ptr)->cfd();
      InstrumentedMutexLock guard_lock(&mutex_);
      delete this->InstallSuperVersionAndScheduleWork(
          cfd, nullptr, *cfd->GetLatestMutableCFOptions());
    } else {
      s = status;
2429 2430 2431 2432 2433 2434
    }
  }

  return s;
}

2435
void DBImpl::MaybeScheduleFlushOrCompaction() {
J
jorlow@chromium.org 已提交
2436
  mutex_.AssertHeld();
2437 2438 2439 2440
  if (!opened_successfully_) {
    // Compaction may introduce data race to DB open
    return;
  }
2441 2442
  if (bg_work_paused_ > 0) {
    // we paused the background work
2443
    return;
I
Igor Canadi 已提交
2444
  } else if (shutting_down_.load(std::memory_order_acquire)) {
J
jorlow@chromium.org 已提交
2445
    // DB is being deleted; no more background compactions
2446 2447
    return;
  }
2448

2449 2450 2451 2452
  while (unscheduled_flushes_ > 0 &&
         bg_flush_scheduled_ < db_options_.max_background_flushes) {
    unscheduled_flushes_--;
    bg_flush_scheduled_++;
2453
    env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::HIGH, this);
2454 2455
  }

2456 2457
  auto bg_compactions_allowed = BGCompactionsAllowed();

2458 2459 2460 2461 2462
  // special case -- if max_background_flushes == 0, then schedule flush on a
  // compaction thread
  if (db_options_.max_background_flushes == 0) {
    while (unscheduled_flushes_ > 0 &&
           bg_flush_scheduled_ + bg_compaction_scheduled_ <
2463
               bg_compactions_allowed) {
2464 2465 2466 2467 2468 2469
      unscheduled_flushes_--;
      bg_flush_scheduled_++;
      env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::LOW, this);
    }
  }

2470
  if (HasExclusiveManualCompaction()) {
2471 2472 2473 2474 2475
    // only manual compactions are allowed to run. don't schedule automatic
    // compactions
    return;
  }

2476
  while (bg_compaction_scheduled_ < bg_compactions_allowed &&
2477
         unscheduled_compactions_ > 0) {
2478 2479 2480
    CompactionArg* ca = new CompactionArg;
    ca->db = this;
    ca->m = nullptr;
2481 2482
    bg_compaction_scheduled_++;
    unscheduled_compactions_--;
2483 2484
    env_->Schedule(&DBImpl::BGWorkCompaction, ca, Env::Priority::LOW, this,
                   &DBImpl::UnscheduleCallback);
2485 2486 2487
  }
}

2488 2489 2490 2491 2492 2493 2494 2495
int DBImpl::BGCompactionsAllowed() const {
  if (write_controller_.NeedSpeedupCompaction()) {
    return db_options_.max_background_compactions;
  } else {
    return db_options_.base_background_compactions;
  }
}

2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538
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_;
2539 2540 2541
  }
}

2542
void DBImpl::RecordFlushIOStats() {
I
Igor Canadi 已提交
2543
  RecordTick(stats_, FLUSH_WRITE_BYTES, IOSTATS(bytes_written));
2544 2545 2546
  IOSTATS_RESET(bytes_written);
}

2547
void DBImpl::BGWorkFlush(void* db) {
2548
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
2549
  TEST_SYNC_POINT("DBImpl::BGWorkFlush");
2550
  reinterpret_cast<DBImpl*>(db)->BackgroundCallFlush();
2551
  TEST_SYNC_POINT("DBImpl::BGWorkFlush:done");
2552 2553
}

2554 2555 2556
void DBImpl::BGWorkCompaction(void* arg) {
  CompactionArg ca = *(reinterpret_cast<CompactionArg*>(arg));
  delete reinterpret_cast<CompactionArg*>(arg);
2557
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::LOW);
2558
  TEST_SYNC_POINT("DBImpl::BGWorkCompaction");
2559 2560 2561 2562 2563 2564 2565 2566 2567 2568
  reinterpret_cast<DBImpl*>(ca.db)->BackgroundCallCompaction(ca.m);
}

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

2571
Status DBImpl::BackgroundFlush(bool* made_progress, JobContext* job_context,
H
Haobo Xu 已提交
2572
                               LogBuffer* log_buffer) {
2573
  mutex_.AssertHeld();
2574

2575 2576 2577 2578 2579 2580 2581
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

  if (!status.ok()) {
    return status;
2582 2583
  }

2584 2585 2586
  ColumnFamilyData* cfd = nullptr;
  while (!flush_queue_.empty()) {
    // This cfd is already referenced
I
Igor Canadi 已提交
2587
    auto first_cfd = PopFirstFromFlushQueue();
2588

I
Igor Canadi 已提交
2589
    if (first_cfd->IsDropped() || !first_cfd->imm()->IsFlushPending()) {
2590
      // can't flush this CF, try next one
I
Igor Canadi 已提交
2591 2592
      if (first_cfd->Unref()) {
        delete first_cfd;
2593 2594
      }
      continue;
2595
    }
2596 2597

    // found a flush!
I
Igor Canadi 已提交
2598
    cfd = first_cfd;
2599 2600 2601 2602 2603 2604 2605 2606 2607
    break;
  }

  if (cfd != nullptr) {
    const MutableCFOptions mutable_cf_options =
        *cfd->GetLatestMutableCFOptions();
    LogToBuffer(
        log_buffer,
        "Calling FlushMemTableToOutputFile with column "
2608 2609 2610 2611
        "family [%s], flush slots available %d, compaction slots allowed %d, "
        "compaction slots scheduled %d",
        cfd->GetName().c_str(), db_options_.max_background_flushes,
        bg_flush_scheduled_, BGCompactionsAllowed() - bg_compaction_scheduled_);
2612
    status = FlushMemTableToOutputFile(cfd, mutable_cf_options, made_progress,
2613 2614 2615
                                       job_context, log_buffer);
    if (cfd->Unref()) {
      delete cfd;
2616
    }
J
jorlow@chromium.org 已提交
2617
  }
2618
  return status;
J
jorlow@chromium.org 已提交
2619 2620
}

2621
void DBImpl::BackgroundCallFlush() {
2622
  bool made_progress = false;
2623
  JobContext job_context(next_job_id_.fetch_add(1), true);
2624 2625
  assert(bg_flush_scheduled_);

2626
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, db_options_.info_log.get());
H
Haobo Xu 已提交
2627
  {
2628
    InstrumentedMutexLock l(&mutex_);
2629
    num_running_flushes_++;
H
Haobo Xu 已提交
2630

I
Igor Canadi 已提交
2631 2632 2633
    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

2634
    Status s = BackgroundFlush(&made_progress, &job_context, &log_buffer);
2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651
    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();
      Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
          "Waiting after background flush error: %s"
          "Accumulated background error counts: %" PRIu64,
          s.ToString().c_str(), error_cnt);
      log_buffer.FlushBufferToLog();
      LogFlush(db_options_.info_log);
      env_->SleepForMicroseconds(1000000);
      mutex_.Lock();
H
Haobo Xu 已提交
2652 2653
    }

I
Igor Canadi 已提交
2654 2655
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

2656 2657 2658
    // 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 已提交
2659
    // delete unnecessary files if any, this is done outside the mutex
I
Igor Canadi 已提交
2660
    if (job_context.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2661
      mutex_.Unlock();
2662 2663 2664 2665 2666
      // 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 已提交
2667
      log_buffer.FlushBufferToLog();
I
Igor Canadi 已提交
2668 2669
      if (job_context.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(job_context);
2670
      }
I
Igor Canadi 已提交
2671
      job_context.Clean();
2672 2673
      mutex_.Lock();
    }
I
Igor Canadi 已提交
2674

2675 2676
    assert(num_running_flushes_ > 0);
    num_running_flushes_--;
H
Haobo Xu 已提交
2677
    bg_flush_scheduled_--;
2678 2679
    // See if there's more work to be done
    MaybeScheduleFlushOrCompaction();
I
Igor Canadi 已提交
2680
    RecordFlushIOStats();
H
Haobo Xu 已提交
2681
    bg_cv_.SignalAll();
I
Igor Canadi 已提交
2682 2683 2684 2685
    // 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.
2686
  }
J
jorlow@chromium.org 已提交
2687 2688
}

2689
void DBImpl::BackgroundCallCompaction(void* arg) {
2690
  bool made_progress = false;
2691
  ManualCompaction* m = reinterpret_cast<ManualCompaction*>(arg);
2692
  JobContext job_context(next_job_id_.fetch_add(1), true);
2693
  TEST_SYNC_POINT("BackgroundCallCompaction:0");
H
Haobo Xu 已提交
2694
  MaybeDumpStats();
2695
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, db_options_.info_log.get());
2696
  {
2697
    InstrumentedMutexLock l(&mutex_);
2698
    num_running_compactions_++;
I
Igor Canadi 已提交
2699 2700 2701 2702

    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

2703
    assert(bg_compaction_scheduled_);
2704 2705
    Status s =
        BackgroundCompaction(&made_progress, &job_context, &log_buffer, m);
2706
    TEST_SYNC_POINT("BackgroundCallCompaction:1");
2707 2708 2709 2710 2711 2712
    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 =
2713
          default_cf_internal_stats_->BumpAndGetBackgroundErrorCount();
2714 2715 2716 2717 2718 2719 2720 2721 2722 2723
      bg_cv_.SignalAll();  // In case a waiter can proceed despite the error
      mutex_.Unlock();
      log_buffer.FlushBufferToLog();
      Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
          "Waiting after background compaction error: %s, "
          "Accumulated background error counts: %" PRIu64,
          s.ToString().c_str(), error_cnt);
      LogFlush(db_options_.info_log);
      env_->SleepForMicroseconds(1000000);
      mutex_.Lock();
2724
    }
H
Haobo Xu 已提交
2725

I
Igor Canadi 已提交
2726 2727
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

2728 2729 2730 2731
    // 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());
2732 2733

    // delete unnecessary files if any, this is done outside the mutex
I
Igor Canadi 已提交
2734
    if (job_context.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2735
      mutex_.Unlock();
2736 2737 2738 2739 2740
      // 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 已提交
2741
      log_buffer.FlushBufferToLog();
I
Igor Canadi 已提交
2742 2743
      if (job_context.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(job_context);
2744
      }
I
Igor Canadi 已提交
2745
      job_context.Clean();
2746 2747
      mutex_.Lock();
    }
D
Dhruba Borthakur 已提交
2748

2749 2750
    assert(num_running_compactions_ > 0);
    num_running_compactions_--;
2751
    bg_compaction_scheduled_--;
J
jorlow@chromium.org 已提交
2752

2753 2754
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();

2755 2756
    // See if there's more work to be done
    MaybeScheduleFlushOrCompaction();
2757 2758
    if (made_progress || bg_compaction_scheduled_ == 0 ||
        HasPendingManualCompaction()) {
2759
      // signal if
2760
      // * made_progress -- need to wakeup DelayWrite
2761
      // * bg_compaction_scheduled_ == 0 -- need to wakeup ~DBImpl
2762
      // * HasPendingManualCompaction -- need to wakeup RunManualCompaction
2763 2764 2765 2766
      // If none of this is true, there is no need to signal since nobody is
      // waiting for it
      bg_cv_.SignalAll();
    }
I
Igor Canadi 已提交
2767 2768 2769 2770
    // 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.
2771
  }
J
jorlow@chromium.org 已提交
2772 2773
}

2774 2775
Status DBImpl::BackgroundCompaction(bool* made_progress,
                                    JobContext* job_context,
2776 2777 2778
                                    LogBuffer* log_buffer, void* arg) {
  ManualCompaction* manual_compaction =
      reinterpret_cast<ManualCompaction*>(arg);
2779
  *made_progress = false;
J
jorlow@chromium.org 已提交
2780
  mutex_.AssertHeld();
2781

2782 2783 2784 2785 2786
  bool is_manual = (manual_compaction != nullptr);

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

2788
  CompactionJobStats compaction_job_stats;
2789 2790 2791 2792 2793 2794
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

  if (!status.ok()) {
2795
    if (is_manual) {
2796 2797 2798 2799 2800
      manual_compaction->status = status;
      manual_compaction->done = true;
      manual_compaction->in_progress = false;
      delete manual_compaction->compaction;
      manual_compaction = nullptr;
2801
    }
2802
    return status;
2803 2804
  }

2805 2806
  if (is_manual) {
    // another thread cannot pick up the same work
2807
    manual_compaction->in_progress = true;
2808 2809 2810
  }

  unique_ptr<Compaction> c;
2811 2812
  // InternalKey manual_end_storage;
  // InternalKey* manual_end = &manual_end_storage;
H
hans@chromium.org 已提交
2813
  if (is_manual) {
2814
    ManualCompaction* m = manual_compaction;
2815
    assert(m->in_progress);
2816
    c.reset(std::move(m->compaction));
2817
    if (!c) {
2818
      m->done = true;
2819
      m->manual_end = nullptr;
2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832
      LogToBuffer(log_buffer,
                  "[%s] Manual compaction from level-%d from %s .. "
                  "%s; nothing to do\n",
                  m->cfd->GetName().c_str(), m->input_level,
                  (m->begin ? m->begin->DebugString().c_str() : "(begin)"),
                  (m->end ? m->end->DebugString().c_str() : "(end)"));
    } else {
      LogToBuffer(log_buffer,
                  "[%s] Manual compaction from level-%d to level-%d from %s .. "
                  "%s; will stop at %s\n",
                  m->cfd->GetName().c_str(), m->input_level, c->output_level(),
                  (m->begin ? m->begin->DebugString().c_str() : "(begin)"),
                  (m->end ? m->end->DebugString().c_str() : "(end)"),
2833
                  ((m->done || m->manual_end == nullptr)
2834
                       ? "(end)"
2835
                       : m->manual_end->DebugString().c_str()));
G
Gabor Cselle 已提交
2836
    }
2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851
  } 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();
    }

2852 2853 2854 2855 2856 2857
    if (HaveManualCompaction(cfd)) {
      // Can't compact right now, but try again later
      TEST_SYNC_POINT("DBImpl::BackgroundCompaction()::Conflict");
      return Status::OK();
    }

2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874
    // 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
      c.reset(cfd->PickCompaction(*mutable_cf_options, log_buffer));
      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 已提交
2875
        // InstallSuperVersionAndScheduleWork
2876
        // 2) When MutableCFOptions changes. This case is also covered by
I
Igor Canadi 已提交
2877 2878
        // InstallSuperVersionAndScheduleWork, because this is when the new
        // options take effect.
2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889
        // 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 已提交
2890
        }
I
Igor Canadi 已提交
2891 2892
      }
    }
J
jorlow@chromium.org 已提交
2893 2894
  }

2895
  if (!c) {
H
hans@chromium.org 已提交
2896
    // Nothing to do
2897
    LogToBuffer(log_buffer, "Compaction nothing to do");
2898
  } else if (c->deletion_compaction()) {
I
Igor Canadi 已提交
2899 2900 2901 2902
    // 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);
2903
    assert(c->column_family_data()->ioptions()->compaction_style ==
I
Igor Canadi 已提交
2904
           kCompactionStyleFIFO);
2905 2906 2907

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

I
Igor Canadi 已提交
2908
    for (const auto& f : *c->inputs(0)) {
2909
      c->edit()->DeleteFile(c->level(), f->fd.GetNumber());
I
Igor Canadi 已提交
2910
    }
2911 2912 2913
    status = versions_->LogAndApply(c->column_family_data(),
                                    *c->mutable_cf_options(), c->edit(),
                                    &mutex_, directories_.GetDbDir());
I
Igor Canadi 已提交
2914 2915
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
I
Igor Canadi 已提交
2916 2917 2918
    LogToBuffer(log_buffer, "[%s] Deleted %d files\n",
                c->column_family_data()->GetName().c_str(),
                c->num_input_files(0));
2919
    *made_progress = true;
2920
  } else if (!trivial_move_disallowed && c->IsTrivialMove()) {
2921
    TEST_SYNC_POINT("DBImpl::BackgroundCompaction:TrivialMove");
2922 2923
    // Instrument for event update
    // TODO(yhchiang): add op details for showing trivial-move.
2924 2925 2926
    ThreadStatusUtil::SetColumnFamily(
        c->column_family_data(), c->column_family_data()->ioptions()->env,
        c->column_family_data()->options()->enable_thread_tracking);
2927 2928
    ThreadStatusUtil::SetThreadOperation(ThreadStatus::OP_COMPACTION);

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

2931 2932 2933
    // Move files to next level
    int32_t moved_files = 0;
    int64_t moved_bytes = 0;
2934
    for (unsigned int l = 0; l < c->num_input_levels(); l++) {
2935
      if (c->level(l) == c->output_level()) {
2936 2937 2938 2939
        continue;
      }
      for (size_t i = 0; i < c->num_input_files(l); i++) {
        FileMetaData* f = c->input(l, i);
2940
        c->edit()->DeleteFile(c->level(l), f->fd.GetNumber());
2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952
        c->edit()->AddFile(c->output_level(), f->fd.GetNumber(),
                           f->fd.GetPathId(), f->fd.GetFileSize(), f->smallest,
                           f->largest, f->smallest_seqno, f->largest_seqno,
                           f->marked_for_compaction);

        LogToBuffer(log_buffer,
                    "[%s] Moving #%" PRIu64 " to level-%d %" PRIu64 " bytes\n",
                    c->column_family_data()->GetName().c_str(),
                    f->fd.GetNumber(), c->output_level(), f->fd.GetFileSize());
        ++moved_files;
        moved_bytes += f->fd.GetFileSize();
      }
2953
    }
2954

2955
    status = versions_->LogAndApply(c->column_family_data(),
2956 2957
                                    *c->mutable_cf_options(), c->edit(),
                                    &mutex_, directories_.GetDbDir());
2958
    // Use latest MutableCFOptions
I
Igor Canadi 已提交
2959 2960
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
2961

S
sdong 已提交
2962
    VersionStorageInfo::LevelSummaryStorage tmp;
I
Islam AbdelRahman 已提交
2963
    c->column_family_data()->internal_stats()->IncBytesMoved(c->output_level(),
2964
                                                             moved_bytes);
2965 2966 2967 2968
    {
      event_logger_.LogToBuffer(log_buffer)
          << "job" << job_context->job_id << "event"
          << "trivial_move"
I
Islam AbdelRahman 已提交
2969
          << "destination_level" << c->output_level() << "files" << moved_files
2970
          << "total_files_size" << moved_bytes;
2971
    }
2972 2973
    LogToBuffer(
        log_buffer,
2974
        "[%s] Moved #%d files to level-%d %" PRIu64 " bytes %s: %s\n",
I
Islam AbdelRahman 已提交
2975 2976
        c->column_family_data()->GetName().c_str(), moved_files,
        c->output_level(), moved_bytes, status.ToString().c_str(),
2977
        c->column_family_data()->current()->storage_info()->LevelSummary(&tmp));
2978
    *made_progress = true;
2979 2980 2981

    // Clear Instrument
    ThreadStatusUtil::ResetThreadStatus();
J
jorlow@chromium.org 已提交
2982
  } else {
2983 2984 2985
    int output_level  __attribute__((unused)) = c->output_level();
    TEST_SYNC_POINT_CALLBACK("DBImpl::BackgroundCompaction:NonTrivial",
                             &output_level);
2986 2987 2988 2989 2990

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

I
Igor Canadi 已提交
2991
    assert(is_snapshot_supported_ || snapshots_.empty());
2992
    CompactionJob compaction_job(
I
Igor Canadi 已提交
2993 2994
        job_context->job_id, c.get(), db_options_, env_options_,
        versions_.get(), &shutting_down_, log_buffer, directories_.GetDbDir(),
2995 2996
        directories_.GetDataDir(c->output_path_id()), stats_, snapshot_seqs,
        earliest_write_conflict_snapshot, table_cache_, &event_logger_,
2997 2998
        c->mutable_cf_options()->paranoid_file_checks,
        c->mutable_cf_options()->compaction_measure_io_stats, dbname_,
S
sdong 已提交
2999
        &compaction_job_stats);
I
Igor Canadi 已提交
3000
    compaction_job.Prepare();
3001

I
Igor Canadi 已提交
3002
    mutex_.Unlock();
3003
    compaction_job.Run();
3004
    TEST_SYNC_POINT("DBImpl::BackgroundCompaction:NonTrivial:AfterRun");
I
Igor Canadi 已提交
3005
    mutex_.Lock();
3006

3007
    status = compaction_job.Install(*c->mutable_cf_options(), &mutex_);
I
Igor Canadi 已提交
3008
    if (status.ok()) {
I
Igor Canadi 已提交
3009 3010
      InstallSuperVersionAndScheduleWorkWrapper(
          c->column_family_data(), job_context, *c->mutable_cf_options());
I
Igor Canadi 已提交
3011
    }
3012
    *made_progress = true;
O
Ori Bernstein 已提交
3013 3014
  }
  if (c != nullptr) {
3015 3016 3017
    NotifyOnCompactionCompleted(
        c->column_family_data(), c.get(), status,
        compaction_job_stats, job_context->job_id);
I
Igor Canadi 已提交
3018
    c->ReleaseCompactionFiles(status);
3019
    *made_progress = true;
J
jorlow@chromium.org 已提交
3020
  }
3021
  // this will unref its input_version and column_family_data
3022
  c.reset();
J
jorlow@chromium.org 已提交
3023 3024 3025

  if (status.ok()) {
    // Done
F
Feng Zhu 已提交
3026
  } else if (status.IsShutdownInProgress()) {
J
jorlow@chromium.org 已提交
3027 3028
    // Ignore compaction errors found during shutting down
  } else {
3029
    Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log, "Compaction error: %s",
3030
        status.ToString().c_str());
3031
    if (db_options_.paranoid_checks && bg_error_.ok()) {
J
jorlow@chromium.org 已提交
3032 3033 3034
      bg_error_ = status;
    }
  }
H
hans@chromium.org 已提交
3035 3036

  if (is_manual) {
3037
    ManualCompaction* m = manual_compaction;
3038
    if (!status.ok()) {
L
Lei Jin 已提交
3039
      m->status = status;
3040 3041
      m->done = true;
    }
3042 3043 3044 3045 3046 3047 3048 3049 3050
    // 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.
3051 3052 3053 3054
    //
    // 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
3055
    if (m->manual_end == nullptr) {
3056 3057
      m->done = true;
    }
G
Gabor Cselle 已提交
3058 3059 3060
    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 已提交
3061
      // Universal and FIFO compactions should always compact the whole range
S
sdong 已提交
3062 3063 3064
      assert(m->cfd->ioptions()->compaction_style !=
                 kCompactionStyleUniversal ||
             m->cfd->ioptions()->num_levels > 1);
3065
      assert(m->cfd->ioptions()->compaction_style != kCompactionStyleFIFO);
3066
      m->tmp_storage = *m->manual_end;
G
Gabor Cselle 已提交
3067
      m->begin = &m->tmp_storage;
3068
      m->incomplete = true;
G
Gabor Cselle 已提交
3069
    }
3070
    m->in_progress = false; // not being processed anymore
H
hans@chromium.org 已提交
3071
  }
3072
  return status;
J
jorlow@chromium.org 已提交
3073 3074
}

3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097
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;
}

3098 3099 3100
bool DBImpl::ShouldntRunManualCompaction(ManualCompaction* m) {
  if (m->exclusive) {
    return (bg_compaction_scheduled_ > 0);
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 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161
  }
  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;
}

3162 3163
namespace {
struct IterState {
3164
  IterState(DBImpl* _db, InstrumentedMutex* _mu, SuperVersion* _super_version)
I
Igor Canadi 已提交
3165
      : db(_db), mu(_mu), super_version(_super_version) {}
3166 3167

  DBImpl* db;
3168
  InstrumentedMutex* mu;
3169
  SuperVersion* super_version;
3170 3171 3172 3173
};

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

3175
  if (state->super_version->Unref()) {
3176 3177 3178
    // Job id == 0 means that this is not our background process, but rather
    // user thread
    JobContext job_context(0);
3179

3180 3181
    state->mu->Lock();
    state->super_version->Cleanup();
I
Igor Canadi 已提交
3182
    state->db->FindObsoleteFiles(&job_context, false, true);
3183 3184 3185
    state->mu->Unlock();

    delete state->super_version;
I
Igor Canadi 已提交
3186 3187
    if (job_context.HaveSomethingToDelete()) {
      state->db->PurgeObsoleteFiles(job_context);
3188
    }
I
Igor Canadi 已提交
3189
    job_context.Clean();
I
Igor Canadi 已提交
3190
  }
T
Tomislav Novak 已提交
3191

3192 3193
  delete state;
}
H
Hans Wennborg 已提交
3194
}  // namespace
3195

S
sdong 已提交
3196 3197 3198 3199 3200
InternalIterator* DBImpl::NewInternalIterator(const ReadOptions& read_options,
                                              ColumnFamilyData* cfd,
                                              SuperVersion* super_version,
                                              Arena* arena) {
  InternalIterator* internal_iter;
3201 3202 3203 3204 3205
  assert(arena != nullptr);
  // Need to create internal iterator from the arena.
  MergeIteratorBuilder merge_iter_builder(&cfd->internal_comparator(), arena);
  // Collect iterator for mutable mem
  merge_iter_builder.AddIterator(
L
Lei Jin 已提交
3206
      super_version->mem->NewIterator(read_options, arena));
3207
  // Collect all needed child iterators for immutable memtables
L
Lei Jin 已提交
3208
  super_version->imm->AddIterators(read_options, &merge_iter_builder);
3209
  // Collect iterators for files in L0 - Ln
L
Lei Jin 已提交
3210
  super_version->current->AddIterators(read_options, env_options_,
3211 3212
                                       &merge_iter_builder);
  internal_iter = merge_iter_builder.Finish();
3213
  IterState* cleanup = new IterState(this, &mutex_, super_version);
3214
  internal_iter->RegisterCleanup(CleanupIteratorState, cleanup, nullptr);
J
jorlow@chromium.org 已提交
3215 3216 3217 3218

  return internal_iter;
}

3219 3220 3221 3222
ColumnFamilyHandle* DBImpl::DefaultColumnFamily() const {
  return default_cf_handle_;
}

L
Lei Jin 已提交
3223
Status DBImpl::Get(const ReadOptions& read_options,
3224
                   ColumnFamilyHandle* column_family, const Slice& key,
J
jorlow@chromium.org 已提交
3225
                   std::string* value) {
L
Lei Jin 已提交
3226
  return GetImpl(read_options, column_family, key, value);
3227 3228
}

I
Igor Canadi 已提交
3229 3230
// JobContext gets created and destructed outside of the lock --
// we
I
Igor Canadi 已提交
3231 3232
// use this convinently to:
// * malloc one SuperVersion() outside of the lock -- new_superversion
3233
// * delete SuperVersion()s outside of the lock -- superversions_to_free
I
Igor Canadi 已提交
3234
//
I
Igor Canadi 已提交
3235 3236 3237
// However, if InstallSuperVersionAndScheduleWork() gets called twice with the
// same job_context, we can't reuse the SuperVersion() that got
// malloced because
I
Igor Canadi 已提交
3238 3239 3240
// 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 已提交
3241
void DBImpl::InstallSuperVersionAndScheduleWorkWrapper(
I
Igor Canadi 已提交
3242
    ColumnFamilyData* cfd, JobContext* job_context,
3243
    const MutableCFOptions& mutable_cf_options) {
3244
  mutex_.AssertHeld();
I
Igor Canadi 已提交
3245
  SuperVersion* old_superversion = InstallSuperVersionAndScheduleWork(
I
Igor Canadi 已提交
3246 3247 3248
      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 已提交
3249 3250
}

I
Igor Canadi 已提交
3251
SuperVersion* DBImpl::InstallSuperVersionAndScheduleWork(
L
Lei Jin 已提交
3252
    ColumnFamilyData* cfd, SuperVersion* new_sv,
I
Igor Canadi 已提交
3253
    const MutableCFOptions& mutable_cf_options) {
L
Lei Jin 已提交
3254
  mutex_.AssertHeld();
3255 3256 3257 3258 3259 3260 3261 3262 3263

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

3267
  // Whenever we install new SuperVersion, we might need to issue new flushes or
I
Igor Canadi 已提交
3268 3269 3270 3271
  // compactions.
  SchedulePendingFlush(cfd);
  SchedulePendingCompaction(cfd);
  MaybeScheduleFlushOrCompaction();
L
Lei Jin 已提交
3272 3273 3274 3275 3276 3277 3278 3279 3280 3281

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

3287 3288 3289
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

3290
  SequenceNumber snapshot;
L
Lei Jin 已提交
3291 3292 3293
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
3294 3295
  } else {
    snapshot = versions_->LastSequence();
J
jorlow@chromium.org 已提交
3296
  }
3297
  // Acquire SuperVersion
3298
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
3299
  // Prepare to store a list of merge operations if merge occurs.
3300
  MergeContext merge_context;
3301

3302
  Status s;
3303
  // First look in the memtable, then in the immutable memtable (if any).
3304
  // s is both in/out. When in, s could either be OK or MergeInProgress.
3305
  // merge_operands will contain the sequence of merges in the latter case.
3306
  LookupKey lkey(key, snapshot);
L
Lei Jin 已提交
3307
  PERF_TIMER_STOP(get_snapshot_time);
3308

3309
  if (sv->mem->Get(lkey, value, &s, &merge_context)) {
3310
    // Done
L
Lei Jin 已提交
3311
    RecordTick(stats_, MEMTABLE_HIT);
3312
  } else if (sv->imm->Get(lkey, value, &s, &merge_context)) {
3313
    // Done
L
Lei Jin 已提交
3314
    RecordTick(stats_, MEMTABLE_HIT);
3315
  } else {
3316
    PERF_TIMER_GUARD(get_from_output_files_time);
L
Lei Jin 已提交
3317 3318
    sv->current->Get(read_options, lkey, value, &s, &merge_context,
                     value_found);
L
Lei Jin 已提交
3319
    RecordTick(stats_, MEMTABLE_MISS);
3320
  }
3321

3322 3323
  {
    PERF_TIMER_GUARD(get_post_process_time);
3324

3325
    ReturnAndCleanupSuperVersion(cfd, sv);
3326

3327 3328
    RecordTick(stats_, NUMBER_KEYS_READ);
    RecordTick(stats_, BYTES_READ, value->size());
3329
    MeasureTime(stats_, BYTES_PER_READ, value->size());
3330
  }
3331
  return s;
J
jorlow@chromium.org 已提交
3332 3333
}

3334
std::vector<Status> DBImpl::MultiGet(
L
Lei Jin 已提交
3335
    const ReadOptions& read_options,
3336
    const std::vector<ColumnFamilyHandle*>& column_family,
3337
    const std::vector<Slice>& keys, std::vector<std::string>* values) {
3338

L
Lei Jin 已提交
3339
  StopWatch sw(env_, stats_, DB_MULTIGET);
3340
  PERF_TIMER_GUARD(get_snapshot_time);
K
Kai Liu 已提交
3341

3342
  SequenceNumber snapshot;
3343

3344
  struct MultiGetColumnFamilyData {
I
Igor Canadi 已提交
3345
    ColumnFamilyData* cfd;
3346 3347 3348 3349 3350
    SuperVersion* super_version;
  };
  std::unordered_map<uint32_t, MultiGetColumnFamilyData*> multiget_cf_data;
  // fill up and allocate outside of mutex
  for (auto cf : column_family) {
3351 3352 3353 3354 3355 3356
    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});
3357 3358 3359
    }
  }

3360
  mutex_.Lock();
L
Lei Jin 已提交
3361 3362 3363
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
3364 3365 3366
  } else {
    snapshot = versions_->LastSequence();
  }
3367
  for (auto mgd_iter : multiget_cf_data) {
3368 3369
    mgd_iter.second->super_version =
        mgd_iter.second->cfd->GetSuperVersion()->Ref();
3370
  }
3371
  mutex_.Unlock();
3372

3373 3374
  // Contain a list of merge operations if merge occurs.
  MergeContext merge_context;
3375

3376
  // Note: this always resizes the values array
3377 3378 3379
  size_t num_keys = keys.size();
  std::vector<Status> stat_list(num_keys);
  values->resize(num_keys);
3380 3381

  // Keep track of bytes that we read for statistics-recording later
3382
  uint64_t bytes_read = 0;
L
Lei Jin 已提交
3383
  PERF_TIMER_STOP(get_snapshot_time);
3384 3385 3386 3387

  // 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.
3388
  // merge_operands will contain the sequence of merges in the latter case.
3389
  for (size_t i = 0; i < num_keys; ++i) {
3390
    merge_context.Clear();
3391
    Status& s = stat_list[i];
3392 3393 3394
    std::string* value = &(*values)[i];

    LookupKey lkey(keys[i], snapshot);
3395 3396
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family[i]);
    auto mgd_iter = multiget_cf_data.find(cfh->cfd()->GetID());
3397 3398 3399
    assert(mgd_iter != multiget_cf_data.end());
    auto mgd = mgd_iter->second;
    auto super_version = mgd->super_version;
3400
    if (super_version->mem->Get(lkey, value, &s, &merge_context)) {
3401
      // Done
3402
    } else if (super_version->imm->Get(lkey, value, &s, &merge_context)) {
3403 3404
      // Done
    } else {
3405
      PERF_TIMER_GUARD(get_from_output_files_time);
L
Lei Jin 已提交
3406 3407
      super_version->current->Get(read_options, lkey, value, &s,
                                  &merge_context);
3408 3409 3410
    }

    if (s.ok()) {
3411
      bytes_read += value->size();
3412 3413 3414 3415
    }
  }

  // Post processing (decrement reference counts and record statistics)
3416
  PERF_TIMER_GUARD(get_post_process_time);
3417 3418
  autovector<SuperVersion*> superversions_to_delete;

I
Igor Canadi 已提交
3419
  // TODO(icanadi) do we need lock here or just around Cleanup()?
3420 3421 3422 3423 3424 3425
  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);
3426 3427
    }
  }
3428 3429 3430 3431 3432 3433 3434
  mutex_.Unlock();

  for (auto td : superversions_to_delete) {
    delete td;
  }
  for (auto mgd : multiget_cf_data) {
    delete mgd.second;
3435
  }
3436

L
Lei Jin 已提交
3437 3438 3439
  RecordTick(stats_, NUMBER_MULTIGET_CALLS);
  RecordTick(stats_, NUMBER_MULTIGET_KEYS_READ, num_keys);
  RecordTick(stats_, NUMBER_MULTIGET_BYTES_READ, bytes_read);
3440
  MeasureTime(stats_, BYTES_PER_MULTIGET, bytes_read);
L
Lei Jin 已提交
3441
  PERF_TIMER_STOP(get_post_process_time);
3442

3443
  return stat_list;
3444 3445
}

3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500
#ifndef ROCKSDB_LITE
Status DBImpl::AddFile(ColumnFamilyHandle* column_family,
                       const std::string& file_path, bool move_file) {
  Status status;
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  ColumnFamilyData* cfd = cfh->cfd();

  ExternalSstFileInfo file_info;
  file_info.file_path = file_path;
  status = env_->GetFileSize(file_path, &file_info.file_size);
  if (!status.ok()) {
    return status;
  }

  // Access the file using TableReader to extract
  // version, number of entries, smallest user key, largest user key
  std::unique_ptr<RandomAccessFile> sst_file;
  status = env_->NewRandomAccessFile(file_path, &sst_file, env_options_);
  if (!status.ok()) {
    return status;
  }
  std::unique_ptr<RandomAccessFileReader> sst_file_reader;
  sst_file_reader.reset(new RandomAccessFileReader(std::move(sst_file)));

  std::unique_ptr<TableReader> table_reader;
  status = cfd->ioptions()->table_factory->NewTableReader(
      TableReaderOptions(*cfd->ioptions(), env_options_,
                         cfd->internal_comparator()),
      std::move(sst_file_reader), file_info.file_size, &table_reader);
  if (!status.ok()) {
    return status;
  }

  // Get the external sst file version from table properties
  const UserCollectedProperties& user_collected_properties =
      table_reader->GetTableProperties()->user_collected_properties;
  UserCollectedProperties::const_iterator external_sst_file_version_iter =
      user_collected_properties.find(ExternalSstFilePropertyNames::kVersion);
  if (external_sst_file_version_iter == user_collected_properties.end()) {
    return Status::InvalidArgument("Generated table version not found");
  }

  file_info.version =
      DecodeFixed32(external_sst_file_version_iter->second.c_str());
  if (file_info.version == 1) {
    // version 1 imply that all sequence numbers in table equal 0
    file_info.sequence_number = 0;
  } else {
    return Status::InvalidArgument("Generated table version is not supported");
  }

  // Get number of entries in table
  file_info.num_entries = table_reader->GetTableProperties()->num_entries;

  ParsedInternalKey key;
S
sdong 已提交
3501 3502
  std::unique_ptr<InternalIterator> iter(
      table_reader->NewIterator(ReadOptions()));
3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532

  // Get first (smallest) key from file
  iter->SeekToFirst();
  if (!ParseInternalKey(iter->key(), &key)) {
    return Status::Corruption("Generated table have corrupted keys");
  }
  if (key.sequence != 0) {
    return Status::Corruption("Generated table have non zero sequence number");
  }
  file_info.smallest_key = key.user_key.ToString();

  // Get last (largest) key from file
  iter->SeekToLast();
  if (!ParseInternalKey(iter->key(), &key)) {
    return Status::Corruption("Generated table have corrupted keys");
  }
  if (key.sequence != 0) {
    return Status::Corruption("Generated table have non zero sequence number");
  }
  file_info.largest_key = key.user_key.ToString();

  return AddFile(column_family, &file_info, move_file);
}

Status DBImpl::AddFile(ColumnFamilyHandle* column_family,
                       const ExternalSstFileInfo* file_info, bool move_file) {
  Status status;
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  ColumnFamilyData* cfd = cfh->cfd();

3533 3534 3535
  if (file_info->num_entries == 0) {
    return Status::InvalidArgument("File contain no entries");
  }
3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581
  if (file_info->version != 1) {
    return Status::InvalidArgument("Generated table version is not supported");
  }
  // version 1 imply that file have only Put Operations with Sequence Number = 0

  FileMetaData meta;
  meta.smallest =
      InternalKey(file_info->smallest_key, file_info->sequence_number,
                  ValueType::kTypeValue);
  meta.largest = InternalKey(file_info->largest_key, file_info->sequence_number,
                             ValueType::kTypeValue);
  if (!meta.smallest.Valid() || !meta.largest.Valid()) {
    return Status::Corruption("Generated table have corrupted keys");
  }
  meta.smallest_seqno = file_info->sequence_number;
  meta.largest_seqno = file_info->sequence_number;
  if (meta.smallest_seqno != 0 || meta.largest_seqno != 0) {
    return Status::InvalidArgument(
        "Non zero sequence numbers are not supported");
  }
  // Generate a location for the new table
  meta.fd = FileDescriptor(versions_->NewFileNumber(), 0, file_info->file_size);
  std::string db_fname = TableFileName(
      db_options_.db_paths, meta.fd.GetNumber(), meta.fd.GetPathId());

  if (move_file) {
    status = env_->LinkFile(file_info->file_path, db_fname);
    if (status.IsNotSupported()) {
      // Original file is on a different FS, use copy instead of hard linking
      status = CopyFile(env_, file_info->file_path, db_fname, 0);
    }
  } else {
    status = CopyFile(env_, file_info->file_path, db_fname, 0);
  }
  if (!status.ok()) {
    return status;
  }

  {
    InstrumentedMutexLock l(&mutex_);
    const MutableCFOptions mutable_cf_options =
        *cfd->GetLatestMutableCFOptions();

    WriteThread::Writer w;
    write_thread_.EnterUnbatched(&w, &mutex_);

3582 3583 3584 3585
    if (!snapshots_.empty()) {
      // Check that no snapshots are being held
      status =
          Status::NotSupported("Cannot add a file while holding snapshots");
3586 3587 3588
    }

    if (status.ok()) {
3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610
      // Verify that added file key range dont overlap with any keys in DB
      SuperVersion* sv = cfd->GetSuperVersion()->Ref();
      Arena arena;
      ReadOptions ro;
      ro.total_order_seek = true;
      ScopedArenaIterator iter(NewInternalIterator(ro, cfd, sv, &arena));

      InternalKey range_start(file_info->smallest_key, kMaxSequenceNumber,
                              kTypeValue);
      iter->Seek(range_start.Encode());
      status = iter->status();

      if (status.ok() && iter->Valid()) {
        ParsedInternalKey seek_result;
        if (ParseInternalKey(iter->key(), &seek_result)) {
          auto* vstorage = cfd->current()->storage_info();
          if (vstorage->InternalComparator()->user_comparator()->Compare(
                  seek_result.user_key, file_info->largest_key) <= 0) {
            status = Status::NotSupported("Cannot add overlapping range");
          }
        } else {
          status = Status::Corruption("DB have corrupted keys");
3611 3612 3613 3614 3615
        }
      }
    }

    if (status.ok()) {
3616
      // Add file to L0
3617 3618
      VersionEdit edit;
      edit.SetColumnFamily(cfd->GetID());
3619
      edit.AddFile(0, meta.fd.GetNumber(), meta.fd.GetPathId(),
3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656
                   meta.fd.GetFileSize(), meta.smallest, meta.largest,
                   meta.smallest_seqno, meta.largest_seqno,
                   meta.marked_for_compaction);

      status = versions_->LogAndApply(cfd, mutable_cf_options, &edit, &mutex_,
                                      directories_.GetDbDir());
    }
    write_thread_.ExitUnbatched(&w);

    if (status.ok()) {
      delete InstallSuperVersionAndScheduleWork(cfd, nullptr,
                                                mutable_cf_options);
    }
  }

  if (!status.ok()) {
    // We failed to add the file to the database
    Status s = env_->DeleteFile(db_fname);
    if (!s.ok()) {
      Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
          "AddFile() clean up for file %s failed : %s", db_fname.c_str(),
          s.ToString().c_str());
    }
  } else if (status.ok() && move_file) {
    // The file was moved and added successfully, remove original file link
    Status s = env_->DeleteFile(file_info->file_path);
    if (!s.ok()) {
      Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
          "%s was added to DB successfully but failed to remove original file "
          "link : %s",
          file_info->file_path.c_str(), s.ToString().c_str());
    }
  }
  return status;
}
#endif  // ROCKSDB_LITE

L
Lei Jin 已提交
3657
Status DBImpl::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
3658
                                  const std::string& column_family_name,
3659
                                  ColumnFamilyHandle** handle) {
Y
Yueh-Hsuan Chiang 已提交
3660
  Status s;
3661
  Status persist_options_status;
I
Igor Canadi 已提交
3662
  *handle = nullptr;
3663 3664

  s = CheckCompressionSupported(cf_options);
3665 3666 3667
  if (s.ok() && db_options_.allow_concurrent_memtable_write) {
    s = CheckConcurrentWritesSupported(cf_options);
  }
3668 3669 3670 3671
  if (!s.ok()) {
    return s;
  }

Y
Yueh-Hsuan Chiang 已提交
3672
  {
3673
    InstrumentedMutexLock l(&mutex_);
I
Igor Canadi 已提交
3674

Y
Yueh-Hsuan Chiang 已提交
3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688
    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
    Options opt(db_options_, cf_options);
I
Igor Canadi 已提交
3689
    {  // write thread
3690 3691
      WriteThread::Writer w;
      write_thread_.EnterUnbatched(&w, &mutex_);
I
Igor Canadi 已提交
3692 3693 3694 3695
      // LogAndApply will both write the creation in MANIFEST and create
      // ColumnFamilyData object
      s = versions_->LogAndApply(
          nullptr, MutableCFOptions(opt, ImmutableCFOptions(opt)), &edit,
3696
          &mutex_, directories_.GetDbDir(), false, &cf_options);
3697 3698 3699 3700 3701 3702

      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();
      }
3703
      write_thread_.ExitUnbatched(&w);
I
Igor Canadi 已提交
3704
    }
Y
Yueh-Hsuan Chiang 已提交
3705 3706 3707 3708 3709
    if (s.ok()) {
      single_column_family_mode_ = false;
      auto* cfd =
          versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name);
      assert(cfd != nullptr);
I
Igor Canadi 已提交
3710
      delete InstallSuperVersionAndScheduleWork(
Y
Yueh-Hsuan Chiang 已提交
3711
          cfd, nullptr, *cfd->GetLatestMutableCFOptions());
S
sdong 已提交
3712 3713 3714 3715 3716

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

Y
Yueh-Hsuan Chiang 已提交
3717 3718 3719 3720 3721 3722 3723 3724 3725
      *handle = new ColumnFamilyHandleImpl(cfd, this, &mutex_);
      Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
          "Created column family [%s] (ID %u)",
          column_family_name.c_str(), (unsigned)cfd->GetID());
    } else {
      Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
          "Creating column family [%s] FAILED -- %s",
          column_family_name.c_str(), s.ToString().c_str());
    }
3726
  }  // InstrumentedMutexLock l(&mutex_)
Y
Yueh-Hsuan Chiang 已提交
3727 3728

  // this is outside the mutex
3729
  if (s.ok()) {
3730 3731
    NewThreadStatusCfInfo(
        reinterpret_cast<ColumnFamilyHandleImpl*>(*handle)->cfd());
3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742
    if (!persist_options_status.ok()) {
      if (db_options_.fail_if_options_file_error) {
        s = Status::IOError(
            "ColumnFamily has been created, but unable to persist"
            "options in CreateColumnFamily()",
            persist_options_status.ToString().c_str());
      }
      Warn(db_options_.info_log,
           "Unable to persist options in CreateColumnFamily() -- %s",
           persist_options_status.ToString().c_str());
    }
3743
  }
3744
  return s;
3745 3746
}

3747 3748 3749 3750
Status DBImpl::DropColumnFamily(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
  if (cfd->GetID() == 0) {
3751 3752
    return Status::InvalidArgument("Can't drop default column family");
  }
3753

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

I
Igor Canadi 已提交
3756 3757
  VersionEdit edit;
  edit.DropColumnFamily();
3758 3759
  edit.SetColumnFamily(cfd->GetID());

3760
  Status s;
3761
  Status options_persist_status;
3762
  {
3763
    InstrumentedMutexLock l(&mutex_);
3764 3765 3766 3767
    if (cfd->IsDropped()) {
      s = Status::InvalidArgument("Column family already dropped!\n");
    }
    if (s.ok()) {
3768
      // we drop column family from a single write thread
3769 3770
      WriteThread::Writer w;
      write_thread_.EnterUnbatched(&w, &mutex_);
3771 3772
      s = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                 &edit, &mutex_);
3773 3774 3775 3776 3777
      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();
      }
3778
      write_thread_.ExitUnbatched(&w);
3779
    }
S
sdong 已提交
3780 3781 3782 3783 3784 3785

    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()) {
3786
        if (!c->IsDropped() && !c->mem()->IsSnapshotSupported()) {
S
sdong 已提交
3787 3788 3789 3790 3791 3792
          new_is_snapshot_supported = false;
          break;
        }
      }
      is_snapshot_supported_ = new_is_snapshot_supported;
    }
3793
  }
3794

3795
  if (s.ok()) {
Y
Yueh-Hsuan Chiang 已提交
3796 3797 3798 3799
    // 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 已提交
3800
    assert(cfd->IsDropped());
L
Lei Jin 已提交
3801 3802 3803
    auto* mutable_cf_options = cfd->GetLatestMutableCFOptions();
    max_total_in_memory_state_ -= mutable_cf_options->write_buffer_size *
                                  mutable_cf_options->max_write_buffer_number;
3804 3805 3806
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
        "Dropped column family with id %u\n", cfd->GetID());

3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817
    if (!options_persist_status.ok()) {
      if (db_options_.fail_if_options_file_error) {
        s = Status::IOError(
            "ColumnFamily has been dropped, but unable to persist "
            "options in DropColumnFamily()",
            options_persist_status.ToString().c_str());
      }
      Warn(db_options_.info_log,
           "Unable to persist options in DropColumnFamily() -- %s",
           options_persist_status.ToString().c_str());
    }
3818
  } else {
3819
    Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
3820
        "Dropping column family with id %u FAILED -- %s\n",
3821 3822 3823
        cfd->GetID(), s.ToString().c_str());
  }

3824
  return s;
3825 3826
}

L
Lei Jin 已提交
3827
bool DBImpl::KeyMayExist(const ReadOptions& read_options,
3828 3829
                         ColumnFamilyHandle* column_family, const Slice& key,
                         std::string* value, bool* value_found) {
3830
  if (value_found != nullptr) {
K
Kai Liu 已提交
3831 3832
    // falsify later if key-may-exist but can't fetch value
    *value_found = true;
3833
  }
L
Lei Jin 已提交
3834
  ReadOptions roptions = read_options;
3835
  roptions.read_tier = kBlockCacheTier; // read from block cache only
3836
  auto s = GetImpl(roptions, column_family, key, value, value_found);
K
Kai Liu 已提交
3837

3838
  // If block_cache is enabled and the index block of the table didn't
K
Kai Liu 已提交
3839 3840 3841
  // 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();
3842 3843
}

3844
Iterator* DBImpl::NewIterator(const ReadOptions& read_options,
3845 3846 3847
                              ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
T
Tomislav Novak 已提交
3848

V
Venkatesh Radhakrishnan 已提交
3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866
  XFUNC_TEST("", "managed_new", managed_new1, xf_manage_new,
             reinterpret_cast<DBImpl*>(this),
             const_cast<ReadOptions*>(&read_options), is_snapshot_supported_);
  if (read_options.managed) {
#ifdef ROCKSDB_LITE
    // not supported in lite version
    return NewErrorIterator(Status::InvalidArgument(
        "Managed Iterators not supported in RocksDBLite."));
#else
    if ((read_options.tailing) || (read_options.snapshot != nullptr) ||
        (is_snapshot_supported_)) {
      return new ManagedIterator(this, read_options, cfd);
    }
    // Managed iter not supported
    return NewErrorIterator(Status::InvalidArgument(
        "Managed Iterators not supported without snapshots."));
#endif
  } else if (read_options.tailing) {
I
Igor Canadi 已提交
3867 3868 3869 3870
#ifdef ROCKSDB_LITE
    // not supported in lite version
    return nullptr;
#else
3871 3872
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
    auto iter = new ForwardIterator(this, read_options, cfd, sv);
3873 3874
    return NewDBIterator(
        env_, *cfd->ioptions(), cfd->user_comparator(), iter,
3875 3876
        kMaxSequenceNumber,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
3877 3878
        read_options.iterate_upper_bound, read_options.prefix_same_as_start,
        read_options.pin_data);
I
Igor Canadi 已提交
3879
#endif
T
Tomislav Novak 已提交
3880
  } else {
3881
    SequenceNumber latest_snapshot = versions_->LastSequence();
3882
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
3883

I
Igor Canadi 已提交
3884
    auto snapshot =
3885 3886 3887
        read_options.snapshot != nullptr
            ? reinterpret_cast<const SnapshotImpl*>(
                read_options.snapshot)->number_
I
Igor Canadi 已提交
3888
            : latest_snapshot;
T
Tomislav Novak 已提交
3889

3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925
    // 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         | <----+
    // |       |   +-------------------+
    // |       |                       |
    // +-------+-----------------------+
    //
3926 3927
    // ArenaWrappedDBIter inlines an arena area where all the iterators in
    // the iterator tree are allocated in the order of being accessed when
3928 3929 3930 3931 3932
    // 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(
3933 3934
        env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
3935 3936
        read_options.iterate_upper_bound, read_options.prefix_same_as_start,
        read_options.pin_data);
3937

S
sdong 已提交
3938
    InternalIterator* internal_iter =
3939
        NewInternalIterator(read_options, cfd, sv, db_iter->GetArena());
3940 3941 3942 3943
    db_iter->SetIterUnderDBIter(internal_iter);

    return db_iter;
  }
3944 3945
  // To stop compiler from complaining
  return nullptr;
J
jorlow@chromium.org 已提交
3946 3947
}

3948
Status DBImpl::NewIterators(
3949
    const ReadOptions& read_options,
I
Igor Canadi 已提交
3950
    const std::vector<ColumnFamilyHandle*>& column_families,
3951
    std::vector<Iterator*>* iterators) {
I
Igor Canadi 已提交
3952 3953
  iterators->clear();
  iterators->reserve(column_families.size());
V
Venkatesh Radhakrishnan 已提交
3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973
  XFUNC_TEST("", "managed_new", managed_new1, xf_manage_new,
             reinterpret_cast<DBImpl*>(this),
             const_cast<ReadOptions*>(&read_options), is_snapshot_supported_);
  if (read_options.managed) {
#ifdef ROCKSDB_LITE
    return Status::InvalidArgument(
        "Managed interator not supported in RocksDB lite");
#else
    if ((!read_options.tailing) && (read_options.snapshot == nullptr) &&
        (!is_snapshot_supported_)) {
      return Status::InvalidArgument(
          "Managed interator not supported without snapshots");
    }
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
      auto iter = new ManagedIterator(this, read_options, cfd);
      iterators->push_back(iter);
    }
#endif
  } else if (read_options.tailing) {
I
Igor Canadi 已提交
3974 3975 3976 3977
#ifdef ROCKSDB_LITE
    return Status::InvalidArgument(
        "Tailing interator not supported in RocksDB lite");
#else
I
Igor Canadi 已提交
3978 3979
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
3980 3981
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
      auto iter = new ForwardIterator(this, read_options, cfd, sv);
3982 3983 3984 3985 3986
      iterators->push_back(NewDBIterator(
          env_, *cfd->ioptions(), cfd->user_comparator(), iter,
          kMaxSequenceNumber,
          sv->mutable_cf_options.max_sequential_skip_in_iterations, nullptr,
          false, read_options.pin_data));
I
Igor Canadi 已提交
3987
    }
I
Igor Canadi 已提交
3988
#endif
I
Igor Canadi 已提交
3989
  } else {
3990 3991
    SequenceNumber latest_snapshot = versions_->LastSequence();

I
Igor Canadi 已提交
3992
    for (size_t i = 0; i < column_families.size(); ++i) {
3993 3994 3995
      auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(
          column_families[i])->cfd();
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
I
Igor Canadi 已提交
3996 3997

      auto snapshot =
3998 3999 4000
          read_options.snapshot != nullptr
              ? reinterpret_cast<const SnapshotImpl*>(
                  read_options.snapshot)->number_
I
Igor Canadi 已提交
4001 4002
              : latest_snapshot;

4003
      ArenaWrappedDBIter* db_iter = NewArenaWrappedDbIterator(
4004
          env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
4005 4006
          sv->mutable_cf_options.max_sequential_skip_in_iterations, nullptr,
          false, read_options.pin_data);
S
sdong 已提交
4007 4008
      InternalIterator* internal_iter =
          NewInternalIterator(read_options, cfd, sv, db_iter->GetArena());
4009 4010
      db_iter->SetIterUnderDBIter(internal_iter);
      iterators->push_back(db_iter);
I
Igor Canadi 已提交
4011 4012 4013 4014
    }
  }

  return Status::OK();
4015 4016
}

4017 4018
const Snapshot* DBImpl::GetSnapshot() { return GetSnapshotImpl(false); }

4019
#ifndef ROCKSDB_LITE
4020 4021 4022
const Snapshot* DBImpl::GetSnapshotForWriteConflictBoundary() {
  return GetSnapshotImpl(true);
}
4023
#endif  // ROCKSDB_LITE
4024 4025

const Snapshot* DBImpl::GetSnapshotImpl(bool is_write_conflict_boundary) {
4026 4027
  int64_t unix_time = 0;
  env_->GetCurrentTime(&unix_time);  // Ignore error
4028
  SnapshotImpl* s = new SnapshotImpl;
4029

4030
  InstrumentedMutexLock l(&mutex_);
4031
  // returns null if the underlying memtable does not support snapshot.
4032 4033 4034 4035
  if (!is_snapshot_supported_) {
    delete s;
    return nullptr;
  }
4036 4037
  return snapshots_.New(s, versions_->LastSequence(), unix_time,
                        is_write_conflict_boundary);
J
jorlow@chromium.org 已提交
4038 4039 4040
}

void DBImpl::ReleaseSnapshot(const Snapshot* s) {
4041 4042 4043 4044 4045 4046
  const SnapshotImpl* casted_s = reinterpret_cast<const SnapshotImpl*>(s);
  {
    InstrumentedMutexLock l(&mutex_);
    snapshots_.Delete(casted_s);
  }
  delete casted_s;
J
jorlow@chromium.org 已提交
4047 4048 4049
}

// Convenience methods
4050 4051
Status DBImpl::Put(const WriteOptions& o, ColumnFamilyHandle* column_family,
                   const Slice& key, const Slice& val) {
4052
  return DB::Put(o, column_family, key, val);
J
jorlow@chromium.org 已提交
4053 4054
}

4055 4056 4057
Status DBImpl::Merge(const WriteOptions& o, ColumnFamilyHandle* column_family,
                     const Slice& key, const Slice& val) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
4058
  if (!cfh->cfd()->ioptions()->merge_operator) {
4059 4060
    return Status::NotSupported("Provide a merge_operator when opening DB");
  } else {
4061
    return DB::Merge(o, column_family, key, val);
4062 4063 4064
  }
}

L
Lei Jin 已提交
4065
Status DBImpl::Delete(const WriteOptions& write_options,
4066
                      ColumnFamilyHandle* column_family, const Slice& key) {
L
Lei Jin 已提交
4067
  return DB::Delete(write_options, column_family, key);
J
jorlow@chromium.org 已提交
4068 4069
}

A
Andres Noetzli 已提交
4070 4071 4072 4073 4074 4075
Status DBImpl::SingleDelete(const WriteOptions& write_options,
                            ColumnFamilyHandle* column_family,
                            const Slice& key) {
  return DB::SingleDelete(write_options, column_family, key);
}

L
Lei Jin 已提交
4076
Status DBImpl::Write(const WriteOptions& write_options, WriteBatch* my_batch) {
A
agiardullo 已提交
4077 4078 4079
  return WriteImpl(write_options, my_batch, nullptr);
}

A
agiardullo 已提交
4080
#ifndef ROCKSDB_LITE
A
agiardullo 已提交
4081 4082 4083 4084 4085
Status DBImpl::WriteWithCallback(const WriteOptions& write_options,
                                 WriteBatch* my_batch,
                                 WriteCallback* callback) {
  return WriteImpl(write_options, my_batch, callback);
}
A
agiardullo 已提交
4086
#endif  // ROCKSDB_LITE
A
agiardullo 已提交
4087 4088 4089

Status DBImpl::WriteImpl(const WriteOptions& write_options,
                         WriteBatch* my_batch, WriteCallback* callback) {
S
Stanislau Hlebik 已提交
4090 4091 4092
  if (my_batch == nullptr) {
    return Status::Corruption("Batch is nullptr!");
  }
4093 4094 4095
  if (write_options.timeout_hint_us != 0) {
    return Status::InvalidArgument("timeout_hint_us is deprecated");
  }
A
agiardullo 已提交
4096 4097

  Status status;
A
agiardullo 已提交
4098

A
agiardullo 已提交
4099 4100 4101 4102 4103 4104 4105 4106 4107 4108
  bool xfunc_attempted_write = false;
  XFUNC_TEST("transaction", "transaction_xftest_write_impl",
             xf_transaction_write1, xf_transaction_write, write_options,
             db_options_, my_batch, callback, this, &status,
             &xfunc_attempted_write);
  if (xfunc_attempted_write) {
    // Test already did the write
    return status;
  }

4109
  PERF_TIMER_GUARD(write_pre_and_post_process_time);
4110
  WriteThread::Writer w;
S
Stanislau Hlebik 已提交
4111
  w.batch = my_batch;
L
Lei Jin 已提交
4112 4113
  w.sync = write_options.sync;
  w.disableWAL = write_options.disableWAL;
S
Stanislau Hlebik 已提交
4114
  w.in_batch_group = false;
4115
  w.callback = callback;
S
Stanislau Hlebik 已提交
4116

L
Lei Jin 已提交
4117
  if (!write_options.disableWAL) {
S
Stanislau Hlebik 已提交
4118 4119 4120
    RecordTick(stats_, WRITE_WITH_WAL);
  }

4121 4122
  StopWatch write_sw(env_, db_options_.statistics.get(), DB_WRITE);

4123
  write_thread_.JoinBatchGroup(&w);
4124 4125 4126 4127
  if (w.state == WriteThread::STATE_PARALLEL_FOLLOWER) {
    // we are a non-leader in a parallel group
    PERF_TIMER_GUARD(write_memtable_time);

4128 4129 4130 4131 4132 4133 4134 4135 4136
    if (!w.CallbackFailed()) {
      ColumnFamilyMemTablesImpl column_family_memtables(
          versions_->GetColumnFamilySet());
      WriteBatchInternal::SetSequence(w.batch, w.sequence);
      w.status = WriteBatchInternal::InsertInto(
          w.batch, &column_family_memtables, &flush_scheduler_,
          write_options.ignore_missing_column_families, 0 /*log_number*/, this,
          true /*dont_filter_deletes*/, true /*concurrent_memtable_writes*/);
    }
4137 4138 4139

    if (write_thread_.CompleteParallelWorker(&w)) {
      // we're responsible for early exit
4140
      auto last_sequence = w.parallel_group->last_sequence;
4141 4142 4143 4144 4145 4146
      SetTickerCount(stats_, SEQUENCE_NUMBER, last_sequence);
      versions_->SetLastSequence(last_sequence);
      write_thread_.EarlyExitParallelGroup(&w);
    }
    assert(w.state == WriteThread::STATE_COMPLETED);
    // STATE_COMPLETED conditional below handles exit
4147 4148

    status = w.FinalStatus();
4149 4150 4151
  }
  if (w.state == WriteThread::STATE_COMPLETED) {
    // write is complete and leader has updated sequence
4152
    RecordTick(stats_, WRITE_DONE_BY_OTHER);
4153
    return w.FinalStatus();
4154 4155
  }
  // else we are the leader of the write batch group
4156
  assert(w.state == WriteThread::STATE_GROUP_LEADER);
4157

S
Stanislau Hlebik 已提交
4158 4159
  WriteContext context;
  mutex_.Lock();
I
Igor Canadi 已提交
4160 4161 4162 4163 4164

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

S
Stanislau Hlebik 已提交
4165 4166
  RecordTick(stats_, WRITE_DONE_BY_SELF);
  default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_DONE_BY_SELF, 1);
4167

4168 4169 4170 4171
  // 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.
4172 4173 4174
  assert(!single_column_family_mode_ ||
         versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1);

4175
  uint64_t max_total_wal_size = (db_options_.max_total_wal_size == 0)
4176
                                    ? 4 * max_total_in_memory_state_
4177
                                    : db_options_.max_total_wal_size;
4178 4179 4180
  if (UNLIKELY(!single_column_family_mode_ &&
               alive_log_files_.begin()->getting_flushed == false &&
               total_log_size_ > max_total_wal_size)) {
I
Igor Canadi 已提交
4181
    uint64_t flush_column_family_if_log_file = alive_log_files_.begin()->number;
I
Igor Canadi 已提交
4182
    alive_log_files_.begin()->getting_flushed = true;
4183
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
4184 4185 4186
        "Flushing all column families with data in WAL number %" PRIu64
        ". Total log size is %" PRIu64 " while max_total_wal_size is %" PRIu64,
        flush_column_family_if_log_file, total_log_size_, max_total_wal_size);
I
Igor Canadi 已提交
4187 4188
    // no need to refcount because drop is happening in write thread, so can't
    // happen while we're in the write thread
4189
    for (auto cfd : *versions_->GetColumnFamilySet()) {
4190 4191 4192
      if (cfd->IsDropped()) {
        continue;
      }
I
Igor Canadi 已提交
4193
      if (cfd->GetLogNumber() <= flush_column_family_if_log_file) {
I
Igor Canadi 已提交
4194
        status = SwitchMemtable(cfd, &context);
I
Igor Canadi 已提交
4195 4196 4197
        if (!status.ok()) {
          break;
        }
S
Stanislau Hlebik 已提交
4198
        cfd->imm()->FlushRequested();
4199
        SchedulePendingFlush(cfd);
4200
      }
4201
    }
I
Igor Canadi 已提交
4202
    MaybeScheduleFlushOrCompaction();
4203 4204
  } else if (UNLIKELY(write_buffer_.ShouldFlush())) {
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
4205 4206
        "Flushing column family with largest mem table size. Write buffer is "
        "using %" PRIu64 " bytes out of a total of %" PRIu64 ".",
4207 4208 4209
        write_buffer_.memory_usage(), write_buffer_.buffer_size());
    // no need to refcount because drop is happening in write thread, so can't
    // happen while we're in the write thread
4210 4211 4212
    ColumnFamilyData* largest_cfd = nullptr;
    size_t largest_cfd_size = 0;

4213
    for (auto cfd : *versions_->GetColumnFamilySet()) {
4214 4215 4216
      if (cfd->IsDropped()) {
        continue;
      }
4217
      if (!cfd->mem()->IsEmpty()) {
4218 4219 4220 4221 4222 4223
        // We only consider active mem table, hoping immutable memtable is
        // already in the process of flushing.
        size_t cfd_size = cfd->mem()->ApproximateMemoryUsage();
        if (largest_cfd == nullptr || cfd_size > largest_cfd_size) {
          largest_cfd = cfd;
          largest_cfd_size = cfd_size;
4224 4225 4226
        }
      }
    }
4227 4228 4229 4230 4231 4232 4233 4234
    if (largest_cfd != nullptr) {
      status = SwitchMemtable(largest_cfd, &context);
      if (status.ok()) {
        largest_cfd->imm()->FlushRequested();
        SchedulePendingFlush(largest_cfd);
        MaybeScheduleFlushOrCompaction();
      }
    }
I
Igor Canadi 已提交
4235 4236 4237 4238 4239 4240 4241 4242 4243 4244
  }

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

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

4245 4246
  if (UNLIKELY(status.ok() && (write_controller_.IsStopped() ||
                               write_controller_.NeedsDelay()))) {
4247 4248
    PERF_TIMER_STOP(write_pre_and_post_process_time);
    PERF_TIMER_GUARD(write_delay_time);
S
sdong 已提交
4249 4250 4251 4252
    // 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.
4253
    status = DelayWrite(last_batch_group_size_);
4254
    PERF_TIMER_START(write_pre_and_post_process_time);
I
Igor Canadi 已提交
4255 4256
  }

D
dgrogan@chromium.org 已提交
4257
  uint64_t last_sequence = versions_->LastSequence();
I
Igor Canadi 已提交
4258
  WriteThread::Writer* last_writer = &w;
4259
  autovector<WriteThread::Writer*> write_group;
4260 4261
  bool need_log_sync = !write_options.disableWAL && write_options.sync;
  bool need_log_dir_sync = need_log_sync && !log_dir_synced_;
A
agiardullo 已提交
4262

S
Stanislau Hlebik 已提交
4263
  if (status.ok()) {
4264
    if (need_log_sync) {
4265 4266 4267 4268 4269 4270 4271 4272 4273
      while (logs_.front().getting_synced) {
        log_sync_cv_.Wait();
      }
      for (auto& log : logs_) {
        assert(!log.getting_synced);
        log.getting_synced = true;
      }
    }

4274 4275 4276
    // 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
4277
    // into memtables
A
agiardullo 已提交
4278 4279
  }

4280 4281
  mutex_.Unlock();

A
agiardullo 已提交
4282 4283
  // At this point the mutex is unlocked

4284
  bool exit_completed_early = false;
4285 4286
  last_batch_group_size_ =
      write_thread_.EnterAsBatchGroupLeader(&w, &last_writer, &write_group);
4287

A
agiardullo 已提交
4288
  if (status.ok()) {
4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301
    // 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.
4302 4303
    bool parallel =
        db_options_.allow_concurrent_memtable_write && write_group.size() > 1;
4304 4305
    int total_count = 0;
    uint64_t total_byte_size = 0;
4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317
    for (auto writer : write_group) {
      if (writer->CheckCallback(this)) {
        total_count += WriteBatchInternal::Count(writer->batch);
        total_byte_size = WriteBatchInternal::AppendedByteSize(
            total_byte_size, WriteBatchInternal::ByteSize(writer->batch));
        parallel = parallel && !writer->batch->HasMerge();
      }
    }

    if (total_count == 0) {
      write_thread_.ExitAsBatchGroupLeader(&w, last_writer, status);
      return w.FinalStatus();
4318 4319 4320 4321 4322 4323 4324 4325
    }

    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);
4326
    MeasureTime(stats_, BYTES_PER_WRITE, total_byte_size);
4327
    PERF_TIMER_STOP(write_pre_and_post_process_time);
4328

4329 4330 4331
    if (write_options.disableWAL) {
      flush_on_destroy_ = true;
    }
4332

4333 4334 4335
    uint64_t log_size = 0;
    if (!write_options.disableWAL) {
      PERF_TIMER_GUARD(write_wal_time);
4336

4337
      WriteBatch* merged_batch = nullptr;
4338 4339
      if (write_group.size() == 1) {
        merged_batch = write_group[0]->batch;
4340 4341 4342 4343 4344
      } 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_;
4345 4346 4347 4348
        for (auto writer : write_group) {
          if (!writer->CallbackFailed()) {
            WriteBatchInternal::Append(merged_batch, writer->batch);
          }
4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384
        }
      }
      WriteBatchInternal::SetSequence(merged_batch, current_sequence);

      assert(WriteBatchInternal::Count(merged_batch) == total_count);
      assert(WriteBatchInternal::ByteSize(merged_batch) == total_byte_size);

      Slice log_entry = WriteBatchInternal::Contents(merged_batch);
      status = logs_.back().writer->AddRecord(log_entry);
      total_log_size_ += log_entry.size();
      alive_log_files_.back().AddSize(log_entry.size());
      log_empty_ = false;
      log_size = log_entry.size();
      RecordTick(stats_, WAL_FILE_BYTES, log_size);
      if (status.ok() && need_log_sync) {
        RecordTick(stats_, WAL_FILE_SYNCED);
        StopWatch sw(env_, stats_, WAL_FILE_SYNC_MICROS);
        // It's safe to access logs_ with unlocked mutex_ here because:
        //  - we've set getting_synced=true for all logs,
        //    so other threads won't pop from logs_ while we're here,
        //  - only writer thread can push to logs_, and we're in
        //    writer thread, so no one will push to logs_,
        //  - as long as other threads don't modify it, it's safe to read
        //    from std::deque from multiple threads concurrently.
        for (auto& log : logs_) {
          status = log.writer->file()->Sync(db_options_.use_fsync);
          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();
        }
4385 4386
      }

4387 4388 4389 4390 4391 4392
      if (merged_batch == &tmp_batch_) {
        tmp_batch_.Clear();
      }
    }
    if (status.ok()) {
      PERF_TIMER_GUARD(write_memtable_time);
4393

4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405
      {
        // 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);
4406
          }
4407
          stats->AddDBStats(InternalStats::WAL_FILE_BYTES, log_size);
4408
        }
4409
        uint64_t for_other = write_group.size() - 1;
4410 4411 4412 4413
        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);
4414
          }
H
heyongqiang 已提交
4415
        }
4416
      }
Y
Yueh-Hsuan Chiang 已提交
4417

4418
      if (!parallel) {
4419
        status = WriteBatchInternal::InsertInto(
4420
            write_group, current_sequence, column_family_memtables_.get(),
4421 4422
            &flush_scheduler_, write_options.ignore_missing_column_families,
            0 /*log_number*/, this, false /*dont_filter_deletes*/);
4423 4424 4425 4426 4427 4428 4429

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

4430
      } else {
4431
        WriteThread::ParallelGroup pg;
4432 4433
        pg.leader = &w;
        pg.last_writer = last_writer;
4434
        pg.last_sequence = last_sequence;
4435
        pg.early_exit_allowed = !need_log_sync;
4436
        pg.running.store(static_cast<uint32_t>(write_group.size()),
4437
                         std::memory_order_relaxed);
4438 4439
        write_thread_.LaunchParallelFollowers(&pg, current_sequence);

4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452
        if (!w.CallbackFailed()) {
          // do leader write
          ColumnFamilyMemTablesImpl column_family_memtables(
              versions_->GetColumnFamilySet());
          assert(w.sequence == current_sequence);
          WriteBatchInternal::SetSequence(w.batch, w.sequence);
          w.status = WriteBatchInternal::InsertInto(
              w.batch, &column_family_memtables, &flush_scheduler_,
              write_options.ignore_missing_column_families, 0 /*log_number*/,
              this, true /*dont_filter_deletes*/,
              true /*concurrent_memtable_writes*/);
        }

4453 4454 4455
        // CompleteParallelWorker returns true if this thread should
        // handle exit, false means somebody else did
        exit_completed_early = !write_thread_.CompleteParallelWorker(&w);
4456
        status = w.FinalStatus();
4457
      }
A
agiardullo 已提交
4458

4459
      if (!exit_completed_early && w.status.ok()) {
4460 4461 4462
        SetTickerCount(stats_, SEQUENCE_NUMBER, last_sequence);
        versions_->SetLastSequence(last_sequence);
        if (!need_log_sync) {
4463
          write_thread_.ExitAsBatchGroupLeader(&w, last_writer, w.status);
4464
          exit_completed_early = true;
4465
        }
4466
      }
4467 4468 4469 4470 4471 4472 4473 4474 4475

      // 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.
4476
      if (!status.ok() && bg_error_.ok() && !w.CallbackFailed()) {
4477
        bg_error_ = status;
4478
      }
4479
    }
4480
  }
4481
  PERF_TIMER_START(write_pre_and_post_process_time);
A
agiardullo 已提交
4482

4483
  if (db_options_.paranoid_checks && !status.ok() && !w.CallbackFailed() &&
4484 4485 4486 4487 4488 4489
      !status.IsBusy()) {
    mutex_.Lock();
    if (bg_error_.ok()) {
      bg_error_ = status;  // stop compaction & fail any further writes
    }
    mutex_.Unlock();
I
Igor Canadi 已提交
4490
  }
4491

4492
  if (need_log_sync) {
4493
    mutex_.Lock();
4494
    MarkLogsSynced(logfile_number_, need_log_dir_sync, status);
4495
    mutex_.Unlock();
4496 4497
  }

4498
  if (!exit_completed_early) {
4499
    write_thread_.ExitAsBatchGroupLeader(&w, last_writer, w.status);
4500
  }
4501

J
jorlow@chromium.org 已提交
4502 4503 4504
  return status;
}

4505 4506
// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
4507
Status DBImpl::DelayWrite(uint64_t num_bytes) {
S
sdong 已提交
4508 4509 4510 4511
  uint64_t time_delayed = 0;
  bool delayed = false;
  {
    StopWatch sw(env_, stats_, WRITE_STALL, &time_delayed);
S
sdong 已提交
4512 4513
    auto delay = write_controller_.GetDelay(env_, num_bytes);
    if (delay > 0) {
S
sdong 已提交
4514 4515
      mutex_.Unlock();
      delayed = true;
S
sdong 已提交
4516
      TEST_SYNC_POINT("DBImpl::DelayWrite:Sleep");
4517 4518
      // hopefully we don't have to sleep more than 2 billion microseconds
      env_->SleepForMicroseconds(static_cast<int>(delay));
S
sdong 已提交
4519 4520
      mutex_.Lock();
    }
4521

4522
    while (bg_error_.ok() && write_controller_.IsStopped()) {
S
sdong 已提交
4523
      delayed = true;
4524 4525
      TEST_SYNC_POINT("DBImpl::DelayWrite:Wait");
      bg_cv_.Wait();
4526 4527
    }
  }
S
sdong 已提交
4528 4529 4530 4531 4532
  if (delayed) {
    default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_STALL_MICROS,
                                           time_delayed);
    RecordTick(stats_, STALL_MICROS, time_delayed);
  }
I
Igor Canadi 已提交
4533 4534

  return bg_error_;
4535 4536
}

I
Igor Canadi 已提交
4537 4538
Status DBImpl::ScheduleFlushes(WriteContext* context) {
  ColumnFamilyData* cfd;
4539
  while ((cfd = flush_scheduler_.TakeNextColumnFamily()) != nullptr) {
I
Igor Canadi 已提交
4540
    auto status = SwitchMemtable(cfd, context);
I
Igor Canadi 已提交
4541 4542 4543 4544 4545
    if (cfd->Unref()) {
      delete cfd;
    }
    if (!status.ok()) {
      return status;
S
Stanislau Hlebik 已提交
4546 4547
    }
  }
I
Igor Canadi 已提交
4548
  return Status::OK();
S
Stanislau Hlebik 已提交
4549 4550 4551 4552
}

// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
I
Igor Canadi 已提交
4553
Status DBImpl::SwitchMemtable(ColumnFamilyData* cfd, WriteContext* context) {
S
Stanislau Hlebik 已提交
4554 4555 4556 4557 4558 4559 4560
  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.
4561
  assert(versions_->prev_log_number() == 0);
S
Stanislau Hlebik 已提交
4562
  bool creating_new_log = !log_empty_;
S
Sage Weil 已提交
4563 4564 4565 4566 4567 4568
  uint64_t recycle_log_number = 0;
  if (creating_new_log && db_options_.recycle_log_file_num &&
      !log_recycle_files.empty()) {
    recycle_log_number = log_recycle_files.front();
    log_recycle_files.pop_front();
  }
S
Stanislau Hlebik 已提交
4569 4570 4571
  uint64_t new_log_number =
      creating_new_log ? versions_->NewFileNumber() : logfile_number_;
  SuperVersion* new_superversion = nullptr;
4572
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
S
Stanislau Hlebik 已提交
4573 4574 4575 4576
  mutex_.Unlock();
  Status s;
  {
    if (creating_new_log) {
4577 4578
      EnvOptions opt_env_opt =
          env_->OptimizeForLogWrite(env_options_, db_options_);
S
Sage Weil 已提交
4579 4580 4581 4582 4583 4584 4585 4586
      if (recycle_log_number) {
        Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
            "reusing log %" PRIu64 " from recycle list\n", recycle_log_number);
        s = env_->ReuseWritableFile(
            LogFileName(db_options_.wal_dir, new_log_number),
            LogFileName(db_options_.wal_dir, recycle_log_number), &lfile,
            opt_env_opt);
      } else {
S
sdong 已提交
4587 4588 4589
        s = NewWritableFile(env_,
                            LogFileName(db_options_.wal_dir, new_log_number),
                            &lfile, opt_env_opt);
S
Sage Weil 已提交
4590
      }
S
Stanislau Hlebik 已提交
4591 4592 4593
      if (s.ok()) {
        // Our final size should be less than write_buffer_size
        // (compression, etc) but err on the side of caution.
D
Dmitri Smirnov 已提交
4594 4595 4596
        lfile->SetPreallocationBlockSize(
            mutable_cf_options.write_buffer_size / 10 +
            mutable_cf_options.write_buffer_size);
4597 4598
        unique_ptr<WritableFileWriter> file_writer(
            new WritableFileWriter(std::move(lfile), opt_env_opt));
S
sdong 已提交
4599 4600
        new_log = new log::Writer(std::move(file_writer), new_log_number,
                                  db_options_.recycle_log_file_num > 0);
I
Igor Canadi 已提交
4601
      }
S
Stanislau Hlebik 已提交
4602 4603 4604
    }

    if (s.ok()) {
A
agiardullo 已提交
4605 4606
      SequenceNumber seq = versions_->LastSequence();
      new_mem = cfd->ConstructNewMemtable(mutable_cf_options, seq);
S
Stanislau Hlebik 已提交
4607 4608 4609
      new_superversion = new SuperVersion();
    }
  }
4610
  Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
I
Igor Canadi 已提交
4611 4612
      "[%s] New memtable created with log file: #%" PRIu64 "\n",
      cfd->GetName().c_str(), new_log_number);
S
Stanislau Hlebik 已提交
4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624
  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;
4625
    log_dir_synced_ = false;
4626
    logs_.emplace_back(logfile_number_, new_log);
S
Stanislau Hlebik 已提交
4627
    alive_log_files_.push_back(LogFileNumberSize(logfile_number_));
I
Igor Canadi 已提交
4628
    for (auto loop_cfd : *versions_->GetColumnFamilySet()) {
S
Stanislau Hlebik 已提交
4629 4630 4631 4632
      // all this is just optimization to delete logs that
      // are no longer needed -- if CF is empty, that means it
      // doesn't need that particular log to stay alive, so we just
      // advance the log number. no need to persist this in the manifest
I
Igor Canadi 已提交
4633
      if (loop_cfd->mem()->GetFirstSequenceNumber() == 0 &&
4634
          loop_cfd->imm()->NumNotFlushed() == 0) {
I
Igor Canadi 已提交
4635
        loop_cfd->SetLogNumber(logfile_number_);
4636
      }
4637 4638
    }
  }
S
Stanislau Hlebik 已提交
4639
  cfd->mem()->SetNextLogNumber(logfile_number_);
4640
  cfd->imm()->Add(cfd->mem(), &context->memtables_to_free_);
S
Stanislau Hlebik 已提交
4641 4642
  new_mem->Ref();
  cfd->SetMemtable(new_mem);
I
Igor Canadi 已提交
4643 4644
  context->superversions_to_free_.push_back(InstallSuperVersionAndScheduleWork(
      cfd, new_superversion, mutable_cf_options));
4645 4646 4647
  return s;
}

I
Igor Canadi 已提交
4648
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
4649 4650 4651 4652 4653
Status DBImpl::GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                        TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

4654 4655
  // Increment the ref count
  mutex_.Lock();
I
Igor Canadi 已提交
4656
  auto version = cfd->current();
4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfAllTables(props);

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

  return s;
}
4669 4670

Status DBImpl::GetPropertiesOfTablesInRange(ColumnFamilyHandle* column_family,
4671
                                            const Range* range, std::size_t n,
4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691
                                            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 已提交
4692
#endif  // ROCKSDB_LITE
4693

I
Igor Canadi 已提交
4694 4695 4696 4697
const std::string& DBImpl::GetName() const {
  return dbname_;
}

4698 4699 4700 4701
Env* DBImpl::GetEnv() const {
  return env_;
}

4702 4703
const Options& DBImpl::GetOptions(ColumnFamilyHandle* column_family) const {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
I
Igor Canadi 已提交
4704
  return *cfh->cfd()->options();
I
Igor Canadi 已提交
4705 4706
}

4707 4708
const DBOptions& DBImpl::GetDBOptions() const { return db_options_; }

4709
bool DBImpl::GetProperty(ColumnFamilyHandle* column_family,
4710
                         const Slice& property, std::string* value) {
4711
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
4712
  value->clear();
4713
  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
4714 4715 4716
  if (property_info == nullptr) {
    return false;
  } else if (property_info->handle_int) {
4717
    uint64_t int_value;
4718 4719
    bool ret_value =
        GetIntPropertyInternal(cfd, *property_info, false, &int_value);
4720
    if (ret_value) {
4721
      *value = ToString(int_value);
4722 4723
    }
    return ret_value;
4724
  } else if (property_info->handle_string) {
4725
    InstrumentedMutexLock l(&mutex_);
4726
    return cfd->internal_stats()->GetStringProperty(*property_info, property,
4727 4728
                                                    value);
  }
4729 4730 4731 4732
  // 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 已提交
4733 4734
}

4735 4736
bool DBImpl::GetIntProperty(ColumnFamilyHandle* column_family,
                            const Slice& property, uint64_t* value) {
4737 4738
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
  if (property_info == nullptr || property_info->handle_int == nullptr) {
4739 4740
    return false;
  }
4741
  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
4742
  return GetIntPropertyInternal(cfd, *property_info, false, value);
4743 4744
}

4745
bool DBImpl::GetIntPropertyInternal(ColumnFamilyData* cfd,
4746 4747 4748 4749
                                    const DBPropertyInfo& property_info,
                                    bool is_locked, uint64_t* value) {
  assert(property_info.handle_int != nullptr);
  if (!property_info.need_out_of_mutex) {
4750 4751
    if (is_locked) {
      mutex_.AssertHeld();
4752
      return cfd->internal_stats()->GetIntProperty(property_info, value, this);
4753 4754
    } else {
      InstrumentedMutexLock l(&mutex_);
4755
      return cfd->internal_stats()->GetIntProperty(property_info, value, this);
4756
    }
4757
  } else {
4758 4759 4760 4761 4762 4763
    SuperVersion* sv = nullptr;
    if (!is_locked) {
      sv = GetAndRefSuperVersion(cfd);
    } else {
      sv = cfd->GetSuperVersion();
    }
4764 4765

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

4768 4769 4770
    if (!is_locked) {
      ReturnAndCleanupSuperVersion(cfd, sv);
    }
4771 4772 4773 4774 4775

    return ret;
  }
}

4776 4777
bool DBImpl::GetAggregatedIntProperty(const Slice& property,
                                      uint64_t* aggregated_value) {
4778 4779
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
  if (property_info == nullptr || property_info->handle_int == nullptr) {
4780 4781 4782 4783 4784 4785 4786 4787 4788
    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()) {
4789
      if (GetIntPropertyInternal(cfd, *property_info, true, &value)) {
4790 4791 4792 4793 4794 4795 4796 4797 4798 4799
        sum += value;
      } else {
        return false;
      }
    }
  }
  *aggregated_value = sum;
  return true;
}

4800 4801
SuperVersion* DBImpl::GetAndRefSuperVersion(ColumnFamilyData* cfd) {
  // TODO(ljin): consider using GetReferencedSuperVersion() directly
I
Igor Canadi 已提交
4802
  return cfd->GetThreadLocalSuperVersion(&mutex_);
4803 4804
}

A
agiardullo 已提交
4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816
// REQUIRED: this function should only be called on the write thread or if the
// mutex is held.
SuperVersion* DBImpl::GetAndRefSuperVersion(uint32_t column_family_id) {
  auto column_family_set = versions_->GetColumnFamilySet();
  auto cfd = column_family_set->GetColumnFamily(column_family_id);
  if (!cfd) {
    return nullptr;
  }

  return GetAndRefSuperVersion(cfd);
}

A
agiardullo 已提交
4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832
// REQUIRED:  mutex is NOT held
SuperVersion* DBImpl::GetAndRefSuperVersionUnlocked(uint32_t column_family_id) {
  ColumnFamilyData* cfd;
  {
    InstrumentedMutexLock l(&mutex_);
    auto column_family_set = versions_->GetColumnFamilySet();
    cfd = column_family_set->GetColumnFamily(column_family_id);
  }

  if (!cfd) {
    return nullptr;
  }

  return GetAndRefSuperVersion(cfd);
}

4833 4834
void DBImpl::ReturnAndCleanupSuperVersion(ColumnFamilyData* cfd,
                                          SuperVersion* sv) {
I
Igor Canadi 已提交
4835
  bool unref_sv = !cfd->ReturnThreadLocalSuperVersion(sv);
4836 4837 4838 4839 4840

  if (unref_sv) {
    // Release SuperVersion
    if (sv->Unref()) {
      {
4841
        InstrumentedMutexLock l(&mutex_);
4842 4843 4844 4845 4846 4847 4848
        sv->Cleanup();
      }
      delete sv;
      RecordTick(stats_, NUMBER_SUPERVERSION_CLEANUPS);
    }
    RecordTick(stats_, NUMBER_SUPERVERSION_RELEASES);
  }
4849 4850
}

A
agiardullo 已提交
4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862
// REQUIRED: this function should only be called on the write thread.
void DBImpl::ReturnAndCleanupSuperVersion(uint32_t column_family_id,
                                          SuperVersion* sv) {
  auto column_family_set = versions_->GetColumnFamilySet();
  auto cfd = column_family_set->GetColumnFamily(column_family_id);

  // If SuperVersion is held, and we successfully fetched a cfd using
  // GetAndRefSuperVersion(), it must still exist.
  assert(cfd != nullptr);
  ReturnAndCleanupSuperVersion(cfd, sv);
}

A
agiardullo 已提交
4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878
// REQUIRED: Mutex should NOT be held.
void DBImpl::ReturnAndCleanupSuperVersionUnlocked(uint32_t column_family_id,
                                                  SuperVersion* sv) {
  ColumnFamilyData* cfd;
  {
    InstrumentedMutexLock l(&mutex_);
    auto column_family_set = versions_->GetColumnFamilySet();
    cfd = column_family_set->GetColumnFamily(column_family_id);
  }

  // If SuperVersion is held, and we successfully fetched a cfd using
  // GetAndRefSuperVersion(), it must still exist.
  assert(cfd != nullptr);
  ReturnAndCleanupSuperVersion(cfd, sv);
}

A
agiardullo 已提交
4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890
// REQUIRED: this function should only be called on the write thread or if the
// mutex is held.
ColumnFamilyHandle* DBImpl::GetColumnFamilyHandle(uint32_t column_family_id) {
  ColumnFamilyMemTables* cf_memtables = column_family_memtables_.get();

  if (!cf_memtables->Seek(column_family_id)) {
    return nullptr;
  }

  return cf_memtables->GetColumnFamilyHandle();
}

A
agiardullo 已提交
4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904
// REQUIRED: mutex is NOT held.
ColumnFamilyHandle* DBImpl::GetColumnFamilyHandleUnlocked(
    uint32_t column_family_id) {
  ColumnFamilyMemTables* cf_memtables = column_family_memtables_.get();

  InstrumentedMutexLock l(&mutex_);

  if (!cf_memtables->Seek(column_family_id)) {
    return nullptr;
  }

  return cf_memtables->GetColumnFamilyHandle();
}

4905
void DBImpl::GetApproximateSizes(ColumnFamilyHandle* column_family,
4906 4907
                                 const Range* range, int n, uint64_t* sizes,
                                 bool include_memtable) {
J
jorlow@chromium.org 已提交
4908
  Version* v;
4909 4910
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
4911 4912
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
  v = sv->current;
J
jorlow@chromium.org 已提交
4913 4914 4915

  for (int i = 0; i < n; i++) {
    // Convert user_key into a corresponding internal key.
4916 4917 4918
    InternalKey k1(range[i].start, kMaxSequenceNumber, kValueTypeForSeek);
    InternalKey k2(range[i].limit, kMaxSequenceNumber, kValueTypeForSeek);
    sizes[i] = versions_->ApproximateSize(v, k1.Encode(), k2.Encode());
4919 4920 4921 4922
    if (include_memtable) {
      sizes[i] += sv->mem->ApproximateSize(k1.Encode(), k2.Encode());
      sizes[i] += sv->imm->ApproximateSize(k1.Encode(), k2.Encode());
    }
J
jorlow@chromium.org 已提交
4923 4924
  }

4925
  ReturnAndCleanupSuperVersion(cfd, sv);
J
jorlow@chromium.org 已提交
4926 4927
}

I
Igor Canadi 已提交
4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943
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 已提交
4944 4945 4946 4947 4948
#ifndef ROCKSDB_LITE
Status DBImpl::GetUpdatesSince(
    SequenceNumber seq, unique_ptr<TransactionLogIterator>* iter,
    const TransactionLogIterator::ReadOptions& read_options) {

L
Lei Jin 已提交
4949
  RecordTick(stats_, GET_UPDATES_SINCE_CALLS);
I
Igor Canadi 已提交
4950 4951 4952
  if (seq > versions_->LastSequence()) {
    return Status::NotFound("Requested sequence not yet written in the db");
  }
I
Igor Canadi 已提交
4953
  return wal_manager_.GetUpdatesSince(seq, iter, read_options, versions_.get());
I
Igor Canadi 已提交
4954 4955
}

4956 4957 4958
Status DBImpl::DeleteFile(std::string name) {
  uint64_t number;
  FileType type;
4959 4960 4961
  WalFileType log_type;
  if (!ParseFileName(name, &number, &type, &log_type) ||
      (type != kTableFile && type != kLogFile)) {
4962 4963
    Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
        "DeleteFile %s failed.\n", name.c_str());
4964 4965 4966
    return Status::InvalidArgument("Invalid file name");
  }

4967 4968 4969 4970
  Status status;
  if (type == kLogFile) {
    // Only allow deleting archived log files
    if (log_type != kArchivedLogFile) {
4971 4972
      Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
          "DeleteFile %s failed - not archived log.\n",
4973
          name.c_str());
4974 4975
      return Status::NotSupported("Delete only supported for archived logs");
    }
4976
    status = env_->DeleteFile(db_options_.wal_dir + "/" + name.c_str());
4977
    if (!status.ok()) {
4978 4979
      Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
          "DeleteFile %s failed -- %s.\n",
4980
          name.c_str(), status.ToString().c_str());
4981 4982 4983 4984
    }
    return status;
  }

4985
  int level;
I
Igor Canadi 已提交
4986
  FileMetaData* metadata;
4987
  ColumnFamilyData* cfd;
4988
  VersionEdit edit;
4989
  JobContext job_context(next_job_id_.fetch_add(1), true);
D
Dhruba Borthakur 已提交
4990
  {
4991
    InstrumentedMutexLock l(&mutex_);
4992
    status = versions_->GetMetadataForFile(number, &level, &metadata, &cfd);
D
Dhruba Borthakur 已提交
4993
    if (!status.ok()) {
4994 4995
      Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
          "DeleteFile %s failed. File not found\n", name.c_str());
I
Igor Canadi 已提交
4996
      job_context.Clean();
D
Dhruba Borthakur 已提交
4997 4998
      return Status::InvalidArgument("File not found");
    }
4999
    assert(level < cfd->NumberLevels());
5000

D
Dhruba Borthakur 已提交
5001
    // If the file is being compacted no need to delete.
5002
    if (metadata->being_compacted) {
5003
      Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
5004
          "DeleteFile %s Skipped. File about to be compacted\n", name.c_str());
I
Igor Canadi 已提交
5005
      job_context.Clean();
D
Dhruba Borthakur 已提交
5006
      return Status::OK();
5007 5008
    }

D
Dhruba Borthakur 已提交
5009 5010 5011
    // 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 已提交
5012
    auto* vstoreage = cfd->current()->storage_info();
I
Igor Canadi 已提交
5013
    for (int i = level + 1; i < cfd->NumberLevels(); i++) {
S
sdong 已提交
5014
      if (vstoreage->NumLevelFiles(i) != 0) {
5015
        Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
5016
            "DeleteFile %s FAILED. File not in last level\n", name.c_str());
I
Igor Canadi 已提交
5017
        job_context.Clean();
D
Dhruba Borthakur 已提交
5018 5019 5020
        return Status::InvalidArgument("File not in last level");
      }
    }
5021
    // if level == 0, it has to be the oldest file
S
sdong 已提交
5022 5023
    if (level == 0 &&
        vstoreage->LevelFiles(0).back()->fd.GetNumber() != number) {
5024 5025
      Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
          "DeleteFile %s failed ---"
L
Lei Jin 已提交
5026
          " target file in level 0 must be the oldest.", name.c_str());
I
Igor Canadi 已提交
5027
      job_context.Clean();
5028 5029 5030
      return Status::InvalidArgument("File in level 0, but not oldest");
    }
    edit.SetColumnFamily(cfd->GetID());
D
Dhruba Borthakur 已提交
5031
    edit.DeleteFile(level, number);
5032
    status = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
5033
                                    &edit, &mutex_, directories_.GetDbDir());
I
Igor Canadi 已提交
5034
    if (status.ok()) {
I
Igor Canadi 已提交
5035 5036
      InstallSuperVersionAndScheduleWorkWrapper(
          cfd, &job_context, *cfd->GetLatestMutableCFOptions());
I
Igor Canadi 已提交
5037
    }
I
Igor Canadi 已提交
5038 5039
    FindObsoleteFiles(&job_context, false);
  }  // lock released here
5040

5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056
  LogFlush(db_options_.info_log);
  // 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;
5057
  std::vector<FileMetaData*> deleted_files;
5058 5059 5060
  JobContext job_context(next_job_id_.fetch_add(1), true);
  {
    InstrumentedMutexLock l(&mutex_);
5061
    Version* input_version = cfd->current();
5062

5063 5064
    auto* vstorage = input_version->storage_info();
    for (int i = 1; i < cfd->NumberLevels(); i++) {
5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085
      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);
5086 5087 5088
      FileMetaData* level_file;
      for (uint32_t j = 0; j < level_files.size(); j++) {
        level_file = level_files[j];
5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099
        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());
5100 5101
          deleted_files.push_back(level_file);
          level_file->being_compacted = true;
5102 5103 5104 5105
        }
      }
    }
    if (edit.GetDeletedFiles().empty()) {
5106
      job_context.Clean();
5107 5108
      return Status::OK();
    }
5109
    input_version->Ref();
5110 5111 5112 5113 5114 5115
    status = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                    &edit, &mutex_, directories_.GetDbDir());
    if (status.ok()) {
      InstallSuperVersionAndScheduleWorkWrapper(
          cfd, &job_context, *cfd->GetLatestMutableCFOptions());
    }
5116 5117 5118 5119
    for (auto* deleted_file : deleted_files) {
      deleted_file->being_compacted = false;
    }
    input_version->Unref();
5120 5121 5122
    FindObsoleteFiles(&job_context, false);
  }  // lock released here

5123
  LogFlush(db_options_.info_log);
I
Igor Canadi 已提交
5124
  // remove files outside the db-lock
I
Igor Canadi 已提交
5125
  if (job_context.HaveSomethingToDelete()) {
5126
    // Call PurgeObsoleteFiles() without holding mutex.
I
Igor Canadi 已提交
5127
    PurgeObsoleteFiles(job_context);
5128
  }
I
Igor Canadi 已提交
5129
  job_context.Clean();
5130 5131 5132
  return status;
}

5133
void DBImpl::GetLiveFilesMetaData(std::vector<LiveFileMetaData>* metadata) {
5134
  InstrumentedMutexLock l(&mutex_);
5135
  versions_->GetLiveFilesMetaData(metadata);
5136
}
5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147

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 已提交
5148
#endif  // ROCKSDB_LITE
5149

I
Igor Canadi 已提交
5150 5151 5152 5153 5154 5155 5156
Status DBImpl::CheckConsistency() {
  mutex_.AssertHeld();
  std::vector<LiveFileMetaData> metadata;
  versions_->GetLiveFilesMetaData(&metadata);

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

I
Igor Canadi 已提交
5160 5161
    uint64_t fsize = 0;
    Status s = env_->GetFileSize(file_path, &fsize);
D
dyniusz 已提交
5162 5163 5164 5165
    if (!s.ok() &&
        env_->GetFileSize(Rocks2LevelTableFileName(file_path), &fsize).ok()) {
      s = Status::OK();
    }
I
Igor Canadi 已提交
5166 5167 5168 5169
    if (!s.ok()) {
      corruption_messages +=
          "Can't access " + md.name + ": " + s.ToString() + "\n";
    } else if (fsize != md.size) {
5170
      corruption_messages += "Sst file size mismatch: " + file_path +
I
Igor Canadi 已提交
5171
                             ". Size recorded in manifest " +
5172 5173
                             ToString(md.size) + ", actual size " +
                             ToString(fsize) + "\n";
I
Igor Canadi 已提交
5174 5175 5176 5177 5178 5179 5180 5181 5182
    }
  }
  if (corruption_messages.size() == 0) {
    return Status::OK();
  } else {
    return Status::Corruption(corruption_messages);
  }
}

5183
Status DBImpl::GetDbIdentity(std::string& identity) const {
5184 5185
  std::string idfilename = IdentityFileName(dbname_);
  const EnvOptions soptions;
5186 5187 5188 5189 5190 5191 5192 5193 5194
  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)));
5195
  }
5196

5197 5198 5199 5200 5201
  uint64_t file_size;
  s = env_->GetFileSize(idfilename, &file_size);
  if (!s.ok()) {
    return s;
  }
D
Dmitri Smirnov 已提交
5202
  char* buffer = reinterpret_cast<char*>(alloca(file_size));
5203
  Slice id;
5204
  s = id_file_reader->Read(static_cast<size_t>(file_size), &id, buffer);
5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215
  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 已提交
5216 5217
// Default implementations of convenience methods that subclasses of DB
// can call if they wish
5218
Status DB::Put(const WriteOptions& opt, ColumnFamilyHandle* column_family,
5219
               const Slice& key, const Slice& value) {
5220 5221 5222 5223
  // 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);
5224
  batch.Put(column_family, key, value);
J
jorlow@chromium.org 已提交
5225 5226 5227
  return Write(opt, &batch);
}

5228 5229
Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
J
jorlow@chromium.org 已提交
5230
  WriteBatch batch;
5231
  batch.Delete(column_family, key);
J
jorlow@chromium.org 已提交
5232 5233 5234
  return Write(opt, &batch);
}

A
Andres Noetzli 已提交
5235 5236 5237 5238 5239 5240 5241
Status DB::SingleDelete(const WriteOptions& opt,
                        ColumnFamilyHandle* column_family, const Slice& key) {
  WriteBatch batch;
  batch.SingleDelete(column_family, key);
  return Write(opt, &batch);
}

5242 5243
Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
5244
  WriteBatch batch;
5245
  batch.Merge(column_family, key, value);
5246 5247 5248
  return Write(opt, &batch);
}

5249
// Default implementation -- returns not supported status
L
Lei Jin 已提交
5250
Status DB::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
5251
                              const std::string& column_family_name,
5252
                              ColumnFamilyHandle** handle) {
5253
  return Status::NotSupported("");
5254
}
5255
Status DB::DropColumnFamily(ColumnFamilyHandle* column_family) {
5256
  return Status::NotSupported("");
5257 5258
}

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

J
Jim Paton 已提交
5261
Status DB::Open(const Options& options, const std::string& dbname, DB** dbptr) {
5262 5263 5264 5265
  DBOptions db_options(options);
  ColumnFamilyOptions cf_options(options);
  std::vector<ColumnFamilyDescriptor> column_families;
  column_families.push_back(
5266
      ColumnFamilyDescriptor(kDefaultColumnFamilyName, cf_options));
5267
  std::vector<ColumnFamilyHandle*> handles;
5268
  Status s = DB::Open(db_options, dbname, column_families, &handles, dbptr);
5269 5270 5271 5272 5273 5274 5275
  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;
5276 5277
}

5278 5279
Status DB::Open(const DBOptions& db_options, const std::string& dbname,
                const std::vector<ColumnFamilyDescriptor>& column_families,
5280
                std::vector<ColumnFamilyHandle*>* handles, DB** dbptr) {
5281
  Status s = SanitizeOptionsByTable(db_options, column_families);
5282 5283 5284
  if (!s.ok()) {
    return s;
  }
5285

5286 5287
  for (auto& cfd : column_families) {
    s = CheckCompressionSupported(cfd.options);
5288 5289 5290
    if (s.ok() && db_options.allow_concurrent_memtable_write) {
      s = CheckConcurrentWritesSupported(cfd.options);
    }
5291 5292 5293 5294
    if (!s.ok()) {
      return s;
    }
    if (db_options.db_paths.size() > 1) {
5295 5296
      if ((cfd.options.compaction_style != kCompactionStyleUniversal) &&
          (cfd.options.compaction_style != kCompactionStyleLevel)) {
5297 5298
        return Status::NotSupported(
            "More than one DB paths are only supported in "
5299
            "universal and level compaction styles. ");
5300 5301
      }
    }
5302
  }
5303

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

5309
  *dbptr = nullptr;
5310
  handles->clear();
J
jorlow@chromium.org 已提交
5311

I
Igor Canadi 已提交
5312 5313 5314 5315
  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);
5316
  }
5317

I
Igor Canadi 已提交
5318
  DBImpl* impl = new DBImpl(db_options, dbname);
5319
  s = impl->env_->CreateDirIfMissing(impl->db_options_.wal_dir);
5320
  if (s.ok()) {
5321
    for (auto db_path : impl->db_options_.db_paths) {
5322
      s = impl->env_->CreateDirIfMissing(db_path.path);
5323 5324 5325 5326 5327 5328
      if (!s.ok()) {
        break;
      }
    }
  }

5329 5330 5331 5332 5333 5334
  if (!s.ok()) {
    delete impl;
    return s;
  }

  s = impl->CreateArchivalDirectory();
5335 5336 5337 5338
  if (!s.ok()) {
    delete impl;
    return s;
  }
J
jorlow@chromium.org 已提交
5339
  impl->mutex_.Lock();
5340 5341
  // Handles create_if_missing, error_if_exists
  s = impl->Recover(column_families);
J
jorlow@chromium.org 已提交
5342
  if (s.ok()) {
5343
    uint64_t new_log_number = impl->versions_->NewFileNumber();
5344
    unique_ptr<WritableFile> lfile;
5345
    EnvOptions soptions(db_options);
5346 5347
    EnvOptions opt_env_options =
        impl->db_options_.env->OptimizeForLogWrite(soptions, impl->db_options_);
S
sdong 已提交
5348 5349 5350
    s = NewWritableFile(impl->db_options_.env,
                        LogFileName(impl->db_options_.wal_dir, new_log_number),
                        &lfile, opt_env_options);
J
jorlow@chromium.org 已提交
5351
    if (s.ok()) {
D
Dmitri Smirnov 已提交
5352
      lfile->SetPreallocationBlockSize((max_write_buffer_size / 10) + max_write_buffer_size);
5353
      impl->logfile_number_ = new_log_number;
5354 5355
      unique_ptr<WritableFileWriter> file_writer(
          new WritableFileWriter(std::move(lfile), opt_env_options));
5356 5357
      impl->logs_.emplace_back(
          new_log_number,
S
sdong 已提交
5358 5359
          new log::Writer(std::move(file_writer), new_log_number,
                          impl->db_options_.recycle_log_file_num > 0));
I
Igor Canadi 已提交
5360

5361 5362
      // set column family handles
      for (auto cf : column_families) {
I
Igor Canadi 已提交
5363 5364
        auto cfd =
            impl->versions_->GetColumnFamilySet()->GetColumnFamily(cf.name);
I
Igor Canadi 已提交
5365 5366 5367
        if (cfd != nullptr) {
          handles->push_back(
              new ColumnFamilyHandleImpl(cfd, impl, &impl->mutex_));
5368
          impl->NewThreadStatusCfInfo(cfd);
I
Igor Canadi 已提交
5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384
        } 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 已提交
5385
        }
5386
      }
I
Igor Canadi 已提交
5387 5388
    }
    if (s.ok()) {
5389
      for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
5390
        delete impl->InstallSuperVersionAndScheduleWork(
L
Lei Jin 已提交
5391
            cfd, nullptr, *cfd->GetLatestMutableCFOptions());
5392
      }
I
Igor Canadi 已提交
5393 5394
      impl->alive_log_files_.push_back(
          DBImpl::LogFileNumberSize(impl->logfile_number_));
J
jorlow@chromium.org 已提交
5395
      impl->DeleteObsoleteFiles();
5396
      s = impl->directories_.GetDbDir()->Fsync();
J
jorlow@chromium.org 已提交
5397 5398
    }
  }
5399

I
Igor Canadi 已提交
5400 5401
  if (s.ok()) {
    for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
S
sdong 已提交
5402
      if (cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
S
sdong 已提交
5403
        auto* vstorage = cfd->current()->storage_info();
5404
        for (int i = 1; i < vstorage->num_levels(); ++i) {
S
sdong 已提交
5405
          int num_files = vstorage->NumLevelFiles(i);
I
Igor Canadi 已提交
5406
          if (num_files > 0) {
I
Igor Canadi 已提交
5407 5408
            s = Status::InvalidArgument(
                "Not all files are at level 0. Cannot "
S
sdong 已提交
5409
                "open with FIFO compaction style.");
I
Igor Canadi 已提交
5410 5411 5412 5413
            break;
          }
        }
      }
S
sdong 已提交
5414 5415 5416
      if (!cfd->mem()->IsSnapshotSupported()) {
        impl->is_snapshot_supported_ = false;
      }
5417
      if (cfd->ioptions()->merge_operator != nullptr &&
5418 5419 5420 5421 5422
          !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 已提交
5423
      if (!s.ok()) {
5424 5425 5426 5427
        break;
      }
    }
  }
5428
  TEST_SYNC_POINT("DBImpl::Open:Opened");
5429
  Status persist_options_status;
5430
  if (s.ok()) {
5431 5432 5433 5434
    // Persist RocksDB Options before scheduling the compaction.
    // The WriteOptionsFile() will release and lock the mutex internally.
    persist_options_status = impl->WriteOptionsFile();

5435
    *dbptr = impl;
5436 5437 5438
    impl->opened_successfully_ = true;
    impl->MaybeScheduleFlushOrCompaction();
  }
5439 5440
  impl->mutex_.Unlock();

5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459
  auto sfm = static_cast<SstFileManagerImpl*>(
      impl->db_options_.sst_file_manager.get());
  if (s.ok() && sfm) {
    // Notify SstFileManager about all sst files that already exist in
    // db_paths[0] when the DB is opened.
    auto& db_path = impl->db_options_.db_paths[0];
    std::vector<std::string> existing_files;
    impl->db_options_.env->GetChildren(db_path.path, &existing_files);
    for (auto& file_name : existing_files) {
      uint64_t file_number;
      FileType file_type;
      std::string file_path = db_path.path + "/" + file_name;
      if (ParseFileName(file_name, &file_number, &file_type) &&
          file_type == kTableFile) {
        sfm->OnAddFile(file_path);
      }
    }
  }

J
jorlow@chromium.org 已提交
5460
  if (s.ok()) {
S
sdong 已提交
5461 5462
    Log(InfoLogLevel::INFO_LEVEL, impl->db_options_.info_log, "DB pointer %p",
        impl);
5463
    LogFlush(impl->db_options_.info_log);
5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474
    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());
      }
      Warn(impl->db_options_.info_log,
           "Unable to persist options in DB::Open() -- %s",
           persist_options_status.ToString().c_str());
    }
  }
5475
  if (!s.ok()) {
Y
Yueh-Hsuan Chiang 已提交
5476
    for (auto* h : *handles) {
5477 5478
      delete h;
    }
5479
    handles->clear();
J
jorlow@chromium.org 已提交
5480
    delete impl;
5481
    *dbptr = nullptr;
J
jorlow@chromium.org 已提交
5482 5483 5484 5485
  }
  return s;
}

5486 5487 5488
Status DB::ListColumnFamilies(const DBOptions& db_options,
                              const std::string& name,
                              std::vector<std::string>* column_families) {
I
Igor Canadi 已提交
5489
  return VersionSet::ListColumnFamilies(column_families, name, db_options.env);
5490 5491
}

5492 5493 5494
Snapshot::~Snapshot() {
}

J
jorlow@chromium.org 已提交
5495
Status DestroyDB(const std::string& dbname, const Options& options) {
5496
  const InternalKeyComparator comparator(options.comparator);
5497
  const Options& soptions(SanitizeOptions(dbname, &comparator, options));
5498
  Env* env = soptions.env;
J
jorlow@chromium.org 已提交
5499
  std::vector<std::string> filenames;
5500

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

J
jorlow@chromium.org 已提交
5504
  FileLock* lock;
5505 5506
  const std::string lockname = LockFileName(dbname);
  Status result = env->LockFile(lockname, &lock);
J
jorlow@chromium.org 已提交
5507 5508 5509
  if (result.ok()) {
    uint64_t number;
    FileType type;
5510
    InfoLogPrefix info_log_prefix(!options.db_log_dir.empty(), dbname);
D
dgrogan@chromium.org 已提交
5511
    for (size_t i = 0; i < filenames.size(); i++) {
5512
      if (ParseFileName(filenames[i], &number, info_log_prefix.prefix, &type) &&
5513
          type != kDBLockFile) {  // Lock file will be deleted at end
K
Kosie van der Merwe 已提交
5514
        Status del;
5515
        std::string path_to_delete = dbname + "/" + filenames[i];
K
Kosie van der Merwe 已提交
5516
        if (type == kMetaDatabase) {
5517 5518
          del = DestroyDB(path_to_delete, options);
        } else if (type == kTableFile) {
5519
          del = DeleteSSTFile(&options, path_to_delete, 0);
K
Kosie van der Merwe 已提交
5520
        } else {
5521
          del = env->DeleteFile(path_to_delete);
K
Kosie van der Merwe 已提交
5522
        }
J
jorlow@chromium.org 已提交
5523 5524 5525 5526 5527
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
5528

5529 5530
    for (size_t path_id = 0; path_id < options.db_paths.size(); path_id++) {
      const auto& db_path = options.db_paths[path_id];
5531
      env->GetChildren(db_path.path, &filenames);
5532 5533 5534
      for (size_t i = 0; i < filenames.size(); i++) {
        if (ParseFileName(filenames[i], &number, &type) &&
            type == kTableFile) {  // Lock file will be deleted at end
5535
          std::string table_path = db_path.path + "/" + filenames[i];
5536 5537
          Status del = DeleteSSTFile(&options, table_path,
                                     static_cast<uint32_t>(path_id));
5538 5539 5540 5541 5542 5543 5544
          if (result.ok() && !del.ok()) {
            result = del;
          }
        }
      }
    }

I
Igor Canadi 已提交
5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562
    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;
5563
    env->GetChildren(archivedir, &archiveFiles);
5564 5565
    // Delete archival files.
    for (size_t i = 0; i < archiveFiles.size(); ++i) {
5566 5567
      if (ParseFileName(archiveFiles[i], &number, &type) &&
          type == kLogFile) {
5568
        Status del = env->DeleteFile(archivedir + "/" + archiveFiles[i]);
5569 5570 5571 5572 5573
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
5574

5575
    // ignore case where no archival directory is present.
5576
    env->DeleteDir(archivedir);
5577

J
jorlow@chromium.org 已提交
5578
    env->UnlockFile(lock);  // Ignore error since state is already gone
5579
    env->DeleteFile(lockname);
J
jorlow@chromium.org 已提交
5580
    env->DeleteDir(dbname);  // Ignore error in case dir contains other files
5581
    env->DeleteDir(soptions.wal_dir);
J
jorlow@chromium.org 已提交
5582 5583 5584 5585
  }
  return result;
}

5586 5587
Status DBImpl::WriteOptionsFile() {
#ifndef ROCKSDB_LITE
5588
  mutex_.AssertHeld();
5589 5590 5591

  std::vector<std::string> cf_names;
  std::vector<ColumnFamilyOptions> cf_opts;
5592 5593 5594 5595 5596

  // This part requires mutex to protect the column family options
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    if (cfd->IsDropped()) {
      continue;
5597
    }
5598 5599 5600
    cf_names.push_back(cfd->GetName());
    cf_opts.push_back(BuildColumnFamilyOptions(
        *cfd->options(), *cfd->GetLatestMutableCFOptions()));
5601 5602
  }

5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615
  // Unlock during expensive operations.  New writes cannot get here
  // because the single write thread ensures all new writes get queued.
  mutex_.Unlock();

  std::string file_name =
      TempOptionsFileName(GetName(), versions_->NewFileNumber());
  Status s = PersistRocksDBOptions(GetDBOptions(), cf_names, cf_opts, file_name,
                                   GetEnv());

  if (s.ok()) {
    s = RenameTempFileToOptionsFile(file_name);
  }
  mutex_.Lock();
5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686
  return s;
#else
  return Status::OK();
#endif  // !ROCKSDB_LITE
}

#ifndef ROCKSDB_LITE
namespace {
void DeleteOptionsFilesHelper(const std::map<uint64_t, std::string>& filenames,
                              const size_t num_files_to_keep,
                              const std::shared_ptr<Logger>& info_log,
                              Env* env) {
  if (filenames.size() <= num_files_to_keep) {
    return;
  }
  for (auto iter = std::next(filenames.begin(), num_files_to_keep);
       iter != filenames.end(); ++iter) {
    if (!env->DeleteFile(iter->second).ok()) {
      Warn(info_log, "Unable to delete options file %s", iter->second.c_str());
    }
  }
}
}  // namespace
#endif  // !ROCKSDB_LITE

Status DBImpl::DeleteObsoleteOptionsFiles() {
#ifndef ROCKSDB_LITE
  std::vector<std::string> filenames;
  // use ordered map to store keep the filenames sorted from the newest
  // to the oldest.
  std::map<uint64_t, std::string> options_filenames;
  Status s;
  s = GetEnv()->GetChildren(GetName(), &filenames);
  if (!s.ok()) {
    return s;
  }
  for (auto& filename : filenames) {
    uint64_t file_number;
    FileType type;
    if (ParseFileName(filename, &file_number, &type) && type == kOptionsFile) {
      options_filenames.insert(
          {std::numeric_limits<uint64_t>::max() - file_number,
           GetName() + "/" + filename});
    }
  }

  // Keeps the latest 2 Options file
  const size_t kNumOptionsFilesKept = 2;
  DeleteOptionsFilesHelper(options_filenames, kNumOptionsFilesKept,
                           db_options_.info_log, GetEnv());
  return Status::OK();
#else
  return Status::OK();
#endif  // !ROCKSDB_LITE
}

Status DBImpl::RenameTempFileToOptionsFile(const std::string& file_name) {
#ifndef ROCKSDB_LITE
  Status s;
  std::string options_file_name =
      OptionsFileName(GetName(), versions_->NewFileNumber());
  // Retry if the file name happen to conflict with an existing one.
  s = GetEnv()->RenameFile(file_name, options_file_name);

  DeleteObsoleteOptionsFiles();
  return s;
#else
  return Status::OK();
#endif  // !ROCKSDB_LITE
}

Y
Yueh-Hsuan Chiang 已提交
5687
#if ROCKSDB_USING_THREAD_STATUS
5688

Y
Yueh-Hsuan Chiang 已提交
5689 5690
void DBImpl::NewThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
5691
  if (db_options_.enable_thread_tracking) {
5692 5693
    ThreadStatusUtil::NewColumnFamilyInfo(this, cfd, cfd->GetName(),
                                          cfd->ioptions()->env);
5694
  }
Y
Yueh-Hsuan Chiang 已提交
5695 5696 5697 5698
}

void DBImpl::EraseThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
5699
  if (db_options_.enable_thread_tracking) {
5700
    ThreadStatusUtil::EraseColumnFamilyInfo(cfd);
5701
  }
Y
Yueh-Hsuan Chiang 已提交
5702 5703 5704
}

void DBImpl::EraseThreadStatusDbInfo() const {
5705
  if (db_options_.enable_thread_tracking) {
5706
    ThreadStatusUtil::EraseDatabaseInfo(this);
5707
  }
Y
Yueh-Hsuan Chiang 已提交
5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722
}

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

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

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

5723 5724
//
// A global method that can dump out the build version
I
Igor Canadi 已提交
5725
void DumpRocksDBBuildVersion(Logger * log) {
I
Igor Canadi 已提交
5726
#if !defined(IOS_CROSS_COMPILE)
I
Igor Canadi 已提交
5727 5728
  // if we compile with Xcode, we don't run build_detect_vesion, so we don't
  // generate util/build_version.cc
5729 5730 5731 5732
  Header(log, "RocksDB version: %d.%d.%d\n", ROCKSDB_MAJOR, ROCKSDB_MINOR,
         ROCKSDB_PATCH);
  Header(log, "Git sha %s", rocksdb_build_git_sha);
  Header(log, "Compile date %s", rocksdb_build_compile_date);
I
Igor Canadi 已提交
5733
#endif
5734 5735
}

A
agiardullo 已提交
5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752
#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
5753 5754 5755
Status DBImpl::GetLatestSequenceForKey(SuperVersion* sv, const Slice& key,
                                       bool cache_only, SequenceNumber* seq,
                                       bool* found_record_for_key) {
A
agiardullo 已提交
5756 5757 5758 5759 5760 5761 5762
  Status s;
  MergeContext merge_context;

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

  *seq = kMaxSequenceNumber;
5763 5764
  *found_record_for_key = false;

A
agiardullo 已提交
5765
  // Check if there is a record for this key in the latest memtable
R
Reid Horuff 已提交
5766
  sv->mem->Get(lkey, nullptr, &s, &merge_context, seq);
A
agiardullo 已提交
5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778

  if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
    // unexpected error reading memtable.
    Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
        "Unexpected status returned from MemTable::Get: %s\n",
        s.ToString().c_str());

    return s;
  }

  if (*seq != kMaxSequenceNumber) {
    // Found a sequence number, no need to check immutable memtables
5779
    *found_record_for_key = true;
A
agiardullo 已提交
5780 5781 5782 5783
    return Status::OK();
  }

  // Check if there is a record for this key in the immutable memtables
R
Reid Horuff 已提交
5784
  sv->imm->Get(lkey, nullptr, &s, &merge_context, seq);
A
agiardullo 已提交
5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796

  if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
    // unexpected error reading memtable.
    Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
        "Unexpected status returned from MemTableList::Get: %s\n",
        s.ToString().c_str());

    return s;
  }

  if (*seq != kMaxSequenceNumber) {
    // Found a sequence number, no need to check memtable history
5797
    *found_record_for_key = true;
A
agiardullo 已提交
5798 5799 5800 5801
    return Status::OK();
  }

  // Check if there is a record for this key in the immutable memtables
R
Reid Horuff 已提交
5802
  sv->imm->GetFromHistory(lkey, nullptr, &s, &merge_context, seq);
A
agiardullo 已提交
5803 5804 5805 5806 5807 5808 5809 5810 5811 5812

  if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
    // unexpected error reading memtable.
    Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
        "Unexpected status returned from MemTableList::GetFromHistory: %s\n",
        s.ToString().c_str());

    return s;
  }

5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824
  if (*seq != kMaxSequenceNumber) {
    // Found a sequence number, no need to check SST files
    *found_record_for_key = true;
    return Status::OK();
  }

  // TODO(agiardullo): possible optimization: consider checking cached
  // SST files if cache_only=true?
  if (!cache_only) {
    // Check tables
    ReadOptions read_options;

R
Reid Horuff 已提交
5825
    sv->current->Get(read_options, lkey, nullptr, &s, &merge_context,
5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837
                     nullptr /* value_found */, found_record_for_key, seq);

    if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
      // unexpected error reading SST files
      Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
          "Unexpected status returned from Version::Get: %s\n",
          s.ToString().c_str());

      return s;
    }
  }

A
agiardullo 已提交
5838 5839 5840 5841
  return Status::OK();
}
#endif  // ROCKSDB_LITE

5842
}  // namespace rocksdb