db_impl.cc 193.2 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 18
#include <stdint.h>

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

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

98
namespace rocksdb {
J
jorlow@chromium.org 已提交
99

100
const std::string kDefaultColumnFamilyName("default");
101

I
Igor Canadi 已提交
102
void DumpRocksDBBuildVersion(Logger * log);
103

S
Stanislau Hlebik 已提交
104 105
struct DBImpl::WriteContext {
  autovector<SuperVersion*> superversions_to_free_;
106
  autovector<MemTable*> memtables_to_free_;
S
Stanislau Hlebik 已提交
107 108 109 110 111

  ~WriteContext() {
    for (auto& sv : superversions_to_free_) {
      delete sv;
    }
112 113 114
    for (auto& m : memtables_to_free_) {
      delete m;
    }
S
Stanislau Hlebik 已提交
115 116 117
  }
};

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

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

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

138
  if (result.info_log == nullptr) {
139
    Status s = CreateLoggerFromOptions(dbname, result, &result.info_log);
J
jorlow@chromium.org 已提交
140 141
    if (!s.ok()) {
      // No place suitable for logging
142
      result.info_log = nullptr;
J
jorlow@chromium.org 已提交
143 144
    }
  }
145 146 147 148
  result.env->IncBackgroundThreadsIfNeeded(src.max_background_compactions,
                                           Env::Priority::LOW);
  result.env->IncBackgroundThreadsIfNeeded(src.max_background_flushes,
                                           Env::Priority::HIGH);
149

I
Igor Canadi 已提交
150
  if (result.rate_limiter.get() != nullptr) {
151 152 153 154 155
    if (result.bytes_per_sync == 0) {
      result.bytes_per_sync = 1024 * 1024;
    }
  }

156 157 158 159
  if (result.WAL_ttl_seconds > 0 || result.WAL_size_limit_MB > 0) {
    result.recycle_log_file_num = false;
  }

160 161 162 163
  if (result.wal_dir.empty()) {
    // Use dbname as default
    result.wal_dir = dbname;
  }
164
  if (result.wal_dir.back() == '/') {
I
Igor Canadi 已提交
165
    result.wal_dir = result.wal_dir.substr(0, result.wal_dir.size() - 1);
166
  }
167

168
  if (result.db_paths.size() == 0) {
169
    result.db_paths.emplace_back(dbname, std::numeric_limits<uint64_t>::max());
170 171
  }

172 173 174 175
  if (result.compaction_readahead_size > 0) {
    result.new_table_reader_for_compaction_inputs = true;
  }

J
jorlow@chromium.org 已提交
176 177 178
  return result;
}

179 180
namespace {

181 182
Status SanitizeOptionsByTable(
    const DBOptions& db_opts,
183 184 185
    const std::vector<ColumnFamilyDescriptor>& column_families) {
  Status s;
  for (auto cf : column_families) {
186
    s = cf.options.table_factory->SanitizeOptions(db_opts, cf.options);
187 188 189 190 191 192 193
    if (!s.ok()) {
      return s;
    }
  }
  return Status::OK();
}

194
CompressionType GetCompressionFlush(const ImmutableCFOptions& ioptions) {
195 196 197 198 199 200
  // 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;

201
  if (ioptions.compaction_style == kCompactionStyleUniversal) {
202
    can_compress =
203
        (ioptions.compaction_options_universal.compression_size_percent < 0);
204 205
  } else {
    // For leveled compress when min_level_to_compress == 0.
206 207
    can_compress = ioptions.compression_per_level.empty() ||
                   ioptions.compression_per_level[0] != kNoCompression;
208 209 210
  }

  if (can_compress) {
211
    return ioptions.compression;
212 213 214 215
  } else {
    return kNoCompression;
  }
}
I
Igor Canadi 已提交
216

217
void DumpSupportInfo(Logger* logger) {
I
Igor Canadi 已提交
218 219 220 221 222 223 224 225
  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());
226 227
  Log(InfoLogLevel::INFO_LEVEL, logger, "Fast CRC32 supported: %d",
      crc32c::IsFastCrc32Supported());
I
Igor Canadi 已提交
228 229
}

230
}  // namespace
231

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

J
jorlow@chromium.org 已提交
275
  // Reserve ten files or so for other uses and give the rest to TableCache.
276
  // Give a large number for setting of "infinite" open files.
277 278
  const int table_cache_size = (db_options_.max_open_files == -1) ?
        4194304 : db_options_.max_open_files - 10;
279
  table_cache_ =
280
      NewLRUCache(table_cache_size, db_options_.table_cache_numshardbits);
281

282
  versions_.reset(new VersionSet(dbname_, &db_options_, env_options_,
283 284
                                 table_cache_.get(), &write_buffer_,
                                 &write_controller_));
I
Igor Canadi 已提交
285 286
  column_family_memtables_.reset(new ColumnFamilyMemTablesImpl(
      versions_->GetColumnFamilySet(), &flush_scheduler_));
287

I
Igor Canadi 已提交
288
  DumpRocksDBBuildVersion(db_options_.info_log.get());
289 290
  DumpDBFileSummary(db_options_, dbname_);
  db_options_.Dump(db_options_.info_log.get());
291
  DumpSupportInfo(db_options_.info_log.get());
J
jorlow@chromium.org 已提交
292 293
}

294
// Will lock the mutex_,  will wait for completion if wait is true
295
void DBImpl::CancelAllBackgroundWork(bool wait) {
296
  InstrumentedMutexLock l(&mutex_);
297
  shutting_down_.store(true, std::memory_order_release);
298
  bg_cv_.SignalAll();
299 300 301 302
  if (!wait) {
    return;
  }
  // Wait for background work to finish
303
  while (bg_compaction_scheduled_ || bg_flush_scheduled_) {
304 305
    bg_cv_.Wait();
  }
306 307
}

J
jorlow@chromium.org 已提交
308
DBImpl::~DBImpl() {
309
  mutex_.Lock();
310

311
  if (!shutting_down_.load(std::memory_order_acquire) && flush_on_destroy_) {
312
    for (auto cfd : *versions_->GetColumnFamilySet()) {
313
      if (!cfd->IsDropped() && !cfd->mem()->IsEmpty()) {
314 315 316 317
        cfd->Ref();
        mutex_.Unlock();
        FlushMemTable(cfd, FlushOptions());
        mutex_.Lock();
318
        cfd->Unref();
319 320
      }
    }
321
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
322
  }
323 324 325
  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
326 327
  // (to consider: moving all the waiting into CancelAllBackgroundWork(true))
  CancelAllBackgroundWork(false);
328 329 330 331 332 333 334
  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
335
  while (bg_compaction_scheduled_ || bg_flush_scheduled_) {
336 337
    bg_cv_.Wait();
  }
338
  EraseThreadStatusDbInfo();
I
Igor Canadi 已提交
339 340
  flush_scheduler_.Clear();

341 342 343 344 345 346 347 348 349 350 351 352 353
  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 已提交
354 355 356 357 358
  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();
359 360
  }

I
Igor Canadi 已提交
361 362 363 364 365 366 367 368 369 370
  // 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_) {
371
    JobContext job_context(next_job_id_.fetch_add(1));
I
Igor Canadi 已提交
372
    FindObsoleteFiles(&job_context, true);
373 374

    mutex_.Unlock();
I
Igor Canadi 已提交
375
    // manifest number starting from 2
I
Igor Canadi 已提交
376 377 378
    job_context.manifest_file_number = 1;
    if (job_context.HaveSomethingToDelete()) {
      PurgeObsoleteFiles(job_context);
379
    }
I
Igor Canadi 已提交
380
    job_context.Clean();
381
    mutex_.Lock();
382 383
  }

384 385 386
  for (auto l : logs_to_free_) {
    delete l;
  }
387 388 389
  for (auto& log : logs_) {
    log.ClearWriter();
  }
390
  logs_.clear();
391

392
  // versions need to be destroyed before table_cache since it can hold
393 394
  // references to table_cache.
  versions_.reset();
395
  mutex_.Unlock();
I
Igor Canadi 已提交
396 397 398
  if (db_lock_ != nullptr) {
    env_->UnlockFile(db_lock_);
  }
399

400
  LogFlush(db_options_.info_log);
J
jorlow@chromium.org 已提交
401 402 403
}

Status DBImpl::NewDB() {
404
  VersionEdit new_db;
405
  new_db.SetLogNumber(0);
J
jorlow@chromium.org 已提交
406 407 408
  new_db.SetNextFile(2);
  new_db.SetLastSequence(0);

409 410
  Status s;

411 412
  Log(InfoLogLevel::INFO_LEVEL,
      db_options_.info_log, "Creating manifest 1 \n");
J
jorlow@chromium.org 已提交
413 414
  const std::string manifest = DescriptorFileName(dbname_, 1);
  {
415 416
    unique_ptr<WritableFile> file;
    EnvOptions env_options = env_->OptimizeForManifestWrite(env_options_);
S
sdong 已提交
417
    s = NewWritableFile(env_, manifest, &file, env_options);
418 419 420 421 422 423
    if (!s.ok()) {
      return s;
    }
    file->SetPreallocationBlockSize(db_options_.manifest_preallocation_size);
    unique_ptr<WritableFileWriter> file_writer(
        new WritableFileWriter(std::move(file), env_options));
424
    log::Writer log(std::move(file_writer), 0, false);
J
jorlow@chromium.org 已提交
425 426 427
    std::string record;
    new_db.EncodeTo(&record);
    s = log.AddRecord(record);
S
sdong 已提交
428 429 430
    if (s.ok()) {
      s = SyncManifest(env_, &db_options_, log.file());
    }
J
jorlow@chromium.org 已提交
431 432 433
  }
  if (s.ok()) {
    // Make "CURRENT" file that points to the new manifest file.
434
    s = SetCurrentFile(env_, dbname_, 1, directories_.GetDbDir());
J
jorlow@chromium.org 已提交
435 436 437 438 439 440 441
  } else {
    env_->DeleteFile(manifest);
  }
  return s;
}

void DBImpl::MaybeIgnoreError(Status* s) const {
442
  if (s->ok() || db_options_.paranoid_checks) {
J
jorlow@chromium.org 已提交
443 444
    // No change needed
  } else {
445 446
    Log(InfoLogLevel::WARN_LEVEL,
        db_options_.info_log, "Ignoring error %s", s->ToString().c_str());
J
jorlow@chromium.org 已提交
447 448 449 450
    *s = Status::OK();
  }
}

451
const Status DBImpl::CreateArchivalDirectory() {
452 453
  if (db_options_.WAL_ttl_seconds > 0 || db_options_.WAL_size_limit_MB > 0) {
    std::string archivalPath = ArchivalDirectory(db_options_.wal_dir);
454 455 456 457 458
    return env_->CreateDirIfMissing(archivalPath);
  }
  return Status::OK();
}

459
void DBImpl::PrintStatistics() {
460
  auto dbstats = db_options_.statistics.get();
461
  if (dbstats) {
Y
Yueh-Hsuan Chiang 已提交
462
    Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
M
Mark Callaghan 已提交
463
        "STATISTICS:\n %s",
464
        dbstats->ToString().c_str());
465 466 467
  }
}

468
void DBImpl::MaybeDumpStats() {
469
  if (db_options_.stats_dump_period_sec == 0) return;
H
Haobo Xu 已提交
470 471 472 473

  const uint64_t now_micros = env_->NowMicros();

  if (last_stats_dump_time_microsec_ +
474
      db_options_.stats_dump_period_sec * 1000000
H
Haobo Xu 已提交
475 476 477 478 479 480
      <= 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;
481

482
#ifndef ROCKSDB_LITE
483 484 485
    bool tmp1 = false;
    bool tmp2 = false;
    DBPropertyType cf_property_type =
486
        GetPropertyType(DB::Properties::kCFStats, &tmp1, &tmp2);
487
    DBPropertyType db_property_type =
488
        GetPropertyType(DB::Properties::kDBStats, &tmp1, &tmp2);
H
Haobo Xu 已提交
489
    std::string stats;
490
    {
491
      InstrumentedMutexLock l(&mutex_);
492
      for (auto cfd : *versions_->GetColumnFamilySet()) {
493
        cfd->internal_stats()->GetStringProperty(cf_property_type,
494 495
                                                 DB::Properties::kCFStats,
                                                 &stats);
496
      }
497
      default_cf_internal_stats_->GetStringProperty(db_property_type,
498 499
                                                    DB::Properties::kDBStats,
                                                    &stats);
500
    }
Y
Yueh-Hsuan Chiang 已提交
501
    Log(InfoLogLevel::WARN_LEVEL,
502
        db_options_.info_log, "------- DUMPING STATS -------");
Y
Yueh-Hsuan Chiang 已提交
503
    Log(InfoLogLevel::WARN_LEVEL,
504
        db_options_.info_log, "%s", stats.c_str());
505
#endif  // !ROCKSDB_LITE
506

507
    PrintStatistics();
508 509 510
  }
}

I
Igor Canadi 已提交
511
// * Returns the list of live files in 'sst_live'
I
Igor Canadi 已提交
512
// If it's doing full scan:
I
Igor Canadi 已提交
513 514
// * Returns the list of all files in the filesystem in
// 'full_scan_candidate_files'.
I
Igor Canadi 已提交
515
// Otherwise, gets obsolete files from VersionSet.
I
Igor Canadi 已提交
516 517
// no_full_scan = true -- never do the full scan using GetChildren()
// force = false -- don't force the full scan, except every
518
//  db_options_.delete_obsolete_files_period_micros
I
Igor Canadi 已提交
519
// force = true -- force the full scan
I
Igor Canadi 已提交
520
void DBImpl::FindObsoleteFiles(JobContext* job_context, bool force,
I
Igor Canadi 已提交
521
                               bool no_full_scan) {
D
Dhruba Borthakur 已提交
522 523
  mutex_.AssertHeld();

524
  // if deletion is disabled, do nothing
525
  if (disable_delete_obsolete_files_ > 0) {
526 527 528
    return;
  }

529 530 531 532 533
  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;
534
  } else if (force || db_options_.delete_obsolete_files_period_micros == 0) {
535 536 537
    doing_the_full_scan = true;
  } else {
    const uint64_t now_micros = env_->NowMicros();
I
Igor Canadi 已提交
538
    if (delete_obsolete_files_next_run_ < now_micros) {
539
      doing_the_full_scan = true;
I
Igor Canadi 已提交
540 541
      delete_obsolete_files_next_run_ =
          now_micros + db_options_.delete_obsolete_files_period_micros;
542 543 544
    }
  }

I
Igor Canadi 已提交
545 546
  // don't delete files that might be currently written to from compaction
  // threads
547 548 549
  // 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 已提交
550 551 552 553 554 555 556
  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();
  }

557 558
  // Get obsolete files.  This function will also update the list of
  // pending files in VersionSet().
I
Igor Canadi 已提交
559 560
  versions_->GetObsoleteFiles(&job_context->sst_delete_files,
                              job_context->min_pending_output);
I
Igor Canadi 已提交
561

I
Igor Canadi 已提交
562
  // store the current filenum, lognum, etc
563
  job_context->manifest_file_number = versions_->manifest_file_number();
I
Igor Canadi 已提交
564
  job_context->pending_manifest_file_number =
565
      versions_->pending_manifest_file_number();
I
Igor Canadi 已提交
566
  job_context->log_number = versions_->MinLogNumber();
567
  job_context->prev_log_number = versions_->prev_log_number();
I
Igor Canadi 已提交
568

I
Igor Canadi 已提交
569
  versions_->AddLiveFiles(&job_context->sst_live);
570
  if (doing_the_full_scan) {
571
    for (size_t path_id = 0; path_id < db_options_.db_paths.size(); path_id++) {
572 573 574
      // set of all files in the directory. We'll exclude files that are still
      // alive in the subsequent processings.
      std::vector<std::string> files;
575
      env_->GetChildren(db_options_.db_paths[path_id].path,
576
                        &files);  // Ignore errors
577
      for (std::string file : files) {
I
Igor Canadi 已提交
578
        // TODO(icanadi) clean up this mess to avoid having one-off "/" prefixes
I
Igor Canadi 已提交
579 580
        job_context->full_scan_candidate_files.emplace_back("/" + file,
                                                            path_id);
581 582
      }
    }
583 584

    //Add log files in wal_dir
585
    if (db_options_.wal_dir != dbname_) {
586
      std::vector<std::string> log_files;
587
      env_->GetChildren(db_options_.wal_dir, &log_files);  // Ignore errors
588
      for (std::string log_file : log_files) {
I
Igor Canadi 已提交
589
        job_context->full_scan_candidate_files.emplace_back(log_file, 0);
590 591
      }
    }
592
    // Add info log files in db_log_dir
593
    if (!db_options_.db_log_dir.empty() && db_options_.db_log_dir != dbname_) {
594
      std::vector<std::string> info_log_files;
595 596
      // Ignore errors
      env_->GetChildren(db_options_.db_log_dir, &info_log_files);
597
      for (std::string log_file : info_log_files) {
I
Igor Canadi 已提交
598
        job_context->full_scan_candidate_files.emplace_back(log_file, 0);
599 600
      }
    }
601
  }
602 603 604 605 606 607

  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 已提交
608 609 610 611 612 613 614
      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);
      }
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
      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();
639 640
}

641
namespace {
I
Igor Canadi 已提交
642 643
bool CompareCandidateFile(const JobContext::CandidateFileInfo& first,
                          const JobContext::CandidateFileInfo& second) {
644 645 646 647 648
  if (first.file_name > second.file_name) {
    return true;
  } else if (first.file_name < second.file_name) {
    return false;
  } else {
649
    return (first.path_id > second.path_id);
650 651 652 653
  }
}
};  // namespace

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

I
Igor Canadi 已提交
662 663 664 665
  // 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 已提交
666 667
    return;
  }
668

669
  // Now, convert live list to an unordered map, WITHOUT mutex held;
670
  // set is slow.
671
  std::unordered_map<uint64_t, const FileDescriptor*> sst_live_map;
I
Igor Canadi 已提交
672
  for (const FileDescriptor& fd : state.sst_live) {
673 674
    sst_live_map[fd.GetNumber()] = &fd;
  }
I
Igor Canadi 已提交
675

I
Igor Canadi 已提交
676
  auto candidate_files = state.full_scan_candidate_files;
I
Igor Canadi 已提交
677 678 679
  candidate_files.reserve(candidate_files.size() +
                          state.sst_delete_files.size() +
                          state.log_delete_files.size());
K
kailiu 已提交
680 681
  // We may ignore the dbname when generating the file names.
  const char* kDumbDbName = "";
682
  for (auto file : state.sst_delete_files) {
683 684 685
    candidate_files.emplace_back(
        MakeTableFileName(kDumbDbName, file->fd.GetNumber()),
        file->fd.GetPathId());
686
    delete file;
I
Igor Canadi 已提交
687 688
  }

K
kailiu 已提交
689 690
  for (auto file_num : state.log_delete_files) {
    if (file_num > 0) {
691 692
      candidate_files.emplace_back(LogFileName(kDumbDbName, file_num).substr(1),
                                   0);
I
Igor Canadi 已提交
693 694
    }
  }
695

K
kailiu 已提交
696
  // dedup state.candidate_files so we don't try to delete the same
I
Igor Canadi 已提交
697
  // file twice
698
  sort(candidate_files.begin(), candidate_files.end(), CompareCandidateFile);
699 700
  candidate_files.erase(unique(candidate_files.begin(), candidate_files.end()),
                        candidate_files.end());
J
jorlow@chromium.org 已提交
701

702
  std::vector<std::string> old_info_log_files;
703
  InfoLogPrefix info_log_prefix(!db_options_.db_log_dir.empty(), dbname_);
704 705 706
  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 已提交
707 708 709
    uint64_t number;
    FileType type;
    // Ignore file if we cannot recognize it.
710
    if (!ParseFileName(to_delete, &number, info_log_prefix.prefix, &type)) {
K
kailiu 已提交
711 712
      continue;
    }
J
jorlow@chromium.org 已提交
713

K
kailiu 已提交
714 715 716 717 718 719 720 721
    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'
722
        // (can happen during manifest roll)
K
kailiu 已提交
723 724 725
        keep = (number >= state.manifest_file_number);
        break;
      case kTableFile:
I
Igor Canadi 已提交
726 727 728 729
        // 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 已提交
730 731 732
        break;
      case kTempFile:
        // Any temp files that are currently being written to must
733 734 735 736
        // 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
737 738 739
        //
        // TODO(yhchiang): carefully modify the third condition to safely
        //                 remove the temp options files.
740
        keep = (sst_live_map.find(number) != sst_live_map.end()) ||
741 742
               (number == state.pending_manifest_file_number) ||
               (to_delete.find(kOptionsFileNamePrefix) != std::string::npos);
K
kailiu 已提交
743 744 745 746
        break;
      case kInfoLogFile:
        keep = true;
        if (number != 0) {
747
          old_info_log_files.push_back(to_delete);
J
jorlow@chromium.org 已提交
748
        }
