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

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

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

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

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

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

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

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

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

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

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

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

    if (keep) {
      continue;
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

S
Stanislau Hlebik 已提交
1234 1235 1236 1237 1238 1239 1240 1241 1242 1243
      // 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()) {
1244 1245 1246 1247
        // 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 已提交
1248
      }
1249

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

      if (!read_only) {
I
Igor Canadi 已提交
1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
        // 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;
1269
          status = WriteLevel0TableForRecovery(job_id, cfd, cfd->mem(), edit);
I
Igor Canadi 已提交
1270 1271 1272 1273
          if (!status.ok()) {
            // Reflect errors immediately so that conditions like full
            // file-systems cause the DB::Open() to fail.
            return status;
1274
          }
A
agiardullo 已提交
1275 1276 1277

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1471
  FileMetaData file_meta;
1472 1473 1474 1475 1476 1477 1478

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

I
Igor Canadi 已提交
1723
#ifndef ROCKSDB_LITE
1724 1725 1726
Status DBImpl::CompactFilesImpl(
    const CompactionOptions& compact_options, ColumnFamilyData* cfd,
    Version* version, const std::vector<std::string>& input_file_names,
1727 1728
    const int output_level, int output_path_id, JobContext* job_context,
    LogBuffer* log_buffer) {
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 1760
  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;
  }

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

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

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

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

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

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

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

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

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

O
Ori Bernstein 已提交
1877
void DBImpl::NotifyOnCompactionCompleted(
1878 1879
    ColumnFamilyData* cfd, Compaction *c, const Status &st,
    const CompactionJobStats& compaction_job_stats,
1880
    const int job_id) {
O
Ori Bernstein 已提交
1881
#ifndef ROCKSDB_LITE
1882
  if (db_options_.listeners.size() == 0U) {
O
Ori Bernstein 已提交
1883 1884 1885 1886 1887 1888 1889 1890
    return;
  }
  mutex_.AssertHeld();
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }
  // release lock while notifying events
  mutex_.Unlock();
1891 1892 1893 1894
  {
    CompactionJobInfo info;
    info.cf_name = cfd->GetName();
    info.status = st;
1895
    info.thread_id = env_->GetThreadID();
1896 1897
    info.job_id = job_id;
    info.base_input_level = c->start_level();
1898
    info.output_level = c->output_level();
1899
    info.stats = compaction_job_stats;
1900
    info.table_properties = c->GetOutputTableProperties();
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 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294
    assert(HasPendingManualCompaction());
    manual_conflict = false;
    if (ShouldRunManualCompaction(&manual) || (manual.in_progress == true) ||
        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);
L
Lei Jin 已提交
2322
  return manual.status;
J
jorlow@chromium.org 已提交
2323 2324
}

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

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

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

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

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

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

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

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

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

2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409
Status DBImpl::EnableAutoCompaction(
    const std::vector<ColumnFamilyHandle*>& column_family_handles) {
  Status s;
  for (auto cf_ptr : column_family_handles) {
    // check options here, enable only if didn't initially disable
    if (s.ok()) {
      s = this->SetOptions(cf_ptr, {{"disable_auto_compactions", "false"}});
    }
  }

  if (s.ok()) {
    InstrumentedMutexLock guard_lock(&mutex_);
    MaybeScheduleFlushOrCompaction();
  }

  return s;
}

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

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

2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442
  // 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);
    }
  }

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

2449 2450
  while (bg_compaction_scheduled_ < db_options_.max_background_compactions &&
         unscheduled_compactions_ > 0) {
2451 2452 2453
    CompactionArg* ca = new CompactionArg;
    ca->db = this;
    ca->m = nullptr;
2454 2455
    bg_compaction_scheduled_++;
    unscheduled_compactions_--;
2456 2457
    env_->Schedule(&DBImpl::BGWorkCompaction, ca, Env::Priority::LOW, this,
                   &DBImpl::UnscheduleCallback);
2458 2459 2460 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
  }
}

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_;
2504 2505 2506
  }
}

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

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

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

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

2540 2541 2542 2543 2544 2545 2546
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

  if (!status.ok()) {
    return status;
2547 2548
  }

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

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

    // found a flush!
I
Igor Canadi 已提交
2563
    cfd = first_cfd;
2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576
    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_);
2577
    status = FlushMemTableToOutputFile(cfd, mutable_cf_options, made_progress,
2578 2579 2580
                                       job_context, log_buffer);
    if (cfd->Unref()) {
      delete cfd;
2581
    }
J
jorlow@chromium.org 已提交
2582
  }
2583
  return status;
J
jorlow@chromium.org 已提交
2584 2585
}

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

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

I
Igor Canadi 已提交
2596 2597 2598
    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

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

I
Igor Canadi 已提交
2619 2620
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

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

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

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

    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

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

I
Igor Canadi 已提交
2691 2692
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

2693 2694 2695 2696
    // 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());
2697 2698

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

2714 2715
    assert(num_running_compactions_ > 0);
    num_running_compactions_--;
2716
    bg_compaction_scheduled_--;
J
jorlow@chromium.org 已提交
2717

2718 2719
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();

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

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

2747 2748 2749 2750 2751
  bool is_manual = (manual_compaction != nullptr);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

3038 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 3064 3065 3066 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
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;
}

bool DBImpl::ShouldRunManualCompaction(ManualCompaction* m) {
  if ((m->exclusive) && (bg_compaction_scheduled_ > 0)) {
    return true;
  }
  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;
}

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

  DBImpl* db;
3131
  InstrumentedMutex* mu;
3132
  SuperVersion* super_version;
3133 3134 3135 3136
};

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

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

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

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

3155 3156
  delete state;
}
H
Hans Wennborg 已提交
3157
}  // namespace
3158

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

  return internal_iter;
}

3182 3183 3184 3185
ColumnFamilyHandle* DBImpl::DefaultColumnFamily() const {
  return default_cf_handle_;
}

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

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

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

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

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

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

3250 3251 3252
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

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

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

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

3285 3286
  {
    PERF_TIMER_GUARD(get_post_process_time);
3287

3288
    ReturnAndCleanupSuperVersion(cfd, sv);
3289

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

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

L
Lei Jin 已提交
3301
  StopWatch sw(env_, stats_, DB_MULTIGET);
3302
  PERF_TIMER_GUARD(get_snapshot_time);
K
Kai Liu 已提交
3303

3304
  SequenceNumber snapshot;
3305

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

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

3335 3336
  // Contain a list of merge operations if merge occurs.
  MergeContext merge_context;
3337

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

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

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

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

    if (s.ok()) {
3373
      bytes_read += value->size();
3374 3375 3376 3377
    }
  }

  // Post processing (decrement reference counts and record statistics)
3378
  PERF_TIMER_GUARD(get_post_process_time);
3379 3380
  autovector<SuperVersion*> superversions_to_delete;

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

  for (auto td : superversions_to_delete) {
    delete td;
  }
  for (auto mgd : multiget_cf_data) {
    delete mgd.second;
3397
  }
3398

L
Lei Jin 已提交
3399 3400 3401
  RecordTick(stats_, NUMBER_MULTIGET_CALLS);
  RecordTick(stats_, NUMBER_MULTIGET_KEYS_READ, num_keys);
  RecordTick(stats_, NUMBER_MULTIGET_BYTES_READ, bytes_read);
L
Lei Jin 已提交
3402
  PERF_TIMER_STOP(get_post_process_time);
3403

3404
  return stat_list;
3405 3406
}

3407 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
#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 已提交
3462 3463
  std::unique_ptr<InternalIterator> iter(
      table_reader->NewIterator(ReadOptions()));
3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 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

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

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

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

    if (status.ok()) {
3574
      // Add file to L0
3575 3576
      VersionEdit edit;
      edit.SetColumnFamily(cfd->GetID());
3577
      edit.AddFile(0, meta.fd.GetNumber(), meta.fd.GetPathId(),
3578 3579 3580 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
                   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 已提交
3615
Status DBImpl::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
3616
                                  const std::string& column_family_name,
3617
                                  ColumnFamilyHandle** handle) {
Y
Yueh-Hsuan Chiang 已提交
3618
  Status s;
3619
  Status persist_options_status;
I
Igor Canadi 已提交
3620
  *handle = nullptr;
3621 3622 3623 3624 3625 3626

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

Y
Yueh-Hsuan Chiang 已提交
3627
  {
3628
    InstrumentedMutexLock l(&mutex_);
I
Igor Canadi 已提交
3629

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

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

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

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

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

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

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

I
Igor Canadi 已提交
3711 3712
  VersionEdit edit;
  edit.DropColumnFamily();
3713 3714
  edit.SetColumnFamily(cfd->GetID());

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

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

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

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

3779
  return s;
3780 3781
}

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

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

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

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

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

3844 3845 3846 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
    // 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         | <----+
    // |       |   +-------------------+
    // |       |                       |
    // +-------+-----------------------+
    //
3880 3881
    // ArenaWrappedDBIter inlines an arena area where all the iterators in
    // the iterator tree are allocated in the order of being accessed when
3882 3883 3884 3885 3886
    // 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(
3887 3888 3889
        env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
        read_options.iterate_upper_bound, read_options.prefix_same_as_start);
3890

S
sdong 已提交
3891
    InternalIterator* internal_iter =
3892
        NewInternalIterator(read_options, cfd, sv, db_iter->GetArena());
3893 3894 3895 3896
    db_iter->SetIterUnderDBIter(internal_iter);

    return db_iter;
  }
3897 3898
  // To stop compiler from complaining
  return nullptr;
J
jorlow@chromium.org 已提交
3899 3900
}

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

I
Igor Canadi 已提交
3944
    for (size_t i = 0; i < column_families.size(); ++i) {
3945 3946 3947
      auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(
          column_families[i])->cfd();
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
I
Igor Canadi 已提交
3948 3949

      auto snapshot =
3950 3951 3952
          read_options.snapshot != nullptr
              ? reinterpret_cast<const SnapshotImpl*>(
                  read_options.snapshot)->number_
I
Igor Canadi 已提交
3953 3954
              : latest_snapshot;

3955
      ArenaWrappedDBIter* db_iter = NewArenaWrappedDbIterator(
3956
          env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
3957
          sv->mutable_cf_options.max_sequential_skip_in_iterations);
S
sdong 已提交
3958 3959
      InternalIterator* internal_iter =
          NewInternalIterator(read_options, cfd, sv, db_iter->GetArena());
3960 3961
      db_iter->SetIterUnderDBIter(internal_iter);
      iterators->push_back(db_iter);
I
Igor Canadi 已提交
3962 3963 3964 3965
    }
  }

  return Status::OK();
3966 3967
}