K
kailiu 已提交
749 750 751 752 753
        break;
      case kCurrentFile:
      case kDBLockFile:
      case kIdentityFile:
      case kMetaDatabase:
754
      case kOptionsFile:
K
kailiu 已提交
755 756 757 758 759 760 761 762
        keep = true;
        break;
    }

    if (keep) {
      continue;
    }

763
    std::string fname;
K
kailiu 已提交
764 765
    if (type == kTableFile) {
      // evict from cache
766
      TableCache::Evict(table_cache_.get(), number);
767
      fname = TableFileName(db_options_.db_paths, number, path_id);
768
    } else {
769 770
      fname = ((type == kLogFile) ?
          db_options_.wal_dir : dbname_) + "/" + to_delete;
K
kailiu 已提交
771
    }
772

773
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
774
    if (type == kLogFile && (db_options_.WAL_ttl_seconds > 0 ||
775
                              db_options_.WAL_size_limit_MB > 0)) {
I
Igor Canadi 已提交
776
      wal_manager_.ArchiveWALFile(fname, number);
777 778 779
      continue;
    }
#endif  // !ROCKSDB_LITE
I
Islam AbdelRahman 已提交
780
    Status file_deletion_status;
781 782
    if (type == kTableFile && path_id == 0) {
      file_deletion_status = DeleteOrMoveToTrash(&db_options_, fname);
I
Islam AbdelRahman 已提交
783 784 785
    } else {
      file_deletion_status = env_->DeleteFile(fname);
    }
786
    if (file_deletion_status.ok()) {
787
      Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
788
          "[JOB %d] Delete %s type=%d #%" PRIu64 " -- %s\n", state.job_id,
789 790
          fname.c_str(), type, number,
          file_deletion_status.ToString().c_str());
791 792 793 794 795 796
    } 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());
797 798 799 800 801 802 803
    } 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) {
804 805 806 807
      EventHelpers::LogAndNotifyTableFileDeletion(
          &event_logger_, state.job_id, number, fname,
          file_deletion_status, GetName(),
          db_options_.listeners);
J
jorlow@chromium.org 已提交
808 809
    }
  }
H
heyongqiang 已提交
810

811
  // Delete old info log files.
812
  size_t old_info_log_file_count = old_info_log_files.size();
813
  if (old_info_log_file_count >= db_options_.keep_log_file_num) {
814
    std::sort(old_info_log_files.begin(), old_info_log_files.end());
815
    size_t end = old_info_log_file_count - db_options_.keep_log_file_num;
816
    for (unsigned int i = 0; i <= end; i++) {
817
      std::string& to_delete = old_info_log_files.at(i);
818 819
      std::string full_path_to_delete = (db_options_.db_log_dir.empty() ?
           dbname_ : db_options_.db_log_dir) + "/" + to_delete;
820
      Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
821
          "[JOB %d] Delete info log file %s\n", state.job_id,
822 823
          full_path_to_delete.c_str());
      Status s = env_->DeleteFile(full_path_to_delete);
824
      if (!s.ok()) {
825 826 827 828 829 830 831 832 833 834
        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());
        }
835
      }
H
heyongqiang 已提交
836 837
    }
  }
I
Igor Canadi 已提交
838 839 840
#ifndef ROCKSDB_LITE
  wal_manager_.PurgeObsoleteWALFiles();
#endif  // ROCKSDB_LITE
841
  LogFlush(db_options_.info_log);
D
Dhruba Borthakur 已提交
842 843 844 845
}

void DBImpl::DeleteObsoleteFiles() {
  mutex_.AssertHeld();
846
  JobContext job_context(next_job_id_.fetch_add(1));
I
Igor Canadi 已提交
847
  FindObsoleteFiles(&job_context, true);
848 849

  mutex_.Unlock();
I
Igor Canadi 已提交
850 851
  if (job_context.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(job_context);
852
  }
I
Igor Canadi 已提交
853
  job_context.Clean();
854
  mutex_.Lock();
855 856
}

857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
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 已提交
873

874 875 876 877 878 879 880 881 882
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_);
883 884 885
    if (!s.ok()) {
      return s;
    }
886
  }
887

888 889 890 891 892 893 894 895
  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);
896 897 898
      if (!s.ok()) {
        return s;
      }
899
      data_dirs_.emplace_back(path_directory.release());
900
    }
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
  }
  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();
920

921 922 923 924 925
  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);
926 927 928 929
    if (!s.ok()) {
      return s;
    }

930
    s = env_->LockFile(LockFileName(dbname_), &db_lock_);
931 932 933
    if (!s.ok()) {
      return s;
    }
J
jorlow@chromium.org 已提交
934

A
agiardullo 已提交
935 936
    s = env_->FileExists(CurrentFileName(dbname_));
    if (s.IsNotFound()) {
937
      if (db_options_.create_if_missing) {
938
        s = NewDB();
939
        is_new_db = true;
940 941 942 943 944 945
        if (!s.ok()) {
          return s;
        }
      } else {
        return Status::InvalidArgument(
            dbname_, "does not exist (create_if_missing is false)");
J
jorlow@chromium.org 已提交
946
      }
A
agiardullo 已提交
947
    } else if (s.ok()) {
948
      if (db_options_.error_if_exists) {
949 950 951
        return Status::InvalidArgument(
            dbname_, "exists (error_if_exists is true)");
      }
A
agiardullo 已提交
952 953 954 955
    } else {
      // Unexpected error reading file
      assert(s.IsIOError());
      return s;
J
jorlow@chromium.org 已提交
956
    }
M
Mayank Agarwal 已提交
957
    // Check for the IDENTITY file and create it if not there
A
agiardullo 已提交
958 959
    s = env_->FileExists(IdentityFileName(dbname_));
    if (s.IsNotFound()) {
M
Mayank Agarwal 已提交
960 961 962 963
      s = SetIdentityFile(env_, dbname_);
      if (!s.ok()) {
        return s;
      }
A
agiardullo 已提交
964 965 966
    } else if (!s.ok()) {
      assert(s.IsIOError());
      return s;
M
Mayank Agarwal 已提交
967
    }
J
jorlow@chromium.org 已提交
968 969
  }

970
  Status s = versions_->Recover(column_families, read_only);
971
  if (db_options_.paranoid_checks && s.ok()) {
I
Igor Canadi 已提交
972 973
    s = CheckConsistency();
  }
J
jorlow@chromium.org 已提交
974
  if (s.ok()) {
A
agiardullo 已提交
975
    SequenceNumber max_sequence(kMaxSequenceNumber);
976 977
    default_cf_handle_ = new ColumnFamilyHandleImpl(
        versions_->GetColumnFamilySet()->GetDefault(), this, &mutex_);
978
    default_cf_internal_stats_ = default_cf_handle_->cfd()->internal_stats();
979 980
    single_column_family_mode_ =
        versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1;
981 982 983 984 985

    // 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).
    //
986
    // Note that prev_log_number() is no longer used, but we pay
987
    // attention to it in case we are recovering a database
988
    // produced by an older version of rocksdb.
989
    const uint64_t min_log = versions_->MinLogNumber();
990
    const uint64_t prev_log = versions_->prev_log_number();
991
    std::vector<std::string> filenames;
992
    s = env_->GetChildren(db_options_.wal_dir, &filenames);
993 994
    if (!s.ok()) {
      return s;
995
    }
K
kailiu 已提交
996

997 998
    std::vector<uint64_t> logs;
    for (size_t i = 0; i < filenames.size(); i++) {
K
kailiu 已提交
999 1000
      uint64_t number;
      FileType type;
1001 1002 1003 1004 1005 1006 1007 1008 1009
      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);
        }
1010
      }
J
jorlow@chromium.org 已提交
1011
    }
1012

H
heyongqiang 已提交
1013 1014 1015 1016 1017 1018
    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 已提交
1019 1020 1021 1022 1023 1024 1025
    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 已提交
1026 1027
          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
                                 kMaxSequenceNumber);
S
Stanislau Hlebik 已提交
1028 1029
        }
      }
1030
    }
L
Lei Jin 已提交
1031
    SetTickerCount(stats_, SEQUENCE_NUMBER, versions_->LastSequence());
J
jorlow@chromium.org 已提交
1032 1033
  }

L
Lei Jin 已提交
1034 1035
  // Initial value
  max_total_in_memory_state_ = 0;
I
Igor Canadi 已提交
1036
  for (auto cfd : *versions_->GetColumnFamilySet()) {
L
Lei Jin 已提交
1037 1038 1039
    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 已提交
1040 1041
  }

J
jorlow@chromium.org 已提交
1042 1043 1044
  return s;
}

S
Stanislau Hlebik 已提交
1045 1046 1047
// 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 已提交
1048 1049
  struct LogReporter : public log::Reader::Reporter {
    Env* env;
1050
    Logger* info_log;
J
jorlow@chromium.org 已提交
1051
    const char* fname;
1052
    Status* status;  // nullptr if db_options_.paranoid_checks==false
I
Igor Sugak 已提交
1053
    virtual void Corruption(size_t bytes, const Status& s) override {
1054 1055
      Log(InfoLogLevel::WARN_LEVEL,
          info_log, "%s%s: dropping %d bytes; %s",
1056
          (this->status == nullptr ? "(ignoring error) " : ""),
J
jorlow@chromium.org 已提交
1057
          fname, static_cast<int>(bytes), s.ToString().c_str());
K
krad 已提交
1058 1059 1060
      if (this->status != nullptr && this->status->ok()) {
        *this->status = s;
      }
J
jorlow@chromium.org 已提交
1061 1062 1063 1064
    }
  };

  mutex_.AssertHeld();
S
Stanislau Hlebik 已提交
1065
  Status status;
1066
  std::unordered_map<int, VersionEdit> version_edits;
1067
  // no need to refcount because iteration is under mutex
1068 1069
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    VersionEdit edit;
1070 1071
    edit.SetColumnFamily(cfd->GetID());
    version_edits.insert({cfd->GetID(), edit});
1072
  }
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
  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 已提交
1085

K
krad 已提交
1086
  bool continue_replay_log = true;
S
Stanislau Hlebik 已提交
1087 1088 1089 1090
  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.
1091
    versions_->MarkFileNumberUsedDuringRecovery(log_number);
S
Stanislau Hlebik 已提交
1092 1093
    // Open the log file
    std::string fname = LogFileName(db_options_.wal_dir, log_number);
1094 1095 1096 1097
    unique_ptr<SequentialFileReader> file_reader;
    {
      unique_ptr<SequentialFile> file;
      status = env_->NewSequentialFile(fname, &file, env_options_);
S
Stanislau Hlebik 已提交
1098
      if (!status.ok()) {
1099 1100 1101 1102 1103 1104 1105 1106
        MaybeIgnoreError(&status);
        if (!status.ok()) {
          return status;
        } else {
          // Fail with one log file, but that's ok.
          // Try next one.
          continue;
        }
S
Stanislau Hlebik 已提交
1107
      }
1108
      file_reader.reset(new SequentialFileReader(std::move(file)));
J
jorlow@chromium.org 已提交
1109 1110
    }

S
Stanislau Hlebik 已提交
1111 1112 1113 1114 1115
    // Create the log reader.
    LogReporter reporter;
    reporter.env = env_;
    reporter.info_log = db_options_.info_log.get();
    reporter.fname = fname.c_str();
K
krad 已提交
1116 1117 1118 1119 1120 1121 1122
    if (!db_options_.paranoid_checks ||
        db_options_.wal_recovery_mode ==
            WALRecoveryMode::kSkipAnyCorruptedRecords) {
      reporter.status = nullptr;
    } else {
      reporter.status = &status;
    }
S
Stanislau Hlebik 已提交
1123 1124 1125 1126
    // 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).
1127 1128
    log::Reader reader(db_options_.info_log, std::move(file_reader), &reporter,
                       true /*checksum*/, 0 /*initial_offset*/, log_number);
K
krad 已提交
1129 1130 1131 1132 1133
    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 已提交
1134 1135 1136 1137
    // Read all the records and add to a memtable
    std::string scratch;
    Slice record;
    WriteBatch batch;
K
krad 已提交
1138 1139 1140 1141 1142 1143 1144 1145 1146 1147

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

1148 1149 1150 1151
    while (
        continue_replay_log &&
        reader.ReadRecord(&record, &scratch, db_options_.wal_recovery_mode) &&
        status.ok()) {
S
Stanislau Hlebik 已提交
1152 1153 1154 1155 1156 1157 1158
      if (record.size() < 12) {
        reporter.Corruption(record.size(),
                            Status::Corruption("log record too small"));
        continue;
      }
      WriteBatchInternal::SetContents(&batch, record);

1159
#ifndef ROCKSDB_LITE
1160
      if (db_options_.wal_filter != nullptr) {
1161 1162 1163
        WriteBatch new_batch;
        bool batch_changed = false;

1164
        WalFilter::WalProcessingOption wal_processing_option =
S
sdong 已提交
1165 1166
            db_options_.wal_filter->LogRecord(batch, &new_batch,
                                              &batch_changed);
1167

1168
        switch (wal_processing_option) {
S
sdong 已提交
1169 1170 1171 1172 1173
          case WalFilter::WalProcessingOption::kContinueProcessing:
            // do nothing, proceeed normally
            break;
          case WalFilter::WalProcessingOption::kIgnoreCurrentRecord:
            // skip current record
1174
            continue;
S
sdong 已提交
1175 1176 1177
          case WalFilter::WalProcessingOption::kStopReplay:
            // skip current record and stop replay
            continue_replay_log = false;
1178
            continue;
S
sdong 已提交
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
          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;
            }
1202 1203 1204 1205 1206 1207 1208 1209 1210
          }
        }

        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) {
1211
            Log(InfoLogLevel::FATAL_LEVEL, db_options_.info_log,
S
sdong 已提交
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
                "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());
1222
            return status;
1223 1224 1225
          }
          // Set the same sequence number in the new_batch
          // as the original batch.
S
sdong 已提交
1226 1227
          WriteBatchInternal::SetSequence(&new_batch,
                                          WriteBatchInternal::Sequence(&batch));
1228
          batch = new_batch;
1229 1230
        }
      }
S
sdong 已提交
1231
#endif  // ROCKSDB_LITE
1232

S
Stanislau Hlebik 已提交
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242
      // 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
      status = WriteBatchInternal::InsertInto(
          &batch, column_family_memtables_.get(), true, log_number);

      MaybeIgnoreError(&status);
      if (!status.ok()) {
1243 1244 1245 1246
        // 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 已提交
1247
      }
1248

S
Stanislau Hlebik 已提交
1249 1250
      const SequenceNumber last_seq = WriteBatchInternal::Sequence(&batch) +
                                      WriteBatchInternal::Count(&batch) - 1;
A
agiardullo 已提交
1251
      if ((*max_sequence == kMaxSequenceNumber) || (last_seq > *max_sequence)) {
S
Stanislau Hlebik 已提交
1252 1253 1254 1255
        *max_sequence = last_seq;
      }

      if (!read_only) {
I
Igor Canadi 已提交
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267
        // 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;

        while ((cfd = flush_scheduler_.GetNextColumnFamily()) != nullptr) {
          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;
1268
          status = WriteLevel0TableForRecovery(job_id, cfd, cfd->mem(), edit);
I
Igor Canadi 已提交
1269 1270 1271 1272
          if (!status.ok()) {
            // Reflect errors immediately so that conditions like full
            // file-systems cause the DB::Open() to fail.
            return status;
1273
          }
A
agiardullo 已提交
1274 1275 1276

          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
                                 *max_sequence);
1277
        }
J
jorlow@chromium.org 已提交
1278 1279 1280
      }
    }

1281
    if (!status.ok()) {
K
krad 已提交
1282
      if (db_options_.wal_recovery_mode ==
1283 1284 1285 1286
             WALRecoveryMode::kSkipAnyCorruptedRecords) {
        // We should ignore all errors unconditionally
        status = Status::OK();
      } else if (db_options_.wal_recovery_mode ==
K
krad 已提交
1287 1288 1289 1290 1291 1292 1293 1294
                 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);
1295 1296 1297 1298 1299
      } else {
        assert(db_options_.wal_recovery_mode ==
                  WALRecoveryMode::kTolerateCorruptedTailRecords
               || db_options_.wal_recovery_mode ==
                  WALRecoveryMode::kAbsoluteConsistency);
K
krad 已提交
1300 1301
        return status;
      }
1302 1303
    }

I
Igor Canadi 已提交
1304
    flush_scheduler_.Clear();
A
agiardullo 已提交
1305 1306
    if ((*max_sequence != kMaxSequenceNumber) &&
        (versions_->LastSequence() < *max_sequence)) {
S
Stanislau Hlebik 已提交
1307 1308
      versions_->SetLastSequence(*max_sequence);
    }
1309 1310
  }

1311
  if (!read_only) {
1312 1313
    // 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 已提交
1314
    auto max_log_number = log_numbers.back();
1315
    for (auto cfd : *versions_->GetColumnFamilySet()) {
1316
      auto iter = version_edits.find(cfd->GetID());
1317 1318 1319
      assert(iter != version_edits.end());
      VersionEdit* edit = &iter->second;

S
Stanislau Hlebik 已提交
1320
      if (cfd->GetLogNumber() > max_log_number) {
1321
        // Column family cfd has already flushed the data
S
Stanislau Hlebik 已提交
1322
        // from all logs. Memtable has to be empty because
1323
        // we filter the updates based on log_number
1324
        // (in WriteBatch::InsertInto)
1325 1326 1327 1328 1329 1330 1331
        assert(cfd->mem()->GetFirstSequenceNumber() == 0);
        assert(edit->NumEntries() == 0);
        continue;
      }

      // flush the final memtable (if non-empty)
      if (cfd->mem()->GetFirstSequenceNumber() != 0) {
1332
        status = WriteLevel0TableForRecovery(job_id, cfd, cfd->mem(), edit);
S
Stanislau Hlebik 已提交
1333 1334 1335 1336
        if (!status.ok()) {
          // Recovery failed
          break;
        }
A
agiardullo 已提交
1337 1338 1339

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

1342
      // write MANIFEST with update
S
Stanislau Hlebik 已提交
1343
      // writing log_number in the manifest means that any log file
1344 1345
      // with number strongly less than (log_number + 1) is already
      // recovered and should be ignored on next reincarnation.
S
Stanislau Hlebik 已提交
1346 1347 1348
      // 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);
1349 1350 1351
      // 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 已提交
1352
      // log number
1353
      versions_->MarkFileNumberUsedDuringRecovery(max_log_number + 1);
1354 1355
      status = versions_->LogAndApply(
          cfd, *cfd->GetLatestMutableCFOptions(), edit, &mutex_);
1356
      if (!status.ok()) {
S
Stanislau Hlebik 已提交
1357 1358
        // Recovery failed
        break;
1359 1360
      }
    }
1361
  }
I
Igor Canadi 已提交
1362

1363 1364 1365
  event_logger_.Log() << "job" << job_id << "event"
                      << "recovery_finished";

J
jorlow@chromium.org 已提交
1366 1367 1368
  return status;
}

1369 1370
Status DBImpl::WriteLevel0TableForRecovery(int job_id, ColumnFamilyData* cfd,
                                           MemTable* mem, VersionEdit* edit) {
J
jorlow@chromium.org 已提交
1371
  mutex_.AssertHeld();
1372
  const uint64_t start_micros = env_->NowMicros();
J
jorlow@chromium.org 已提交
1373
  FileMetaData meta;
1374
  meta.fd = FileDescriptor(versions_->NewFileNumber(), 0, 0);
I
Igor Canadi 已提交
1375 1376
  auto pending_outputs_inserted_elem =
      CaptureCurrentFileNumberInPendingOutputs();
1377 1378
  ReadOptions ro;
  ro.total_order_seek = true;
1379
  Arena arena;
1380
  Status s;
1381
  TableProperties table_properties;
1382
  {
1383
    ScopedArenaIterator iter(mem->NewIterator(ro, &arena));
1384 1385 1386
    Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
        "[%s] [WriteLevel0TableForRecovery]"
        " Level-0 table #%" PRIu64 ": started",
1387
        cfd->GetName().c_str(), meta.fd.GetNumber());
1388

1389 1390
    bool paranoid_file_checks =
        cfd->GetLatestMutableCFOptions()->paranoid_file_checks;
1391 1392
    {
      mutex_.Unlock();
1393
      TableFileCreationInfo info;
1394 1395 1396 1397 1398

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

1399 1400
      s = BuildTable(
          dbname_, env_, *cfd->ioptions(), env_options_, cfd->table_cache(),
1401
          iter.get(), &meta, cfd->internal_comparator(),
1402 1403 1404
          cfd->int_tbl_prop_collector_factories(), cfd->GetID(), snapshot_seqs,
          earliest_write_conflict_snapshot,
          GetCompressionFlush(*cfd->ioptions()),
1405 1406
          cfd->ioptions()->compression_opts, paranoid_file_checks,
          cfd->internal_stats(), Env::IO_HIGH, &info.table_properties);
1407
      LogFlush(db_options_.info_log);
1408 1409 1410 1411 1412 1413 1414 1415
      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()) {
1416 1417 1418 1419 1420 1421 1422 1423 1424
        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);
1425
      }
1426 1427
      mutex_.Lock();
    }
1428
  }
I
Igor Canadi 已提交
1429
  ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);
1430 1431 1432 1433

  // Note that if file_size is zero, the file has been deleted and
  // should not be added to the manifest.
  int level = 0;
1434
  if (s.ok() && meta.fd.GetFileSize() > 0) {
1435 1436
    edit->AddFile(level, meta.fd.GetNumber(), meta.fd.GetPathId(),
                  meta.fd.GetFileSize(), meta.smallest, meta.largest,
1437 1438
                  meta.smallest_seqno, meta.largest_seqno,
                  meta.marked_for_compaction);
1439 1440
  }

L
Lei Jin 已提交
1441
  InternalStats::CompactionStats stats(1);
1442
  stats.micros = env_->NowMicros() - start_micros;
1443
  stats.bytes_written = meta.fd.GetFileSize();
1444
  stats.num_output_files = 1;
1445
  cfd->internal_stats()->AddCompactionStats(level, stats);
1446 1447
  cfd->internal_stats()->AddCFStats(
      InternalStats::BYTES_FLUSHED, meta.fd.GetFileSize());
L
Lei Jin 已提交
1448
  RecordTick(stats_, COMPACT_WRITE_BYTES, meta.fd.GetFileSize());
J
jorlow@chromium.org 已提交
1449 1450 1451
  return s;
}

1452 1453
Status DBImpl::FlushMemTableToOutputFile(
    ColumnFamilyData* cfd, const MutableCFOptions& mutable_cf_options,
1454
    bool* made_progress, JobContext* job_context, LogBuffer* log_buffer) {
1455
  mutex_.AssertHeld();
1456
  assert(cfd->imm()->NumNotFlushed() != 0);
1457
  assert(cfd->imm()->IsFlushPending());
1458

1459 1460 1461 1462 1463 1464 1465 1466 1467 1468
  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_);
1469

1470
  FileMetaData file_meta;
1471 1472 1473 1474 1475 1476 1477

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

  if (s.ok()) {
I
Igor Canadi 已提交
1481 1482
    InstallSuperVersionAndScheduleWorkWrapper(cfd, job_context,
                                              mutable_cf_options);
1483 1484
    if (made_progress) {
      *made_progress = 1;
1485
    }
S
sdong 已提交
1486
    VersionStorageInfo::LevelSummaryStorage tmp;
I
Igor Canadi 已提交
1487
    LogToBuffer(log_buffer, "[%s] Level summary: %s\n", cfd->GetName().c_str(),
S
sdong 已提交
1488
                cfd->current()->storage_info()->LevelSummary(&tmp));
J
jorlow@chromium.org 已提交
1489
  }
1490

1491
  if (!s.ok() && !s.IsShutdownInProgress() && db_options_.paranoid_checks &&
1492 1493 1494 1495 1496
      bg_error_.ok()) {
    // if a bad error happened (not ShutdownInProgress) and paranoid_checks is
    // true, mark DB read-only
    bg_error_ = s;
  }
1497
  RecordFlushIOStats();
1498 1499 1500
#ifndef ROCKSDB_LITE
  if (s.ok()) {
    // may temporarily unlock and lock the mutex.
1501
    NotifyOnFlushCompleted(cfd, &file_meta, mutable_cf_options,
1502
                           job_context->job_id, flush_job.GetTableProperties());
1503 1504
  }
#endif  // ROCKSDB_LITE
J
jorlow@chromium.org 已提交
1505 1506 1507
  return s;
}

1508 1509 1510 1511
void DBImpl::NotifyOnFlushCompleted(ColumnFamilyData* cfd,
                                    FileMetaData* file_meta,
                                    const MutableCFOptions& mutable_cf_options,
                                    int job_id, TableProperties prop) {
1512
#ifndef ROCKSDB_LITE
1513
  if (db_options_.listeners.size() == 0U) {
1514 1515
    return;
  }
1516 1517 1518 1519
  mutex_.AssertHeld();
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }
1520
  bool triggered_writes_slowdown =
1521
      (cfd->current()->storage_info()->NumLevelFiles(0) >=
1522
       mutable_cf_options.level0_slowdown_writes_trigger);
1523
  bool triggered_writes_stop =
1524
      (cfd->current()->storage_info()->NumLevelFiles(0) >=
1525
       mutable_cf_options.level0_stop_writes_trigger);
1526 1527
  // release lock while notifying events
  mutex_.Unlock();
1528
  {
1529 1530 1531 1532 1533
    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,
1534
                                       file_meta->fd.GetNumber());
1535
    info.thread_id = env_->GetThreadID();
1536 1537 1538
    info.job_id = job_id;
    info.triggered_writes_slowdown = triggered_writes_slowdown;
    info.triggered_writes_stop = triggered_writes_stop;
1539 1540
    info.smallest_seqno = file_meta->smallest_seqno;
    info.largest_seqno = file_meta->largest_seqno;
1541
    info.table_properties = prop;
1542
    for (auto listener : db_options_.listeners) {
1543
      listener->OnFlushCompleted(this, info);
1544 1545
    }
  }
1546 1547 1548
  mutex_.Lock();
  // no need to signal bg_cv_ as it will be signaled at the end of the
  // flush process.
1549
#endif  // ROCKSDB_LITE
1550 1551
}

1552 1553 1554 1555
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()) {
1556 1557 1558
    return Status::InvalidArgument("Invalid target path ID");
  }

1559 1560
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
1561
  bool exclusive = options.exclusive_manual_compaction;
I
Igor Canadi 已提交
1562 1563

  Status s = FlushMemTable(cfd, FlushOptions());
L
Lei Jin 已提交
1564
  if (!s.ok()) {
1565
    LogFlush(db_options_.info_log);
L
Lei Jin 已提交
1566 1567 1568
    return s;
  }

I
Igor Canadi 已提交
1569
  int max_level_with_files = 0;
G
Gabor Cselle 已提交
1570
  {
1571
    InstrumentedMutexLock l(&mutex_);
I
Igor Canadi 已提交
1572
    Version* base = cfd->current();
1573 1574
    for (int level = 1; level < base->storage_info()->num_non_empty_levels();
         level++) {
S
sdong 已提交
1575
      if (base->storage_info()->OverlapInLevel(level, begin, end)) {
G
Gabor Cselle 已提交
1576 1577 1578 1579
        max_level_with_files = level;
      }
    }
  }
1580

1581
  int final_output_level = 0;
1582 1583 1584 1585
  if (cfd->ioptions()->compaction_style == kCompactionStyleUniversal &&
      cfd->NumberLevels() > 1) {
    // Always compact all files together.
    s = RunManualCompaction(cfd, ColumnFamilyData::kCompactAllLevels,
1586
                            cfd->NumberLevels() - 1, options.target_path_id,
1587
                            begin, end, exclusive);
1588
    final_output_level = cfd->NumberLevels() - 1;
1589 1590
  } else {
    for (int level = 0; level <= max_level_with_files; level++) {
1591
      int output_level;
A
Andres Notzli 已提交
1592
      // in case the compaction is universal or if we're compacting the
1593 1594 1595 1596
      // 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 ||
1597 1598 1599
          cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
        output_level = level;
      } else if (level == max_level_with_files && level > 0) {
1600 1601 1602 1603 1604 1605 1606
        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 已提交
1607
                   cfd->ioptions()->compaction_filter_factory == nullptr) {
A
Andres Notzli 已提交
1608 1609
          // Skip bottommost level compaction since we don't have a compaction
          // filter
1610 1611
          continue;
        }
1612
        output_level = level;
1613
      } else {
1614
        output_level = level + 1;
1615 1616 1617 1618 1619
        if (cfd->ioptions()->compaction_style == kCompactionStyleLevel &&
            cfd->ioptions()->level_compaction_dynamic_level_bytes &&
            level == 0) {
          output_level = ColumnFamilyData::kCompactToBaseLevel;
        }
1620
      }
1621
      s = RunManualCompaction(cfd, level, output_level, options.target_path_id,
1622
                              begin, end, exclusive);
1623 1624 1625
      if (!s.ok()) {
        break;
      }
1626 1627 1628 1629 1630
      if (output_level == ColumnFamilyData::kCompactToBaseLevel) {
        final_output_level = cfd->NumberLevels() - 1;
      } else if (output_level > final_output_level) {
        final_output_level = output_level;
      }
1631 1632
      TEST_SYNC_POINT("DBImpl::RunManualCompaction()::1");
      TEST_SYNC_POINT("DBImpl::RunManualCompaction()::2");
1633
    }
G
Gabor Cselle 已提交
1634
  }
1635 1636 1637 1638
  if (!s.ok()) {
    LogFlush(db_options_.info_log);
    return s;
  }
1639

1640
  if (options.change_level) {
1641 1642 1643 1644 1645 1646 1647
    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();
1648
  }
1649
  LogFlush(db_options_.info_log);
L
Lei Jin 已提交
1650

1651
  {
1652
    InstrumentedMutexLock l(&mutex_);
1653 1654 1655 1656 1657
    // an automatic compaction that has been scheduled might have been
    // preempted by the manual compactions. Need to schedule it back.
    MaybeScheduleFlushOrCompaction();
  }

L
Lei Jin 已提交
1658
  return s;
1659 1660
}

1661 1662 1663 1664 1665
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 已提交
1666 1667 1668 1669
#ifdef ROCKSDB_LITE
    // not supported in lite version
  return Status::NotSupported("Not supported in ROCKSDB LITE");
#else
1670 1671 1672 1673 1674 1675
  if (column_family == nullptr) {
    return Status::InvalidArgument("ColumnFamilyHandle must be non-null.");
  }

  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  assert(cfd);
1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700

  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());
1701
  }  // release the mutex
1702 1703 1704 1705 1706 1707 1708 1709 1710 1711

  // 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()) {
1712
      // no mutex is locked here.  No need to Unlock() and Lock() here.
1713 1714 1715 1716 1717
      PurgeObsoleteFiles(job_context);
    }
    job_context.Clean();
  }

1718
  return s;
I
Igor Canadi 已提交
1719
#endif  // ROCKSDB_LITE
1720 1721
}

I
Igor Canadi 已提交
1722
#ifndef ROCKSDB_LITE
1723 1724 1725
Status DBImpl::CompactFilesImpl(
    const CompactionOptions& compact_options, ColumnFamilyData* cfd,
    Version* version, const std::vector<std::string>& input_file_names,
1726 1727
    const int output_level, int output_path_id, JobContext* job_context,
    LogBuffer* log_buffer) {
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759
  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;
  }

1760
  std::vector<CompactionInputFiles> input_files;
1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780
  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(
1781 1782
      compact_options, input_files, output_level, version->storage_info(),
      *cfd->GetLatestMutableCFOptions(), output_path_id));
1783 1784 1785
  if (!c) {
    return Status::Aborted("Another Level 0 compaction is running");
  }
1786 1787
  c->SetInputVersion(version);
  // deletion compaction currently not allowed in CompactFiles.
1788
  assert(!c->deletion_compaction());
1789

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

I
Igor Canadi 已提交
1794
  assert(is_snapshot_supported_ || snapshots_.empty());
1795
  CompactionJob compaction_job(
I
Igor Canadi 已提交
1796 1797
      job_context->job_id, c.get(), db_options_, env_options_, versions_.get(),
      &shutting_down_, log_buffer, directories_.GetDbDir(),
1798 1799
      directories_.GetDataDir(c->output_path_id()), stats_, snapshot_seqs,
      earliest_write_conflict_snapshot, table_cache_, &event_logger_,
1800 1801
      c->mutable_cf_options()->paranoid_file_checks,
      c->mutable_cf_options()->compaction_measure_io_stats, dbname_,
1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814
      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.
1815 1816 1817
  compaction_job.Prepare();

  mutex_.Unlock();
1818 1819
  TEST_SYNC_POINT("CompactFilesImpl:0");
  TEST_SYNC_POINT("CompactFilesImpl:1");
1820
  compaction_job.Run();
1821
  mutex_.Lock();
1822

1823
  Status status = compaction_job.Install(*c->mutable_cf_options(), &mutex_);
1824
  if (status.ok()) {
I
Igor Canadi 已提交
1825 1826
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
1827 1828 1829 1830 1831 1832 1833 1834 1835
  }
  c->ReleaseCompactionFiles(s);
  c.reset();

  if (status.ok()) {
    // Done
  } else if (status.IsShutdownInProgress()) {
    // Ignore compaction errors found during shutting down
  } else {
1836 1837
    Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
        "[%s] [JOB %d] Compaction error: %s",
1838
        c->column_family_data()->GetName().c_str(), job_context->job_id,
1839 1840 1841 1842 1843 1844 1845
        status.ToString().c_str());
    if (db_options_.paranoid_checks && bg_error_.ok()) {
      bg_error_ = status;
    }
  }

  bg_compaction_scheduled_--;
1846 1847 1848
  if (bg_compaction_scheduled_ == 0) {
    bg_cv_.SignalAll();
  }
1849 1850 1851

  return status;
}
I
Igor Canadi 已提交
1852
#endif  // ROCKSDB_LITE
1853

1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864
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_);
1865 1866 1867
  if (bg_work_paused_ == 0) {
    return Status::InvalidArgument();
  }
1868 1869 1870 1871 1872 1873 1874 1875
  assert(bg_work_paused_ > 0);
  bg_work_paused_--;
  if (bg_work_paused_ == 0) {
    MaybeScheduleFlushOrCompaction();
  }
  return Status::OK();
}

O
Ori Bernstein 已提交
1876
void DBImpl::NotifyOnCompactionCompleted(
1877 1878
    ColumnFamilyData* cfd, Compaction *c, const Status &st,
    const CompactionJobStats& compaction_job_stats,
1879
    const int job_id) {
O
Ori Bernstein 已提交
1880
#ifndef ROCKSDB_LITE
1881
  if (db_options_.listeners.size() == 0U) {
O
Ori Bernstein 已提交
1882 1883 1884 1885 1886 1887 1888 1889
    return;
  }
  mutex_.AssertHeld();
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }
  // release lock while notifying events
  mutex_.Unlock();
1890 1891 1892 1893
  {
    CompactionJobInfo info;
    info.cf_name = cfd->GetName();
    info.status = st;
1894
    info.thread_id = env_->GetThreadID();
1895 1896
    info.job_id = job_id;
    info.base_input_level = c->start_level();
1897
    info.output_level = c->output_level();
1898
    info.stats = compaction_job_stats;
1899
    info.table_properties = c->GetOutputTableProperties();
1900
    info.compaction_reason = c->compaction_reason();
1901 1902
    for (size_t i = 0; i < c->num_input_levels(); ++i) {
      for (const auto fmd : *c->inputs(i)) {
1903 1904 1905 1906 1907
        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;
1908
          auto s = cfd->current()->GetTableProperties(&tp, fmd, &fn);
1909 1910 1911 1912
          if (s.ok()) {
            info.table_properties[fn] = tp;
          }
        }
1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924
      }
    }
    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 已提交
1925 1926 1927 1928 1929 1930
  mutex_.Lock();
  // no need to signal bg_cv_ as it will be signaled at the end of the
  // flush process.
#endif  // ROCKSDB_LITE
}

1931
Status DBImpl::SetOptions(ColumnFamilyHandle* column_family,
1932
    const std::unordered_map<std::string, std::string>& options_map) {
I
Igor Canadi 已提交
1933 1934 1935
#ifdef ROCKSDB_LITE
  return Status::NotSupported("Not supported in ROCKSDB LITE");
#else
L
Lei Jin 已提交
1936 1937
  auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  if (options_map.empty()) {
1938 1939
    Log(InfoLogLevel::WARN_LEVEL,
        db_options_.info_log, "SetOptions() on column family [%s], empty input",
L
Lei Jin 已提交
1940
        cfd->GetName().c_str());
1941
    return Status::InvalidArgument("empty input");
L
Lei Jin 已提交
1942 1943 1944
  }

  MutableCFOptions new_options;
1945
  Status s;
1946
  Status persist_options_status;
L
Lei Jin 已提交
1947
  {
1948
    InstrumentedMutexLock l(&mutex_);
1949 1950
    s = cfd->SetOptions(options_map);
    if (s.ok()) {
L
Lei Jin 已提交
1951 1952
      new_options = *cfd->GetLatestMutableCFOptions();
    }
1953 1954 1955 1956 1957 1958 1959 1960
    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);
1961 1962
    }
  }
L
Lei Jin 已提交
1963

1964 1965
  Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
      "SetOptions() on column family [%s], inputs:",
L
Lei Jin 已提交
1966 1967
      cfd->GetName().c_str());
  for (const auto& o : options_map) {
1968 1969
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
        "%s: %s\n", o.first.c_str(), o.second.c_str());
L
Lei Jin 已提交
1970
  }
1971
  if (s.ok()) {
1972 1973
    Log(InfoLogLevel::INFO_LEVEL,
        db_options_.info_log, "[%s] SetOptions succeeded",
L
Lei Jin 已提交
1974 1975
        cfd->GetName().c_str());
    new_options.Dump(db_options_.info_log.get());
1976 1977 1978 1979 1980 1981 1982 1983 1984 1985
    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 已提交
1986
  } else {
1987 1988
    Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
        "[%s] SetOptions failed", cfd->GetName().c_str());
L
Lei Jin 已提交
1989
  }
S
sdong 已提交
1990
  LogFlush(db_options_.info_log);
1991
  return s;
I
Igor Canadi 已提交
1992
#endif  // ROCKSDB_LITE
1993 1994
}

1995
// return the same level if it cannot be moved
1996 1997
int DBImpl::FindMinimumEmptyLevelFitting(ColumnFamilyData* cfd,
    const MutableCFOptions& mutable_cf_options, int level) {
1998
  mutex_.AssertHeld();
S
sdong 已提交
1999
  const auto* vstorage = cfd->current()->storage_info();
2000
  int minimum_level = level;
2001
  for (int i = level - 1; i > 0; --i) {
2002
    // stop if level i is not empty
S
sdong 已提交
2003
    if (vstorage->NumLevelFiles(i) > 0) break;
2004
    // stop if level i is too small (cannot fit the level files)
2005
    if (vstorage->MaxBytesForLevel(i) < vstorage->NumLevelBytes(level)) {
2006 2007
      break;
    }
2008 2009 2010 2011 2012 2013

    minimum_level = i;
  }
  return minimum_level;
}

2014 2015
// REQUIREMENT: block all background work by calling PauseBackgroundWork()
// before calling this function
I
Igor Canadi 已提交
2016 2017
Status DBImpl::ReFitLevel(ColumnFamilyData* cfd, int level, int target_level) {
  assert(level < cfd->NumberLevels());
2018 2019 2020
  if (target_level >= cfd->NumberLevels()) {
    return Status::InvalidArgument("Target level exceeds number of levels");
  }
2021

2022 2023 2024 2025
  std::unique_ptr<SuperVersion> superversion_to_free;
  std::unique_ptr<SuperVersion> new_superversion(new SuperVersion());

  Status status;
I
Igor Canadi 已提交
2026

I
Islam AbdelRahman 已提交
2027
  InstrumentedMutexLock guard_lock(&mutex_);
2028 2029 2030

  // only allow one thread refitting
  if (refitting_level_) {
2031 2032
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
        "[ReFitLevel] another thread is refitting");
L
Lei Jin 已提交
2033
    return Status::NotSupported("another thread is refitting");
2034 2035 2036
  }
  refitting_level_ = true;

2037
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
2038
  // move to a smaller level
2039 2040
  int to_level = target_level;
  if (target_level < 0) {
2041
    to_level = FindMinimumEmptyLevelFitting(cfd, mutable_cf_options, level);
2042
  }
2043

2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058
  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) {
2059
    Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
2060 2061
        "[%s] Before refitting:\n%s", cfd->GetName().c_str(),
        cfd->current()->DebugString().data());
2062

2063
    VersionEdit edit;
I
Igor Canadi 已提交
2064
    edit.SetColumnFamily(cfd->GetID());
2065
    for (const auto& f : vstorage->LevelFiles(level)) {
2066
      edit.DeleteFile(level, f->fd.GetNumber());
2067 2068
      edit.AddFile(to_level, f->fd.GetNumber(), f->fd.GetPathId(),
                   f->fd.GetFileSize(), f->smallest, f->largest,
2069 2070
                   f->smallest_seqno, f->largest_seqno,
                   f->marked_for_compaction);
2071
    }
2072
    Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
2073 2074
        "[%s] Apply version edit:\n%s", cfd->GetName().c_str(),
        edit.DebugString().data());
2075