3968 3969
const Snapshot* DBImpl::GetSnapshot() { return GetSnapshotImpl(false); }

3970
#ifndef ROCKSDB_LITE
3971 3972 3973
const Snapshot* DBImpl::GetSnapshotForWriteConflictBoundary() {
  return GetSnapshotImpl(true);
}
3974
#endif  // ROCKSDB_LITE
3975 3976

const Snapshot* DBImpl::GetSnapshotImpl(bool is_write_conflict_boundary) {
3977 3978
  int64_t unix_time = 0;
  env_->GetCurrentTime(&unix_time);  // Ignore error
3979
  SnapshotImpl* s = new SnapshotImpl;
3980

3981
  InstrumentedMutexLock l(&mutex_);
3982
  // returns null if the underlying memtable does not support snapshot.
3983 3984 3985 3986
  if (!is_snapshot_supported_) {
    delete s;
    return nullptr;
  }
3987 3988
  return snapshots_.New(s, versions_->LastSequence(), unix_time,
                        is_write_conflict_boundary);
J
jorlow@chromium.org 已提交
3989 3990 3991
}

void DBImpl::ReleaseSnapshot(const Snapshot* s) {
3992 3993 3994 3995 3996 3997
  const SnapshotImpl* casted_s = reinterpret_cast<const SnapshotImpl*>(s);
  {
    InstrumentedMutexLock l(&mutex_);
    snapshots_.Delete(casted_s);
  }
  delete casted_s;
J
jorlow@chromium.org 已提交
3998 3999 4000
}

// Convenience methods
4001 4002
Status DBImpl::Put(const WriteOptions& o, ColumnFamilyHandle* column_family,
                   const Slice& key, const Slice& val) {
4003
  return DB::Put(o, column_family, key, val);
J
jorlow@chromium.org 已提交
4004 4005
}

4006 4007 4008
Status DBImpl::Merge(const WriteOptions& o, ColumnFamilyHandle* column_family,
                     const Slice& key, const Slice& val) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
4009
  if (!cfh->cfd()->ioptions()->merge_operator) {
4010 4011
    return Status::NotSupported("Provide a merge_operator when opening DB");
  } else {
4012
    return DB::Merge(o, column_family, key, val);
4013 4014 4015
  }
}

L
Lei Jin 已提交
4016
Status DBImpl::Delete(const WriteOptions& write_options,
4017
                      ColumnFamilyHandle* column_family, const Slice& key) {
L
Lei Jin 已提交
4018
  return DB::Delete(write_options, column_family, key);
J
jorlow@chromium.org 已提交
4019 4020
}

A
Andres Noetzli 已提交
4021 4022 4023 4024 4025 4026
Status DBImpl::SingleDelete(const WriteOptions& write_options,
                            ColumnFamilyHandle* column_family,
                            const Slice& key) {
  return DB::SingleDelete(write_options, column_family, key);
}

L
Lei Jin 已提交
4027
Status DBImpl::Write(const WriteOptions& write_options, WriteBatch* my_batch) {
A
agiardullo 已提交
4028 4029 4030
  return WriteImpl(write_options, my_batch, nullptr);
}

A
agiardullo 已提交
4031
#ifndef ROCKSDB_LITE
A
agiardullo 已提交
4032 4033 4034 4035 4036
Status DBImpl::WriteWithCallback(const WriteOptions& write_options,
                                 WriteBatch* my_batch,
                                 WriteCallback* callback) {
  return WriteImpl(write_options, my_batch, callback);
}
A
agiardullo 已提交
4037
#endif  // ROCKSDB_LITE
A
agiardullo 已提交
4038 4039 4040

Status DBImpl::WriteImpl(const WriteOptions& write_options,
                         WriteBatch* my_batch, WriteCallback* callback) {
S
Stanislau Hlebik 已提交
4041 4042 4043
  if (my_batch == nullptr) {
    return Status::Corruption("Batch is nullptr!");
  }
4044 4045 4046
  if (write_options.timeout_hint_us != 0) {
    return Status::InvalidArgument("timeout_hint_us is deprecated");
  }
A
agiardullo 已提交
4047 4048

  Status status;
A
agiardullo 已提交
4049 4050
  bool callback_failed = false;

A
agiardullo 已提交
4051 4052 4053 4054 4055 4056 4057 4058 4059 4060
  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;
  }

4061
  PERF_TIMER_GUARD(write_pre_and_post_process_time);
4062
  WriteThread::Writer w;
S
Stanislau Hlebik 已提交
4063
  w.batch = my_batch;
L
Lei Jin 已提交
4064 4065
  w.sync = write_options.sync;
  w.disableWAL = write_options.disableWAL;
S
Stanislau Hlebik 已提交
4066 4067
  w.in_batch_group = false;
  w.done = false;
A
agiardullo 已提交
4068
  w.has_callback = (callback != nullptr) ? true : false;
S
Stanislau Hlebik 已提交
4069

L
Lei Jin 已提交
4070
  if (!write_options.disableWAL) {
S
Stanislau Hlebik 已提交
4071 4072 4073
    RecordTick(stats_, WRITE_WITH_WAL);
  }

4074 4075
  StopWatch write_sw(env_, db_options_.statistics.get(), DB_WRITE);

4076 4077 4078 4079 4080 4081 4082 4083
  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 已提交
4084 4085
  WriteContext context;
  mutex_.Lock();
I
Igor Canadi 已提交
4086 4087 4088 4089 4090

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