2076 2077
    status = versions_->LogAndApply(cfd, mutable_cf_options, &edit, &mutex_,
                                    directories_.GetDbDir());
2078 2079
    superversion_to_free.reset(InstallSuperVersionAndScheduleWork(
        cfd, new_superversion.release(), mutable_cf_options));
2080

2081 2082
    Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
        "[%s] LogAndApply: %s\n", cfd->GetName().c_str(),
I
Igor Canadi 已提交
2083
        status.ToString().data());
2084 2085

    if (status.ok()) {
2086
      Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
2087 2088
          "[%s] After refitting:\n%s", cfd->GetName().c_str(),
          cfd->current()->DebugString().data());
2089 2090 2091 2092
    }
  }

  refitting_level_ = false;
I
Igor Canadi 已提交
2093

L
Lei Jin 已提交
2094
  return status;
G
Gabor Cselle 已提交
2095 2096
}

2097 2098 2099
int DBImpl::NumberLevels(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->NumberLevels();
2100 2101
}

2102
int DBImpl::MaxMemCompactionLevel(ColumnFamilyHandle* column_family) {
2103
  return 0;
2104 2105
}

2106 2107
int DBImpl::Level0StopWriteTrigger(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
2108
  InstrumentedMutexLock l(&mutex_);
L
Lei Jin 已提交
2109 2110
  return cfh->cfd()->GetSuperVersion()->
      mutable_cf_options.level0_stop_writes_trigger;
2111 2112
}

L
Lei Jin 已提交
2113
Status DBImpl::Flush(const FlushOptions& flush_options,
2114 2115
                     ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
L
Lei Jin 已提交
2116
  return FlushMemTable(cfh->cfd(), flush_options);
H
heyongqiang 已提交
2117 2118
}

2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150
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;
2151
      logs_to_sync.push_back(log.writer);
2152 2153 2154 2155 2156
    }

    need_log_dir_sync = !log_dir_synced_;
  }

2157
  RecordTick(stats_, WAL_FILE_SYNCED);
2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188
  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) {
2189
      logs_to_free_.push_back(log.ReleaseWriter());
A
Andres Noetzli 已提交
2190
      it = logs_.erase(it);
2191 2192 2193 2194 2195
    } else {
      log.getting_synced = false;
      ++it;
    }
  }
A
Andres Noetzli 已提交
2196
  assert(logs_.empty() || (logs_.size() == 1 && !logs_[0].getting_synced));
2197 2198 2199
  log_sync_cv_.SignalAll();
}

2200
SequenceNumber DBImpl::GetLatestSequenceNumber() const {
2201 2202 2203
  return versions_->LastSequence();
}

I
Igor Canadi 已提交
2204
Status DBImpl::RunManualCompaction(ColumnFamilyData* cfd, int input_level,
2205
                                   int output_level, uint32_t output_path_id,
2206
                                   const Slice* begin, const Slice* end,
2207
                                   bool exclusive, bool disallow_trivial_move) {
2208 2209
  assert(input_level == ColumnFamilyData::kCompactAllLevels ||
         input_level >= 0);
2210

G
Gabor Cselle 已提交
2211
  InternalKey begin_storage, end_storage;
2212
  CompactionArg* ca;
G
Gabor Cselle 已提交
2213

2214 2215
  bool scheduled = false;
  bool manual_conflict = false;
H
hans@chromium.org 已提交
2216
  ManualCompaction manual;
I
Igor Canadi 已提交
2217
  manual.cfd = cfd;
2218 2219
  manual.input_level = input_level;
  manual.output_level = output_level;
2220
  manual.output_path_id = output_path_id;
G
Gabor Cselle 已提交
2221
  manual.done = false;
2222
  manual.in_progress = false;
2223 2224
  manual.incomplete = false;
  manual.exclusive = exclusive;
2225
  manual.disallow_trivial_move = disallow_trivial_move;
2226 2227 2228
  // For universal compaction, we enforce every manual compaction to compact
  // all files.
  if (begin == nullptr ||
2229 2230
      cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
      cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
2231
    manual.begin = nullptr;
G
Gabor Cselle 已提交
2232
  } else {
2233
    begin_storage.SetMaxPossibleForUserKey(*begin);
G
Gabor Cselle 已提交
2234 2235
    manual.begin = &begin_storage;
  }
2236
  if (end == nullptr ||
2237 2238
      cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
      cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
2239
    manual.end = nullptr;
G
Gabor Cselle 已提交
2240
  } else {
2241
    end_storage.SetMinPossibleForUserKey(*end);
G
Gabor Cselle 已提交
2242 2243 2244
    manual.end = &end_storage;
  }

2245
  InstrumentedMutexLock l(&mutex_);
2246

2247 2248 2249 2250 2251
  // 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.
  //
2252
  // HasPendingManualCompaction() is true when at least one thread is inside
2253
  // RunManualCompaction(), i.e. during that time no other compaction will
2254 2255 2256
  // get scheduled (see MaybeScheduleFlushOrCompaction).
  //
  // Note that the following loop doesn't stop more that one thread calling
2257
  // RunManualCompaction() from getting to the second while loop below.
2258 2259 2260
  // However, only one of them will actually schedule compaction, while
  // others will wait on a condition variable until it completes.

2261 2262 2263 2264 2265 2266 2267 2268 2269 2270
  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();
    }
2271
  }
2272

2273 2274
  Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
      "[%s] Manual compaction starting",
I
Igor Canadi 已提交
2275
      cfd->GetName().c_str());
2276

2277 2278 2279 2280
  // 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) {
2281 2282
    assert(HasPendingManualCompaction());
    manual_conflict = false;
2283
    if (ShouldntRunManualCompaction(&manual) || (manual.in_progress == true) ||
2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294
        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);
2295
      // Running either this or some other manual compaction
G
Gabor Cselle 已提交
2296
      bg_cv_.Wait();
2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311
      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;
2312
      bg_compaction_scheduled_++;
2313 2314 2315
      env_->Schedule(&DBImpl::BGWorkCompaction, ca, Env::Priority::LOW, this,
                     &DBImpl::UnscheduleCallback);
      scheduled = true;
G
Gabor Cselle 已提交
2316
    }
H
hans@chromium.org 已提交
2317
  }
2318

2319
  assert(!manual.in_progress);
2320 2321
  assert(HasPendingManualCompaction());
  RemoveManualCompaction(&manual);
2322
  bg_cv_.SignalAll();
L
Lei Jin 已提交
2323
  return manual.status;
J
jorlow@chromium.org 已提交
2324 2325
}

2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342
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);
}

2343
Status DBImpl::FlushMemTable(ColumnFamilyData* cfd,
L
Lei Jin 已提交
2344
                             const FlushOptions& flush_options) {
S
Stanislau Hlebik 已提交
2345 2346 2347
  Status s;
  {
    WriteContext context;
2348
    InstrumentedMutexLock guard_lock(&mutex_);
2349

2350
    if (cfd->imm()->NumNotFlushed() == 0 && cfd->mem()->IsEmpty()) {
2351 2352 2353 2354
      // Nothing to flush
      return Status::OK();
    }

2355 2356
    WriteThread::Writer w;
    write_thread_.EnterUnbatched(&w, &mutex_);
S
Stanislau Hlebik 已提交
2357

I
Igor Canadi 已提交
2358
    // SwitchMemtable() will release and reacquire mutex
S
Stanislau Hlebik 已提交
2359
    // during execution
I
Igor Canadi 已提交
2360
    s = SwitchMemtable(cfd, &context);
2361
    write_thread_.ExitUnbatched(&w);
2362

S
Stanislau Hlebik 已提交
2363 2364
    cfd->imm()->FlushRequested();

2365 2366 2367
    // schedule flush
    SchedulePendingFlush(cfd);
    MaybeScheduleFlushOrCompaction();
S
Stanislau Hlebik 已提交
2368
  }
S
Stanislau Hlebik 已提交
2369

L
Lei Jin 已提交
2370
  if (s.ok() && flush_options.wait) {
2371
    // Wait until the compaction completes
2372
    s = WaitForFlushMemTable(cfd);
2373 2374
  }
  return s;
J
jorlow@chromium.org 已提交
2375 2376
}

2377
Status DBImpl::WaitForFlushMemTable(ColumnFamilyData* cfd) {
2378 2379
  Status s;
  // Wait until the compaction completes
2380
  InstrumentedMutexLock l(&mutex_);
2381
  while (cfd->imm()->NumNotFlushed() > 0 && bg_error_.ok()) {
2382 2383 2384
    if (shutting_down_.load(std::memory_order_acquire)) {
      return Status::ShutdownInProgress();
    }
2385 2386
    bg_cv_.Wait();
  }
2387
  if (!bg_error_.ok()) {
2388 2389 2390
    s = bg_error_;
  }
  return s;
H
heyongqiang 已提交
2391 2392
}

2393 2394 2395 2396
Status DBImpl::EnableAutoCompaction(
    const std::vector<ColumnFamilyHandle*>& column_family_handles) {
  Status s;
  for (auto cf_ptr : column_family_handles) {
2397 2398 2399 2400 2401 2402 2403 2404 2405 2406
    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;
2407 2408 2409 2410 2411 2412
    }
  }

  return s;
}

2413
void DBImpl::MaybeScheduleFlushOrCompaction() {
J
jorlow@chromium.org 已提交
2414
  mutex_.AssertHeld();
2415 2416 2417 2418
  if (!opened_successfully_) {
    // Compaction may introduce data race to DB open
    return;
  }
2419 2420
  if (bg_work_paused_ > 0) {
    // we paused the background work
2421
    return;
I
Igor Canadi 已提交
2422
  } else if (shutting_down_.load(std::memory_order_acquire)) {
J
jorlow@chromium.org 已提交
2423
    // DB is being deleted; no more background compactions
2424 2425
    return;
  }
2426

2427 2428 2429 2430
  while (unscheduled_flushes_ > 0 &&
         bg_flush_scheduled_ < db_options_.max_background_flushes) {
    unscheduled_flushes_--;
    bg_flush_scheduled_++;
2431
    env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::HIGH, this);
2432 2433
  }

2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445
  // 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_ <
               db_options_.max_background_compactions) {
      unscheduled_flushes_--;
      bg_flush_scheduled_++;
      env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::LOW, this);
    }
  }

2446
  if (HasExclusiveManualCompaction()) {
2447 2448 2449 2450 2451
    // only manual compactions are allowed to run. don't schedule automatic
    // compactions
    return;
  }

2452 2453
  while (bg_compaction_scheduled_ < db_options_.max_background_compactions &&
         unscheduled_compactions_ > 0) {
2454 2455 2456
    CompactionArg* ca = new CompactionArg;
    ca->db = this;
    ca->m = nullptr;
2457 2458
    bg_compaction_scheduled_++;
    unscheduled_compactions_--;
2459 2460
    env_->Schedule(&DBImpl::BGWorkCompaction, ca, Env::Priority::LOW, this,
                   &DBImpl::UnscheduleCallback);
2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506
  }
}

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_;
2507 2508 2509
  }
}

2510
void DBImpl::RecordFlushIOStats() {
I
Igor Canadi 已提交
2511
  RecordTick(stats_, FLUSH_WRITE_BYTES, IOSTATS(bytes_written));
2512 2513 2514
  IOSTATS_RESET(bytes_written);
}

2515
void DBImpl::BGWorkFlush(void* db) {
2516
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
2517
  TEST_SYNC_POINT("DBImpl::BGWorkFlush");
2518
  reinterpret_cast<DBImpl*>(db)->BackgroundCallFlush();
2519
  TEST_SYNC_POINT("DBImpl::BGWorkFlush:done");
2520 2521
}

2522 2523 2524
void DBImpl::BGWorkCompaction(void* arg) {
  CompactionArg ca = *(reinterpret_cast<CompactionArg*>(arg));
  delete reinterpret_cast<CompactionArg*>(arg);
2525
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::LOW);
2526
  TEST_SYNC_POINT("DBImpl::BGWorkCompaction");
2527 2528 2529 2530 2531 2532 2533 2534 2535 2536
  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");
2537 2538
}

2539
Status DBImpl::BackgroundFlush(bool* made_progress, JobContext* job_context,
H
Haobo Xu 已提交
2540
                               LogBuffer* log_buffer) {
2541
  mutex_.AssertHeld();
2542

2543 2544 2545 2546 2547 2548 2549
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

  if (!status.ok()) {
    return status;
2550 2551
  }

2552 2553 2554
  ColumnFamilyData* cfd = nullptr;
  while (!flush_queue_.empty()) {
    // This cfd is already referenced
I
Igor Canadi 已提交
2555
    auto first_cfd = PopFirstFromFlushQueue();
2556

I
Igor Canadi 已提交
2557
    if (first_cfd->IsDropped() || !first_cfd->imm()->IsFlushPending()) {
2558
      // can't flush this CF, try next one
I
Igor Canadi 已提交
2559 2560
      if (first_cfd->Unref()) {
        delete first_cfd;
2561 2562
      }
      continue;
2563
    }
2564 2565

    // found a flush!
I
Igor Canadi 已提交
2566
    cfd = first_cfd;
2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579
    break;
  }

  if (cfd != nullptr) {
    const MutableCFOptions mutable_cf_options =
        *cfd->GetLatestMutableCFOptions();
    LogToBuffer(
        log_buffer,
        "Calling FlushMemTableToOutputFile with column "
        "family [%s], flush slots available %d, compaction slots available %d",
        cfd->GetName().c_str(),
        db_options_.max_background_flushes - bg_flush_scheduled_,
        db_options_.max_background_compactions - bg_compaction_scheduled_);
2580
    status = FlushMemTableToOutputFile(cfd, mutable_cf_options, made_progress,
2581 2582 2583
                                       job_context, log_buffer);
    if (cfd->Unref()) {
      delete cfd;
2584
    }
J
jorlow@chromium.org 已提交
2585
  }
2586
  return status;
J
jorlow@chromium.org 已提交
2587 2588
}

2589
void DBImpl::BackgroundCallFlush() {
2590
  bool made_progress = false;
2591
  JobContext job_context(next_job_id_.fetch_add(1), true);
2592 2593
  assert(bg_flush_scheduled_);

2594
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, db_options_.info_log.get());
H
Haobo Xu 已提交
2595
  {
2596
    InstrumentedMutexLock l(&mutex_);
2597
    num_running_flushes_++;
H
Haobo Xu 已提交
2598

I
Igor Canadi 已提交
2599 2600 2601
    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

2602
    Status s = BackgroundFlush(&made_progress, &job_context, &log_buffer);
2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619
    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 已提交
2620 2621
    }

I
Igor Canadi 已提交
2622 2623
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

2624 2625 2626
    // 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 已提交
2627
    // delete unnecessary files if any, this is done outside the mutex
I
Igor Canadi 已提交
2628
    if (job_context.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2629
      mutex_.Unlock();
2630 2631 2632 2633 2634
      // 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 已提交
2635
      log_buffer.FlushBufferToLog();
I
Igor Canadi 已提交
2636 2637
      if (job_context.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(job_context);
2638
      }
I
Igor Canadi 已提交
2639
      job_context.Clean();
2640 2641
      mutex_.Lock();
    }
I
Igor Canadi 已提交
2642

2643 2644
    assert(num_running_flushes_ > 0);
    num_running_flushes_--;
H
Haobo Xu 已提交
2645
    bg_flush_scheduled_--;
2646 2647
    // See if there's more work to be done
    MaybeScheduleFlushOrCompaction();
I
Igor Canadi 已提交
2648
    RecordFlushIOStats();
H
Haobo Xu 已提交
2649
    bg_cv_.SignalAll();
I
Igor Canadi 已提交
2650 2651 2652 2653
    // 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.
2654
  }
J
jorlow@chromium.org 已提交
2655 2656
}

2657
void DBImpl::BackgroundCallCompaction(void* arg) {
2658
  bool made_progress = false;
2659
  ManualCompaction* m = reinterpret_cast<ManualCompaction*>(arg);
2660
  JobContext job_context(next_job_id_.fetch_add(1), true);
2661
  TEST_SYNC_POINT("BackgroundCallCompaction:0");
H
Haobo Xu 已提交
2662
  MaybeDumpStats();
2663
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, db_options_.info_log.get());
2664
  {
2665
    InstrumentedMutexLock l(&mutex_);
2666
    num_running_compactions_++;
I
Igor Canadi 已提交
2667 2668 2669 2670

    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

2671
    assert(bg_compaction_scheduled_);
2672 2673
    Status s =
        BackgroundCompaction(&made_progress, &job_context, &log_buffer, m);
2674
    TEST_SYNC_POINT("BackgroundCallCompaction:1");
2675 2676 2677 2678 2679 2680
    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 =
2681
          default_cf_internal_stats_->BumpAndGetBackgroundErrorCount();
2682 2683 2684 2685 2686 2687 2688 2689 2690 2691
      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();
2692
    }
H
Haobo Xu 已提交
2693

I
Igor Canadi 已提交
2694 2695
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

2696 2697 2698 2699
    // 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());
2700 2701

    // delete unnecessary files if any, this is done outside the mutex
I
Igor Canadi 已提交
2702
    if (job_context.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2703
      mutex_.Unlock();
2704 2705 2706 2707 2708
      // 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 已提交
2709
      log_buffer.FlushBufferToLog();
I
Igor Canadi 已提交
2710 2711
      if (job_context.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(job_context);
2712
      }
I
Igor Canadi 已提交
2713
      job_context.Clean();
2714 2715
      mutex_.Lock();
    }
D
Dhruba Borthakur 已提交
2716

2717 2718
    assert(num_running_compactions_ > 0);
    num_running_compactions_--;
2719
    bg_compaction_scheduled_--;
J
jorlow@chromium.org 已提交
2720

2721 2722
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();

2723 2724
    // See if there's more work to be done
    MaybeScheduleFlushOrCompaction();
2725 2726
    if (made_progress || bg_compaction_scheduled_ == 0 ||
        HasPendingManualCompaction()) {
2727
      // signal if
2728
      // * made_progress -- need to wakeup DelayWrite
2729
      // * bg_compaction_scheduled_ == 0 -- need to wakeup ~DBImpl
2730
      // * HasPendingManualCompaction -- need to wakeup RunManualCompaction
2731 2732 2733 2734
      // If none of this is true, there is no need to signal since nobody is
      // waiting for it
      bg_cv_.SignalAll();
    }
I
Igor Canadi 已提交
2735 2736 2737 2738
    // 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.
2739
  }
J
jorlow@chromium.org 已提交
2740 2741
}

2742 2743
Status DBImpl::BackgroundCompaction(bool* made_progress,
                                    JobContext* job_context,
2744 2745 2746
                                    LogBuffer* log_buffer, void* arg) {
  ManualCompaction* manual_compaction =
      reinterpret_cast<ManualCompaction*>(arg);
2747
  *made_progress = false;
J
jorlow@chromium.org 已提交
2748
  mutex_.AssertHeld();
2749

2750 2751 2752 2753 2754
  bool is_manual = (manual_compaction != nullptr);

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

2756
  CompactionJobStats compaction_job_stats;
2757 2758 2759 2760 2761 2762
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

  if (!status.ok()) {
2763
    if (is_manual) {
2764 2765 2766 2767 2768
      manual_compaction->status = status;
      manual_compaction->done = true;
      manual_compaction->in_progress = false;
      delete manual_compaction->compaction;
      manual_compaction = nullptr;
2769
    }
2770
    return status;
2771 2772
  }

2773 2774
  if (is_manual) {
    // another thread cannot pick up the same work
2775
    manual_compaction->in_progress = true;
2776 2777 2778
  }

  unique_ptr<Compaction> c;
2779 2780
  // InternalKey manual_end_storage;
  // InternalKey* manual_end = &manual_end_storage;
H
hans@chromium.org 已提交
2781
  if (is_manual) {
2782
    ManualCompaction* m = manual_compaction;
2783
    assert(m->in_progress);
2784
    c.reset(std::move(m->compaction));
2785
    if (!c) {
2786
      m->done = true;
2787
      m->manual_end = nullptr;
2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800
      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)"),
2801
                  ((m->done || m->manual_end == nullptr)
2802
                       ? "(end)"
2803
                       : m->manual_end->DebugString().c_str()));
G
Gabor Cselle 已提交
2804
    }
2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819
  } 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();
    }

2820 2821 2822 2823 2824 2825
    if (HaveManualCompaction(cfd)) {
      // Can't compact right now, but try again later
      TEST_SYNC_POINT("DBImpl::BackgroundCompaction()::Conflict");
      return Status::OK();
    }

2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842
    // 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 已提交
2843
        // InstallSuperVersionAndScheduleWork
2844
        // 2) When MutableCFOptions changes. This case is also covered by
I
Igor Canadi 已提交
2845 2846
        // InstallSuperVersionAndScheduleWork, because this is when the new
        // options take effect.
2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857
        // 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 已提交
2858
        }
I
Igor Canadi 已提交
2859 2860
      }
    }
J
jorlow@chromium.org 已提交
2861 2862
  }

2863
  if (!c) {
H
hans@chromium.org 已提交
2864
    // Nothing to do
2865
    LogToBuffer(log_buffer, "Compaction nothing to do");
2866
  } else if (c->deletion_compaction()) {
I
Igor Canadi 已提交
2867 2868 2869 2870
    // 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);
2871
    assert(c->column_family_data()->ioptions()->compaction_style ==
I
Igor Canadi 已提交
2872
           kCompactionStyleFIFO);
2873 2874 2875

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

I
Igor Canadi 已提交
2876
    for (const auto& f : *c->inputs(0)) {
2877
      c->edit()->DeleteFile(c->level(), f->fd.GetNumber());
I
Igor Canadi 已提交
2878
    }
2879 2880 2881
    status = versions_->LogAndApply(c->column_family_data(),
                                    *c->mutable_cf_options(), c->edit(),
                                    &mutex_, directories_.GetDbDir());
I
Igor Canadi 已提交
2882 2883
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
I
Igor Canadi 已提交
2884 2885 2886
    LogToBuffer(log_buffer, "[%s] Deleted %d files\n",
                c->column_family_data()->GetName().c_str(),
                c->num_input_files(0));
2887
    *made_progress = true;
2888
  } else if (!trivial_move_disallowed && c->IsTrivialMove()) {
2889
    TEST_SYNC_POINT("DBImpl::BackgroundCompaction:TrivialMove");
2890 2891 2892 2893 2894
    // Instrument for event update
    // TODO(yhchiang): add op details for showing trivial-move.
    ThreadStatusUtil::SetColumnFamily(c->column_family_data());
    ThreadStatusUtil::SetThreadOperation(ThreadStatus::OP_COMPACTION);

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

2897 2898 2899
    // Move files to next level
    int32_t moved_files = 0;
    int64_t moved_bytes = 0;
2900
    for (unsigned int l = 0; l < c->num_input_levels(); l++) {
2901
      if (c->level(l) == c->output_level()) {
2902 2903 2904 2905
        continue;
      }
      for (size_t i = 0; i < c->num_input_files(l); i++) {
        FileMetaData* f = c->input(l, i);
2906
        c->edit()->DeleteFile(c->level(l), f->fd.GetNumber());
2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918
        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();
      }
2919
    }
2920

2921
    status = versions_->LogAndApply(c->column_family_data(),
2922 2923
                                    *c->mutable_cf_options(), c->edit(),
                                    &mutex_, directories_.GetDbDir());
2924
    // Use latest MutableCFOptions
I
Igor Canadi 已提交
2925 2926
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
2927

S
sdong 已提交
2928
    VersionStorageInfo::LevelSummaryStorage tmp;
I
Islam AbdelRahman 已提交
2929
    c->column_family_data()->internal_stats()->IncBytesMoved(c->output_level(),
2930
                                                             moved_bytes);
2931 2932 2933 2934
    {
      event_logger_.LogToBuffer(log_buffer)
          << "job" << job_context->job_id << "event"
          << "trivial_move"
I
Islam AbdelRahman 已提交
2935
          << "destination_level" << c->output_level() << "files" << moved_files
2936
          << "total_files_size" << moved_bytes;
2937
    }
2938 2939
    LogToBuffer(
        log_buffer,
2940
        "[%s] Moved #%d files to level-%d %" PRIu64 " bytes %s: %s\n",
I
Islam AbdelRahman 已提交
2941 2942
        c->column_family_data()->GetName().c_str(), moved_files,
        c->output_level(), moved_bytes, status.ToString().c_str(),
2943
        c->column_family_data()->current()->storage_info()->LevelSummary(&tmp));
2944
    *made_progress = true;
2945 2946 2947

    // Clear Instrument
    ThreadStatusUtil::ResetThreadStatus();
J
jorlow@chromium.org 已提交
2948
  } else {
2949 2950 2951
    int output_level  __attribute__((unused)) = c->output_level();
    TEST_SYNC_POINT_CALLBACK("DBImpl::BackgroundCompaction:NonTrivial",
                             &output_level);
2952 2953 2954 2955 2956

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

I
Igor Canadi 已提交
2957
    assert(is_snapshot_supported_ || snapshots_.empty());
2958
    CompactionJob compaction_job(
I
Igor Canadi 已提交
2959 2960
        job_context->job_id, c.get(), db_options_, env_options_,
        versions_.get(), &shutting_down_, log_buffer, directories_.GetDbDir(),
2961 2962
        directories_.GetDataDir(c->output_path_id()), stats_, snapshot_seqs,
        earliest_write_conflict_snapshot, table_cache_, &event_logger_,
2963 2964
        c->mutable_cf_options()->paranoid_file_checks,
        c->mutable_cf_options()->compaction_measure_io_stats, dbname_,
S
sdong 已提交
2965
        &compaction_job_stats);
I
Igor Canadi 已提交
2966
    compaction_job.Prepare();
2967

I
Igor Canadi 已提交
2968
    mutex_.Unlock();
2969
    compaction_job.Run();
2970
    TEST_SYNC_POINT("DBImpl::BackgroundCompaction:NonTrivial:AfterRun");
I
Igor Canadi 已提交
2971
    mutex_.Lock();
2972

2973
    status = compaction_job.Install(*c->mutable_cf_options(), &mutex_);
I
Igor Canadi 已提交
2974
    if (status.ok()) {
I
Igor Canadi 已提交
2975 2976
      InstallSuperVersionAndScheduleWorkWrapper(
          c->column_family_data(), job_context, *c->mutable_cf_options());
I
Igor Canadi 已提交
2977
    }
2978
    *made_progress = true;
O
Ori Bernstein 已提交
2979 2980
  }
  if (c != nullptr) {
2981 2982 2983
    NotifyOnCompactionCompleted(
        c->column_family_data(), c.get(), status,
        compaction_job_stats, job_context->job_id);
I
Igor Canadi 已提交
2984
    c->ReleaseCompactionFiles(status);
2985
    *made_progress = true;
J
jorlow@chromium.org 已提交
2986
  }
2987
  // this will unref its input_version and column_family_data
2988
  c.reset();
J
jorlow@chromium.org 已提交
2989 2990 2991

  if (status.ok()) {
    // Done
F
Feng Zhu 已提交
2992
  } else if (status.IsShutdownInProgress()) {
J
jorlow@chromium.org 已提交
2993 2994
    // Ignore compaction errors found during shutting down
  } else {
2995
    Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log, "Compaction error: %s",
2996
        status.ToString().c_str());
2997
    if (db_options_.paranoid_checks && bg_error_.ok()) {
J
jorlow@chromium.org 已提交
2998 2999 3000
      bg_error_ = status;
    }
  }
H
hans@chromium.org 已提交
3001 3002

  if (is_manual) {
3003
    ManualCompaction* m = manual_compaction;
3004
    if (!status.ok()) {
L
Lei Jin 已提交
3005
      m->status = status;
3006 3007
      m->done = true;
    }
3008 3009 3010 3011 3012 3013 3014 3015 3016
    // 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.
3017 3018 3019 3020
    //
    // 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
3021
    if (m->manual_end == nullptr) {
3022 3023
      m->done = true;
    }
G
Gabor Cselle 已提交
3024 3025 3026
    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 已提交
3027
      // Universal and FIFO compactions should always compact the whole range
S
sdong 已提交
3028 3029 3030
      assert(m->cfd->ioptions()->compaction_style !=
                 kCompactionStyleUniversal ||
             m->cfd->ioptions()->num_levels > 1);
3031
      assert(m->cfd->ioptions()->compaction_style != kCompactionStyleFIFO);
3032
      m->tmp_storage = *m->manual_end;
G
Gabor Cselle 已提交
3033
      m->begin = &m->tmp_storage;
3034
      m->incomplete = true;
G
Gabor Cselle 已提交
3035
    }
3036
    m->in_progress = false; // not being processed anymore
H
hans@chromium.org 已提交
3037
  }
3038
  return status;
J
jorlow@chromium.org 已提交
3039 3040
}

3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063
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;
}

3064 3065 3066
bool DBImpl::ShouldntRunManualCompaction(ManualCompaction* m) {
  if (m->exclusive) {
    return (bg_compaction_scheduled_ > 0);
3067 3068 3069 3070 3071 3072 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 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127
  }
  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;
}

3128 3129
namespace {
struct IterState {
3130
  IterState(DBImpl* _db, InstrumentedMutex* _mu, SuperVersion* _super_version)
I
Igor Canadi 已提交
3131
      : db(_db), mu(_mu), super_version(_super_version) {}
3132 3133

  DBImpl* db;
3134
  InstrumentedMutex* mu;
3135
  SuperVersion* super_version;
3136 3137 3138 3139
};

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

3141
  if (state->super_version->Unref()) {
3142 3143 3144
    // Job id == 0 means that this is not our background process, but rather
    // user thread
    JobContext job_context(0);
3145

3146 3147
    state->mu->Lock();
    state->super_version->Cleanup();
I
Igor Canadi 已提交
3148
    state->db->FindObsoleteFiles(&job_context, false, true);
3149 3150 3151
    state->mu->Unlock();

    delete state->super_version;
I
Igor Canadi 已提交
3152 3153
    if (job_context.HaveSomethingToDelete()) {
      state->db->PurgeObsoleteFiles(job_context);
3154
    }
I
Igor Canadi 已提交
3155
    job_context.Clean();
I
Igor Canadi 已提交
3156
  }
T
Tomislav Novak 已提交
3157

3158 3159
  delete state;
}
H
Hans Wennborg 已提交
3160
}  // namespace
3161

S
sdong 已提交
3162 3163 3164 3165 3166
InternalIterator* DBImpl::NewInternalIterator(const ReadOptions& read_options,
                                              ColumnFamilyData* cfd,
                                              SuperVersion* super_version,
                                              Arena* arena) {
  InternalIterator* internal_iter;
3167 3168 3169 3170 3171
  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 已提交
3172
      super_version->mem->NewIterator(read_options, arena));
3173
  // Collect all needed child iterators for immutable memtables
L
Lei Jin 已提交
3174
  super_version->imm->AddIterators(read_options, &merge_iter_builder);
3175
  // Collect iterators for files in L0 - Ln
L
Lei Jin 已提交
3176
  super_version->current->AddIterators(read_options, env_options_,
3177 3178
                                       &merge_iter_builder);
  internal_iter = merge_iter_builder.Finish();
3179
  IterState* cleanup = new IterState(this, &mutex_, super_version);
3180
  internal_iter->RegisterCleanup(CleanupIteratorState, cleanup, nullptr);
J
jorlow@chromium.org 已提交
3181 3182 3183 3184

  return internal_iter;
}

3185 3186 3187 3188
ColumnFamilyHandle* DBImpl::DefaultColumnFamily() const {
  return default_cf_handle_;
}

L
Lei Jin 已提交
3189
Status DBImpl::Get(const ReadOptions& read_options,
3190
                   ColumnFamilyHandle* column_family, const Slice& key,
J
jorlow@chromium.org 已提交
3191
                   std::string* value) {
L
Lei Jin 已提交
3192
  return GetImpl(read_options, column_family, key, value);
3193 3194
}

I
Igor Canadi 已提交
3195 3196
// JobContext gets created and destructed outside of the lock --
// we
I
Igor Canadi 已提交
3197 3198
// use this convinently to:
// * malloc one SuperVersion() outside of the lock -- new_superversion
3199
// * delete SuperVersion()s outside of the lock -- superversions_to_free
I
Igor Canadi 已提交
3200
//
I
Igor Canadi 已提交
3201 3202 3203
// However, if InstallSuperVersionAndScheduleWork() gets called twice with the
// same job_context, we can't reuse the SuperVersion() that got
// malloced because
I
Igor Canadi 已提交
3204 3205 3206
// 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 已提交
3207
void DBImpl::InstallSuperVersionAndScheduleWorkWrapper(
I
Igor Canadi 已提交
3208
    ColumnFamilyData* cfd, JobContext* job_context,
3209
    const MutableCFOptions& mutable_cf_options) {
3210
  mutex_.AssertHeld();
I
Igor Canadi 已提交
3211
  SuperVersion* old_superversion = InstallSuperVersionAndScheduleWork(
I
Igor Canadi 已提交
3212 3213 3214
      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 已提交
3215 3216
}

I
Igor Canadi 已提交
3217
SuperVersion* DBImpl::InstallSuperVersionAndScheduleWork(
L
Lei Jin 已提交
3218
    ColumnFamilyData* cfd, SuperVersion* new_sv,
I
Igor Canadi 已提交
3219
    const MutableCFOptions& mutable_cf_options) {
L
Lei Jin 已提交
3220
  mutex_.AssertHeld();
3221 3222 3223 3224 3225 3226 3227 3228 3229

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

3233
  // Whenever we install new SuperVersion, we might need to issue new flushes or
I
Igor Canadi 已提交
3234 3235 3236 3237
  // compactions.
  SchedulePendingFlush(cfd);
  SchedulePendingCompaction(cfd);
  MaybeScheduleFlushOrCompaction();
L
Lei Jin 已提交
3238 3239 3240 3241 3242 3243 3244 3245 3246 3247

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

3253 3254 3255
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

3256
  SequenceNumber snapshot;
L
Lei Jin 已提交
3257 3258 3259
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
3260 3261
  } else {
    snapshot = versions_->LastSequence();
J
jorlow@chromium.org 已提交
3262
  }
3263
  // Acquire SuperVersion
3264
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
3265
  // Prepare to store a list of merge operations if merge occurs.
3266
  MergeContext merge_context;
3267

3268
  Status s;
3269
  // First look in the memtable, then in the immutable memtable (if any).
3270
  // s is both in/out. When in, s could either be OK or MergeInProgress.
3271
  // merge_operands will contain the sequence of merges in the latter case.
3272
  LookupKey lkey(key, snapshot);
L
Lei Jin 已提交
3273
  PERF_TIMER_STOP(get_snapshot_time);
3274

3275
  if (sv->mem->Get(lkey, value, &s, &merge_context)) {
3276
    // Done
L
Lei Jin 已提交
3277
    RecordTick(stats_, MEMTABLE_HIT);
3278
  } else if (sv->imm->Get(lkey, value, &s, &merge_context)) {
3279
    // Done
L
Lei Jin 已提交
3280
    RecordTick(stats_, MEMTABLE_HIT);
3281
  } else {
3282
    PERF_TIMER_GUARD(get_from_output_files_time);
L
Lei Jin 已提交
3283 3284
    sv->current->Get(read_options, lkey, value, &s, &merge_context,
                     value_found);
L
Lei Jin 已提交
3285
    RecordTick(stats_, MEMTABLE_MISS);
3286
  }
3287

3288 3289
  {
    PERF_TIMER_GUARD(get_post_process_time);
3290

3291
    ReturnAndCleanupSuperVersion(cfd, sv);
3292

3293 3294 3295
    RecordTick(stats_, NUMBER_KEYS_READ);
    RecordTick(stats_, BYTES_READ, value->size());
  }
3296
  return s;
J
jorlow@chromium.org 已提交
3297 3298
}

3299
std::vector<Status> DBImpl::MultiGet(
L
Lei Jin 已提交
3300
    const ReadOptions& read_options,
3301
    const std::vector<ColumnFamilyHandle*>& column_family,
3302
    const std::vector<Slice>& keys, std::vector<std::string>* values) {
3303

L
Lei Jin 已提交
3304
  StopWatch sw(env_, stats_, DB_MULTIGET);
3305
  PERF_TIMER_GUARD(get_snapshot_time);
K
Kai Liu 已提交
3306

3307
  SequenceNumber snapshot;
3308

3309
  struct MultiGetColumnFamilyData {
I
Igor Canadi 已提交
3310
    ColumnFamilyData* cfd;
3311 3312 3313 3314 3315
    SuperVersion* super_version;
  };
  std::unordered_map<uint32_t, MultiGetColumnFamilyData*> multiget_cf_data;
  // fill up and allocate outside of mutex
  for (auto cf : column_family) {
3316 3317 3318 3319 3320 3321
    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});
3322 3323 3324
    }
  }

3325
  mutex_.Lock();
L
Lei Jin 已提交
3326 3327 3328
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
3329 3330 3331
  } else {
    snapshot = versions_->LastSequence();
  }
3332
  for (auto mgd_iter : multiget_cf_data) {
3333 3334
    mgd_iter.second->super_version =
        mgd_iter.second->cfd->GetSuperVersion()->Ref();
3335
  }
3336
  mutex_.Unlock();
3337

3338 3339
  // Contain a list of merge operations if merge occurs.
  MergeContext merge_context;
3340

3341
  // Note: this always resizes the values array
3342 3343 3344
  size_t num_keys = keys.size();
  std::vector<Status> stat_list(num_keys);
  values->resize(num_keys);
3345 3346

  // Keep track of bytes that we read for statistics-recording later
3347
  uint64_t bytes_read = 0;
L
Lei Jin 已提交
3348
  PERF_TIMER_STOP(get_snapshot_time);
3349 3350 3351 3352

  // 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.
3353
  // merge_operands will contain the sequence of merges in the latter case.
3354
  for (size_t i = 0; i < num_keys; ++i) {
3355
    merge_context.Clear();
3356
    Status& s = stat_list[i];
3357 3358 3359
    std::string* value = &(*values)[i];

    LookupKey lkey(keys[i], snapshot);
3360 3361
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family[i]);
    auto mgd_iter = multiget_cf_data.find(cfh->cfd()->GetID());
3362 3363 3364
    assert(mgd_iter != multiget_cf_data.end());
    auto mgd = mgd_iter->second;
    auto super_version = mgd->super_version;
3365
    if (super_version->mem->Get(lkey, value, &s, &merge_context)) {
3366
      // Done
3367
    } else if (super_version->imm->Get(lkey, value, &s, &merge_context)) {
3368 3369
      // Done
    } else {
3370
      PERF_TIMER_GUARD(get_from_output_files_time);
L
Lei Jin 已提交
3371 3372
      super_version->current->Get(read_options, lkey, value, &s,
                                  &merge_context);
3373 3374 3375
    }

    if (s.ok()) {
3376
      bytes_read += value->size();
3377 3378 3379 3380
    }
  }

  // Post processing (decrement reference counts and record statistics)
3381
  PERF_TIMER_GUARD(get_post_process_time);
3382 3383
  autovector<SuperVersion*> superversions_to_delete;

I
Igor Canadi 已提交
3384
  // TODO(icanadi) do we need lock here or just around Cleanup()?
3385 3386 3387 3388 3389 3390
  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);
3391 3392
    }
  }
3393 3394 3395 3396 3397 3398 3399
  mutex_.Unlock();

  for (auto td : superversions_to_delete) {
    delete td;
  }
  for (auto mgd : multiget_cf_data) {
    delete mgd.second;
3400
  }
3401

L
Lei Jin 已提交
3402 3403 3404
  RecordTick(stats_, NUMBER_MULTIGET_CALLS);
  RecordTick(stats_, NUMBER_MULTIGET_KEYS_READ, num_keys);
  RecordTick(stats_, NUMBER_MULTIGET_BYTES_READ, bytes_read);
L
Lei Jin 已提交
3405
  PERF_TIMER_STOP(get_post_process_time);
3406

3407
  return stat_list;
3408 3409
}

3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464
#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 已提交
3465 3466
  std::unique_ptr<InternalIterator> iter(
      table_reader->NewIterator(ReadOptions()));
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 3501 3502 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 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542

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

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

3543 3544 3545 3546
    if (!snapshots_.empty()) {
      // Check that no snapshots are being held
      status =
          Status::NotSupported("Cannot add a file while holding snapshots");
3547 3548 3549
    }

    if (status.ok()) {
3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571
      // 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");
3572 3573 3574 3575 3576
        }
      }
    }

    if (status.ok()) {
3577
      // Add file to L0
3578 3579
      VersionEdit edit;
      edit.SetColumnFamily(cfd->GetID());
3580
      edit.AddFile(0, meta.fd.GetNumber(), meta.fd.GetPathId(),
3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617
                   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 已提交
3618
Status DBImpl::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
3619
                                  const std::string& column_family_name,
3620
                                  ColumnFamilyHandle** handle) {
Y
Yueh-Hsuan Chiang 已提交
3621
  Status s;
3622
  Status persist_options_status;
I
Igor Canadi 已提交
3623
  *handle = nullptr;
3624 3625 3626 3627 3628 3629

  s = CheckCompressionSupported(cf_options);
  if (!s.ok()) {
    return s;
  }

Y
Yueh-Hsuan Chiang 已提交
3630
  {
3631
    InstrumentedMutexLock l(&mutex_);
I
Igor Canadi 已提交
3632

Y
Yueh-Hsuan Chiang 已提交
3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646
    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 已提交
3647
    {  // write thread
3648 3649
      WriteThread::Writer w;
      write_thread_.EnterUnbatched(&w, &mutex_);
I
Igor Canadi 已提交
3650 3651 3652 3653
      // LogAndApply will both write the creation in MANIFEST and create
      // ColumnFamilyData object
      s = versions_->LogAndApply(
          nullptr, MutableCFOptions(opt, ImmutableCFOptions(opt)), &edit,
3654
          &mutex_, directories_.GetDbDir(), false, &cf_options);
3655 3656 3657 3658 3659 3660

      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();
      }
3661
      write_thread_.ExitUnbatched(&w);
I
Igor Canadi 已提交
3662
    }
Y
Yueh-Hsuan Chiang 已提交
3663 3664 3665 3666 3667
    if (s.ok()) {
      single_column_family_mode_ = false;
      auto* cfd =
          versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name);
      assert(cfd != nullptr);
I
Igor Canadi 已提交
3668
      delete InstallSuperVersionAndScheduleWork(
Y
Yueh-Hsuan Chiang 已提交
3669
          cfd, nullptr, *cfd->GetLatestMutableCFOptions());
S
sdong 已提交
3670 3671 3672 3673 3674

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

Y
Yueh-Hsuan Chiang 已提交
3675 3676 3677 3678 3679 3680 3681 3682 3683
      *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());
    }