S
Stanislau Hlebik 已提交
4091 4092
  RecordTick(stats_, WRITE_DONE_BY_SELF);
  default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_DONE_BY_SELF, 1);
4093

4094 4095 4096 4097
  // 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.
4098 4099 4100
  assert(!single_column_family_mode_ ||
         versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1);

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

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

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

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

S
sdong 已提交
4171 4172
  if (UNLIKELY(status.ok()) &&
      (write_controller_.IsStopped() || write_controller_.NeedsDelay())) {
4173 4174
    PERF_TIMER_STOP(write_pre_and_post_process_time);
    PERF_TIMER_GUARD(write_delay_time);
S
sdong 已提交
4175 4176 4177 4178
    // 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.
4179
    status = DelayWrite(last_batch_group_size_);
4180
    PERF_TIMER_START(write_pre_and_post_process_time);
I
Igor Canadi 已提交
4181 4182
  }

D
dgrogan@chromium.org 已提交
4183
  uint64_t last_sequence = versions_->LastSequence();
I
Igor Canadi 已提交
4184
  WriteThread::Writer* last_writer = &w;
A
agiardullo 已提交
4185
  autovector<WriteBatch*> write_batch_group;
4186 4187
  bool need_log_sync = !write_options.disableWAL && write_options.sync;
  bool need_log_dir_sync = need_log_sync && !log_dir_synced_;
A
agiardullo 已提交
4188

S
Stanislau Hlebik 已提交
4189
  if (status.ok()) {
4190 4191
    last_batch_group_size_ = write_thread_.EnterAsBatchGroupLeader(
        &w, &last_writer, &write_batch_group);
4192

4193
    if (need_log_sync) {
4194 4195 4196 4197 4198 4199 4200 4201 4202
      while (logs_.front().getting_synced) {
        log_sync_cv_.Wait();
      }
      for (auto& log : logs_) {
        assert(!log.getting_synced);
        log.getting_synced = true;
      }
    }

4203 4204 4205
    // 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
4206
    // into memtables
A
agiardullo 已提交
4207 4208 4209 4210 4211 4212 4213

    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 已提交
4214
      callback_failed = true;
A
agiardullo 已提交
4215 4216 4217 4218 4219 4220 4221 4222
    }
  } else {
    mutex_.Unlock();
  }

  // At this point the mutex is unlocked

  if (status.ok()) {
4223 4224 4225 4226 4227 4228
      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));
4229 4230
      }

4231
      const SequenceNumber current_sequence = last_sequence + 1;
4232 4233
      last_sequence += total_count;

4234
      // Record statistics
4235 4236 4237 4238
      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 已提交
4239
      if (write_options.disableWAL) {
4240
        flush_on_destroy_ = true;
4241 4242
      }

4243
      uint64_t log_size = 0;
L
Lei Jin 已提交
4244
      if (!write_options.disableWAL) {
4245
        PERF_TIMER_GUARD(write_wal_time);
4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264

        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);
4265
        status = logs_.back().writer->AddRecord(log_entry);
I
Igor Canadi 已提交
4266 4267
        total_log_size_ += log_entry.size();
        alive_log_files_.back().AddSize(log_entry.size());
4268
        log_empty_ = false;
4269
        log_size = log_entry.size();
L
Lei Jin 已提交
4270
        RecordTick(stats_, WAL_FILE_BYTES, log_size);
4271
        if (status.ok() && need_log_sync) {
I
Igor Canadi 已提交
4272
          RecordTick(stats_, WAL_FILE_SYNCED);
4273
          StopWatch sw(env_, stats_, WAL_FILE_SYNC_MICROS);
4274 4275 4276 4277 4278 4279 4280 4281
          // 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_) {
4282
            status = log.writer->file()->Sync(db_options_.use_fsync);
4283 4284 4285 4286
            if (!status.ok()) {
              break;
            }
          }
4287
          if (status.ok() && need_log_dir_sync) {
4288 4289 4290 4291 4292
            // 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 已提交
4293
        }
4294 4295 4296 4297

        if (merged_batch == &tmp_batch_) {
          tmp_batch_.Clear();
        }
4298 4299
      }
      if (status.ok()) {
4300
        PERF_TIMER_GUARD(write_memtable_time);
Y
Yueh-Hsuan Chiang 已提交
4301

4302
        status = WriteBatchInternal::InsertInto(
4303 4304 4305 4306 4307 4308 4309 4310 4311
            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 已提交
4312
        //
4313 4314 4315 4316 4317
        // 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 已提交
4318

L
Lei Jin 已提交
4319
        SetTickerCount(stats_, SEQUENCE_NUMBER, last_sequence);
4320
      }
L
Lei Jin 已提交
4321
      PERF_TIMER_START(write_pre_and_post_process_time);
4322
      mutex_.Lock();
A
agiardullo 已提交
4323

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

A
agiardullo 已提交
4345
  if (db_options_.paranoid_checks && !status.ok() && !callback_failed &&
4346
      !status.IsBusy() && bg_error_.ok()) {
I
Igor Canadi 已提交
4347 4348
    bg_error_ = status; // stop compaction & fail any further writes
  }
4349

A
agiardullo 已提交
4350
  mutex_.AssertHeld();
4351

4352 4353
  if (need_log_sync) {
    MarkLogsSynced(logfile_number_, need_log_dir_sync, status);
4354 4355
  }

4356 4357 4358 4359 4360 4361 4362 4363 4364
  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);
    }
  }