3684
  }  // InstrumentedMutexLock l(&mutex_)
Y
Yueh-Hsuan Chiang 已提交
3685 3686

  // this is outside the mutex
3687
  if (s.ok()) {
3688 3689
    NewThreadStatusCfInfo(
        reinterpret_cast<ColumnFamilyHandleImpl*>(*handle)->cfd());
3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700
    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());
    }
3701
  }
3702
  return s;
3703 3704
}

3705 3706 3707 3708
Status DBImpl::DropColumnFamily(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
  if (cfd->GetID() == 0) {
3709 3710
    return Status::InvalidArgument("Can't drop default column family");
  }
3711

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

I
Igor Canadi 已提交
3714 3715
  VersionEdit edit;
  edit.DropColumnFamily();
3716 3717
  edit.SetColumnFamily(cfd->GetID());

3718
  Status s;
3719
  Status options_persist_status;
3720
  {
3721
    InstrumentedMutexLock l(&mutex_);
3722 3723 3724 3725
    if (cfd->IsDropped()) {
      s = Status::InvalidArgument("Column family already dropped!\n");
    }
    if (s.ok()) {
3726
      // we drop column family from a single write thread
3727 3728
      WriteThread::Writer w;
      write_thread_.EnterUnbatched(&w, &mutex_);
3729 3730
      s = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                 &edit, &mutex_);
3731 3732 3733 3734 3735
      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();
      }
3736
      write_thread_.ExitUnbatched(&w);
3737
    }
S
sdong 已提交
3738 3739 3740 3741 3742 3743

    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()) {
3744
        if (!c->IsDropped() && !c->mem()->IsSnapshotSupported()) {
S
sdong 已提交
3745 3746 3747 3748 3749 3750
          new_is_snapshot_supported = false;
          break;
        }
      }
      is_snapshot_supported_ = new_is_snapshot_supported;
    }
3751
  }
3752

3753
  if (s.ok()) {
Y
Yueh-Hsuan Chiang 已提交
3754 3755 3756 3757
    // 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 已提交
3758
    assert(cfd->IsDropped());
L
Lei Jin 已提交
3759 3760 3761
    auto* mutable_cf_options = cfd->GetLatestMutableCFOptions();
    max_total_in_memory_state_ -= mutable_cf_options->write_buffer_size *
                                  mutable_cf_options->max_write_buffer_number;
3762 3763 3764
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
        "Dropped column family with id %u\n", cfd->GetID());

3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775
    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());
    }
3776
  } else {
3777
    Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
3778
        "Dropping column family with id %u FAILED -- %s\n",
3779 3780 3781
        cfd->GetID(), s.ToString().c_str());
  }

3782
  return s;
3783 3784
}

L
Lei Jin 已提交
3785
bool DBImpl::KeyMayExist(const ReadOptions& read_options,
3786 3787
                         ColumnFamilyHandle* column_family, const Slice& key,
                         std::string* value, bool* value_found) {
3788
  if (value_found != nullptr) {
K
Kai Liu 已提交
3789 3790
    // falsify later if key-may-exist but can't fetch value
    *value_found = true;
3791
  }
L
Lei Jin 已提交
3792
  ReadOptions roptions = read_options;
3793
  roptions.read_tier = kBlockCacheTier; // read from block cache only
3794
  auto s = GetImpl(roptions, column_family, key, value, value_found);
K
Kai Liu 已提交
3795

3796
  // If block_cache is enabled and the index block of the table didn't
K
Kai Liu 已提交
3797 3798 3799
  // 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();
3800 3801
}

3802
Iterator* DBImpl::NewIterator(const ReadOptions& read_options,
3803 3804 3805
                              ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
T
Tomislav Novak 已提交
3806

V
Venkatesh Radhakrishnan 已提交
3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824
  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 已提交
3825 3826 3827 3828
#ifdef ROCKSDB_LITE
    // not supported in lite version
    return nullptr;
#else
3829 3830
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
    auto iter = new ForwardIterator(this, read_options, cfd, sv);
3831 3832
    return NewDBIterator(
        env_, *cfd->ioptions(), cfd->user_comparator(), iter,
3833 3834
        kMaxSequenceNumber,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
3835 3836
        read_options.iterate_upper_bound, read_options.prefix_same_as_start,
        read_options.pin_data);
I
Igor Canadi 已提交
3837
#endif
T
Tomislav Novak 已提交
3838
  } else {
3839
    SequenceNumber latest_snapshot = versions_->LastSequence();
3840
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
3841

I
Igor Canadi 已提交
3842
    auto snapshot =
3843 3844 3845
        read_options.snapshot != nullptr
            ? reinterpret_cast<const SnapshotImpl*>(
                read_options.snapshot)->number_
I
Igor Canadi 已提交
3846
            : latest_snapshot;
T
Tomislav Novak 已提交
3847

3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883
    // 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         | <----+
    // |       |   +-------------------+
    // |       |                       |
    // +-------+-----------------------+
    //
3884 3885
    // ArenaWrappedDBIter inlines an arena area where all the iterators in
    // the iterator tree are allocated in the order of being accessed when
3886 3887 3888 3889 3890
    // 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(
3891 3892
        env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
3893 3894
        read_options.iterate_upper_bound, read_options.prefix_same_as_start,
        read_options.pin_data);
3895

S
sdong 已提交
3896
    InternalIterator* internal_iter =
3897
        NewInternalIterator(read_options, cfd, sv, db_iter->GetArena());
3898 3899 3900 3901
    db_iter->SetIterUnderDBIter(internal_iter);

    return db_iter;
  }
3902 3903
  // To stop compiler from complaining
  return nullptr;
J
jorlow@chromium.org 已提交
3904 3905
}

3906
Status DBImpl::NewIterators(
3907
    const ReadOptions& read_options,
I
Igor Canadi 已提交
3908
    const std::vector<ColumnFamilyHandle*>& column_families,
3909
    std::vector<Iterator*>* iterators) {
I
Igor Canadi 已提交
3910 3911
  iterators->clear();
  iterators->reserve(column_families.size());
V
Venkatesh Radhakrishnan 已提交
3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931
  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 已提交
3932 3933 3934 3935
#ifdef ROCKSDB_LITE
    return Status::InvalidArgument(
        "Tailing interator not supported in RocksDB lite");
#else
I
Igor Canadi 已提交
3936 3937
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
3938 3939
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
      auto iter = new ForwardIterator(this, read_options, cfd, sv);
3940 3941 3942 3943 3944
      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 已提交
3945
    }
I
Igor Canadi 已提交
3946
#endif
I
Igor Canadi 已提交
3947
  } else {
3948 3949
    SequenceNumber latest_snapshot = versions_->LastSequence();

I
Igor Canadi 已提交
3950
    for (size_t i = 0; i < column_families.size(); ++i) {
3951 3952 3953
      auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(
          column_families[i])->cfd();
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
I
Igor Canadi 已提交
3954 3955

      auto snapshot =
3956 3957 3958
          read_options.snapshot != nullptr
              ? reinterpret_cast<const SnapshotImpl*>(
                  read_options.snapshot)->number_
I
Igor Canadi 已提交
3959 3960
              : latest_snapshot;

3961
      ArenaWrappedDBIter* db_iter = NewArenaWrappedDbIterator(
3962
          env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
3963 3964
          sv->mutable_cf_options.max_sequential_skip_in_iterations, nullptr,
          false, read_options.pin_data);
S
sdong 已提交
3965 3966
      InternalIterator* internal_iter =
          NewInternalIterator(read_options, cfd, sv, db_iter->GetArena());
3967 3968
      db_iter->SetIterUnderDBIter(internal_iter);
      iterators->push_back(db_iter);
I
Igor Canadi 已提交
3969 3970 3971 3972
    }
  }

  return Status::OK();
3973 3974
}

3975 3976
const Snapshot* DBImpl::GetSnapshot() { return GetSnapshotImpl(false); }

3977
#ifndef ROCKSDB_LITE
3978 3979 3980
const Snapshot* DBImpl::GetSnapshotForWriteConflictBoundary() {
  return GetSnapshotImpl(true);
}
3981
#endif  // ROCKSDB_LITE
3982 3983

const Snapshot* DBImpl::GetSnapshotImpl(bool is_write_conflict_boundary) {
3984 3985
  int64_t unix_time = 0;
  env_->GetCurrentTime(&unix_time);  // Ignore error
3986
  SnapshotImpl* s = new SnapshotImpl;
3987

3988
  InstrumentedMutexLock l(&mutex_);
3989
  // returns null if the underlying memtable does not support snapshot.
3990 3991 3992 3993
  if (!is_snapshot_supported_) {
    delete s;
    return nullptr;
  }
3994 3995
  return snapshots_.New(s, versions_->LastSequence(), unix_time,
                        is_write_conflict_boundary);
J
jorlow@chromium.org 已提交
3996 3997 3998
}

void DBImpl::ReleaseSnapshot(const Snapshot* s) {
3999 4000 4001 4002 4003 4004
  const SnapshotImpl* casted_s = reinterpret_cast<const SnapshotImpl*>(s);
  {
    InstrumentedMutexLock l(&mutex_);
    snapshots_.Delete(casted_s);
  }
  delete casted_s;
J
jorlow@chromium.org 已提交
4005 4006 4007
}

// Convenience methods
4008 4009
Status DBImpl::Put(const WriteOptions& o, ColumnFamilyHandle* column_family,
                   const Slice& key, const Slice& val) {
4010
  return DB::Put(o, column_family, key, val);
J
jorlow@chromium.org 已提交
4011 4012
}

4013 4014 4015
Status DBImpl::Merge(const WriteOptions& o, ColumnFamilyHandle* column_family,
                     const Slice& key, const Slice& val) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
4016
  if (!cfh->cfd()->ioptions()->merge_operator) {
4017 4018
    return Status::NotSupported("Provide a merge_operator when opening DB");
  } else {
4019
    return DB::Merge(o, column_family, key, val);
4020 4021 4022
  }
}

L
Lei Jin 已提交
4023
Status DBImpl::Delete(const WriteOptions& write_options,
4024
                      ColumnFamilyHandle* column_family, const Slice& key) {
L
Lei Jin 已提交
4025
  return DB::Delete(write_options, column_family, key);
J
jorlow@chromium.org 已提交
4026 4027
}

A
Andres Noetzli 已提交
4028 4029 4030 4031 4032 4033
Status DBImpl::SingleDelete(const WriteOptions& write_options,
                            ColumnFamilyHandle* column_family,
                            const Slice& key) {
  return DB::SingleDelete(write_options, column_family, key);
}

L
Lei Jin 已提交
4034
Status DBImpl::Write(const WriteOptions& write_options, WriteBatch* my_batch) {
A
agiardullo 已提交
4035 4036 4037
  return WriteImpl(write_options, my_batch, nullptr);
}

A
agiardullo 已提交
4038
#ifndef ROCKSDB_LITE
A
agiardullo 已提交
4039 4040 4041 4042 4043
Status DBImpl::WriteWithCallback(const WriteOptions& write_options,
                                 WriteBatch* my_batch,
                                 WriteCallback* callback) {
  return WriteImpl(write_options, my_batch, callback);
}
A
agiardullo 已提交
4044
#endif  // ROCKSDB_LITE
A
agiardullo 已提交
4045 4046 4047

Status DBImpl::WriteImpl(const WriteOptions& write_options,
                         WriteBatch* my_batch, WriteCallback* callback) {
S
Stanislau Hlebik 已提交
4048 4049 4050
  if (my_batch == nullptr) {
    return Status::Corruption("Batch is nullptr!");
  }
4051 4052 4053
  if (write_options.timeout_hint_us != 0) {
    return Status::InvalidArgument("timeout_hint_us is deprecated");
  }
A
agiardullo 已提交
4054 4055

  Status status;
A
agiardullo 已提交
4056 4057
  bool callback_failed = false;

A
agiardullo 已提交
4058 4059 4060 4061 4062 4063 4064 4065 4066 4067
  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;
  }

4068
  PERF_TIMER_GUARD(write_pre_and_post_process_time);
4069
  WriteThread::Writer w;
S
Stanislau Hlebik 已提交
4070
  w.batch = my_batch;
L
Lei Jin 已提交
4071 4072
  w.sync = write_options.sync;
  w.disableWAL = write_options.disableWAL;
S
Stanislau Hlebik 已提交
4073 4074
  w.in_batch_group = false;
  w.done = false;
A
agiardullo 已提交
4075
  w.has_callback = (callback != nullptr) ? true : false;
S
Stanislau Hlebik 已提交
4076

L
Lei Jin 已提交
4077
  if (!write_options.disableWAL) {
S
Stanislau Hlebik 已提交
4078 4079 4080
    RecordTick(stats_, WRITE_WITH_WAL);
  }

4081 4082
  StopWatch write_sw(env_, db_options_.statistics.get(), DB_WRITE);

4083 4084 4085 4086 4087 4088 4089 4090
  write_thread_.JoinBatchGroup(&w);
  if (w.done) {
    // write was done by someone else, no need to grab mutex
    RecordTick(stats_, WRITE_DONE_BY_OTHER);
    return w.status;
  }
  // else we are the leader of the write batch group

S
Stanislau Hlebik 已提交
4091 4092
  WriteContext context;
  mutex_.Lock();
I
Igor Canadi 已提交
4093 4094 4095 4096 4097

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

S
Stanislau Hlebik 已提交
4098 4099
  RecordTick(stats_, WRITE_DONE_BY_SELF);
  default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_DONE_BY_SELF, 1);
4100

4101 4102 4103 4104
  // 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.
4105 4106 4107
  assert(!single_column_family_mode_ ||
         versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1);

4108
  uint64_t max_total_wal_size = (db_options_.max_total_wal_size == 0)
4109
                                    ? 4 * max_total_in_memory_state_
4110
                                    : db_options_.max_total_wal_size;
4111
  if (UNLIKELY(!single_column_family_mode_) &&
4112
      alive_log_files_.begin()->getting_flushed == false &&
I
Igor Canadi 已提交
4113
      total_log_size_ > max_total_wal_size) {
I
Igor Canadi 已提交
4114
    uint64_t flush_column_family_if_log_file = alive_log_files_.begin()->number;
I
Igor Canadi 已提交
4115
    alive_log_files_.begin()->getting_flushed = true;
4116
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
4117 4118 4119
        "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 已提交
4120 4121
    // no need to refcount because drop is happening in write thread, so can't
    // happen while we're in the write thread
4122
    for (auto cfd : *versions_->GetColumnFamilySet()) {
4123 4124 4125
      if (cfd->IsDropped()) {
        continue;
      }
I
Igor Canadi 已提交
4126
      if (cfd->GetLogNumber() <= flush_column_family_if_log_file) {
I
Igor Canadi 已提交
4127
        status = SwitchMemtable(cfd, &context);
I
Igor Canadi 已提交
4128 4129 4130
        if (!status.ok()) {
          break;
        }
S
Stanislau Hlebik 已提交
4131
        cfd->imm()->FlushRequested();
4132
        SchedulePendingFlush(cfd);
4133
      }
4134
    }
I
Igor Canadi 已提交
4135
    MaybeScheduleFlushOrCompaction();
4136 4137
  } else if (UNLIKELY(write_buffer_.ShouldFlush())) {
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
4138 4139
        "Flushing column family with largest mem table size. Write buffer is "
        "using %" PRIu64 " bytes out of a total of %" PRIu64 ".",
4140 4141 4142
        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
4143 4144 4145
    ColumnFamilyData* largest_cfd = nullptr;
    size_t largest_cfd_size = 0;

4146
    for (auto cfd : *versions_->GetColumnFamilySet()) {
4147 4148 4149
      if (cfd->IsDropped()) {
        continue;
      }
4150
      if (!cfd->mem()->IsEmpty()) {
4151 4152 4153 4154 4155 4156
        // 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;
4157 4158 4159
        }
      }
    }
4160 4161 4162 4163 4164 4165 4166 4167
    if (largest_cfd != nullptr) {
      status = SwitchMemtable(largest_cfd, &context);
      if (status.ok()) {
        largest_cfd->imm()->FlushRequested();
        SchedulePendingFlush(largest_cfd);
        MaybeScheduleFlushOrCompaction();
      }
    }
I
Igor Canadi 已提交
4168 4169 4170 4171 4172 4173 4174 4175 4176 4177
  }

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

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

S
sdong 已提交
4178 4179
  if (UNLIKELY(status.ok()) &&
      (write_controller_.IsStopped() || write_controller_.NeedsDelay())) {
4180 4181
    PERF_TIMER_STOP(write_pre_and_post_process_time);
    PERF_TIMER_GUARD(write_delay_time);
S
sdong 已提交
4182 4183 4184 4185
    // 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.
4186
    status = DelayWrite(last_batch_group_size_);
4187
    PERF_TIMER_START(write_pre_and_post_process_time);
I
Igor Canadi 已提交
4188 4189
  }

D
dgrogan@chromium.org 已提交
4190
  uint64_t last_sequence = versions_->LastSequence();
I
Igor Canadi 已提交
4191
  WriteThread::Writer* last_writer = &w;
A
agiardullo 已提交
4192
  autovector<WriteBatch*> write_batch_group;
4193 4194
  bool need_log_sync = !write_options.disableWAL && write_options.sync;
  bool need_log_dir_sync = need_log_sync && !log_dir_synced_;
A
agiardullo 已提交
4195

S
Stanislau Hlebik 已提交
4196
  if (status.ok()) {
4197 4198
    last_batch_group_size_ = write_thread_.EnterAsBatchGroupLeader(
        &w, &last_writer, &write_batch_group);
4199

4200
    if (need_log_sync) {
4201 4202 4203 4204 4205 4206 4207 4208 4209
      while (logs_.front().getting_synced) {
        log_sync_cv_.Wait();
      }
      for (auto& log : logs_) {
        assert(!log.getting_synced);
        log.getting_synced = true;
      }
    }

4210 4211 4212
    // 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
4213
    // into memtables
A
agiardullo 已提交
4214 4215 4216 4217 4218 4219 4220

    mutex_.Unlock();

    if (callback != nullptr) {
      // If this write has a validation callback, check to see if this write
      // is able to be written.  Must be called on the write thread.
      status = callback->Callback(this);
A
agiardullo 已提交
4221
      callback_failed = true;
A
agiardullo 已提交
4222 4223 4224 4225 4226 4227 4228 4229
    }
  } else {
    mutex_.Unlock();
  }

  // At this point the mutex is unlocked

  if (status.ok()) {
4230 4231 4232 4233 4234 4235
      int total_count = 0;
      uint64_t total_byte_size = 0;
      for (auto b : write_batch_group) {
        total_count += WriteBatchInternal::Count(b);
        total_byte_size = WriteBatchInternal::AppendedByteSize(
            total_byte_size, WriteBatchInternal::ByteSize(b));
4236 4237
      }

4238
      const SequenceNumber current_sequence = last_sequence + 1;
4239 4240
      last_sequence += total_count;

4241
      // Record statistics
4242 4243 4244 4245
      RecordTick(stats_, NUMBER_KEYS_WRITTEN, total_count);
      RecordTick(stats_, BYTES_WRITTEN, total_byte_size);
      PERF_TIMER_STOP(write_pre_and_post_process_time);

L
Lei Jin 已提交
4246
      if (write_options.disableWAL) {
4247
        flush_on_destroy_ = true;
4248 4249
      }

4250
      uint64_t log_size = 0;
L
Lei Jin 已提交
4251
      if (!write_options.disableWAL) {
4252
        PERF_TIMER_GUARD(write_wal_time);
4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271

        WriteBatch* merged_batch = nullptr;
        if (write_batch_group.size() == 1) {
          merged_batch = write_batch_group[0];
        } 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_;
          for (auto b : write_batch_group) {
            WriteBatchInternal::Append(merged_batch, b);
          }
        }
        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);
4272
        status = logs_.back().writer->AddRecord(log_entry);
I
Igor Canadi 已提交
4273 4274
        total_log_size_ += log_entry.size();
        alive_log_files_.back().AddSize(log_entry.size());
4275
        log_empty_ = false;
4276
        log_size = log_entry.size();
L
Lei Jin 已提交
4277
        RecordTick(stats_, WAL_FILE_BYTES, log_size);
4278
        if (status.ok() && need_log_sync) {
I
Igor Canadi 已提交
4279
          RecordTick(stats_, WAL_FILE_SYNCED);
4280
          StopWatch sw(env_, stats_, WAL_FILE_SYNC_MICROS);
4281 4282 4283 4284 4285 4286 4287 4288
          // 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_) {
4289
            status = log.writer->file()->Sync(db_options_.use_fsync);
4290 4291 4292 4293
            if (!status.ok()) {
              break;
            }
          }
4294
          if (status.ok() && need_log_dir_sync) {
4295 4296 4297 4298 4299
            // 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();
          }
H
heyongqiang 已提交
4300
        }
4301 4302 4303 4304

        if (merged_batch == &tmp_batch_) {
          tmp_batch_.Clear();
        }
4305 4306
      }
      if (status.ok()) {
4307
        PERF_TIMER_GUARD(write_memtable_time);
Y
Yueh-Hsuan Chiang 已提交
4308

4309
        status = WriteBatchInternal::InsertInto(
4310 4311 4312 4313 4314 4315 4316 4317 4318
            write_batch_group, current_sequence, column_family_memtables_.get(),
            write_options.ignore_missing_column_families,
            /*log_number*/ 0, this, /*dont_filter_deletes*/ false);

        // 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.
Y
Yueh-Hsuan Chiang 已提交
4319
        //
4320 4321 4322 4323 4324
        // Is setting bg_error_ enough here?  This will at least stop
        // compaction and fail any further writes.
        if (!status.ok() && bg_error_.ok()) {
          bg_error_ = status;
        }
Y
Yueh-Hsuan Chiang 已提交
4325

L
Lei Jin 已提交
4326
        SetTickerCount(stats_, SEQUENCE_NUMBER, last_sequence);
4327
      }
L
Lei Jin 已提交
4328
      PERF_TIMER_START(write_pre_and_post_process_time);
4329
      mutex_.Lock();
A
agiardullo 已提交
4330

4331
      // internal stats
4332 4333
      default_cf_internal_stats_->AddDBStats(InternalStats::BYTES_WRITTEN,
                                             total_byte_size);
S
sdong 已提交
4334
      default_cf_internal_stats_->AddDBStats(InternalStats::NUMBER_KEYS_WRITTEN,
4335
                                             total_count);
L
Lei Jin 已提交
4336
      if (!write_options.disableWAL) {
4337 4338 4339 4340
        if (write_options.sync) {
          default_cf_internal_stats_->AddDBStats(InternalStats::WAL_FILE_SYNCED,
                                                 1);
        }
4341 4342 4343
        default_cf_internal_stats_->AddDBStats(
            InternalStats::WAL_FILE_BYTES, log_size);
      }
4344
      if (status.ok()) {
4345
        versions_->SetLastSequence(last_sequence);
4346
      }
A
agiardullo 已提交
4347 4348 4349
  } else {
    // Operation failed.  Make sure sure mutex is held for cleanup code below.
    mutex_.Lock();
4350
  }
A
agiardullo 已提交
4351

A
agiardullo 已提交
4352
  if (db_options_.paranoid_checks && !status.ok() && !callback_failed &&
4353
      !status.IsBusy() && bg_error_.ok()) {
I
Igor Canadi 已提交
4354 4355
    bg_error_ = status; // stop compaction & fail any further writes
  }
4356

A
agiardullo 已提交
4357
  mutex_.AssertHeld();
4358

4359 4360
  if (need_log_sync) {
    MarkLogsSynced(logfile_number_, need_log_dir_sync, status);
4361 4362
  }

4363 4364 4365 4366 4367 4368 4369 4370 4371
  uint64_t writes_for_other = write_batch_group.size() - 1;
  if (writes_for_other > 0) {
    default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_DONE_BY_OTHER,
                                           writes_for_other);
    if (!write_options.disableWAL) {
      default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_WITH_WAL,
                                             writes_for_other);
    }
  }
4372

I
Igor Canadi 已提交
4373
  mutex_.Unlock();
4374

4375 4376
  write_thread_.ExitAsBatchGroupLeader(&w, last_writer, status);

J
jorlow@chromium.org 已提交
4377 4378 4379
  return status;
}

4380 4381
// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
4382
Status DBImpl::DelayWrite(uint64_t num_bytes) {
S
sdong 已提交
4383 4384 4385 4386
  uint64_t time_delayed = 0;
  bool delayed = false;
  {
    StopWatch sw(env_, stats_, WRITE_STALL, &time_delayed);
S
sdong 已提交
4387 4388
    auto delay = write_controller_.GetDelay(env_, num_bytes);
    if (delay > 0) {
S
sdong 已提交
4389 4390
      mutex_.Unlock();
      delayed = true;
S
sdong 已提交
4391
      TEST_SYNC_POINT("DBImpl::DelayWrite:Sleep");
4392 4393
      // hopefully we don't have to sleep more than 2 billion microseconds
      env_->SleepForMicroseconds(static_cast<int>(delay));
S
sdong 已提交
4394 4395
      mutex_.Lock();
    }
4396

4397
    while (bg_error_.ok() && write_controller_.IsStopped()) {
S
sdong 已提交
4398
      delayed = true;
4399 4400
      TEST_SYNC_POINT("DBImpl::DelayWrite:Wait");
      bg_cv_.Wait();
4401 4402
    }
  }
S
sdong 已提交
4403 4404 4405 4406 4407
  if (delayed) {
    default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_STALL_MICROS,
                                           time_delayed);
    RecordTick(stats_, STALL_MICROS, time_delayed);
  }
I
Igor Canadi 已提交
4408 4409

  return bg_error_;
4410 4411
}

I
Igor Canadi 已提交
4412 4413 4414
Status DBImpl::ScheduleFlushes(WriteContext* context) {
  ColumnFamilyData* cfd;
  while ((cfd = flush_scheduler_.GetNextColumnFamily()) != nullptr) {
I
Igor Canadi 已提交
4415
    auto status = SwitchMemtable(cfd, context);
I
Igor Canadi 已提交
4416 4417 4418 4419 4420
    if (cfd->Unref()) {
      delete cfd;
    }
    if (!status.ok()) {
      return status;
S
Stanislau Hlebik 已提交
4421 4422
    }
  }
I
Igor Canadi 已提交
4423
  return Status::OK();
S
Stanislau Hlebik 已提交
4424 4425 4426 4427
}

// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
I
Igor Canadi 已提交
4428
Status DBImpl::SwitchMemtable(ColumnFamilyData* cfd, WriteContext* context) {
S
Stanislau Hlebik 已提交
4429 4430 4431 4432 4433 4434 4435
  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.
4436
  assert(versions_->prev_log_number() == 0);
S
Stanislau Hlebik 已提交
4437
  bool creating_new_log = !log_empty_;
S
Sage Weil 已提交
4438 4439 4440 4441 4442 4443
  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 已提交
4444 4445 4446
  uint64_t new_log_number =
      creating_new_log ? versions_->NewFileNumber() : logfile_number_;
  SuperVersion* new_superversion = nullptr;
4447
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
S
Stanislau Hlebik 已提交
4448 4449 4450 4451
  mutex_.Unlock();
  Status s;
  {
    if (creating_new_log) {
4452 4453
      EnvOptions opt_env_opt =
          env_->OptimizeForLogWrite(env_options_, db_options_);
S
Sage Weil 已提交
4454 4455 4456 4457 4458 4459 4460 4461
      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 已提交
4462 4463 4464
        s = NewWritableFile(env_,
                            LogFileName(db_options_.wal_dir, new_log_number),
                            &lfile, opt_env_opt);
S
Sage Weil 已提交
4465
      }
S
Stanislau Hlebik 已提交
4466 4467 4468
      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 已提交
4469 4470 4471
        lfile->SetPreallocationBlockSize(
            mutable_cf_options.write_buffer_size / 10 +
            mutable_cf_options.write_buffer_size);
4472 4473
        unique_ptr<WritableFileWriter> file_writer(
            new WritableFileWriter(std::move(lfile), opt_env_opt));
S
sdong 已提交
4474 4475
        new_log = new log::Writer(std::move(file_writer), new_log_number,
                                  db_options_.recycle_log_file_num > 0);
I
Igor Canadi 已提交
4476
      }
S
Stanislau Hlebik 已提交
4477 4478 4479
    }

    if (s.ok()) {
A
agiardullo 已提交
4480 4481
      SequenceNumber seq = versions_->LastSequence();
      new_mem = cfd->ConstructNewMemtable(mutable_cf_options, seq);
S
Stanislau Hlebik 已提交
4482 4483 4484
      new_superversion = new SuperVersion();
    }
  }
4485
  Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
I
Igor Canadi 已提交
4486 4487
      "[%s] New memtable created with log file: #%" PRIu64 "\n",
      cfd->GetName().c_str(), new_log_number);
S
Stanislau Hlebik 已提交
4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499
  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;
4500
    log_dir_synced_ = false;
4501
    logs_.emplace_back(logfile_number_, new_log);
S
Stanislau Hlebik 已提交
4502
    alive_log_files_.push_back(LogFileNumberSize(logfile_number_));
I
Igor Canadi 已提交
4503
    for (auto loop_cfd : *versions_->GetColumnFamilySet()) {
S
Stanislau Hlebik 已提交
4504 4505 4506 4507
      // 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 已提交
4508
      if (loop_cfd->mem()->GetFirstSequenceNumber() == 0 &&
4509
          loop_cfd->imm()->NumNotFlushed() == 0) {
I
Igor Canadi 已提交
4510
        loop_cfd->SetLogNumber(logfile_number_);
4511
      }
4512 4513
    }
  }
S
Stanislau Hlebik 已提交
4514
  cfd->mem()->SetNextLogNumber(logfile_number_);
4515
  cfd->imm()->Add(cfd->mem(), &context->memtables_to_free_);
S
Stanislau Hlebik 已提交
4516 4517
  new_mem->Ref();
  cfd->SetMemtable(new_mem);
I
Igor Canadi 已提交
4518 4519
  context->superversions_to_free_.push_back(InstallSuperVersionAndScheduleWork(
      cfd, new_superversion, mutable_cf_options));
4520 4521 4522
  return s;
}

I
Igor Canadi 已提交
4523
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
4524 4525 4526 4527 4528
Status DBImpl::GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                        TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

4529 4530
  // Increment the ref count
  mutex_.Lock();
I
Igor Canadi 已提交
4531
  auto version = cfd->current();
4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfAllTables(props);

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

  return s;
}
4544 4545

Status DBImpl::GetPropertiesOfTablesInRange(ColumnFamilyHandle* column_family,
4546
                                            const Range* range, std::size_t n,
4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566
                                            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 已提交
4567
#endif  // ROCKSDB_LITE
4568

I
Igor Canadi 已提交
4569 4570 4571 4572
const std::string& DBImpl::GetName() const {
  return dbname_;
}

4573 4574 4575 4576
Env* DBImpl::GetEnv() const {
  return env_;
}

4577 4578
const Options& DBImpl::GetOptions(ColumnFamilyHandle* column_family) const {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
I
Igor Canadi 已提交
4579
  return *cfh->cfd()->options();
I
Igor Canadi 已提交
4580 4581
}

4582 4583
const DBOptions& DBImpl::GetDBOptions() const { return db_options_; }

4584
bool DBImpl::GetProperty(ColumnFamilyHandle* column_family,
4585
                         const Slice& property, std::string* value) {
4586 4587
  bool is_int_property = false;
  bool need_out_of_mutex = false;
4588 4589 4590
  DBPropertyType property_type =
      GetPropertyType(property, &is_int_property, &need_out_of_mutex);

4591
  value->clear();
4592
  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
4593 4594
  if (is_int_property) {
    uint64_t int_value;
4595 4596
    bool ret_value = GetIntPropertyInternal(
        cfd, property_type, need_out_of_mutex, false, &int_value);
4597
    if (ret_value) {
4598
      *value = ToString(int_value);
4599 4600 4601
    }
    return ret_value;
  } else {
4602
    InstrumentedMutexLock l(&mutex_);
4603 4604 4605
    return cfd->internal_stats()->GetStringProperty(property_type, property,
                                                    value);
  }
J
jorlow@chromium.org 已提交
4606 4607
}

4608 4609
bool DBImpl::GetIntProperty(ColumnFamilyHandle* column_family,
                            const Slice& property, uint64_t* value) {
4610 4611
  bool is_int_property = false;
  bool need_out_of_mutex = false;
4612 4613 4614 4615 4616
  DBPropertyType property_type =
      GetPropertyType(property, &is_int_property, &need_out_of_mutex);
  if (!is_int_property) {
    return false;
  }
4617 4618
  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  return GetIntPropertyInternal(cfd, property_type, need_out_of_mutex, false,
4619 4620 4621
                                value);
}

4622
bool DBImpl::GetIntPropertyInternal(ColumnFamilyData* cfd,
4623
                                    DBPropertyType property_type,
4624 4625
                                    bool need_out_of_mutex, bool is_locked,
                                    uint64_t* value) {
4626
  if (!need_out_of_mutex) {
4627 4628 4629 4630 4631 4632 4633
    if (is_locked) {
      mutex_.AssertHeld();
      return cfd->internal_stats()->GetIntProperty(property_type, value, this);
    } else {
      InstrumentedMutexLock l(&mutex_);
      return cfd->internal_stats()->GetIntProperty(property_type, value, this);
    }
4634
  } else {
4635 4636 4637 4638 4639 4640
    SuperVersion* sv = nullptr;
    if (!is_locked) {
      sv = GetAndRefSuperVersion(cfd);
    } else {
      sv = cfd->GetSuperVersion();
    }
4641 4642 4643 4644

    bool ret = cfd->internal_stats()->GetIntPropertyOutOfMutex(
        property_type, sv->current, value);

4645 4646 4647
    if (!is_locked) {
      ReturnAndCleanupSuperVersion(cfd, sv);
    }
4648 4649 4650 4651 4652

    return ret;
  }
}

4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680
bool DBImpl::GetAggregatedIntProperty(const Slice& property,
                                      uint64_t* aggregated_value) {
  bool need_out_of_mutex;
  bool is_int_property;
  DBPropertyType property_type =
      GetPropertyType(property, &is_int_property, &need_out_of_mutex);
  if (!is_int_property) {
    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()) {
      if (GetIntPropertyInternal(cfd, property_type, need_out_of_mutex, true,
                                 &value)) {
        sum += value;
      } else {
        return false;
      }
    }
  }
  *aggregated_value = sum;
  return true;
}

4681 4682
SuperVersion* DBImpl::GetAndRefSuperVersion(ColumnFamilyData* cfd) {
  // TODO(ljin): consider using GetReferencedSuperVersion() directly
I
Igor Canadi 已提交
4683
  return cfd->GetThreadLocalSuperVersion(&mutex_);
4684 4685
}

A
agiardullo 已提交
4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697
// 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 已提交
4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713
// 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);
}

4714 4715
void DBImpl::ReturnAndCleanupSuperVersion(ColumnFamilyData* cfd,
                                          SuperVersion* sv) {
I
Igor Canadi 已提交
4716
  bool unref_sv = !cfd->ReturnThreadLocalSuperVersion(sv);
4717 4718 4719 4720 4721

  if (unref_sv) {
    // Release SuperVersion
    if (sv->Unref()) {
      {
4722
        InstrumentedMutexLock l(&mutex_);
4723 4724 4725 4726 4727 4728 4729
        sv->Cleanup();
      }
      delete sv;
      RecordTick(stats_, NUMBER_SUPERVERSION_CLEANUPS);
    }
    RecordTick(stats_, NUMBER_SUPERVERSION_RELEASES);
  }
4730 4731
}

A
agiardullo 已提交
4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743
// 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 已提交
4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759
// 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 已提交
4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771
// 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 已提交
4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785
// 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();
}

4786
void DBImpl::GetApproximateSizes(ColumnFamilyHandle* column_family,
4787 4788
                                 const Range* range, int n, uint64_t* sizes,
                                 bool include_memtable) {
J
jorlow@chromium.org 已提交
4789
  Version* v;
4790 4791
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
4792 4793
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
  v = sv->current;
J
jorlow@chromium.org 已提交
4794 4795 4796

  for (int i = 0; i < n; i++) {
    // Convert user_key into a corresponding internal key.
4797 4798 4799
    InternalKey k1(range[i].start, kMaxSequenceNumber, kValueTypeForSeek);
    InternalKey k2(range[i].limit, kMaxSequenceNumber, kValueTypeForSeek);
    sizes[i] = versions_->ApproximateSize(v, k1.Encode(), k2.Encode());
4800 4801 4802 4803
    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 已提交
4804 4805
  }

4806
  ReturnAndCleanupSuperVersion(cfd, sv);
J
jorlow@chromium.org 已提交
4807 4808
}

I
Igor Canadi 已提交
4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824
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 已提交
4825 4826 4827 4828 4829
#ifndef ROCKSDB_LITE
Status DBImpl::GetUpdatesSince(
    SequenceNumber seq, unique_ptr<TransactionLogIterator>* iter,
    const TransactionLogIterator::ReadOptions& read_options) {

L
Lei Jin 已提交
4830
  RecordTick(stats_, GET_UPDATES_SINCE_CALLS);
I
Igor Canadi 已提交
4831 4832 4833
  if (seq > versions_->LastSequence()) {
    return Status::NotFound("Requested sequence not yet written in the db");
  }
I
Igor Canadi 已提交
4834
  return wal_manager_.GetUpdatesSince(seq, iter, read_options, versions_.get());
I
Igor Canadi 已提交
4835 4836
}

4837 4838 4839
Status DBImpl::DeleteFile(std::string name) {
  uint64_t number;
  FileType type;
4840 4841 4842
  WalFileType log_type;
  if (!ParseFileName(name, &number, &type, &log_type) ||
      (type != kTableFile && type != kLogFile)) {
4843 4844
    Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
        "DeleteFile %s failed.\n", name.c_str());
4845 4846 4847
    return Status::InvalidArgument("Invalid file name");
  }

4848 4849 4850 4851
  Status status;
  if (type == kLogFile) {
    // Only allow deleting archived log files
    if (log_type != kArchivedLogFile) {
4852 4853
      Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
          "DeleteFile %s failed - not archived log.\n",
4854
          name.c_str());
4855 4856
      return Status::NotSupported("Delete only supported for archived logs");
    }
4857
    status = env_->DeleteFile(db_options_.wal_dir + "/" + name.c_str());
4858
    if (!status.ok()) {
4859 4860
      Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
          "DeleteFile %s failed -- %s.\n",
4861
          name.c_str(), status.ToString().c_str());
4862 4863 4864 4865
    }
    return status;
  }

4866
  int level;
I
Igor Canadi 已提交
4867
  FileMetaData* metadata;
4868
  ColumnFamilyData* cfd;
4869
  VersionEdit edit;
4870
  JobContext job_context(next_job_id_.fetch_add(1), true);
D
Dhruba Borthakur 已提交
4871
  {
4872
    InstrumentedMutexLock l(&mutex_);
4873
    status = versions_->GetMetadataForFile(number, &level, &metadata, &cfd);
D
Dhruba Borthakur 已提交
4874
    if (!status.ok()) {
4875 4876
      Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
          "DeleteFile %s failed. File not found\n", name.c_str());
I
Igor Canadi 已提交
4877
      job_context.Clean();
D
Dhruba Borthakur 已提交
4878 4879
      return Status::InvalidArgument("File not found");
    }
4880
    assert(level < cfd->NumberLevels());
4881

D
Dhruba Borthakur 已提交
4882
    // If the file is being compacted no need to delete.
4883
    if (metadata->being_compacted) {
4884
      Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
4885
          "DeleteFile %s Skipped. File about to be compacted\n", name.c_str());
I
Igor Canadi 已提交
4886
      job_context.Clean();
D
Dhruba Borthakur 已提交
4887
      return Status::OK();
4888 4889
    }

D
Dhruba Borthakur 已提交
4890 4891 4892
    // 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 已提交
4893
    auto* vstoreage = cfd->current()->storage_info();
I
Igor Canadi 已提交
4894
    for (int i = level + 1; i < cfd->NumberLevels(); i++) {
S
sdong 已提交
4895
      if (vstoreage->NumLevelFiles(i) != 0) {
4896
        Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
4897
            "DeleteFile %s FAILED. File not in last level\n", name.c_str());
I
Igor Canadi 已提交
4898
        job_context.Clean();
D
Dhruba Borthakur 已提交
4899 4900 4901
        return Status::InvalidArgument("File not in last level");
      }
    }