4365

I
Igor Canadi 已提交
4366
  mutex_.Unlock();
4367

4368 4369
  write_thread_.ExitAsBatchGroupLeader(&w, last_writer, status);

J
jorlow@chromium.org 已提交
4370 4371 4372
  return status;
}

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

4390
    while (bg_error_.ok() && write_controller_.IsStopped()) {
S
sdong 已提交
4391
      delayed = true;
4392 4393
      TEST_SYNC_POINT("DBImpl::DelayWrite:Wait");
      bg_cv_.Wait();
4394 4395
    }
  }
S
sdong 已提交
4396 4397 4398 4399 4400
  if (delayed) {
    default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_STALL_MICROS,
                                           time_delayed);
    RecordTick(stats_, STALL_MICROS, time_delayed);
  }
I
Igor Canadi 已提交
4401 4402

  return bg_error_;
4403 4404
}

I
Igor Canadi 已提交
4405 4406 4407
Status DBImpl::ScheduleFlushes(WriteContext* context) {
  ColumnFamilyData* cfd;
  while ((cfd = flush_scheduler_.GetNextColumnFamily()) != nullptr) {
I
Igor Canadi 已提交
4408
    auto status = SwitchMemtable(cfd, context);
I
Igor Canadi 已提交
4409 4410 4411 4412 4413
    if (cfd->Unref()) {
      delete cfd;
    }
    if (!status.ok()) {
      return status;
S
Stanislau Hlebik 已提交
4414 4415
    }
  }
I
Igor Canadi 已提交
4416
  return Status::OK();
S
Stanislau Hlebik 已提交
4417 4418 4419 4420
}

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

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

I
Igor Canadi 已提交
4515
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
4516 4517 4518 4519 4520
Status DBImpl::GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                        TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

4521 4522
  // Increment the ref count
  mutex_.Lock();
I
Igor Canadi 已提交
4523
  auto version = cfd->current();
4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfAllTables(props);

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

  return s;
}
4536 4537

Status DBImpl::GetPropertiesOfTablesInRange(ColumnFamilyHandle* column_family,
4538
                                            const Range* range, std::size_t n,
4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558
                                            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 已提交
4559
#endif  // ROCKSDB_LITE
4560

I
Igor Canadi 已提交
4561 4562 4563 4564
const std::string& DBImpl::GetName() const {
  return dbname_;
}

4565 4566 4567 4568
Env* DBImpl::GetEnv() const {
  return env_;
}

4569 4570
const Options& DBImpl::GetOptions(ColumnFamilyHandle* column_family) const {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
I
Igor Canadi 已提交
4571
  return *cfh->cfd()->options();
I
Igor Canadi 已提交
4572 4573
}

4574 4575
const DBOptions& DBImpl::GetDBOptions() const { return db_options_; }

4576
bool DBImpl::GetProperty(ColumnFamilyHandle* column_family,
4577
                         const Slice& property, std::string* value) {
4578 4579
  bool is_int_property = false;
  bool need_out_of_mutex = false;
4580 4581 4582
  DBPropertyType property_type =
      GetPropertyType(property, &is_int_property, &need_out_of_mutex);

4583
  value->clear();
4584
  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
4585 4586
  if (is_int_property) {
    uint64_t int_value;
4587 4588
    bool ret_value = GetIntPropertyInternal(
        cfd, property_type, need_out_of_mutex, false, &int_value);
4589
    if (ret_value) {
4590
      *value = ToString(int_value);
4591 4592 4593
    }
    return ret_value;
  } else {
4594
    InstrumentedMutexLock l(&mutex_);
4595 4596 4597
    return cfd->internal_stats()->GetStringProperty(property_type, property,
                                                    value);
  }
J
jorlow@chromium.org 已提交
4598 4599
}

4600 4601
bool DBImpl::GetIntProperty(ColumnFamilyHandle* column_family,
                            const Slice& property, uint64_t* value) {
4602 4603
  bool is_int_property = false;
  bool need_out_of_mutex = false;
4604 4605 4606 4607 4608
  DBPropertyType property_type =
      GetPropertyType(property, &is_int_property, &need_out_of_mutex);
  if (!is_int_property) {
    return false;
  }
4609 4610
  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  return GetIntPropertyInternal(cfd, property_type, need_out_of_mutex, false,
4611 4612 4613
                                value);
}

4614
bool DBImpl::GetIntPropertyInternal(ColumnFamilyData* cfd,
4615
                                    DBPropertyType property_type,
4616 4617
                                    bool need_out_of_mutex, bool is_locked,
                                    uint64_t* value) {
4618
  if (!need_out_of_mutex) {
4619 4620 4621 4622 4623 4624 4625
    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);
    }
4626
  } else {
4627 4628 4629 4630 4631 4632
    SuperVersion* sv = nullptr;
    if (!is_locked) {
      sv = GetAndRefSuperVersion(cfd);
    } else {
      sv = cfd->GetSuperVersion();
    }
4633 4634 4635 4636

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

4637 4638 4639
    if (!is_locked) {
      ReturnAndCleanupSuperVersion(cfd, sv);
    }
4640 4641 4642 4643 4644

    return ret;
  }
}

4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672
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;
}

4673 4674
SuperVersion* DBImpl::GetAndRefSuperVersion(ColumnFamilyData* cfd) {
  // TODO(ljin): consider using GetReferencedSuperVersion() directly
I
Igor Canadi 已提交
4675
  return cfd->GetThreadLocalSuperVersion(&mutex_);
4676 4677
}

A
agiardullo 已提交
4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689
// 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 已提交
4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705
// 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);
}

4706 4707
void DBImpl::ReturnAndCleanupSuperVersion(ColumnFamilyData* cfd,
                                          SuperVersion* sv) {
I
Igor Canadi 已提交
4708
  bool unref_sv = !cfd->ReturnThreadLocalSuperVersion(sv);
4709 4710 4711 4712 4713

  if (unref_sv) {
    // Release SuperVersion
    if (sv->Unref()) {
      {
4714
        InstrumentedMutexLock l(&mutex_);
4715 4716 4717 4718 4719 4720 4721
        sv->Cleanup();
      }
      delete sv;
      RecordTick(stats_, NUMBER_SUPERVERSION_CLEANUPS);
    }
    RecordTick(stats_, NUMBER_SUPERVERSION_RELEASES);
  }
4722 4723
}

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

4778
void DBImpl::GetApproximateSizes(ColumnFamilyHandle* column_family,
4779 4780
                                 const Range* range, int n, uint64_t* sizes,
                                 bool include_memtable) {
J
jorlow@chromium.org 已提交
4781
  Version* v;
4782 4783
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
4784 4785
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
  v = sv->current;
J
jorlow@chromium.org 已提交
4786 4787 4788

  for (int i = 0; i < n; i++) {
    // Convert user_key into a corresponding internal key.
4789 4790 4791
    InternalKey k1(range[i].start, kMaxSequenceNumber, kValueTypeForSeek);
    InternalKey k2(range[i].limit, kMaxSequenceNumber, kValueTypeForSeek);
    sizes[i] = versions_->ApproximateSize(v, k1.Encode(), k2.Encode());
4792 4793 4794 4795
    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 已提交
4796 4797
  }

4798
  ReturnAndCleanupSuperVersion(cfd, sv);
J
jorlow@chromium.org 已提交
4799 4800
}

I
Igor Canadi 已提交
4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816
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 已提交
4817 4818 4819 4820 4821
#ifndef ROCKSDB_LITE
Status DBImpl::GetUpdatesSince(
    SequenceNumber seq, unique_ptr<TransactionLogIterator>* iter,
    const TransactionLogIterator::ReadOptions& read_options) {

L
Lei Jin 已提交
4822
  RecordTick(stats_, GET_UPDATES_SINCE_CALLS);
I
Igor Canadi 已提交
4823 4824 4825
  if (seq > versions_->LastSequence()) {
    return Status::NotFound("Requested sequence not yet written in the db");
  }
I
Igor Canadi 已提交
4826
  return wal_manager_.GetUpdatesSince(seq, iter, read_options, versions_.get());
I
Igor Canadi 已提交
4827 4828
}

4829 4830 4831
Status DBImpl::DeleteFile(std::string name) {
  uint64_t number;
  FileType type;
4832 4833 4834
  WalFileType log_type;
  if (!ParseFileName(name, &number, &type, &log_type) ||
      (type != kTableFile && type != kLogFile)) {
4835 4836
    Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
        "DeleteFile %s failed.\n", name.c_str());
4837 4838 4839
    return Status::InvalidArgument("Invalid file name");
  }

4840 4841 4842 4843
  Status status;
  if (type == kLogFile) {
    // Only allow deleting archived log files
    if (log_type != kArchivedLogFile) {
4844 4845
      Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
          "DeleteFile %s failed - not archived log.\n",
4846
          name.c_str());
4847 4848
      return Status::NotSupported("Delete only supported for archived logs");
    }
4849
    status = env_->DeleteFile(db_options_.wal_dir + "/" + name.c_str());
4850
    if (!status.ok()) {
4851 4852
      Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
          "DeleteFile %s failed -- %s.\n",
4853
          name.c_str(), status.ToString().c_str());
4854 4855 4856 4857
    }
    return status;
  }

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

D
Dhruba Borthakur 已提交
4874
    // If the file is being compacted no need to delete.
4875
    if (metadata->being_compacted) {
4876
      Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
4877
          "DeleteFile %s Skipped. File about to be compacted\n", name.c_str());
I
Igor Canadi 已提交
4878
      job_context.Clean();
D
Dhruba Borthakur 已提交
4879
      return Status::OK();
4880 4881
    }

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

4914
  LogFlush(db_options_.info_log);
I
Igor Canadi 已提交
4915
  // remove files outside the db-lock
I
Igor Canadi 已提交
4916
  if (job_context.HaveSomethingToDelete()) {
4917
    // Call PurgeObsoleteFiles() without holding mutex.
I
Igor Canadi 已提交
4918
    PurgeObsoleteFiles(job_context);
4919
  }
I
Igor Canadi 已提交
4920
  job_context.Clean();
4921 4922 4923
  return status;
}

4924
void DBImpl::GetLiveFilesMetaData(std::vector<LiveFileMetaData>* metadata) {
4925
  InstrumentedMutexLock l(&mutex_);
4926
  versions_->GetLiveFilesMetaData(metadata);
4927
}
4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938

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 已提交
4939
#endif  // ROCKSDB_LITE
4940