4902
    // if level == 0, it has to be the oldest file
S
sdong 已提交
4903 4904
    if (level == 0 &&
        vstoreage->LevelFiles(0).back()->fd.GetNumber() != number) {
4905 4906
      Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
          "DeleteFile %s failed ---"
L
Lei Jin 已提交
4907
          " target file in level 0 must be the oldest.", name.c_str());
I
Igor Canadi 已提交
4908
      job_context.Clean();
4909 4910 4911
      return Status::InvalidArgument("File in level 0, but not oldest");
    }
    edit.SetColumnFamily(cfd->GetID());
D
Dhruba Borthakur 已提交
4912
    edit.DeleteFile(level, number);
4913
    status = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
4914
                                    &edit, &mutex_, directories_.GetDbDir());
I
Igor Canadi 已提交
4915
    if (status.ok()) {
I
Igor Canadi 已提交
4916 4917
      InstallSuperVersionAndScheduleWorkWrapper(
          cfd, &job_context, *cfd->GetLatestMutableCFOptions());
I
Igor Canadi 已提交
4918
    }
I
Igor Canadi 已提交
4919 4920
    FindObsoleteFiles(&job_context, false);
  }  // lock released here
4921

4922
  LogFlush(db_options_.info_log);
I
Igor Canadi 已提交
4923
  // remove files outside the db-lock
I
Igor Canadi 已提交
4924
  if (job_context.HaveSomethingToDelete()) {
4925
    // Call PurgeObsoleteFiles() without holding mutex.
I
Igor Canadi 已提交
4926
    PurgeObsoleteFiles(job_context);
4927
  }
I
Igor Canadi 已提交
4928
  job_context.Clean();
4929 4930 4931
  return status;
}

4932
void DBImpl::GetLiveFilesMetaData(std::vector<LiveFileMetaData>* metadata) {
4933
  InstrumentedMutexLock l(&mutex_);
4934
  versions_->GetLiveFilesMetaData(metadata);
4935
}
4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946

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 已提交
4947
#endif  // ROCKSDB_LITE
4948

I
Igor Canadi 已提交
4949 4950 4951 4952 4953 4954 4955
Status DBImpl::CheckConsistency() {
  mutex_.AssertHeld();
  std::vector<LiveFileMetaData> metadata;
  versions_->GetLiveFilesMetaData(&metadata);

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

I
Igor Canadi 已提交
4959 4960
    uint64_t fsize = 0;
    Status s = env_->GetFileSize(file_path, &fsize);
D
dyniusz 已提交
4961 4962 4963 4964
    if (!s.ok() &&
        env_->GetFileSize(Rocks2LevelTableFileName(file_path), &fsize).ok()) {
      s = Status::OK();
    }
I
Igor Canadi 已提交
4965 4966 4967 4968
    if (!s.ok()) {
      corruption_messages +=
          "Can't access " + md.name + ": " + s.ToString() + "\n";
    } else if (fsize != md.size) {
4969
      corruption_messages += "Sst file size mismatch: " + file_path +
I
Igor Canadi 已提交
4970
                             ". Size recorded in manifest " +
4971 4972
                             ToString(md.size) + ", actual size " +
                             ToString(fsize) + "\n";
I
Igor Canadi 已提交
4973 4974 4975 4976 4977 4978 4979 4980 4981
    }
  }
  if (corruption_messages.size() == 0) {
    return Status::OK();
  } else {
    return Status::Corruption(corruption_messages);
  }
}

4982
Status DBImpl::GetDbIdentity(std::string& identity) const {
4983 4984
  std::string idfilename = IdentityFileName(dbname_);
  const EnvOptions soptions;
4985 4986 4987 4988 4989 4990 4991 4992 4993
  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)));
4994
  }
4995

4996 4997 4998 4999 5000
  uint64_t file_size;
  s = env_->GetFileSize(idfilename, &file_size);
  if (!s.ok()) {
    return s;
  }
D
Dmitri Smirnov 已提交
5001
  char* buffer = reinterpret_cast<char*>(alloca(file_size));
5002
  Slice id;
5003
  s = id_file_reader->Read(static_cast<size_t>(file_size), &id, buffer);
5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014
  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 已提交
5015 5016
// Default implementations of convenience methods that subclasses of DB
// can call if they wish
5017
Status DB::Put(const WriteOptions& opt, ColumnFamilyHandle* column_family,
5018
               const Slice& key, const Slice& value) {
5019 5020 5021 5022
  // 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);
5023
  batch.Put(column_family, key, value);
J
jorlow@chromium.org 已提交
5024 5025 5026
  return Write(opt, &batch);
}

5027 5028
Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
J
jorlow@chromium.org 已提交
5029
  WriteBatch batch;
5030
  batch.Delete(column_family, key);
J
jorlow@chromium.org 已提交
5031 5032 5033
  return Write(opt, &batch);
}

A
Andres Noetzli 已提交
5034 5035 5036 5037 5038 5039 5040
Status DB::SingleDelete(const WriteOptions& opt,
                        ColumnFamilyHandle* column_family, const Slice& key) {
  WriteBatch batch;
  batch.SingleDelete(column_family, key);
  return Write(opt, &batch);
}

5041 5042
Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
5043
  WriteBatch batch;
5044
  batch.Merge(column_family, key, value);
5045 5046 5047
  return Write(opt, &batch);
}

5048
// Default implementation -- returns not supported status
L
Lei Jin 已提交
5049
Status DB::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
5050
                              const std::string& column_family_name,
5051
                              ColumnFamilyHandle** handle) {
5052
  return Status::NotSupported("");
5053
}
5054
Status DB::DropColumnFamily(ColumnFamilyHandle* column_family) {
5055
  return Status::NotSupported("");
5056 5057
}

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

J
Jim Paton 已提交
5060
Status DB::Open(const Options& options, const std::string& dbname, DB** dbptr) {
5061 5062 5063 5064
  DBOptions db_options(options);
  ColumnFamilyOptions cf_options(options);
  std::vector<ColumnFamilyDescriptor> column_families;
  column_families.push_back(
5065
      ColumnFamilyDescriptor(kDefaultColumnFamilyName, cf_options));
5066
  std::vector<ColumnFamilyHandle*> handles;
5067
  Status s = DB::Open(db_options, dbname, column_families, &handles, dbptr);
5068 5069 5070 5071 5072 5073 5074
  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;
5075 5076
}

5077 5078
Status DB::Open(const DBOptions& db_options, const std::string& dbname,
                const std::vector<ColumnFamilyDescriptor>& column_families,
5079
                std::vector<ColumnFamilyHandle*>* handles, DB** dbptr) {
5080
  Status s = SanitizeOptionsByTable(db_options, column_families);
5081 5082 5083
  if (!s.ok()) {
    return s;
  }
5084

5085 5086 5087 5088 5089 5090
  for (auto& cfd : column_families) {
    s = CheckCompressionSupported(cfd.options);
    if (!s.ok()) {
      return s;
    }
    if (db_options.db_paths.size() > 1) {
5091 5092
      if ((cfd.options.compaction_style != kCompactionStyleUniversal) &&
          (cfd.options.compaction_style != kCompactionStyleLevel)) {
5093 5094
        return Status::NotSupported(
            "More than one DB paths are only supported in "
5095
            "universal and level compaction styles. ");
5096 5097
      }
    }
5098
  }
5099

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

5105
  *dbptr = nullptr;
5106
  handles->clear();
J
jorlow@chromium.org 已提交
5107

I
Igor Canadi 已提交
5108 5109 5110 5111
  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);
5112
  }
5113

I
Igor Canadi 已提交
5114
  DBImpl* impl = new DBImpl(db_options, dbname);
5115
  s = impl->env_->CreateDirIfMissing(impl->db_options_.wal_dir);
5116
  if (s.ok()) {
5117
    for (auto db_path : impl->db_options_.db_paths) {
5118
      s = impl->env_->CreateDirIfMissing(db_path.path);
5119 5120 5121 5122 5123 5124
      if (!s.ok()) {
        break;
      }
    }
  }

5125 5126 5127 5128 5129 5130
  if (!s.ok()) {
    delete impl;
    return s;
  }

  s = impl->CreateArchivalDirectory();
5131 5132 5133 5134
  if (!s.ok()) {
    delete impl;
    return s;
  }
J
jorlow@chromium.org 已提交
5135
  impl->mutex_.Lock();
5136 5137
  // Handles create_if_missing, error_if_exists
  s = impl->Recover(column_families);
J
jorlow@chromium.org 已提交
5138
  if (s.ok()) {
5139
    uint64_t new_log_number = impl->versions_->NewFileNumber();
5140
    unique_ptr<WritableFile> lfile;
5141
    EnvOptions soptions(db_options);
5142 5143
    EnvOptions opt_env_options =
        impl->db_options_.env->OptimizeForLogWrite(soptions, impl->db_options_);
S
sdong 已提交
5144 5145 5146
    s = NewWritableFile(impl->db_options_.env,
                        LogFileName(impl->db_options_.wal_dir, new_log_number),
                        &lfile, opt_env_options);
J
jorlow@chromium.org 已提交
5147
    if (s.ok()) {
D
Dmitri Smirnov 已提交
5148
      lfile->SetPreallocationBlockSize((max_write_buffer_size / 10) + max_write_buffer_size);
5149
      impl->logfile_number_ = new_log_number;
5150 5151
      unique_ptr<WritableFileWriter> file_writer(
          new WritableFileWriter(std::move(lfile), opt_env_options));
5152 5153
      impl->logs_.emplace_back(
          new_log_number,
S
sdong 已提交
5154 5155
          new log::Writer(std::move(file_writer), new_log_number,
                          impl->db_options_.recycle_log_file_num > 0));
I
Igor Canadi 已提交
5156

5157 5158
      // set column family handles
      for (auto cf : column_families) {
I
Igor Canadi 已提交
5159 5160
        auto cfd =
            impl->versions_->GetColumnFamilySet()->GetColumnFamily(cf.name);
I
Igor Canadi 已提交
5161 5162 5163
        if (cfd != nullptr) {
          handles->push_back(
              new ColumnFamilyHandleImpl(cfd, impl, &impl->mutex_));
5164
          impl->NewThreadStatusCfInfo(cfd);
I
Igor Canadi 已提交
5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180
        } 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 已提交
5181
        }
5182
      }
I
Igor Canadi 已提交
5183 5184
    }
    if (s.ok()) {
5185
      for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
5186
        delete impl->InstallSuperVersionAndScheduleWork(
L
Lei Jin 已提交
5187
            cfd, nullptr, *cfd->GetLatestMutableCFOptions());
5188
      }
I
Igor Canadi 已提交
5189 5190
      impl->alive_log_files_.push_back(
          DBImpl::LogFileNumberSize(impl->logfile_number_));
J
jorlow@chromium.org 已提交
5191
      impl->DeleteObsoleteFiles();
5192
      s = impl->directories_.GetDbDir()->Fsync();
J
jorlow@chromium.org 已提交
5193 5194
    }
  }
5195

I
Igor Canadi 已提交
5196 5197
  if (s.ok()) {
    for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
S
sdong 已提交
5198
      if (cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
S
sdong 已提交
5199
        auto* vstorage = cfd->current()->storage_info();
5200
        for (int i = 1; i < vstorage->num_levels(); ++i) {
S
sdong 已提交
5201
          int num_files = vstorage->NumLevelFiles(i);
I
Igor Canadi 已提交
5202
          if (num_files > 0) {
I
Igor Canadi 已提交
5203 5204
            s = Status::InvalidArgument(
                "Not all files are at level 0. Cannot "
S
sdong 已提交
5205
                "open with FIFO compaction style.");
I
Igor Canadi 已提交
5206 5207 5208 5209
            break;
          }
        }
      }
S
sdong 已提交
5210 5211 5212
      if (!cfd->mem()->IsSnapshotSupported()) {
        impl->is_snapshot_supported_ = false;
      }
5213
      if (cfd->ioptions()->merge_operator != nullptr &&
5214 5215 5216 5217 5218
          !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 已提交
5219
      if (!s.ok()) {
5220 5221 5222 5223
        break;
      }
    }
  }
5224
  TEST_SYNC_POINT("DBImpl::Open:Opened");
5225
  Status persist_options_status;
5226
  if (s.ok()) {
5227 5228 5229 5230
    // Persist RocksDB Options before scheduling the compaction.
    // The WriteOptionsFile() will release and lock the mutex internally.
    persist_options_status = impl->WriteOptionsFile();

5231
    *dbptr = impl;
5232 5233 5234
    impl->opened_successfully_ = true;
    impl->MaybeScheduleFlushOrCompaction();
  }
5235 5236
  impl->mutex_.Unlock();

J
jorlow@chromium.org 已提交
5237
  if (s.ok()) {
S
sdong 已提交
5238 5239
    Log(InfoLogLevel::INFO_LEVEL, impl->db_options_.info_log, "DB pointer %p",
        impl);
5240
    LogFlush(impl->db_options_.info_log);
5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251
    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());
    }
  }
5252
  if (!s.ok()) {
Y
Yueh-Hsuan Chiang 已提交
5253
    for (auto* h : *handles) {
5254 5255
      delete h;
    }
5256
    handles->clear();
J
jorlow@chromium.org 已提交
5257
    delete impl;
5258
    *dbptr = nullptr;
J
jorlow@chromium.org 已提交
5259 5260 5261 5262
  }
  return s;
}

5263 5264 5265
Status DB::ListColumnFamilies(const DBOptions& db_options,
                              const std::string& name,
                              std::vector<std::string>* column_families) {
I
Igor Canadi 已提交
5266
  return VersionSet::ListColumnFamilies(column_families, name, db_options.env);
5267 5268
}

5269 5270 5271
Snapshot::~Snapshot() {
}

J
jorlow@chromium.org 已提交
5272
Status DestroyDB(const std::string& dbname, const Options& options) {
5273
  const InternalKeyComparator comparator(options.comparator);
5274
  const Options& soptions(SanitizeOptions(dbname, &comparator, options));
5275
  Env* env = soptions.env;
J
jorlow@chromium.org 已提交
5276
  std::vector<std::string> filenames;
5277

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

J
jorlow@chromium.org 已提交
5281
  FileLock* lock;
5282 5283
  const std::string lockname = LockFileName(dbname);
  Status result = env->LockFile(lockname, &lock);
J
jorlow@chromium.org 已提交
5284 5285 5286
  if (result.ok()) {
    uint64_t number;
    FileType type;
5287
    InfoLogPrefix info_log_prefix(!options.db_log_dir.empty(), dbname);
D
dgrogan@chromium.org 已提交
5288
    for (size_t i = 0; i < filenames.size(); i++) {
5289
      if (ParseFileName(filenames[i], &number, info_log_prefix.prefix, &type) &&
5290
          type != kDBLockFile) {  // Lock file will be deleted at end
K
Kosie van der Merwe 已提交
5291
        Status del;
5292
        std::string path_to_delete = dbname + "/" + filenames[i];
K
Kosie van der Merwe 已提交
5293
        if (type == kMetaDatabase) {
5294 5295 5296
          del = DestroyDB(path_to_delete, options);
        } else if (type == kTableFile) {
          del = DeleteOrMoveToTrash(&options, path_to_delete);
K
Kosie van der Merwe 已提交
5297
        } else {
5298
          del = env->DeleteFile(path_to_delete);
K
Kosie van der Merwe 已提交
5299
        }
J
jorlow@chromium.org 已提交
5300 5301 5302 5303 5304
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
5305

5306 5307
    for (size_t path_id = 0; path_id < options.db_paths.size(); path_id++) {
      const auto& db_path = options.db_paths[path_id];
5308
      env->GetChildren(db_path.path, &filenames);
5309 5310 5311
      for (size_t i = 0; i < filenames.size(); i++) {
        if (ParseFileName(filenames[i], &number, &type) &&
            type == kTableFile) {  // Lock file will be deleted at end
5312 5313 5314 5315 5316 5317 5318
          Status del;
          std::string table_path = db_path.path + "/" + filenames[i];
          if (path_id == 0) {
            del = DeleteOrMoveToTrash(&options, table_path);
          } else {
            del = env->DeleteFile(table_path);
          }
5319 5320 5321 5322 5323 5324 5325
          if (result.ok() && !del.ok()) {
            result = del;
          }
        }
      }
    }

I
Igor Canadi 已提交
5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343
    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;
5344
    env->GetChildren(archivedir, &archiveFiles);
5345 5346
    // Delete archival files.
    for (size_t i = 0; i < archiveFiles.size(); ++i) {
5347 5348
      if (ParseFileName(archiveFiles[i], &number, &type) &&
          type == kLogFile) {
5349
        Status del = env->DeleteFile(archivedir + "/" + archiveFiles[i]);
5350 5351 5352 5353 5354
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
5355

5356
    // ignore case where no archival directory is present.
5357
    env->DeleteDir(archivedir);
5358

J
jorlow@chromium.org 已提交
5359
    env->UnlockFile(lock);  // Ignore error since state is already gone
5360
    env->DeleteFile(lockname);
J
jorlow@chromium.org 已提交
5361
    env->DeleteDir(dbname);  // Ignore error in case dir contains other files
5362
    env->DeleteDir(soptions.wal_dir);
J
jorlow@chromium.org 已提交
5363 5364 5365 5366
  }
  return result;
}

5367 5368
Status DBImpl::WriteOptionsFile() {
#ifndef ROCKSDB_LITE
5369
  mutex_.AssertHeld();
5370 5371 5372

  std::vector<std::string> cf_names;
  std::vector<ColumnFamilyOptions> cf_opts;
5373 5374 5375 5376 5377

  // This part requires mutex to protect the column family options
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    if (cfd->IsDropped()) {
      continue;
5378
    }
5379 5380 5381
    cf_names.push_back(cfd->GetName());
    cf_opts.push_back(BuildColumnFamilyOptions(
        *cfd->options(), *cfd->GetLatestMutableCFOptions()));
5382 5383
  }

5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396
  // 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();
5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467
  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 已提交
5468
#if ROCKSDB_USING_THREAD_STATUS
5469

Y
Yueh-Hsuan Chiang 已提交
5470 5471
void DBImpl::NewThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
5472
  if (db_options_.enable_thread_tracking) {
5473
    ThreadStatusUtil::NewColumnFamilyInfo(this, cfd);
5474
  }
Y
Yueh-Hsuan Chiang 已提交
5475 5476 5477 5478
}

void DBImpl::EraseThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
5479
  if (db_options_.enable_thread_tracking) {
5480
    ThreadStatusUtil::EraseColumnFamilyInfo(cfd);
5481
  }
Y
Yueh-Hsuan Chiang 已提交
5482 5483 5484
}

void DBImpl::EraseThreadStatusDbInfo() const {
5485
  if (db_options_.enable_thread_tracking) {
5486
    ThreadStatusUtil::EraseDatabaseInfo(this);
5487
  }
Y
Yueh-Hsuan Chiang 已提交
5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502
}

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

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

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

5503 5504
//
// A global method that can dump out the build version
I
Igor Canadi 已提交
5505
void DumpRocksDBBuildVersion(Logger * log) {
I
Igor Canadi 已提交
5506
#if !defined(IOS_CROSS_COMPILE)
I
Igor Canadi 已提交
5507 5508
  // if we compile with Xcode, we don't run build_detect_vesion, so we don't
  // generate util/build_version.cc
5509 5510 5511 5512
  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 已提交
5513
#endif
5514 5515
}

A
agiardullo 已提交
5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532
#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
5533 5534 5535
Status DBImpl::GetLatestSequenceForKey(SuperVersion* sv, const Slice& key,
                                       bool cache_only, SequenceNumber* seq,
                                       bool* found_record_for_key) {
A
agiardullo 已提交
5536 5537 5538 5539 5540 5541 5542 5543
  Status s;
  std::string value;
  MergeContext merge_context;

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

  *seq = kMaxSequenceNumber;
5544 5545 5546 5547
  *found_record_for_key = false;

  // TODO(agiardullo): Should optimize all the Get() functions below to not
  // return a value since we do not use it.
A
agiardullo 已提交
5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562

  // Check if there is a record for this key in the latest memtable
  sv->mem->Get(lkey, &value, &s, &merge_context, seq);

  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
5563
    *found_record_for_key = true;
A
agiardullo 已提交
5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580
    return Status::OK();
  }

  // Check if there is a record for this key in the immutable memtables
  sv->imm->Get(lkey, &value, &s, &merge_context, seq);

  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
5581
    *found_record_for_key = true;
A
agiardullo 已提交
5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596
    return Status::OK();
  }

  // Check if there is a record for this key in the immutable memtables
  sv->imm->GetFromHistory(lkey, &value, &s, &merge_context, seq);

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

5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621
  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;

    sv->current->Get(read_options, lkey, &value, &s, &merge_context,
                     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 已提交
5622 5623 5624 5625
  return Status::OK();
}
#endif  // ROCKSDB_LITE

5626
}  // namespace rocksdb