I
Igor Canadi 已提交
4941 4942 4943 4944 4945 4946 4947
Status DBImpl::CheckConsistency() {
  mutex_.AssertHeld();
  std::vector<LiveFileMetaData> metadata;
  versions_->GetLiveFilesMetaData(&metadata);

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

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

4974
Status DBImpl::GetDbIdentity(std::string& identity) const {
4975 4976
  std::string idfilename = IdentityFileName(dbname_);
  const EnvOptions soptions;
4977 4978 4979 4980 4981 4982 4983 4984 4985
  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)));
4986
  }
4987

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

5019 5020
Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
J
jorlow@chromium.org 已提交
5021
  WriteBatch batch;
5022
  batch.Delete(column_family, key);
J
jorlow@chromium.org 已提交
5023 5024 5025
  return Write(opt, &batch);
}

A
Andres Noetzli 已提交
5026 5027 5028 5029 5030 5031 5032
Status DB::SingleDelete(const WriteOptions& opt,
                        ColumnFamilyHandle* column_family, const Slice& key) {
  WriteBatch batch;
  batch.SingleDelete(column_family, key);
  return Write(opt, &batch);
}

5033 5034
Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
5035
  WriteBatch batch;
5036
  batch.Merge(column_family, key, value);
5037 5038 5039
  return Write(opt, &batch);
}

5040
// Default implementation -- returns not supported status
L
Lei Jin 已提交
5041
Status DB::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
5042
                              const std::string& column_family_name,
5043
                              ColumnFamilyHandle** handle) {
5044
  return Status::NotSupported("");
5045
}
5046
Status DB::DropColumnFamily(ColumnFamilyHandle* column_family) {
5047
  return Status::NotSupported("");
5048 5049
}

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

J
Jim Paton 已提交
5052
Status DB::Open(const Options& options, const std::string& dbname, DB** dbptr) {
5053 5054 5055 5056
  DBOptions db_options(options);
  ColumnFamilyOptions cf_options(options);
  std::vector<ColumnFamilyDescriptor> column_families;
  column_families.push_back(
5057
      ColumnFamilyDescriptor(kDefaultColumnFamilyName, cf_options));
5058
  std::vector<ColumnFamilyHandle*> handles;
5059
  Status s = DB::Open(db_options, dbname, column_families, &handles, dbptr);
5060 5061 5062 5063 5064 5065 5066
  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;
5067 5068
}

5069 5070
Status DB::Open(const DBOptions& db_options, const std::string& dbname,
                const std::vector<ColumnFamilyDescriptor>& column_families,
5071
                std::vector<ColumnFamilyHandle*>* handles, DB** dbptr) {
5072
  Status s = SanitizeOptionsByTable(db_options, column_families);
5073 5074 5075
  if (!s.ok()) {
    return s;
  }
5076

5077 5078 5079 5080 5081 5082
  for (auto& cfd : column_families) {
    s = CheckCompressionSupported(cfd.options);
    if (!s.ok()) {
      return s;
    }
    if (db_options.db_paths.size() > 1) {
5083 5084
      if ((cfd.options.compaction_style != kCompactionStyleUniversal) &&
          (cfd.options.compaction_style != kCompactionStyleLevel)) {
5085 5086
        return Status::NotSupported(
            "More than one DB paths are only supported in "
5087
            "universal and level compaction styles. ");
5088 5089
      }
    }
5090
  }
5091

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

5097
  *dbptr = nullptr;
5098
  handles->clear();
J
jorlow@chromium.org 已提交
5099

I
Igor Canadi 已提交
5100 5101 5102 5103
  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);
5104
  }
5105

I
Igor Canadi 已提交
5106
  DBImpl* impl = new DBImpl(db_options, dbname);
5107
  s = impl->env_->CreateDirIfMissing(impl->db_options_.wal_dir);
5108
  if (s.ok()) {
5109
    for (auto db_path : impl->db_options_.db_paths) {
5110
      s = impl->env_->CreateDirIfMissing(db_path.path);
5111 5112 5113 5114 5115 5116
      if (!s.ok()) {
        break;
      }
    }
  }

5117 5118 5119 5120 5121 5122
  if (!s.ok()) {
    delete impl;
    return s;
  }

  s = impl->CreateArchivalDirectory();
5123 5124 5125 5126
  if (!s.ok()) {
    delete impl;
    return s;
  }
J
jorlow@chromium.org 已提交
5127
  impl->mutex_.Lock();
5128 5129
  // Handles create_if_missing, error_if_exists
  s = impl->Recover(column_families);
J
jorlow@chromium.org 已提交
5130
  if (s.ok()) {
5131
    uint64_t new_log_number = impl->versions_->NewFileNumber();
5132
    unique_ptr<WritableFile> lfile;
5133
    EnvOptions soptions(db_options);
5134 5135
    EnvOptions opt_env_options =
        impl->db_options_.env->OptimizeForLogWrite(soptions, impl->db_options_);
S
sdong 已提交
5136 5137 5138
    s = NewWritableFile(impl->db_options_.env,
                        LogFileName(impl->db_options_.wal_dir, new_log_number),
                        &lfile, opt_env_options);
J
jorlow@chromium.org 已提交
5139
    if (s.ok()) {
5140
      lfile->SetPreallocationBlockSize(1.1 * max_write_buffer_size);
5141
      impl->logfile_number_ = new_log_number;
5142 5143
      unique_ptr<WritableFileWriter> file_writer(
          new WritableFileWriter(std::move(lfile), opt_env_options));
5144 5145
      impl->logs_.emplace_back(
          new_log_number,
S
sdong 已提交
5146 5147
          new log::Writer(std::move(file_writer), new_log_number,
                          impl->db_options_.recycle_log_file_num > 0));
I
Igor Canadi 已提交
5148

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

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

5223
    *dbptr = impl;
5224 5225 5226
    impl->opened_successfully_ = true;
    impl->MaybeScheduleFlushOrCompaction();
  }
5227 5228
  impl->mutex_.Unlock();

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

5255 5256 5257
Status DB::ListColumnFamilies(const DBOptions& db_options,
                              const std::string& name,
                              std::vector<std::string>* column_families) {
I
Igor Canadi 已提交
5258
  return VersionSet::ListColumnFamilies(column_families, name, db_options.env);
5259 5260
}

5261 5262 5263
Snapshot::~Snapshot() {
}

J
jorlow@chromium.org 已提交
5264
Status DestroyDB(const std::string& dbname, const Options& options) {
5265
  const InternalKeyComparator comparator(options.comparator);
5266
  const Options& soptions(SanitizeOptions(dbname, &comparator, options));
5267
  Env* env = soptions.env;
J
jorlow@chromium.org 已提交
5268
  std::vector<std::string> filenames;
5269

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

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

5298 5299
    for (size_t path_id = 0; path_id < options.db_paths.size(); path_id++) {
      const auto& db_path = options.db_paths[path_id];
5300
      env->GetChildren(db_path.path, &filenames);
5301 5302 5303
      for (size_t i = 0; i < filenames.size(); i++) {
        if (ParseFileName(filenames[i], &number, &type) &&
            type == kTableFile) {  // Lock file will be deleted at end
5304 5305 5306 5307 5308 5309 5310
          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);
          }
5311 5312 5313 5314 5315 5316 5317
          if (result.ok() && !del.ok()) {
            result = del;
          }
        }
      }
    }

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

5348
    // ignore case where no archival directory is present.
5349
    env->DeleteDir(archivedir);
5350

J
jorlow@chromium.org 已提交
5351
    env->UnlockFile(lock);  // Ignore error since state is already gone
5352
    env->DeleteFile(lockname);
J
jorlow@chromium.org 已提交
5353
    env->DeleteDir(dbname);  // Ignore error in case dir contains other files
5354
    env->DeleteDir(soptions.wal_dir);
J
jorlow@chromium.org 已提交
5355 5356 5357 5358
  }
  return result;
}

5359 5360
Status DBImpl::WriteOptionsFile() {
#ifndef ROCKSDB_LITE
5361
  mutex_.AssertHeld();
5362 5363 5364

  std::vector<std::string> cf_names;
  std::vector<ColumnFamilyOptions> cf_opts;
5365 5366 5367 5368 5369

  // This part requires mutex to protect the column family options
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    if (cfd->IsDropped()) {
      continue;
5370
    }
5371 5372 5373
    cf_names.push_back(cfd->GetName());
    cf_opts.push_back(BuildColumnFamilyOptions(
        *cfd->options(), *cfd->GetLatestMutableCFOptions()));
5374 5375
  }

5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388
  // 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();
5389 5390 5391 5392 5393 5394 5395 5396 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
  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 已提交
5460
#if ROCKSDB_USING_THREAD_STATUS
5461

Y
Yueh-Hsuan Chiang 已提交
5462 5463
void DBImpl::NewThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
5464
  if (db_options_.enable_thread_tracking) {
5465
    ThreadStatusUtil::NewColumnFamilyInfo(this, cfd);
5466
  }
Y
Yueh-Hsuan Chiang 已提交
5467 5468 5469 5470
}

void DBImpl::EraseThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
5471
  if (db_options_.enable_thread_tracking) {
5472
    ThreadStatusUtil::EraseColumnFamilyInfo(cfd);
5473
  }
Y
Yueh-Hsuan Chiang 已提交
5474 5475 5476
}

void DBImpl::EraseThreadStatusDbInfo() const {
5477
  if (db_options_.enable_thread_tracking) {
5478
    ThreadStatusUtil::EraseDatabaseInfo(this);
5479
  }
Y
Yueh-Hsuan Chiang 已提交
5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494
}

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

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

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

5495 5496
//
// A global method that can dump out the build version
I
Igor Canadi 已提交
5497
void DumpRocksDBBuildVersion(Logger * log) {
I
Igor Canadi 已提交
5498
#if !defined(IOS_CROSS_COMPILE)
I
Igor Canadi 已提交
5499 5500
  // if we compile with Xcode, we don't run build_detect_vesion, so we don't
  // generate util/build_version.cc
5501 5502 5503 5504
  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 已提交
5505
#endif
5506 5507
}

A
agiardullo 已提交
5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524
#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
5525 5526 5527
Status DBImpl::GetLatestSequenceForKey(SuperVersion* sv, const Slice& key,
                                       bool cache_only, SequenceNumber* seq,
                                       bool* found_record_for_key) {
A
agiardullo 已提交
5528 5529 5530 5531 5532 5533 5534 5535
  Status s;
  std::string value;
  MergeContext merge_context;

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

  *seq = kMaxSequenceNumber;
5536 5537 5538 5539
  *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 已提交
5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554

  // 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
5555
    *found_record_for_key = true;
A
agiardullo 已提交
5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572
    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
5573
    *found_record_for_key = true;
A
agiardullo 已提交
5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588
    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;
  }

5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613
  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 已提交
5614 5615 5616 5617
  return Status::OK();
}
#endif  // ROCKSDB_LITE

5618
}  // namespace rocksdb