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

#include "db/db_impl.h"

L
liuhuahang 已提交
12
#ifndef __STDC_FORMAT_MACROS
I
Igor Canadi 已提交
13
#define __STDC_FORMAT_MACROS
L
liuhuahang 已提交
14 15
#endif

I
Igor Canadi 已提交
16
#include <inttypes.h>
17 18
#include <stdint.h>

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

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

94
namespace rocksdb {
J
jorlow@chromium.org 已提交
95

96
const std::string kDefaultColumnFamilyName("default");
97

I
Igor Canadi 已提交
98
void DumpRocksDBBuildVersion(Logger * log);
99

S
Stanislau Hlebik 已提交
100 101
struct DBImpl::WriteContext {
  autovector<SuperVersion*> superversions_to_free_;
102
  autovector<MemTable*> memtables_to_free_;
S
Stanislau Hlebik 已提交
103 104 105 106 107

  ~WriteContext() {
    for (auto& sv : superversions_to_free_) {
      delete sv;
    }
108 109 110
    for (auto& m : memtables_to_free_) {
      delete m;
    }
S
Stanislau Hlebik 已提交
111 112 113
  }
};

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

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

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

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

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

153 154 155 156
  if (result.wal_dir.empty()) {
    // Use dbname as default
    result.wal_dir = dbname;
  }
157
  if (result.wal_dir.back() == '/') {
I
Igor Canadi 已提交
158
    result.wal_dir = result.wal_dir.substr(0, result.wal_dir.size() - 1);
159
  }
160

161
  if (result.db_paths.size() == 0) {
162
    result.db_paths.emplace_back(dbname, std::numeric_limits<uint64_t>::max());
163 164
  }

165 166 167 168
  if (result.compaction_readahead_size > 0) {
    result.new_table_reader_for_compaction_inputs = true;
  }

J
jorlow@chromium.org 已提交
169 170 171
  return result;
}

172 173
namespace {

174 175
Status SanitizeOptionsByTable(
    const DBOptions& db_opts,
176 177 178
    const std::vector<ColumnFamilyDescriptor>& column_families) {
  Status s;
  for (auto cf : column_families) {
179
    s = cf.options.table_factory->SanitizeOptions(db_opts, cf.options);
180 181 182 183 184 185 186
    if (!s.ok()) {
      return s;
    }
  }
  return Status::OK();
}

187
CompressionType GetCompressionFlush(const ImmutableCFOptions& ioptions) {
188 189 190 191 192 193
  // 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;

194
  if (ioptions.compaction_style == kCompactionStyleUniversal) {
195
    can_compress =
196
        (ioptions.compaction_options_universal.compression_size_percent < 0);
197 198
  } else {
    // For leveled compress when min_level_to_compress == 0.
199 200
    can_compress = ioptions.compression_per_level.empty() ||
                   ioptions.compression_per_level[0] != kNoCompression;
201 202 203
  }

  if (can_compress) {
204
    return ioptions.compression;
205 206 207 208
  } else {
    return kNoCompression;
  }
}
I
Igor Canadi 已提交
209

210
void DumpSupportInfo(Logger* logger) {
I
Igor Canadi 已提交
211 212 213 214 215 216 217 218
  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());
219 220
  Log(InfoLogLevel::INFO_LEVEL, logger, "Fast CRC32 supported: %d",
      crc32c::IsFastCrc32Supported());
I
Igor Canadi 已提交
221 222
}

223
}  // namespace
224

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

J
jorlow@chromium.org 已提交
268
  // Reserve ten files or so for other uses and give the rest to TableCache.
269
  // Give a large number for setting of "infinite" open files.
270 271
  const int table_cache_size = (db_options_.max_open_files == -1) ?
        4194304 : db_options_.max_open_files - 10;
272
  table_cache_ =
273
      NewLRUCache(table_cache_size, db_options_.table_cache_numshardbits);
274

275
  versions_.reset(new VersionSet(dbname_, &db_options_, env_options_,
276 277
                                 table_cache_.get(), &write_buffer_,
                                 &write_controller_));
I
Igor Canadi 已提交
278 279
  column_family_memtables_.reset(new ColumnFamilyMemTablesImpl(
      versions_->GetColumnFamilySet(), &flush_scheduler_));
280

I
Igor Canadi 已提交
281
  DumpRocksDBBuildVersion(db_options_.info_log.get());
282 283
  DumpDBFileSummary(db_options_, dbname_);
  db_options_.Dump(db_options_.info_log.get());
284
  DumpSupportInfo(db_options_.info_log.get());
J
jorlow@chromium.org 已提交
285 286
}

287
// Will lock the mutex_,  will wait for completion if wait is true
288
void DBImpl::CancelAllBackgroundWork(bool wait) {
289
  InstrumentedMutexLock l(&mutex_);
290
  shutting_down_.store(true, std::memory_order_release);
291
  bg_cv_.SignalAll();
292 293 294 295
  if (!wait) {
    return;
  }
  // Wait for background work to finish
296
  while (bg_compaction_scheduled_ || bg_flush_scheduled_) {
297 298
    bg_cv_.Wait();
  }
299 300
}

J
jorlow@chromium.org 已提交
301
DBImpl::~DBImpl() {
302
  mutex_.Lock();
303

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

334 335 336 337 338 339 340 341 342 343 344 345 346
  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 已提交
347 348 349 350 351
  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();
352 353
  }

I
Igor Canadi 已提交
354 355 356 357 358 359 360 361 362 363
  // 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_) {
364
    JobContext job_context(next_job_id_.fetch_add(1));
I
Igor Canadi 已提交
365
    FindObsoleteFiles(&job_context, true);
366 367

    mutex_.Unlock();
I
Igor Canadi 已提交
368
    // manifest number starting from 2
I
Igor Canadi 已提交
369 370 371
    job_context.manifest_file_number = 1;
    if (job_context.HaveSomethingToDelete()) {
      PurgeObsoleteFiles(job_context);
372
    }
I
Igor Canadi 已提交
373
    job_context.Clean();
374
    mutex_.Lock();
375 376
  }

377 378 379
  for (auto l : logs_to_free_) {
    delete l;
  }
380 381 382
  for (auto& log : logs_) {
    log.ClearWriter();
  }
383
  logs_.clear();
384

385
  // versions need to be destroyed before table_cache since it can hold
386 387
  // references to table_cache.
  versions_.reset();
388
  mutex_.Unlock();
I
Igor Canadi 已提交
389 390 391
  if (db_lock_ != nullptr) {
    env_->UnlockFile(db_lock_);
  }
392

393
  LogFlush(db_options_.info_log);
J
jorlow@chromium.org 已提交
394 395 396
}

Status DBImpl::NewDB() {
397
  VersionEdit new_db;
398
  new_db.SetLogNumber(0);
J
jorlow@chromium.org 已提交
399 400 401
  new_db.SetNextFile(2);
  new_db.SetLastSequence(0);

402 403
  Status s;

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

void DBImpl::MaybeIgnoreError(Status* s) const {
435
  if (s->ok() || db_options_.paranoid_checks) {
J
jorlow@chromium.org 已提交
436 437
    // No change needed
  } else {
438 439
    Log(InfoLogLevel::WARN_LEVEL,
        db_options_.info_log, "Ignoring error %s", s->ToString().c_str());
J
jorlow@chromium.org 已提交
440 441 442 443
    *s = Status::OK();
  }
}

444
const Status DBImpl::CreateArchivalDirectory() {
445 446
  if (db_options_.WAL_ttl_seconds > 0 || db_options_.WAL_size_limit_MB > 0) {
    std::string archivalPath = ArchivalDirectory(db_options_.wal_dir);
447 448 449 450 451
    return env_->CreateDirIfMissing(archivalPath);
  }
  return Status::OK();
}

452
void DBImpl::PrintStatistics() {
453
  auto dbstats = db_options_.statistics.get();
454
  if (dbstats) {
Y
Yueh-Hsuan Chiang 已提交
455
    Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
M
Mark Callaghan 已提交
456
        "STATISTICS:\n %s",
457
        dbstats->ToString().c_str());
458 459 460
  }
}

461
void DBImpl::MaybeDumpStats() {
462
  if (db_options_.stats_dump_period_sec == 0) return;
H
Haobo Xu 已提交
463 464 465 466

  const uint64_t now_micros = env_->NowMicros();

  if (last_stats_dump_time_microsec_ +
467
      db_options_.stats_dump_period_sec * 1000000
H
Haobo Xu 已提交
468 469 470 471 472 473
      <= 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;
474

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

500
    PrintStatistics();
501 502 503
  }
}

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

517
  // if deletion is disabled, do nothing
518
  if (disable_delete_obsolete_files_ > 0) {
519 520 521
    return;
  }

522 523 524 525 526
  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;
527
  } else if (force || db_options_.delete_obsolete_files_period_micros == 0) {
528 529 530
    doing_the_full_scan = true;
  } else {
    const uint64_t now_micros = env_->NowMicros();
I
Igor Canadi 已提交
531
    if (delete_obsolete_files_next_run_ < now_micros) {
532
      doing_the_full_scan = true;
I
Igor Canadi 已提交
533 534
      delete_obsolete_files_next_run_ =
          now_micros + db_options_.delete_obsolete_files_period_micros;
535 536 537
    }
  }

I
Igor Canadi 已提交
538 539
  // don't delete files that might be currently written to from compaction
  // threads
540 541 542
  // 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 已提交
543 544 545 546 547 548 549
  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();
  }

550 551
  // Get obsolete files.  This function will also update the list of
  // pending files in VersionSet().
I
Igor Canadi 已提交
552 553
  versions_->GetObsoleteFiles(&job_context->sst_delete_files,
                              job_context->min_pending_output);
I
Igor Canadi 已提交
554

I
Igor Canadi 已提交
555
  // store the current filenum, lognum, etc
556
  job_context->manifest_file_number = versions_->manifest_file_number();
I
Igor Canadi 已提交
557
  job_context->pending_manifest_file_number =
558
      versions_->pending_manifest_file_number();
I
Igor Canadi 已提交
559
  job_context->log_number = versions_->MinLogNumber();
560
  job_context->prev_log_number = versions_->prev_log_number();
I
Igor Canadi 已提交
561

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

    //Add log files in wal_dir
579
    if (db_options_.wal_dir != dbname_) {
580
      std::vector<std::string> log_files;
581
      env_->GetChildren(db_options_.wal_dir, &log_files);  // Ignore errors
582
      for (std::string log_file : log_files) {
I
Igor Canadi 已提交
583
        job_context->full_scan_candidate_files.emplace_back(log_file, 0);
584 585
      }
    }
586
    // Add info log files in db_log_dir
587
    if (!db_options_.db_log_dir.empty() && db_options_.db_log_dir != dbname_) {
588
      std::vector<std::string> info_log_files;
589 590
      // Ignore errors
      env_->GetChildren(db_options_.db_log_dir, &info_log_files);
591
      for (std::string log_file : info_log_files) {
I
Igor Canadi 已提交
592
        job_context->full_scan_candidate_files.emplace_back(log_file, 0);
593 594
      }
    }
595
  }
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626

  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();
      job_context->log_delete_files.push_back(earliest.number);
      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();
627 628
}

629
namespace {
I
Igor Canadi 已提交
630 631
bool CompareCandidateFile(const JobContext::CandidateFileInfo& first,
                          const JobContext::CandidateFileInfo& second) {
632 633 634 635 636
  if (first.file_name > second.file_name) {
    return true;
  } else if (first.file_name < second.file_name) {
    return false;
  } else {
637
    return (first.path_id > second.path_id);
638 639 640 641
  }
}
};  // namespace

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

I
Igor Canadi 已提交
650 651 652 653
  // 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 已提交
654 655
    return;
  }
656

657
  // Now, convert live list to an unordered map, WITHOUT mutex held;
658
  // set is slow.
659
  std::unordered_map<uint64_t, const FileDescriptor*> sst_live_map;
I
Igor Canadi 已提交
660
  for (const FileDescriptor& fd : state.sst_live) {
661 662
    sst_live_map[fd.GetNumber()] = &fd;
  }
I
Igor Canadi 已提交
663

I
Igor Canadi 已提交
664
  auto candidate_files = state.full_scan_candidate_files;
I
Igor Canadi 已提交
665 666 667
  candidate_files.reserve(candidate_files.size() +
                          state.sst_delete_files.size() +
                          state.log_delete_files.size());
K
kailiu 已提交
668 669
  // We may ignore the dbname when generating the file names.
  const char* kDumbDbName = "";
670
  for (auto file : state.sst_delete_files) {
671 672 673
    candidate_files.emplace_back(
        MakeTableFileName(kDumbDbName, file->fd.GetNumber()),
        file->fd.GetPathId());
674
    delete file;
I
Igor Canadi 已提交
675 676
  }

K
kailiu 已提交
677 678
  for (auto file_num : state.log_delete_files) {
    if (file_num > 0) {
679 680
      candidate_files.emplace_back(LogFileName(kDumbDbName, file_num).substr(1),
                                   0);
I
Igor Canadi 已提交
681 682
    }
  }
683

K
kailiu 已提交
684
  // dedup state.candidate_files so we don't try to delete the same
I
Igor Canadi 已提交
685
  // file twice
686
  sort(candidate_files.begin(), candidate_files.end(), CompareCandidateFile);
687 688
  candidate_files.erase(unique(candidate_files.begin(), candidate_files.end()),
                        candidate_files.end());
J
jorlow@chromium.org 已提交
689

690
  std::vector<std::string> old_info_log_files;
691
  InfoLogPrefix info_log_prefix(!db_options_.db_log_dir.empty(), dbname_);
692 693 694
  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 已提交
695 696 697
    uint64_t number;
    FileType type;
    // Ignore file if we cannot recognize it.
698
    if (!ParseFileName(to_delete, &number, info_log_prefix.prefix, &type)) {
K
kailiu 已提交
699 700
      continue;
    }
J
jorlow@chromium.org 已提交
701

K
kailiu 已提交
702 703 704 705 706 707 708 709
    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'
710
        // (can happen during manifest roll)
K
kailiu 已提交
711 712 713
        keep = (number >= state.manifest_file_number);
        break;
      case kTableFile:
I
Igor Canadi 已提交
714 715 716 717
        // 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 已提交
718 719 720
        break;
      case kTempFile:
        // Any temp files that are currently being written to must
721 722 723 724
        // 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
725
        keep = (sst_live_map.find(number) != sst_live_map.end()) ||
726
               (number == state.pending_manifest_file_number);
K
kailiu 已提交
727 728 729 730
        break;
      case kInfoLogFile:
        keep = true;
        if (number != 0) {
731
          old_info_log_files.push_back(to_delete);
J
jorlow@chromium.org 已提交
732
        }
K
kailiu 已提交
733 734 735 736 737 738 739 740 741 742 743 744 745
        break;
      case kCurrentFile:
      case kDBLockFile:
      case kIdentityFile:
      case kMetaDatabase:
        keep = true;
        break;
    }

    if (keep) {
      continue;
    }

746
    std::string fname;
K
kailiu 已提交
747 748
    if (type == kTableFile) {
      // evict from cache
749
      TableCache::Evict(table_cache_.get(), number);
750
      fname = TableFileName(db_options_.db_paths, number, path_id);
751
    } else {
752 753
      fname = ((type == kLogFile) ?
          db_options_.wal_dir : dbname_) + "/" + to_delete;
K
kailiu 已提交
754
    }
755

756
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
757
    if (type == kLogFile && (db_options_.WAL_ttl_seconds > 0 ||
758
                              db_options_.WAL_size_limit_MB > 0)) {
I
Igor Canadi 已提交
759
      wal_manager_.ArchiveWALFile(fname, number);
760 761 762
      continue;
    }
#endif  // !ROCKSDB_LITE
I
Islam AbdelRahman 已提交
763
    Status file_deletion_status;
764 765
    if (type == kTableFile && path_id == 0) {
      file_deletion_status = DeleteOrMoveToTrash(&db_options_, fname);
I
Islam AbdelRahman 已提交
766 767 768
    } else {
      file_deletion_status = env_->DeleteFile(fname);
    }
769
    if (file_deletion_status.ok()) {
770
      Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
771
          "[JOB %d] Delete %s type=%d #%" PRIu64 " -- %s\n", state.job_id,
772 773
          fname.c_str(), type, number,
          file_deletion_status.ToString().c_str());
774 775 776 777 778 779
    } 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());
780 781 782 783 784 785 786
    } 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) {
787 788 789 790
      EventHelpers::LogAndNotifyTableFileDeletion(
          &event_logger_, state.job_id, number, fname,
          file_deletion_status, GetName(),
          db_options_.listeners);
J
jorlow@chromium.org 已提交
791 792
    }
  }
H
heyongqiang 已提交
793

794
  // Delete old info log files.
795
  size_t old_info_log_file_count = old_info_log_files.size();
796
  if (old_info_log_file_count >= db_options_.keep_log_file_num) {
797
    std::sort(old_info_log_files.begin(), old_info_log_files.end());
798
    size_t end = old_info_log_file_count - db_options_.keep_log_file_num;
799
    for (unsigned int i = 0; i <= end; i++) {
800
      std::string& to_delete = old_info_log_files.at(i);
801 802
      std::string full_path_to_delete = (db_options_.db_log_dir.empty() ?
           dbname_ : db_options_.db_log_dir) + "/" + to_delete;
803
      Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
804
          "[JOB %d] Delete info log file %s\n", state.job_id,
805 806
          full_path_to_delete.c_str());
      Status s = env_->DeleteFile(full_path_to_delete);
807
      if (!s.ok()) {
808 809 810 811 812 813 814 815 816 817
        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());
        }
818
      }
H
heyongqiang 已提交
819 820
    }
  }
I
Igor Canadi 已提交
821 822 823
#ifndef ROCKSDB_LITE
  wal_manager_.PurgeObsoleteWALFiles();
#endif  // ROCKSDB_LITE
824
  LogFlush(db_options_.info_log);
D
Dhruba Borthakur 已提交
825 826 827 828
}

void DBImpl::DeleteObsoleteFiles() {
  mutex_.AssertHeld();
829
  JobContext job_context(next_job_id_.fetch_add(1));
I
Igor Canadi 已提交
830
  FindObsoleteFiles(&job_context, true);
831 832

  mutex_.Unlock();
I
Igor Canadi 已提交
833 834
  if (job_context.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(job_context);
835
  }
I
Igor Canadi 已提交
836
  job_context.Clean();
837
  mutex_.Lock();
838 839
}

840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
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 已提交
856

857 858 859 860 861 862 863 864 865
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_);
866 867 868
    if (!s.ok()) {
      return s;
    }
869
  }
870

871 872 873 874 875 876 877 878
  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);
879 880 881
      if (!s.ok()) {
        return s;
      }
882
      data_dirs_.emplace_back(path_directory.release());
883
    }
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
  }
  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();
903

904 905 906 907 908
  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);
909 910 911 912
    if (!s.ok()) {
      return s;
    }

913
    s = env_->LockFile(LockFileName(dbname_), &db_lock_);
914 915 916
    if (!s.ok()) {
      return s;
    }
J
jorlow@chromium.org 已提交
917

A
agiardullo 已提交
918 919
    s = env_->FileExists(CurrentFileName(dbname_));
    if (s.IsNotFound()) {
920
      if (db_options_.create_if_missing) {
921
        s = NewDB();
922
        is_new_db = true;
923 924 925 926 927 928
        if (!s.ok()) {
          return s;
        }
      } else {
        return Status::InvalidArgument(
            dbname_, "does not exist (create_if_missing is false)");
J
jorlow@chromium.org 已提交
929
      }
A
agiardullo 已提交
930
    } else if (s.ok()) {
931
      if (db_options_.error_if_exists) {
932 933 934
        return Status::InvalidArgument(
            dbname_, "exists (error_if_exists is true)");
      }
A
agiardullo 已提交
935 936 937 938
    } else {
      // Unexpected error reading file
      assert(s.IsIOError());
      return s;
J
jorlow@chromium.org 已提交
939
    }
M
Mayank Agarwal 已提交
940
    // Check for the IDENTITY file and create it if not there
A
agiardullo 已提交
941 942
    s = env_->FileExists(IdentityFileName(dbname_));
    if (s.IsNotFound()) {
M
Mayank Agarwal 已提交
943 944 945 946
      s = SetIdentityFile(env_, dbname_);
      if (!s.ok()) {
        return s;
      }
A
agiardullo 已提交
947 948 949
    } else if (!s.ok()) {
      assert(s.IsIOError());
      return s;
M
Mayank Agarwal 已提交
950
    }
J
jorlow@chromium.org 已提交
951 952
  }

953
  Status s = versions_->Recover(column_families, read_only);
954
  if (db_options_.paranoid_checks && s.ok()) {
I
Igor Canadi 已提交
955 956
    s = CheckConsistency();
  }
J
jorlow@chromium.org 已提交
957
  if (s.ok()) {
A
agiardullo 已提交
958
    SequenceNumber max_sequence(kMaxSequenceNumber);
959 960
    default_cf_handle_ = new ColumnFamilyHandleImpl(
        versions_->GetColumnFamilySet()->GetDefault(), this, &mutex_);
961
    default_cf_internal_stats_ = default_cf_handle_->cfd()->internal_stats();
962 963
    single_column_family_mode_ =
        versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1;
964 965 966 967 968

    // 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).
    //
969
    // Note that prev_log_number() is no longer used, but we pay
970
    // attention to it in case we are recovering a database
971
    // produced by an older version of rocksdb.
972
    const uint64_t min_log = versions_->MinLogNumber();
973
    const uint64_t prev_log = versions_->prev_log_number();
974
    std::vector<std::string> filenames;
975
    s = env_->GetChildren(db_options_.wal_dir, &filenames);
976 977
    if (!s.ok()) {
      return s;
978
    }
K
kailiu 已提交
979

980 981
    std::vector<uint64_t> logs;
    for (size_t i = 0; i < filenames.size(); i++) {
K
kailiu 已提交
982 983
      uint64_t number;
      FileType type;
984 985 986 987 988 989 990 991 992
      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);
        }
993
      }
J
jorlow@chromium.org 已提交
994
    }
995

H
heyongqiang 已提交
996 997 998 999 1000 1001
    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 已提交
1002 1003 1004 1005 1006 1007 1008
    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 已提交
1009 1010
          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
                                 kMaxSequenceNumber);
S
Stanislau Hlebik 已提交
1011 1012
        }
      }
1013
    }
L
Lei Jin 已提交
1014
    SetTickerCount(stats_, SEQUENCE_NUMBER, versions_->LastSequence());
J
jorlow@chromium.org 已提交
1015 1016
  }

L
Lei Jin 已提交
1017 1018
  // Initial value
  max_total_in_memory_state_ = 0;
I
Igor Canadi 已提交
1019
  for (auto cfd : *versions_->GetColumnFamilySet()) {
L
Lei Jin 已提交
1020 1021 1022
    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 已提交
1023 1024
  }

J
jorlow@chromium.org 已提交
1025 1026 1027
  return s;
}

S
Stanislau Hlebik 已提交
1028 1029 1030
// 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 已提交
1031 1032
  struct LogReporter : public log::Reader::Reporter {
    Env* env;
1033
    Logger* info_log;
J
jorlow@chromium.org 已提交
1034
    const char* fname;
1035
    Status* status;  // nullptr if db_options_.paranoid_checks==false
I
Igor Sugak 已提交
1036
    virtual void Corruption(size_t bytes, const Status& s) override {
1037 1038
      Log(InfoLogLevel::WARN_LEVEL,
          info_log, "%s%s: dropping %d bytes; %s",
1039
          (this->status == nullptr ? "(ignoring error) " : ""),
J
jorlow@chromium.org 已提交
1040
          fname, static_cast<int>(bytes), s.ToString().c_str());
K
krad 已提交
1041 1042 1043
      if (this->status != nullptr && this->status->ok()) {
        *this->status = s;
      }
J
jorlow@chromium.org 已提交
1044 1045 1046 1047
    }
  };

  mutex_.AssertHeld();
S
Stanislau Hlebik 已提交
1048
  Status status;
1049
  std::unordered_map<int, VersionEdit> version_edits;
1050
  // no need to refcount because iteration is under mutex
1051 1052
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    VersionEdit edit;
1053 1054
    edit.SetColumnFamily(cfd->GetID());
    version_edits.insert({cfd->GetID(), edit});
1055
  }
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
  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 已提交
1068

K
krad 已提交
1069
  bool continue_replay_log = true;
S
Stanislau Hlebik 已提交
1070 1071 1072 1073
  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.
1074
    versions_->MarkFileNumberUsedDuringRecovery(log_number);
S
Stanislau Hlebik 已提交
1075 1076
    // Open the log file
    std::string fname = LogFileName(db_options_.wal_dir, log_number);
1077 1078 1079 1080
    unique_ptr<SequentialFileReader> file_reader;
    {
      unique_ptr<SequentialFile> file;
      status = env_->NewSequentialFile(fname, &file, env_options_);
S
Stanislau Hlebik 已提交
1081
      if (!status.ok()) {
1082 1083 1084 1085 1086 1087 1088 1089
        MaybeIgnoreError(&status);
        if (!status.ok()) {
          return status;
        } else {
          // Fail with one log file, but that's ok.
          // Try next one.
          continue;
        }
S
Stanislau Hlebik 已提交
1090
      }
1091
      file_reader.reset(new SequentialFileReader(std::move(file)));
J
jorlow@chromium.org 已提交
1092 1093
    }

S
Stanislau Hlebik 已提交
1094 1095 1096 1097 1098
    // Create the log reader.
    LogReporter reporter;
    reporter.env = env_;
    reporter.info_log = db_options_.info_log.get();
    reporter.fname = fname.c_str();
K
krad 已提交
1099 1100 1101 1102 1103 1104 1105
    if (!db_options_.paranoid_checks ||
        db_options_.wal_recovery_mode ==
            WALRecoveryMode::kSkipAnyCorruptedRecords) {
      reporter.status = nullptr;
    } else {
      reporter.status = &status;
    }
S
Stanislau Hlebik 已提交
1106 1107 1108 1109
    // 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).
1110
    log::Reader reader(std::move(file_reader), &reporter, true /*checksum*/,
S
Stanislau Hlebik 已提交
1111
                       0 /*initial_offset*/);
K
krad 已提交
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
    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
    // log
    bool report_eof_inconsistency;
    if (db_options_.wal_recovery_mode ==
        WALRecoveryMode::kAbsoluteConsistency) {
      // in clean shutdown we don't expect any error in the log files
      report_eof_inconsistency = true;
    } else {
      // for other modes ignore only incomplete records in the last log file
      // which is presumably due to write in progress during restart
      report_eof_inconsistency = false;

      // TODO krad: Evaluate if we need to move to a more strict mode where we
      // restrict the inconsistency to only the last log
    }
S
Stanislau Hlebik 已提交
1131 1132 1133 1134 1135

    // Read all the records and add to a memtable
    std::string scratch;
    Slice record;
    WriteBatch batch;
K
krad 已提交
1136 1137 1138 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));
      }
    }

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

      // 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()) {
1166 1167 1168 1169
        // 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 已提交
1170
      }
1171

S
Stanislau Hlebik 已提交
1172 1173
      const SequenceNumber last_seq = WriteBatchInternal::Sequence(&batch) +
                                      WriteBatchInternal::Count(&batch) - 1;
A
agiardullo 已提交
1174
      if ((*max_sequence == kMaxSequenceNumber) || (last_seq > *max_sequence)) {
S
Stanislau Hlebik 已提交
1175 1176 1177 1178
        *max_sequence = last_seq;
      }

      if (!read_only) {
I
Igor Canadi 已提交
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
        // 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;
1191
          status = WriteLevel0TableForRecovery(job_id, cfd, cfd->mem(), edit);
I
Igor Canadi 已提交
1192 1193 1194 1195
          if (!status.ok()) {
            // Reflect errors immediately so that conditions like full
            // file-systems cause the DB::Open() to fail.
            return status;
1196
          }
A
agiardullo 已提交
1197 1198 1199

          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
                                 *max_sequence);
1200
        }
J
jorlow@chromium.org 已提交
1201 1202 1203
      }
    }

1204
    if (!status.ok()) {
K
krad 已提交
1205
      if (db_options_.wal_recovery_mode ==
1206 1207 1208 1209
             WALRecoveryMode::kSkipAnyCorruptedRecords) {
        // We should ignore all errors unconditionally
        status = Status::OK();
      } else if (db_options_.wal_recovery_mode ==
K
krad 已提交
1210 1211 1212 1213 1214 1215 1216 1217
                 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);
1218 1219 1220 1221 1222
      } else {
        assert(db_options_.wal_recovery_mode ==
                  WALRecoveryMode::kTolerateCorruptedTailRecords
               || db_options_.wal_recovery_mode ==
                  WALRecoveryMode::kAbsoluteConsistency);
K
krad 已提交
1223 1224
        return status;
      }
1225 1226
    }

I
Igor Canadi 已提交
1227
    flush_scheduler_.Clear();
A
agiardullo 已提交
1228 1229
    if ((*max_sequence != kMaxSequenceNumber) &&
        (versions_->LastSequence() < *max_sequence)) {
S
Stanislau Hlebik 已提交
1230 1231
      versions_->SetLastSequence(*max_sequence);
    }
1232 1233
  }

1234
  if (!read_only) {
1235 1236
    // 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 已提交
1237
    auto max_log_number = log_numbers.back();
1238
    for (auto cfd : *versions_->GetColumnFamilySet()) {
1239
      auto iter = version_edits.find(cfd->GetID());
1240 1241 1242
      assert(iter != version_edits.end());
      VersionEdit* edit = &iter->second;

S
Stanislau Hlebik 已提交
1243
      if (cfd->GetLogNumber() > max_log_number) {
1244
        // Column family cfd has already flushed the data
S
Stanislau Hlebik 已提交
1245
        // from all logs. Memtable has to be empty because
1246
        // we filter the updates based on log_number
1247
        // (in WriteBatch::InsertInto)
1248 1249 1250 1251 1252 1253 1254
        assert(cfd->mem()->GetFirstSequenceNumber() == 0);
        assert(edit->NumEntries() == 0);
        continue;
      }

      // flush the final memtable (if non-empty)
      if (cfd->mem()->GetFirstSequenceNumber() != 0) {
1255
        status = WriteLevel0TableForRecovery(job_id, cfd, cfd->mem(), edit);
S
Stanislau Hlebik 已提交
1256 1257 1258 1259
        if (!status.ok()) {
          // Recovery failed
          break;
        }
A
agiardullo 已提交
1260 1261 1262

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

1265
      // write MANIFEST with update
S
Stanislau Hlebik 已提交
1266
      // writing log_number in the manifest means that any log file
1267 1268
      // with number strongly less than (log_number + 1) is already
      // recovered and should be ignored on next reincarnation.
S
Stanislau Hlebik 已提交
1269 1270 1271
      // 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);
1272 1273 1274
      // 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 已提交
1275
      // log number
1276
      versions_->MarkFileNumberUsedDuringRecovery(max_log_number + 1);
1277 1278
      status = versions_->LogAndApply(
          cfd, *cfd->GetLatestMutableCFOptions(), edit, &mutex_);
1279
      if (!status.ok()) {
S
Stanislau Hlebik 已提交
1280 1281
        // Recovery failed
        break;
1282 1283
      }
    }
1284
  }
I
Igor Canadi 已提交
1285

1286 1287 1288
  event_logger_.Log() << "job" << job_id << "event"
                      << "recovery_finished";

J
jorlow@chromium.org 已提交
1289 1290 1291
  return status;
}

1292 1293
Status DBImpl::WriteLevel0TableForRecovery(int job_id, ColumnFamilyData* cfd,
                                           MemTable* mem, VersionEdit* edit) {
J
jorlow@chromium.org 已提交
1294
  mutex_.AssertHeld();
1295
  const uint64_t start_micros = env_->NowMicros();
J
jorlow@chromium.org 已提交
1296
  FileMetaData meta;
1297
  meta.fd = FileDescriptor(versions_->NewFileNumber(), 0, 0);
I
Igor Canadi 已提交
1298 1299
  auto pending_outputs_inserted_elem =
      CaptureCurrentFileNumberInPendingOutputs();
1300 1301
  ReadOptions ro;
  ro.total_order_seek = true;
1302
  Arena arena;
1303
  Status s;
1304
  TableProperties table_properties;
1305
  {
1306
    ScopedArenaIterator iter(mem->NewIterator(ro, &arena));
1307 1308 1309
    Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
        "[%s] [WriteLevel0TableForRecovery]"
        " Level-0 table #%" PRIu64 ": started",
1310
        cfd->GetName().c_str(), meta.fd.GetNumber());
1311

1312 1313
    bool paranoid_file_checks =
        cfd->GetLatestMutableCFOptions()->paranoid_file_checks;
1314 1315
    {
      mutex_.Unlock();
1316
      TableFileCreationInfo info;
1317 1318
      s = BuildTable(
          dbname_, env_, *cfd->ioptions(), env_options_, cfd->table_cache(),
1319
          iter.get(), &meta, cfd->internal_comparator(),
I
Igor Canadi 已提交
1320 1321
          cfd->int_tbl_prop_collector_factories(), snapshots_.GetAll(),
          GetCompressionFlush(*cfd->ioptions()),
1322 1323
          cfd->ioptions()->compression_opts, paranoid_file_checks,
          cfd->internal_stats(), Env::IO_HIGH, &info.table_properties);
1324
      LogFlush(db_options_.info_log);
1325 1326 1327 1328 1329 1330 1331 1332
      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()) {
1333 1334 1335 1336 1337 1338 1339 1340 1341
        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);
1342
      }
1343 1344
      mutex_.Lock();
    }
1345
  }
I
Igor Canadi 已提交
1346
  ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);
1347 1348 1349 1350

  // Note that if file_size is zero, the file has been deleted and
  // should not be added to the manifest.
  int level = 0;
1351
  if (s.ok() && meta.fd.GetFileSize() > 0) {
1352 1353
    edit->AddFile(level, meta.fd.GetNumber(), meta.fd.GetPathId(),
                  meta.fd.GetFileSize(), meta.smallest, meta.largest,
1354 1355
                  meta.smallest_seqno, meta.largest_seqno,
                  meta.marked_for_compaction);
1356 1357
  }

L
Lei Jin 已提交
1358
  InternalStats::CompactionStats stats(1);
1359
  stats.micros = env_->NowMicros() - start_micros;
1360
  stats.bytes_written = meta.fd.GetFileSize();
1361
  stats.num_output_files = 1;
1362
  cfd->internal_stats()->AddCompactionStats(level, stats);
1363 1364
  cfd->internal_stats()->AddCFStats(
      InternalStats::BYTES_FLUSHED, meta.fd.GetFileSize());
L
Lei Jin 已提交
1365
  RecordTick(stats_, COMPACT_WRITE_BYTES, meta.fd.GetFileSize());
J
jorlow@chromium.org 已提交
1366 1367 1368
  return s;
}

1369 1370
Status DBImpl::FlushMemTableToOutputFile(
    ColumnFamilyData* cfd, const MutableCFOptions& mutable_cf_options,
1371
    bool* made_progress, JobContext* job_context, LogBuffer* log_buffer) {
1372
  mutex_.AssertHeld();
1373
  assert(cfd->imm()->NumNotFlushed() != 0);
1374
  assert(cfd->imm()->IsFlushPending());
1375

I
Igor Canadi 已提交
1376 1377
  FlushJob flush_job(dbname_, cfd, db_options_, mutable_cf_options,
                     env_options_, versions_.get(), &mutex_, &shutting_down_,
I
Igor Canadi 已提交
1378
                     snapshots_.GetAll(), job_context, log_buffer,
1379
                     directories_.GetDbDir(), directories_.GetDataDir(0U),
I
Igor Canadi 已提交
1380 1381
                     GetCompressionFlush(*cfd->ioptions()), stats_,
                     &event_logger_);
1382

1383
  FileMetaData file_meta;
1384 1385 1386 1387 1388 1389 1390

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

  if (s.ok()) {
I
Igor Canadi 已提交
1394 1395
    InstallSuperVersionAndScheduleWorkWrapper(cfd, job_context,
                                              mutable_cf_options);
1396 1397
    if (made_progress) {
      *made_progress = 1;
1398
    }
S
sdong 已提交
1399
    VersionStorageInfo::LevelSummaryStorage tmp;
I
Igor Canadi 已提交
1400
    LogToBuffer(log_buffer, "[%s] Level summary: %s\n", cfd->GetName().c_str(),
S
sdong 已提交
1401
                cfd->current()->storage_info()->LevelSummary(&tmp));
J
jorlow@chromium.org 已提交
1402
  }
1403

1404
  if (!s.ok() && !s.IsShutdownInProgress() && db_options_.paranoid_checks &&
1405 1406 1407 1408 1409
      bg_error_.ok()) {
    // if a bad error happened (not ShutdownInProgress) and paranoid_checks is
    // true, mark DB read-only
    bg_error_ = s;
  }
1410
  RecordFlushIOStats();
1411 1412 1413
#ifndef ROCKSDB_LITE
  if (s.ok()) {
    // may temporarily unlock and lock the mutex.
1414
    NotifyOnFlushCompleted(cfd, &file_meta, mutable_cf_options,
1415
                           job_context->job_id);
1416 1417
  }
#endif  // ROCKSDB_LITE
J
jorlow@chromium.org 已提交
1418 1419 1420
  return s;
}

1421
void DBImpl::NotifyOnFlushCompleted(
1422
    ColumnFamilyData* cfd, FileMetaData* file_meta,
1423
    const MutableCFOptions& mutable_cf_options, int job_id) {
1424
#ifndef ROCKSDB_LITE
1425
  if (db_options_.listeners.size() == 0U) {
1426 1427
    return;
  }
1428 1429 1430 1431
  mutex_.AssertHeld();
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }
1432
  bool triggered_writes_slowdown =
1433
      (cfd->current()->storage_info()->NumLevelFiles(0) >=
1434
       mutable_cf_options.level0_slowdown_writes_trigger);
1435
  bool triggered_writes_stop =
1436
      (cfd->current()->storage_info()->NumLevelFiles(0) >=
1437
       mutable_cf_options.level0_stop_writes_trigger);
1438 1439
  // release lock while notifying events
  mutex_.Unlock();
1440
  {
1441 1442 1443 1444 1445
    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,
1446
                                       file_meta->fd.GetNumber());
1447
    info.thread_id = env_->GetThreadID();
1448 1449 1450
    info.job_id = job_id;
    info.triggered_writes_slowdown = triggered_writes_slowdown;
    info.triggered_writes_stop = triggered_writes_stop;
1451 1452
    info.smallest_seqno = file_meta->smallest_seqno;
    info.largest_seqno = file_meta->largest_seqno;
1453
    for (auto listener : db_options_.listeners) {
1454
      listener->OnFlushCompleted(this, info);
1455 1456
    }
  }
1457 1458 1459
  mutex_.Lock();
  // no need to signal bg_cv_ as it will be signaled at the end of the
  // flush process.
1460
#endif  // ROCKSDB_LITE
1461 1462
}

1463 1464 1465 1466
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()) {
1467 1468 1469
    return Status::InvalidArgument("Invalid target path ID");
  }

1470 1471
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
I
Igor Canadi 已提交
1472 1473

  Status s = FlushMemTable(cfd, FlushOptions());
L
Lei Jin 已提交
1474
  if (!s.ok()) {
1475
    LogFlush(db_options_.info_log);
L
Lei Jin 已提交
1476 1477 1478
    return s;
  }

I
Igor Canadi 已提交
1479
  int max_level_with_files = 0;
G
Gabor Cselle 已提交
1480
  {
1481
    InstrumentedMutexLock l(&mutex_);
I
Igor Canadi 已提交
1482
    Version* base = cfd->current();
1483 1484
    for (int level = 1; level < base->storage_info()->num_non_empty_levels();
         level++) {
S
sdong 已提交
1485
      if (base->storage_info()->OverlapInLevel(level, begin, end)) {
G
Gabor Cselle 已提交
1486 1487 1488 1489
        max_level_with_files = level;
      }
    }
  }
1490

1491
  int final_output_level = 0;
1492 1493 1494 1495
  if (cfd->ioptions()->compaction_style == kCompactionStyleUniversal &&
      cfd->NumberLevels() > 1) {
    // Always compact all files together.
    s = RunManualCompaction(cfd, ColumnFamilyData::kCompactAllLevels,
1496 1497
                            cfd->NumberLevels() - 1, options.target_path_id,
                            begin, end);
1498
    final_output_level = cfd->NumberLevels() - 1;
1499 1500
  } else {
    for (int level = 0; level <= max_level_with_files; level++) {
1501
      int output_level;
A
Andres Notzli 已提交
1502
      // in case the compaction is universal or if we're compacting the
1503 1504 1505 1506
      // 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 ||
1507 1508 1509
          cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
        output_level = level;
      } else if (level == max_level_with_files && level > 0) {
1510 1511 1512 1513 1514 1515 1516
        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 已提交
1517
                   cfd->ioptions()->compaction_filter_factory == nullptr) {
A
Andres Notzli 已提交
1518 1519
          // Skip bottommost level compaction since we don't have a compaction
          // filter
1520 1521
          continue;
        }
1522
        output_level = level;
1523
      } else {
1524
        output_level = level + 1;
1525 1526 1527 1528 1529
        if (cfd->ioptions()->compaction_style == kCompactionStyleLevel &&
            cfd->ioptions()->level_compaction_dynamic_level_bytes &&
            level == 0) {
          output_level = ColumnFamilyData::kCompactToBaseLevel;
        }
1530
      }
1531 1532
      s = RunManualCompaction(cfd, level, output_level, options.target_path_id,
                              begin, end);
1533 1534 1535
      if (!s.ok()) {
        break;
      }
1536 1537 1538 1539 1540
      if (output_level == ColumnFamilyData::kCompactToBaseLevel) {
        final_output_level = cfd->NumberLevels() - 1;
      } else if (output_level > final_output_level) {
        final_output_level = output_level;
      }
1541 1542
      TEST_SYNC_POINT("DBImpl::RunManualCompaction()::1");
      TEST_SYNC_POINT("DBImpl::RunManualCompaction()::2");
1543
    }
G
Gabor Cselle 已提交
1544
  }
1545 1546 1547 1548
  if (!s.ok()) {
    LogFlush(db_options_.info_log);
    return s;
  }
1549

1550 1551
  if (options.change_level) {
    s = ReFitLevel(cfd, final_output_level, options.target_level);
1552
  }
1553
  LogFlush(db_options_.info_log);
L
Lei Jin 已提交
1554

1555
  {
1556
    InstrumentedMutexLock l(&mutex_);
1557 1558 1559 1560 1561
    // an automatic compaction that has been scheduled might have been
    // preempted by the manual compactions. Need to schedule it back.
    MaybeScheduleFlushOrCompaction();
  }

L
Lei Jin 已提交
1562
  return s;
1563 1564
}

1565 1566 1567 1568 1569
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 已提交
1570 1571 1572 1573
#ifdef ROCKSDB_LITE
    // not supported in lite version
  return Status::NotSupported("Not supported in ROCKSDB LITE");
#else
1574 1575 1576 1577 1578 1579
  if (column_family == nullptr) {
    return Status::InvalidArgument("ColumnFamilyHandle must be non-null.");
  }

  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  assert(cfd);
1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604

  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());
1605
  }  // release the mutex
1606 1607 1608 1609 1610 1611 1612 1613 1614 1615

  // 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()) {
1616
      // no mutex is locked here.  No need to Unlock() and Lock() here.
1617 1618 1619 1620 1621
      PurgeObsoleteFiles(job_context);
    }
    job_context.Clean();
  }

1622
  return s;
I
Igor Canadi 已提交
1623
#endif  // ROCKSDB_LITE
1624 1625
}

I
Igor Canadi 已提交
1626
#ifndef ROCKSDB_LITE
1627 1628 1629
Status DBImpl::CompactFilesImpl(
    const CompactionOptions& compact_options, ColumnFamilyData* cfd,
    Version* version, const std::vector<std::string>& input_file_names,
1630 1631
    const int output_level, int output_path_id, JobContext* job_context,
    LogBuffer* log_buffer) {
1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663
  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;
  }

1664
  std::vector<CompactionInputFiles> input_files;
1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684
  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(
1685 1686
      compact_options, input_files, output_level, version->storage_info(),
      *cfd->GetLatestMutableCFOptions(), output_path_id));
1687 1688 1689
  assert(c);
  c->SetInputVersion(version);
  // deletion compaction currently not allowed in CompactFiles.
1690
  assert(!c->deletion_compaction());
1691

I
Igor Canadi 已提交
1692
  assert(is_snapshot_supported_ || snapshots_.empty());
1693
  CompactionJob compaction_job(
I
Igor Canadi 已提交
1694 1695
      job_context->job_id, c.get(), db_options_, env_options_, versions_.get(),
      &shutting_down_, log_buffer, directories_.GetDbDir(),
S
sdong 已提交
1696
      directories_.GetDataDir(c->output_path_id()), stats_, snapshots_.GetAll(),
1697
      table_cache_, &event_logger_,
1698 1699
      c->mutable_cf_options()->paranoid_file_checks,
      c->mutable_cf_options()->compaction_measure_io_stats, dbname_,
1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712
      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.
1713 1714 1715
  compaction_job.Prepare();

  mutex_.Unlock();
1716
  compaction_job.Run();
1717
  mutex_.Lock();
1718

1719
  Status status = compaction_job.Install(*c->mutable_cf_options(), &mutex_);
1720
  if (status.ok()) {
I
Igor Canadi 已提交
1721 1722
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
1723 1724 1725 1726 1727 1728 1729 1730 1731
  }
  c->ReleaseCompactionFiles(s);
  c.reset();

  if (status.ok()) {
    // Done
  } else if (status.IsShutdownInProgress()) {
    // Ignore compaction errors found during shutting down
  } else {
1732 1733
    Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
        "[%s] [JOB %d] Compaction error: %s",
1734
        c->column_family_data()->GetName().c_str(), job_context->job_id,
1735 1736 1737 1738 1739 1740 1741
        status.ToString().c_str());
    if (db_options_.paranoid_checks && bg_error_.ok()) {
      bg_error_ = status;
    }
  }

  bg_compaction_scheduled_--;
1742 1743 1744
  if (bg_compaction_scheduled_ == 0) {
    bg_cv_.SignalAll();
  }
1745 1746 1747

  return status;
}
I
Igor Canadi 已提交
1748
#endif  // ROCKSDB_LITE
1749

O
Ori Bernstein 已提交
1750
void DBImpl::NotifyOnCompactionCompleted(
1751 1752
    ColumnFamilyData* cfd, Compaction *c, const Status &st,
    const CompactionJobStats& compaction_job_stats,
1753
    const int job_id) {
O
Ori Bernstein 已提交
1754
#ifndef ROCKSDB_LITE
1755
  if (db_options_.listeners.size() == 0U) {
O
Ori Bernstein 已提交
1756 1757 1758 1759 1760 1761 1762 1763
    return;
  }
  mutex_.AssertHeld();
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }
  // release lock while notifying events
  mutex_.Unlock();
1764 1765 1766 1767
  {
    CompactionJobInfo info;
    info.cf_name = cfd->GetName();
    info.status = st;
1768
    info.thread_id = env_->GetThreadID();
1769 1770
    info.job_id = job_id;
    info.base_input_level = c->start_level();
1771
    info.output_level = c->output_level();
1772
    info.stats = compaction_job_stats;
1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790
    for (size_t i = 0; i < c->num_input_levels(); ++i) {
      for (const auto fmd : *c->inputs(i)) {
        info.input_files.push_back(
            TableFileName(db_options_.db_paths,
                          fmd->fd.GetNumber(),
                          fmd->fd.GetPathId()));
      }
    }
    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 已提交
1791 1792 1793 1794 1795 1796
  mutex_.Lock();
  // no need to signal bg_cv_ as it will be signaled at the end of the
  // flush process.
#endif  // ROCKSDB_LITE
}

1797
Status DBImpl::SetOptions(ColumnFamilyHandle* column_family,
1798
    const std::unordered_map<std::string, std::string>& options_map) {
I
Igor Canadi 已提交
1799 1800 1801
#ifdef ROCKSDB_LITE
  return Status::NotSupported("Not supported in ROCKSDB LITE");
#else
L
Lei Jin 已提交
1802 1803
  auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  if (options_map.empty()) {
1804 1805
    Log(InfoLogLevel::WARN_LEVEL,
        db_options_.info_log, "SetOptions() on column family [%s], empty input",
L
Lei Jin 已提交
1806
        cfd->GetName().c_str());
1807
    return Status::InvalidArgument("empty input");
L
Lei Jin 已提交
1808 1809 1810
  }

  MutableCFOptions new_options;
1811
  Status s;
L
Lei Jin 已提交
1812
  {
1813
    InstrumentedMutexLock l(&mutex_);
1814 1815
    s = cfd->SetOptions(options_map);
    if (s.ok()) {
L
Lei Jin 已提交
1816 1817 1818 1819
      new_options = *cfd->GetLatestMutableCFOptions();
    }
  }

1820 1821
  Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
      "SetOptions() on column family [%s], inputs:",
L
Lei Jin 已提交
1822 1823
      cfd->GetName().c_str());
  for (const auto& o : options_map) {
1824 1825
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
        "%s: %s\n", o.first.c_str(), o.second.c_str());
L
Lei Jin 已提交
1826
  }
1827
  if (s.ok()) {
1828 1829
    Log(InfoLogLevel::INFO_LEVEL,
        db_options_.info_log, "[%s] SetOptions succeeded",
L
Lei Jin 已提交
1830 1831 1832
        cfd->GetName().c_str());
    new_options.Dump(db_options_.info_log.get());
  } else {
1833 1834
    Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
        "[%s] SetOptions failed", cfd->GetName().c_str());
L
Lei Jin 已提交
1835
  }
S
sdong 已提交
1836
  LogFlush(db_options_.info_log);
1837
  return s;
I
Igor Canadi 已提交
1838
#endif  // ROCKSDB_LITE
1839 1840
}

1841
// return the same level if it cannot be moved
1842 1843
int DBImpl::FindMinimumEmptyLevelFitting(ColumnFamilyData* cfd,
    const MutableCFOptions& mutable_cf_options, int level) {
1844
  mutex_.AssertHeld();
S
sdong 已提交
1845
  const auto* vstorage = cfd->current()->storage_info();
1846
  int minimum_level = level;
1847
  for (int i = level - 1; i > 0; --i) {
1848
    // stop if level i is not empty
S
sdong 已提交
1849
    if (vstorage->NumLevelFiles(i) > 0) break;
1850
    // stop if level i is too small (cannot fit the level files)
1851
    if (vstorage->MaxBytesForLevel(i) < vstorage->NumLevelBytes(level)) {
1852 1853
      break;
    }
1854 1855 1856 1857 1858 1859

    minimum_level = i;
  }
  return minimum_level;
}

I
Igor Canadi 已提交
1860 1861
Status DBImpl::ReFitLevel(ColumnFamilyData* cfd, int level, int target_level) {
  assert(level < cfd->NumberLevels());
1862 1863 1864
  if (target_level >= cfd->NumberLevels()) {
    return Status::InvalidArgument("Target level exceeds number of levels");
  }
1865

I
Igor Canadi 已提交
1866
  SuperVersion* superversion_to_free = nullptr;
1867
  SuperVersion* new_superversion = new SuperVersion();
I
Igor Canadi 已提交
1868

I
Islam AbdelRahman 已提交
1869
  InstrumentedMutexLock guard_lock(&mutex_);
1870 1871 1872

  // only allow one thread refitting
  if (refitting_level_) {
1873 1874
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
        "[ReFitLevel] another thread is refitting");
I
Igor Canadi 已提交
1875
    delete new_superversion;
L
Lei Jin 已提交
1876
    return Status::NotSupported("another thread is refitting");
1877 1878 1879 1880 1881
  }
  refitting_level_ = true;

  // wait for all background threads to stop
  bg_work_gate_closed_ = true;
1882
  while (bg_compaction_scheduled_ > 0 || bg_flush_scheduled_) {
1883 1884
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
        "[RefitLevel] waiting for background threads to stop: %d %d",
1885
        bg_compaction_scheduled_, bg_flush_scheduled_);
1886 1887 1888
    bg_cv_.Wait();
  }

1889 1890
  const MutableCFOptions mutable_cf_options =
    *cfd->GetLatestMutableCFOptions();
1891
  // move to a smaller level
1892 1893
  int to_level = target_level;
  if (target_level < 0) {
1894
    to_level = FindMinimumEmptyLevelFitting(cfd, mutable_cf_options, level);
1895
  }
1896

L
Lei Jin 已提交
1897
  Status status;
1898 1899 1900
  auto* vstorage = cfd->current()->storage_info();
  if (to_level > level) {
    if (level == 0) {
I
Islam AbdelRahman 已提交
1901
      delete new_superversion;
1902 1903 1904 1905 1906 1907
      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) {
I
Islam AbdelRahman 已提交
1908
        delete new_superversion;
1909 1910 1911 1912 1913 1914
        return Status::NotSupported(
            "Levels between source and target are not empty for a move.");
      }
    }
  }
  if (to_level != level) {
1915 1916
    Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
        "[%s] Before refitting:\n%s",
1917
        cfd->GetName().c_str(), cfd->current()->DebugString().data());
1918

1919
    VersionEdit edit;
I
Igor Canadi 已提交
1920
    edit.SetColumnFamily(cfd->GetID());
1921
    for (const auto& f : vstorage->LevelFiles(level)) {
1922
      edit.DeleteFile(level, f->fd.GetNumber());
1923 1924
      edit.AddFile(to_level, f->fd.GetNumber(), f->fd.GetPathId(),
                   f->fd.GetFileSize(), f->smallest, f->largest,
1925 1926
                   f->smallest_seqno, f->largest_seqno,
                   f->marked_for_compaction);
1927
    }
1928 1929
    Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
        "[%s] Apply version edit:\n%s",
I
Igor Canadi 已提交
1930
        cfd->GetName().c_str(), edit.DebugString().data());
1931

1932 1933
    status = versions_->LogAndApply(cfd, mutable_cf_options, &edit, &mutex_,
                                    directories_.GetDbDir());
I
Igor Canadi 已提交
1934
    superversion_to_free = InstallSuperVersionAndScheduleWork(
L
Lei Jin 已提交
1935
        cfd, new_superversion, mutable_cf_options);
I
Igor Canadi 已提交
1936
    new_superversion = nullptr;
1937

1938 1939
    Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
        "[%s] LogAndApply: %s\n", cfd->GetName().c_str(),
I
Igor Canadi 已提交
1940
        status.ToString().data());
1941 1942

    if (status.ok()) {
1943 1944
      Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
          "[%s] After refitting:\n%s",
I
Igor Canadi 已提交
1945
          cfd->GetName().c_str(), cfd->current()->DebugString().data());
1946 1947 1948 1949 1950
    }
  }

  refitting_level_ = false;
  bg_work_gate_closed_ = false;
I
Igor Canadi 已提交
1951 1952 1953

  delete superversion_to_free;
  delete new_superversion;
L
Lei Jin 已提交
1954
  return status;
G
Gabor Cselle 已提交
1955 1956
}

1957 1958 1959
int DBImpl::NumberLevels(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->NumberLevels();
1960 1961
}

1962
int DBImpl::MaxMemCompactionLevel(ColumnFamilyHandle* column_family) {
1963
  return 0;
1964 1965
}

1966 1967
int DBImpl::Level0StopWriteTrigger(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
1968
  InstrumentedMutexLock l(&mutex_);
L
Lei Jin 已提交
1969 1970
  return cfh->cfd()->GetSuperVersion()->
      mutable_cf_options.level0_stop_writes_trigger;
1971 1972
}

L
Lei Jin 已提交
1973
Status DBImpl::Flush(const FlushOptions& flush_options,
1974 1975
                     ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
L
Lei Jin 已提交
1976
  return FlushMemTable(cfh->cfd(), flush_options);
H
heyongqiang 已提交
1977 1978
}

1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010
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;
2011
      logs_to_sync.push_back(log.writer);
2012 2013 2014 2015 2016
    }

    need_log_dir_sync = !log_dir_synced_;
  }

2017
  RecordTick(stats_, WAL_FILE_SYNCED);
2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048
  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) {
2049
      logs_to_free_.push_back(log.ReleaseWriter());
A
Andres Noetzli 已提交
2050
      it = logs_.erase(it);
2051 2052 2053 2054 2055
    } else {
      log.getting_synced = false;
      ++it;
    }
  }
A
Andres Noetzli 已提交
2056
  assert(logs_.empty() || (logs_.size() == 1 && !logs_[0].getting_synced));
2057 2058 2059
  log_sync_cv_.SignalAll();
}

2060
SequenceNumber DBImpl::GetLatestSequenceNumber() const {
2061 2062 2063
  return versions_->LastSequence();
}

I
Igor Canadi 已提交
2064
Status DBImpl::RunManualCompaction(ColumnFamilyData* cfd, int input_level,
2065
                                   int output_level, uint32_t output_path_id,
2066 2067
                                   const Slice* begin, const Slice* end,
                                   bool disallow_trivial_move) {
2068 2069
  assert(input_level == ColumnFamilyData::kCompactAllLevels ||
         input_level >= 0);
2070

G
Gabor Cselle 已提交
2071 2072
  InternalKey begin_storage, end_storage;

H
hans@chromium.org 已提交
2073
  ManualCompaction manual;
I
Igor Canadi 已提交
2074
  manual.cfd = cfd;
2075 2076
  manual.input_level = input_level;
  manual.output_level = output_level;
2077
  manual.output_path_id = output_path_id;
G
Gabor Cselle 已提交
2078
  manual.done = false;
2079
  manual.in_progress = false;
2080
  manual.disallow_trivial_move = disallow_trivial_move;
2081 2082 2083
  // For universal compaction, we enforce every manual compaction to compact
  // all files.
  if (begin == nullptr ||
2084 2085
      cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
      cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
2086
    manual.begin = nullptr;
G
Gabor Cselle 已提交
2087
  } else {
2088
    begin_storage.SetMaxPossibleForUserKey(*begin);
G
Gabor Cselle 已提交
2089 2090
    manual.begin = &begin_storage;
  }
2091
  if (end == nullptr ||
2092 2093
      cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
      cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
2094
    manual.end = nullptr;
G
Gabor Cselle 已提交
2095
  } else {
2096
    end_storage.SetMinPossibleForUserKey(*end);
G
Gabor Cselle 已提交
2097 2098 2099
    manual.end = &end_storage;
  }

2100
  InstrumentedMutexLock l(&mutex_);
2101

2102 2103 2104 2105 2106 2107
  // 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.
  //
  // bg_manual_only_ is non-zero when at least one thread is inside
2108
  // RunManualCompaction(), i.e. during that time no other compaction will
2109 2110 2111
  // get scheduled (see MaybeScheduleFlushOrCompaction).
  //
  // Note that the following loop doesn't stop more that one thread calling
2112
  // RunManualCompaction() from getting to the second while loop below.
2113 2114 2115 2116 2117
  // However, only one of them will actually schedule compaction, while
  // others will wait on a condition variable until it completes.

  ++bg_manual_only_;
  while (bg_compaction_scheduled_ > 0) {
2118
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
I
Igor Canadi 已提交
2119 2120 2121
        "[%s] Manual compaction waiting for all other scheduled background "
        "compactions to finish",
        cfd->GetName().c_str());
2122 2123
    bg_cv_.Wait();
  }
2124

2125 2126
  Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
      "[%s] Manual compaction starting",
I
Igor Canadi 已提交
2127
      cfd->GetName().c_str());
2128

2129 2130 2131 2132
  // 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) {
2133 2134 2135
    assert(bg_manual_only_ > 0);
    if (manual_compaction_ != nullptr) {
      // Running either this or some other manual compaction
G
Gabor Cselle 已提交
2136
      bg_cv_.Wait();
2137 2138
    } else {
      manual_compaction_ = &manual;
2139
      bg_compaction_scheduled_++;
2140
      env_->Schedule(&DBImpl::BGWorkCompaction, this, Env::Priority::LOW, this);
G
Gabor Cselle 已提交
2141
    }
H
hans@chromium.org 已提交
2142
  }
2143

2144 2145 2146
  assert(!manual.in_progress);
  assert(bg_manual_only_ > 0);
  --bg_manual_only_;
L
Lei Jin 已提交
2147
  return manual.status;
J
jorlow@chromium.org 已提交
2148 2149
}

2150
Status DBImpl::FlushMemTable(ColumnFamilyData* cfd,
L
Lei Jin 已提交
2151
                             const FlushOptions& flush_options) {
S
Stanislau Hlebik 已提交
2152 2153 2154
  Status s;
  {
    WriteContext context;
2155
    InstrumentedMutexLock guard_lock(&mutex_);
2156

2157
    if (cfd->imm()->NumNotFlushed() == 0 && cfd->mem()->IsEmpty()) {
2158 2159 2160 2161
      // Nothing to flush
      return Status::OK();
    }

2162 2163
    WriteThread::Writer w;
    write_thread_.EnterUnbatched(&w, &mutex_);
S
Stanislau Hlebik 已提交
2164

I
Igor Canadi 已提交
2165
    // SwitchMemtable() will release and reacquire mutex
S
Stanislau Hlebik 已提交
2166
    // during execution
I
Igor Canadi 已提交
2167
    s = SwitchMemtable(cfd, &context);
2168
    write_thread_.ExitUnbatched(&w);
2169

S
Stanislau Hlebik 已提交
2170 2171
    cfd->imm()->FlushRequested();

2172 2173 2174
    // schedule flush
    SchedulePendingFlush(cfd);
    MaybeScheduleFlushOrCompaction();
S
Stanislau Hlebik 已提交
2175
  }
S
Stanislau Hlebik 已提交
2176

L
Lei Jin 已提交
2177
  if (s.ok() && flush_options.wait) {
2178
    // Wait until the compaction completes
2179
    s = WaitForFlushMemTable(cfd);
2180 2181
  }
  return s;
J
jorlow@chromium.org 已提交
2182 2183
}

2184
Status DBImpl::WaitForFlushMemTable(ColumnFamilyData* cfd) {
2185 2186
  Status s;
  // Wait until the compaction completes
2187
  InstrumentedMutexLock l(&mutex_);
2188
  while (cfd->imm()->NumNotFlushed() > 0 && bg_error_.ok()) {
2189 2190 2191
    if (shutting_down_.load(std::memory_order_acquire)) {
      return Status::ShutdownInProgress();
    }
2192 2193
    bg_cv_.Wait();
  }
2194
  if (!bg_error_.ok()) {
2195 2196 2197
    s = bg_error_;
  }
  return s;
H
heyongqiang 已提交
2198 2199
}

2200
void DBImpl::MaybeScheduleFlushOrCompaction() {
J
jorlow@chromium.org 已提交
2201
  mutex_.AssertHeld();
2202 2203 2204 2205
  if (!opened_successfully_) {
    // Compaction may introduce data race to DB open
    return;
  }
2206
  if (bg_work_gate_closed_) {
2207 2208
    // gate closed for background work
    return;
I
Igor Canadi 已提交
2209
  } else if (shutting_down_.load(std::memory_order_acquire)) {
J
jorlow@chromium.org 已提交
2210
    // DB is being deleted; no more background compactions
2211 2212
    return;
  }
2213

2214 2215 2216 2217
  while (unscheduled_flushes_ > 0 &&
         bg_flush_scheduled_ < db_options_.max_background_flushes) {
    unscheduled_flushes_--;
    bg_flush_scheduled_++;
2218
    env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::HIGH, this);
2219 2220
  }

2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232
  // 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);
    }
  }

2233 2234 2235 2236 2237 2238
  if (bg_manual_only_) {
    // only manual compactions are allowed to run. don't schedule automatic
    // compactions
    return;
  }

2239 2240 2241 2242
  while (bg_compaction_scheduled_ < db_options_.max_background_compactions &&
         unscheduled_compactions_ > 0) {
    bg_compaction_scheduled_++;
    unscheduled_compactions_--;
2243
    env_->Schedule(&DBImpl::BGWorkCompaction, this, Env::Priority::LOW, this);
2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289
  }
}

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_;
2290 2291 2292
  }
}

2293
void DBImpl::RecordFlushIOStats() {
I
Igor Canadi 已提交
2294
  RecordTick(stats_, FLUSH_WRITE_BYTES, IOSTATS(bytes_written));
2295 2296 2297
  IOSTATS_RESET(bytes_written);
}

2298
void DBImpl::BGWorkFlush(void* db) {
2299
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
2300
  TEST_SYNC_POINT("DBImpl::BGWorkFlush");
2301
  reinterpret_cast<DBImpl*>(db)->BackgroundCallFlush();
2302
  TEST_SYNC_POINT("DBImpl::BGWorkFlush:done");
2303 2304 2305
}

void DBImpl::BGWorkCompaction(void* db) {
2306
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::LOW);
2307
  TEST_SYNC_POINT("DBImpl::BGWorkCompaction");
2308 2309 2310
  reinterpret_cast<DBImpl*>(db)->BackgroundCallCompaction();
}

2311
Status DBImpl::BackgroundFlush(bool* made_progress, JobContext* job_context,
H
Haobo Xu 已提交
2312
                               LogBuffer* log_buffer) {
2313
  mutex_.AssertHeld();
2314

2315 2316 2317 2318 2319 2320 2321
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

  if (!status.ok()) {
    return status;
2322 2323
  }

2324 2325 2326
  ColumnFamilyData* cfd = nullptr;
  while (!flush_queue_.empty()) {
    // This cfd is already referenced
I
Igor Canadi 已提交
2327
    auto first_cfd = PopFirstFromFlushQueue();
2328

I
Igor Canadi 已提交
2329
    if (first_cfd->IsDropped() || !first_cfd->imm()->IsFlushPending()) {
2330
      // can't flush this CF, try next one
I
Igor Canadi 已提交
2331 2332
      if (first_cfd->Unref()) {
        delete first_cfd;
2333 2334
      }
      continue;
2335
    }
2336 2337

    // found a flush!
I
Igor Canadi 已提交
2338
    cfd = first_cfd;
2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351
    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_);
2352
    status = FlushMemTableToOutputFile(cfd, mutable_cf_options, made_progress,
2353 2354 2355
                                       job_context, log_buffer);
    if (cfd->Unref()) {
      delete cfd;
2356
    }
J
jorlow@chromium.org 已提交
2357
  }
2358
  return status;
J
jorlow@chromium.org 已提交
2359 2360
}

2361
void DBImpl::BackgroundCallFlush() {
2362
  bool made_progress = false;
2363
  JobContext job_context(next_job_id_.fetch_add(1), true);
2364 2365
  assert(bg_flush_scheduled_);

2366
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, db_options_.info_log.get());
H
Haobo Xu 已提交
2367
  {
2368
    InstrumentedMutexLock l(&mutex_);
H
Haobo Xu 已提交
2369

I
Igor Canadi 已提交
2370 2371 2372
    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

2373
    Status s = BackgroundFlush(&made_progress, &job_context, &log_buffer);
2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390
    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 已提交
2391 2392
    }

I
Igor Canadi 已提交
2393 2394
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

2395 2396 2397
    // 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 已提交
2398
    // delete unnecessary files if any, this is done outside the mutex
I
Igor Canadi 已提交
2399
    if (job_context.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2400
      mutex_.Unlock();
2401 2402 2403 2404 2405
      // 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 已提交
2406
      log_buffer.FlushBufferToLog();
I
Igor Canadi 已提交
2407 2408
      if (job_context.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(job_context);
2409
      }
I
Igor Canadi 已提交
2410
      job_context.Clean();
2411 2412
      mutex_.Lock();
    }
I
Igor Canadi 已提交
2413

H
Haobo Xu 已提交
2414
    bg_flush_scheduled_--;
2415 2416
    // See if there's more work to be done
    MaybeScheduleFlushOrCompaction();
I
Igor Canadi 已提交
2417
    RecordFlushIOStats();
H
Haobo Xu 已提交
2418
    bg_cv_.SignalAll();
I
Igor Canadi 已提交
2419 2420 2421 2422
    // 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.
2423
  }
J
jorlow@chromium.org 已提交
2424 2425
}

2426
void DBImpl::BackgroundCallCompaction() {
2427
  bool made_progress = false;
2428
  JobContext job_context(next_job_id_.fetch_add(1), true);
H
Haobo Xu 已提交
2429 2430

  MaybeDumpStats();
2431
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, db_options_.info_log.get());
2432
  {
2433
    InstrumentedMutexLock l(&mutex_);
I
Igor Canadi 已提交
2434 2435 2436 2437

    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

2438
    assert(bg_compaction_scheduled_);
2439
    Status s = BackgroundCompaction(&made_progress, &job_context, &log_buffer);
2440 2441 2442 2443 2444 2445
    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 =
2446
          default_cf_internal_stats_->BumpAndGetBackgroundErrorCount();
2447 2448 2449 2450 2451 2452 2453 2454 2455 2456
      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();
2457
    }
H
Haobo Xu 已提交
2458

I
Igor Canadi 已提交
2459 2460
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

2461 2462 2463 2464
    // 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());
2465 2466

    // delete unnecessary files if any, this is done outside the mutex
I
Igor Canadi 已提交
2467
    if (job_context.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2468
      mutex_.Unlock();
2469 2470 2471 2472 2473
      // 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 已提交
2474
      log_buffer.FlushBufferToLog();
I
Igor Canadi 已提交
2475 2476
      if (job_context.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(job_context);
2477
      }
I
Igor Canadi 已提交
2478
      job_context.Clean();
2479 2480
      mutex_.Lock();
    }
D
Dhruba Borthakur 已提交
2481

2482
    bg_compaction_scheduled_--;
J
jorlow@chromium.org 已提交
2483

2484 2485
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();

2486 2487
    // See if there's more work to be done
    MaybeScheduleFlushOrCompaction();
2488
    if (made_progress || bg_compaction_scheduled_ == 0 || bg_manual_only_ > 0) {
2489
      // signal if
2490
      // * made_progress -- need to wakeup DelayWrite
2491 2492 2493 2494 2495 2496
      // * bg_compaction_scheduled_ == 0 -- need to wakeup ~DBImpl
      // * bg_manual_only_ > 0 -- need to wakeup RunManualCompaction
      // If none of this is true, there is no need to signal since nobody is
      // waiting for it
      bg_cv_.SignalAll();
    }
I
Igor Canadi 已提交
2497 2498 2499 2500
    // 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.
2501
  }
J
jorlow@chromium.org 已提交
2502 2503
}

2504 2505
Status DBImpl::BackgroundCompaction(bool* made_progress,
                                    JobContext* job_context,
2506
                                    LogBuffer* log_buffer) {
2507
  *made_progress = false;
J
jorlow@chromium.org 已提交
2508
  mutex_.AssertHeld();
2509

2510 2511
  bool is_manual = (manual_compaction_ != nullptr) &&
                   (manual_compaction_->in_progress == false);
2512 2513
  bool trivial_move_disallowed = is_manual &&
                                 manual_compaction_->disallow_trivial_move;
2514

2515
  CompactionJobStats compaction_job_stats;
2516 2517 2518 2519 2520 2521
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

  if (!status.ok()) {
2522
    if (is_manual) {
2523
      manual_compaction_->status = status;
2524 2525 2526 2527
      manual_compaction_->done = true;
      manual_compaction_->in_progress = false;
      manual_compaction_ = nullptr;
    }
2528
    return status;
2529 2530
  }

2531 2532 2533
  if (is_manual) {
    // another thread cannot pick up the same work
    manual_compaction_->in_progress = true;
2534 2535 2536 2537
  } else if (manual_compaction_ != nullptr) {
    // there should be no automatic compactions running when manual compaction
    // is running
    return Status::OK();
2538 2539 2540
  }

  unique_ptr<Compaction> c;
2541 2542
  InternalKey manual_end_storage;
  InternalKey* manual_end = &manual_end_storage;
H
hans@chromium.org 已提交
2543
  if (is_manual) {
G
Gabor Cselle 已提交
2544
    ManualCompaction* m = manual_compaction_;
2545
    assert(m->in_progress);
2546 2547 2548
    c.reset(m->cfd->CompactRange(
          *m->cfd->GetLatestMutableCFOptions(), m->input_level, m->output_level,
          m->output_path_id, m->begin, m->end, &manual_end));
2549
    if (!c) {
2550
      m->done = true;
2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566
      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)"),
                  ((m->done || manual_end == nullptr)
                       ? "(end)"
                       : manual_end->DebugString().c_str()));
G
Gabor Cselle 已提交
2567
    }
2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599
  } 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();
    }

    // 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 已提交
2600
        // InstallSuperVersionAndScheduleWork
2601
        // 2) When MutableCFOptions changes. This case is also covered by
I
Igor Canadi 已提交
2602 2603
        // InstallSuperVersionAndScheduleWork, because this is when the new
        // options take effect.
2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614
        // 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 已提交
2615
        }
I
Igor Canadi 已提交
2616 2617
      }
    }
J
jorlow@chromium.org 已提交
2618 2619
  }

2620
  if (!c) {
H
hans@chromium.org 已提交
2621
    // Nothing to do
2622
    LogToBuffer(log_buffer, "Compaction nothing to do");
2623
  } else if (c->deletion_compaction()) {
I
Igor Canadi 已提交
2624 2625 2626 2627
    // 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);
2628
    assert(c->column_family_data()->ioptions()->compaction_style ==
I
Igor Canadi 已提交
2629
           kCompactionStyleFIFO);
2630 2631 2632

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

I
Igor Canadi 已提交
2633
    for (const auto& f : *c->inputs(0)) {
2634
      c->edit()->DeleteFile(c->level(), f->fd.GetNumber());
I
Igor Canadi 已提交
2635
    }
2636 2637 2638
    status = versions_->LogAndApply(c->column_family_data(),
                                    *c->mutable_cf_options(), c->edit(),
                                    &mutex_, directories_.GetDbDir());
I
Igor Canadi 已提交
2639 2640
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
I
Igor Canadi 已提交
2641 2642 2643
    LogToBuffer(log_buffer, "[%s] Deleted %d files\n",
                c->column_family_data()->GetName().c_str(),
                c->num_input_files(0));
2644
    *made_progress = true;
2645
  } else if (!trivial_move_disallowed && c->IsTrivialMove()) {
2646
    TEST_SYNC_POINT("DBImpl::BackgroundCompaction:TrivialMove");
2647 2648 2649 2650 2651
    // Instrument for event update
    // TODO(yhchiang): add op details for showing trivial-move.
    ThreadStatusUtil::SetColumnFamily(c->column_family_data());
    ThreadStatusUtil::SetThreadOperation(ThreadStatus::OP_COMPACTION);

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

2654 2655 2656
    // Move files to next level
    int32_t moved_files = 0;
    int64_t moved_bytes = 0;
2657
    for (unsigned int l = 0; l < c->num_input_levels(); l++) {
2658
      if (c->level(l) == c->output_level()) {
2659 2660 2661 2662
        continue;
      }
      for (size_t i = 0; i < c->num_input_files(l); i++) {
        FileMetaData* f = c->input(l, i);
2663
        c->edit()->DeleteFile(c->level(l), f->fd.GetNumber());
2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675
        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();
      }
2676
    }
2677

2678
    status = versions_->LogAndApply(c->column_family_data(),
2679 2680
                                    *c->mutable_cf_options(), c->edit(),
                                    &mutex_, directories_.GetDbDir());
2681
    // Use latest MutableCFOptions
I
Igor Canadi 已提交
2682 2683
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
2684

S
sdong 已提交
2685
    VersionStorageInfo::LevelSummaryStorage tmp;
I
Islam AbdelRahman 已提交
2686
    c->column_family_data()->internal_stats()->IncBytesMoved(c->output_level(),
2687
                                                             moved_bytes);
2688 2689 2690 2691
    {
      event_logger_.LogToBuffer(log_buffer)
          << "job" << job_context->job_id << "event"
          << "trivial_move"
I
Islam AbdelRahman 已提交
2692
          << "destination_level" << c->output_level() << "files" << moved_files
2693
          << "total_files_size" << moved_bytes;
2694
    }
2695 2696
    LogToBuffer(
        log_buffer,
2697
        "[%s] Moved #%d files to level-%d %" PRIu64 " bytes %s: %s\n",
I
Islam AbdelRahman 已提交
2698 2699
        c->column_family_data()->GetName().c_str(), moved_files,
        c->output_level(), moved_bytes, status.ToString().c_str(),
2700
        c->column_family_data()->current()->storage_info()->LevelSummary(&tmp));
2701
    *made_progress = true;
2702 2703 2704

    // Clear Instrument
    ThreadStatusUtil::ResetThreadStatus();
J
jorlow@chromium.org 已提交
2705
  } else {
2706 2707 2708
    int output_level  __attribute__((unused)) = c->output_level();
    TEST_SYNC_POINT_CALLBACK("DBImpl::BackgroundCompaction:NonTrivial",
                             &output_level);
I
Igor Canadi 已提交
2709
    assert(is_snapshot_supported_ || snapshots_.empty());
2710
    CompactionJob compaction_job(
I
Igor Canadi 已提交
2711 2712
        job_context->job_id, c.get(), db_options_, env_options_,
        versions_.get(), &shutting_down_, log_buffer, directories_.GetDbDir(),
2713
        directories_.GetDataDir(c->output_path_id()), stats_,
2714
        snapshots_.GetAll(), table_cache_, &event_logger_,
2715 2716
        c->mutable_cf_options()->paranoid_file_checks,
        c->mutable_cf_options()->compaction_measure_io_stats, dbname_,
S
sdong 已提交
2717
        &compaction_job_stats);
I
Igor Canadi 已提交
2718
    compaction_job.Prepare();
2719

I
Igor Canadi 已提交
2720
    mutex_.Unlock();
2721
    compaction_job.Run();
2722
    TEST_SYNC_POINT("DBImpl::BackgroundCompaction:NonTrivial:AfterRun");
I
Igor Canadi 已提交
2723
    mutex_.Lock();
2724

2725
    status = compaction_job.Install(*c->mutable_cf_options(), &mutex_);
I
Igor Canadi 已提交
2726
    if (status.ok()) {
I
Igor Canadi 已提交
2727 2728
      InstallSuperVersionAndScheduleWorkWrapper(
          c->column_family_data(), job_context, *c->mutable_cf_options());
I
Igor Canadi 已提交
2729
    }
2730
    *made_progress = true;
O
Ori Bernstein 已提交
2731 2732
  }
  if (c != nullptr) {
2733 2734 2735
    NotifyOnCompactionCompleted(
        c->column_family_data(), c.get(), status,
        compaction_job_stats, job_context->job_id);
I
Igor Canadi 已提交
2736
    c->ReleaseCompactionFiles(status);
2737
    *made_progress = true;
J
jorlow@chromium.org 已提交
2738
  }
2739
  // this will unref its input_version and column_family_data
2740
  c.reset();
J
jorlow@chromium.org 已提交
2741 2742 2743

  if (status.ok()) {
    // Done
F
Feng Zhu 已提交
2744
  } else if (status.IsShutdownInProgress()) {
J
jorlow@chromium.org 已提交
2745 2746
    // Ignore compaction errors found during shutting down
  } else {
2747
    Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log, "Compaction error: %s",
2748
        status.ToString().c_str());
2749
    if (db_options_.paranoid_checks && bg_error_.ok()) {
J
jorlow@chromium.org 已提交
2750 2751 2752
      bg_error_ = status;
    }
  }
H
hans@chromium.org 已提交
2753 2754

  if (is_manual) {
G
Gabor Cselle 已提交
2755
    ManualCompaction* m = manual_compaction_;
2756
    if (!status.ok()) {
L
Lei Jin 已提交
2757
      m->status = status;
2758 2759
      m->done = true;
    }
2760 2761 2762 2763 2764 2765 2766 2767 2768
    // 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.
2769 2770 2771 2772 2773
    //
    // 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
    if (manual_end == nullptr) {
2774 2775
      m->done = true;
    }
G
Gabor Cselle 已提交
2776 2777 2778
    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 已提交
2779
      // Universal and FIFO compactions should always compact the whole range
S
sdong 已提交
2780 2781 2782
      assert(m->cfd->ioptions()->compaction_style !=
                 kCompactionStyleUniversal ||
             m->cfd->ioptions()->num_levels > 1);
2783
      assert(m->cfd->ioptions()->compaction_style != kCompactionStyleFIFO);
2784
      m->tmp_storage = *manual_end;
G
Gabor Cselle 已提交
2785 2786
      m->begin = &m->tmp_storage;
    }
2787
    m->in_progress = false; // not being processed anymore
2788
    manual_compaction_ = nullptr;
H
hans@chromium.org 已提交
2789
  }
2790
  return status;
J
jorlow@chromium.org 已提交
2791 2792
}

2793 2794
namespace {
struct IterState {
2795
  IterState(DBImpl* _db, InstrumentedMutex* _mu, SuperVersion* _super_version)
I
Igor Canadi 已提交
2796
      : db(_db), mu(_mu), super_version(_super_version) {}
2797 2798

  DBImpl* db;
2799
  InstrumentedMutex* mu;
2800
  SuperVersion* super_version;
2801 2802 2803 2804
};

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

2806
  if (state->super_version->Unref()) {
2807 2808 2809
    // Job id == 0 means that this is not our background process, but rather
    // user thread
    JobContext job_context(0);
2810

2811 2812
    state->mu->Lock();
    state->super_version->Cleanup();
I
Igor Canadi 已提交
2813
    state->db->FindObsoleteFiles(&job_context, false, true);
2814 2815 2816
    state->mu->Unlock();

    delete state->super_version;
I
Igor Canadi 已提交
2817 2818
    if (job_context.HaveSomethingToDelete()) {
      state->db->PurgeObsoleteFiles(job_context);
2819
    }
I
Igor Canadi 已提交
2820
    job_context.Clean();
I
Igor Canadi 已提交
2821
  }
T
Tomislav Novak 已提交
2822

2823 2824
  delete state;
}
H
Hans Wennborg 已提交
2825
}  // namespace
2826

L
Lei Jin 已提交
2827
Iterator* DBImpl::NewInternalIterator(const ReadOptions& read_options,
2828
                                      ColumnFamilyData* cfd,
2829 2830 2831
                                      SuperVersion* super_version,
                                      Arena* arena) {
  Iterator* internal_iter;
2832 2833 2834 2835 2836
  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 已提交
2837
      super_version->mem->NewIterator(read_options, arena));
2838
  // Collect all needed child iterators for immutable memtables
L
Lei Jin 已提交
2839
  super_version->imm->AddIterators(read_options, &merge_iter_builder);
2840
  // Collect iterators for files in L0 - Ln
L
Lei Jin 已提交
2841
  super_version->current->AddIterators(read_options, env_options_,
2842 2843
                                       &merge_iter_builder);
  internal_iter = merge_iter_builder.Finish();
2844
  IterState* cleanup = new IterState(this, &mutex_, super_version);
2845
  internal_iter->RegisterCleanup(CleanupIteratorState, cleanup, nullptr);
J
jorlow@chromium.org 已提交
2846 2847 2848 2849

  return internal_iter;
}

2850 2851 2852 2853
ColumnFamilyHandle* DBImpl::DefaultColumnFamily() const {
  return default_cf_handle_;
}

L
Lei Jin 已提交
2854
Status DBImpl::Get(const ReadOptions& read_options,
2855
                   ColumnFamilyHandle* column_family, const Slice& key,
J
jorlow@chromium.org 已提交
2856
                   std::string* value) {
L
Lei Jin 已提交
2857
  return GetImpl(read_options, column_family, key, value);
2858 2859
}

I
Igor Canadi 已提交
2860 2861
// JobContext gets created and destructed outside of the lock --
// we
I
Igor Canadi 已提交
2862 2863
// use this convinently to:
// * malloc one SuperVersion() outside of the lock -- new_superversion
2864
// * delete SuperVersion()s outside of the lock -- superversions_to_free
I
Igor Canadi 已提交
2865
//
I
Igor Canadi 已提交
2866 2867 2868
// However, if InstallSuperVersionAndScheduleWork() gets called twice with the
// same job_context, we can't reuse the SuperVersion() that got
// malloced because
I
Igor Canadi 已提交
2869 2870 2871
// 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 已提交
2872
void DBImpl::InstallSuperVersionAndScheduleWorkWrapper(
I
Igor Canadi 已提交
2873
    ColumnFamilyData* cfd, JobContext* job_context,
2874
    const MutableCFOptions& mutable_cf_options) {
2875
  mutex_.AssertHeld();
I
Igor Canadi 已提交
2876
  SuperVersion* old_superversion = InstallSuperVersionAndScheduleWork(
I
Igor Canadi 已提交
2877 2878 2879
      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 已提交
2880 2881
}

I
Igor Canadi 已提交
2882
SuperVersion* DBImpl::InstallSuperVersionAndScheduleWork(
L
Lei Jin 已提交
2883
    ColumnFamilyData* cfd, SuperVersion* new_sv,
I
Igor Canadi 已提交
2884
    const MutableCFOptions& mutable_cf_options) {
L
Lei Jin 已提交
2885
  mutex_.AssertHeld();
2886 2887 2888 2889 2890 2891 2892 2893 2894

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

2898
  // Whenever we install new SuperVersion, we might need to issue new flushes or
I
Igor Canadi 已提交
2899 2900 2901 2902
  // compactions.
  SchedulePendingFlush(cfd);
  SchedulePendingCompaction(cfd);
  MaybeScheduleFlushOrCompaction();
L
Lei Jin 已提交
2903 2904 2905 2906 2907 2908 2909 2910 2911 2912

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

2918 2919 2920
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

2921
  SequenceNumber snapshot;
L
Lei Jin 已提交
2922 2923 2924
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
2925 2926
  } else {
    snapshot = versions_->LastSequence();
J
jorlow@chromium.org 已提交
2927
  }
2928
  // Acquire SuperVersion
2929
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
2930
  // Prepare to store a list of merge operations if merge occurs.
2931
  MergeContext merge_context;
2932

2933
  Status s;
2934
  // First look in the memtable, then in the immutable memtable (if any).
2935
  // s is both in/out. When in, s could either be OK or MergeInProgress.
2936
  // merge_operands will contain the sequence of merges in the latter case.
2937
  LookupKey lkey(key, snapshot);
L
Lei Jin 已提交
2938
  PERF_TIMER_STOP(get_snapshot_time);
2939

2940
  if (sv->mem->Get(lkey, value, &s, &merge_context)) {
2941
    // Done
L
Lei Jin 已提交
2942
    RecordTick(stats_, MEMTABLE_HIT);
2943
  } else if (sv->imm->Get(lkey, value, &s, &merge_context)) {
2944
    // Done
L
Lei Jin 已提交
2945
    RecordTick(stats_, MEMTABLE_HIT);
2946
  } else {
2947
    PERF_TIMER_GUARD(get_from_output_files_time);
L
Lei Jin 已提交
2948 2949
    sv->current->Get(read_options, lkey, value, &s, &merge_context,
                     value_found);
L
Lei Jin 已提交
2950
    RecordTick(stats_, MEMTABLE_MISS);
2951
  }
2952

2953 2954
  {
    PERF_TIMER_GUARD(get_post_process_time);
2955

2956
    ReturnAndCleanupSuperVersion(cfd, sv);
2957

2958 2959 2960
    RecordTick(stats_, NUMBER_KEYS_READ);
    RecordTick(stats_, BYTES_READ, value->size());
  }
2961
  return s;
J
jorlow@chromium.org 已提交
2962 2963
}

2964
std::vector<Status> DBImpl::MultiGet(
L
Lei Jin 已提交
2965
    const ReadOptions& read_options,
2966
    const std::vector<ColumnFamilyHandle*>& column_family,
2967
    const std::vector<Slice>& keys, std::vector<std::string>* values) {
2968

L
Lei Jin 已提交
2969
  StopWatch sw(env_, stats_, DB_MULTIGET);
2970
  PERF_TIMER_GUARD(get_snapshot_time);
K
Kai Liu 已提交
2971

2972
  SequenceNumber snapshot;
2973

2974
  struct MultiGetColumnFamilyData {
I
Igor Canadi 已提交
2975
    ColumnFamilyData* cfd;
2976 2977 2978 2979 2980
    SuperVersion* super_version;
  };
  std::unordered_map<uint32_t, MultiGetColumnFamilyData*> multiget_cf_data;
  // fill up and allocate outside of mutex
  for (auto cf : column_family) {
2981 2982 2983 2984 2985 2986
    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});
2987 2988 2989
    }
  }

2990
  mutex_.Lock();
L
Lei Jin 已提交
2991 2992 2993
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
2994 2995 2996
  } else {
    snapshot = versions_->LastSequence();
  }
2997
  for (auto mgd_iter : multiget_cf_data) {
2998 2999
    mgd_iter.second->super_version =
        mgd_iter.second->cfd->GetSuperVersion()->Ref();
3000
  }
3001
  mutex_.Unlock();
3002

3003 3004
  // Contain a list of merge operations if merge occurs.
  MergeContext merge_context;
3005

3006
  // Note: this always resizes the values array
3007 3008 3009
  size_t num_keys = keys.size();
  std::vector<Status> stat_list(num_keys);
  values->resize(num_keys);
3010 3011

  // Keep track of bytes that we read for statistics-recording later
3012
  uint64_t bytes_read = 0;
L
Lei Jin 已提交
3013
  PERF_TIMER_STOP(get_snapshot_time);
3014 3015 3016 3017

  // 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.
3018
  // merge_operands will contain the sequence of merges in the latter case.
3019
  for (size_t i = 0; i < num_keys; ++i) {
3020
    merge_context.Clear();
3021
    Status& s = stat_list[i];
3022 3023 3024
    std::string* value = &(*values)[i];

    LookupKey lkey(keys[i], snapshot);
3025 3026
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family[i]);
    auto mgd_iter = multiget_cf_data.find(cfh->cfd()->GetID());
3027 3028 3029
    assert(mgd_iter != multiget_cf_data.end());
    auto mgd = mgd_iter->second;
    auto super_version = mgd->super_version;
3030
    if (super_version->mem->Get(lkey, value, &s, &merge_context)) {
3031
      // Done
3032
    } else if (super_version->imm->Get(lkey, value, &s, &merge_context)) {
3033 3034
      // Done
    } else {
3035
      PERF_TIMER_GUARD(get_from_output_files_time);
L
Lei Jin 已提交
3036 3037
      super_version->current->Get(read_options, lkey, value, &s,
                                  &merge_context);
3038 3039 3040
    }

    if (s.ok()) {
3041
      bytes_read += value->size();
3042 3043 3044 3045
    }
  }

  // Post processing (decrement reference counts and record statistics)
3046
  PERF_TIMER_GUARD(get_post_process_time);
3047 3048
  autovector<SuperVersion*> superversions_to_delete;

I
Igor Canadi 已提交
3049
  // TODO(icanadi) do we need lock here or just around Cleanup()?
3050 3051 3052 3053 3054 3055
  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);
3056 3057
    }
  }
3058 3059 3060 3061 3062 3063 3064
  mutex_.Unlock();

  for (auto td : superversions_to_delete) {
    delete td;
  }
  for (auto mgd : multiget_cf_data) {
    delete mgd.second;
3065
  }
3066

L
Lei Jin 已提交
3067 3068 3069
  RecordTick(stats_, NUMBER_MULTIGET_CALLS);
  RecordTick(stats_, NUMBER_MULTIGET_KEYS_READ, num_keys);
  RecordTick(stats_, NUMBER_MULTIGET_BYTES_READ, bytes_read);
L
Lei Jin 已提交
3070
  PERF_TIMER_STOP(get_post_process_time);
3071

3072
  return stat_list;
3073 3074
}

3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289
#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;
  std::unique_ptr<Iterator> iter(table_reader->NewIterator(ReadOptions()));

  // 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 (cfd->NumberLevels() <= 1) {
    return Status::NotSupported(
        "AddFile requires a database with at least 2 levels");
  }
  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_);

    // Make sure memtables are empty
    if (!cfd->mem()->IsEmpty() || cfd->imm()->NumNotFlushed() > 0) {
      // Cannot add the file since the keys in memtable
      // will hide the keys in file
      status = Status::NotSupported("Memtable is not empty");
    }

    // Make sure last sequence number is 0, if there are existing files then
    // they should have sequence number = 0
    if (status.ok() && versions_->LastSequence() > 0) {
      status = Status::NotSupported("Last Sequence number is not zero");
    }

    auto* vstorage = cfd->current()->storage_info();
    if (status.ok()) {
      // Make sure that the key range in the file we will add does not overlap
      // with previously added files
      Slice smallest_user_key = meta.smallest.user_key();
      Slice largest_user_key = meta.largest.user_key();
      for (int level = 0; level < vstorage->num_non_empty_levels(); level++) {
        if (vstorage->OverlapInLevel(level, &smallest_user_key,
                                     &largest_user_key)) {
          status = Status::NotSupported("Cannot add overlapping files");
          break;
        }
      }
    }

    if (status.ok()) {
      // We add the file to the last level
      int target_level = cfd->NumberLevels() - 1;
      if (cfd->ioptions()->level_compaction_dynamic_level_bytes == false) {
        // If we are using dynamic level compaction we add the file to
        // last level with files
        target_level = vstorage->num_non_empty_levels() - 1;
        if (target_level <= 0) {
          target_level = 1;
        }
      }
      VersionEdit edit;
      edit.SetColumnFamily(cfd->GetID());
      edit.AddFile(target_level, meta.fd.GetNumber(), meta.fd.GetPathId(),
                   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 已提交
3290
Status DBImpl::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
3291
                                  const std::string& column_family_name,
3292
                                  ColumnFamilyHandle** handle) {
Y
Yueh-Hsuan Chiang 已提交
3293
  Status s;
I
Igor Canadi 已提交
3294
  *handle = nullptr;
3295 3296 3297 3298 3299 3300

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

Y
Yueh-Hsuan Chiang 已提交
3301
  {
3302
    InstrumentedMutexLock l(&mutex_);
I
Igor Canadi 已提交
3303

Y
Yueh-Hsuan Chiang 已提交
3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317
    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 已提交
3318
    {  // write thread
3319 3320
      WriteThread::Writer w;
      write_thread_.EnterUnbatched(&w, &mutex_);
I
Igor Canadi 已提交
3321 3322 3323 3324
      // LogAndApply will both write the creation in MANIFEST and create
      // ColumnFamilyData object
      s = versions_->LogAndApply(
          nullptr, MutableCFOptions(opt, ImmutableCFOptions(opt)), &edit,
3325
          &mutex_, directories_.GetDbDir(), false, &cf_options);
3326
      write_thread_.ExitUnbatched(&w);
I
Igor Canadi 已提交
3327
    }
Y
Yueh-Hsuan Chiang 已提交
3328 3329 3330 3331 3332
    if (s.ok()) {
      single_column_family_mode_ = false;
      auto* cfd =
          versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name);
      assert(cfd != nullptr);
I
Igor Canadi 已提交
3333
      delete InstallSuperVersionAndScheduleWork(
Y
Yueh-Hsuan Chiang 已提交
3334
          cfd, nullptr, *cfd->GetLatestMutableCFOptions());
S
sdong 已提交
3335 3336 3337 3338 3339

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

Y
Yueh-Hsuan Chiang 已提交
3340 3341 3342 3343 3344 3345 3346 3347 3348
      *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());
    }
3349
  }  // InstrumentedMutexLock l(&mutex_)
Y
Yueh-Hsuan Chiang 已提交
3350 3351

  // this is outside the mutex
3352
  if (s.ok()) {
Y
Yueh-Hsuan Chiang 已提交
3353 3354
    NewThreadStatusCfInfo(
        reinterpret_cast<ColumnFamilyHandleImpl*>(*handle)->cfd());
3355
  }
3356
  return s;
3357 3358
}

3359 3360 3361 3362
Status DBImpl::DropColumnFamily(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
  if (cfd->GetID() == 0) {
3363 3364
    return Status::InvalidArgument("Can't drop default column family");
  }
3365

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

I
Igor Canadi 已提交
3368 3369
  VersionEdit edit;
  edit.DropColumnFamily();
3370 3371
  edit.SetColumnFamily(cfd->GetID());

3372
  Status s;
3373
  {
3374
    InstrumentedMutexLock l(&mutex_);
3375 3376 3377 3378
    if (cfd->IsDropped()) {
      s = Status::InvalidArgument("Column family already dropped!\n");
    }
    if (s.ok()) {
3379
      // we drop column family from a single write thread
3380 3381
      WriteThread::Writer w;
      write_thread_.EnterUnbatched(&w, &mutex_);
3382 3383
      s = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                 &edit, &mutex_);
3384
      write_thread_.ExitUnbatched(&w);
3385
    }
S
sdong 已提交
3386 3387 3388 3389 3390 3391

    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()) {
3392
        if (!c->IsDropped() && !c->mem()->IsSnapshotSupported()) {
S
sdong 已提交
3393 3394 3395 3396 3397 3398
          new_is_snapshot_supported = false;
          break;
        }
      }
      is_snapshot_supported_ = new_is_snapshot_supported;
    }
3399
  }
3400

3401
  if (s.ok()) {
Y
Yueh-Hsuan Chiang 已提交
3402 3403 3404 3405
    // 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 已提交
3406
    assert(cfd->IsDropped());
L
Lei Jin 已提交
3407 3408 3409
    auto* mutable_cf_options = cfd->GetLatestMutableCFOptions();
    max_total_in_memory_state_ -= mutable_cf_options->write_buffer_size *
                                  mutable_cf_options->max_write_buffer_number;
3410 3411
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
        "Dropped column family with id %u\n",
3412
        cfd->GetID());
3413
  } else {
3414
    Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
3415
        "Dropping column family with id %u FAILED -- %s\n",
3416 3417 3418
        cfd->GetID(), s.ToString().c_str());
  }

3419
  return s;
3420 3421
}

L
Lei Jin 已提交
3422
bool DBImpl::KeyMayExist(const ReadOptions& read_options,
3423 3424
                         ColumnFamilyHandle* column_family, const Slice& key,
                         std::string* value, bool* value_found) {
3425
  if (value_found != nullptr) {
K
Kai Liu 已提交
3426 3427
    // falsify later if key-may-exist but can't fetch value
    *value_found = true;
3428
  }
L
Lei Jin 已提交
3429
  ReadOptions roptions = read_options;
3430
  roptions.read_tier = kBlockCacheTier; // read from block cache only
3431
  auto s = GetImpl(roptions, column_family, key, value, value_found);
K
Kai Liu 已提交
3432

3433
  // If block_cache is enabled and the index block of the table didn't
K
Kai Liu 已提交
3434 3435 3436
  // 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();
3437 3438
}

3439
Iterator* DBImpl::NewIterator(const ReadOptions& read_options,
3440 3441 3442
                              ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
T
Tomislav Novak 已提交
3443

V
Venkatesh Radhakrishnan 已提交
3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461
  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 已提交
3462 3463 3464 3465
#ifdef ROCKSDB_LITE
    // not supported in lite version
    return nullptr;
#else
3466 3467
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
    auto iter = new ForwardIterator(this, read_options, cfd, sv);
3468
    return NewDBIterator(env_, *cfd->ioptions(), cfd->user_comparator(), iter,
3469 3470 3471
        kMaxSequenceNumber,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
        read_options.iterate_upper_bound);
I
Igor Canadi 已提交
3472
#endif
T
Tomislav Novak 已提交
3473
  } else {
3474
    SequenceNumber latest_snapshot = versions_->LastSequence();
3475
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
3476

I
Igor Canadi 已提交
3477
    auto snapshot =
3478 3479 3480
        read_options.snapshot != nullptr
            ? reinterpret_cast<const SnapshotImpl*>(
                read_options.snapshot)->number_
I
Igor Canadi 已提交
3481
            : latest_snapshot;
T
Tomislav Novak 已提交
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
    // 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         | <----+
    // |       |   +-------------------+
    // |       |                       |
    // +-------+-----------------------+
    //
3519 3520
    // ArenaWrappedDBIter inlines an arena area where all the iterators in
    // the iterator tree are allocated in the order of being accessed when
3521 3522 3523 3524 3525
    // 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(
3526
        env_, *cfd->ioptions(), cfd->user_comparator(),
3527
        snapshot, sv->mutable_cf_options.max_sequential_skip_in_iterations,
3528
        read_options.iterate_upper_bound);
3529

3530
    Iterator* internal_iter =
3531
        NewInternalIterator(read_options, cfd, sv, db_iter->GetArena());
3532 3533 3534 3535
    db_iter->SetIterUnderDBIter(internal_iter);

    return db_iter;
  }
3536 3537
  // To stop compiler from complaining
  return nullptr;
J
jorlow@chromium.org 已提交
3538 3539
}

3540
Status DBImpl::NewIterators(
3541
    const ReadOptions& read_options,
I
Igor Canadi 已提交
3542
    const std::vector<ColumnFamilyHandle*>& column_families,
3543
    std::vector<Iterator*>* iterators) {
I
Igor Canadi 已提交
3544 3545
  iterators->clear();
  iterators->reserve(column_families.size());
V
Venkatesh Radhakrishnan 已提交
3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565
  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 已提交
3566 3567 3568 3569
#ifdef ROCKSDB_LITE
    return Status::InvalidArgument(
        "Tailing interator not supported in RocksDB lite");
#else
I
Igor Canadi 已提交
3570 3571
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
3572 3573
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
      auto iter = new ForwardIterator(this, read_options, cfd, sv);
L
Lei Jin 已提交
3574
      iterators->push_back(
3575
          NewDBIterator(env_, *cfd->ioptions(), cfd->user_comparator(), iter,
3576 3577
              kMaxSequenceNumber,
              sv->mutable_cf_options.max_sequential_skip_in_iterations));
I
Igor Canadi 已提交
3578
    }
I
Igor Canadi 已提交
3579
#endif
I
Igor Canadi 已提交
3580
  } else {
3581 3582
    SequenceNumber latest_snapshot = versions_->LastSequence();

I
Igor Canadi 已提交
3583
    for (size_t i = 0; i < column_families.size(); ++i) {
3584 3585 3586
      auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(
          column_families[i])->cfd();
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
I
Igor Canadi 已提交
3587 3588

      auto snapshot =
3589 3590 3591
          read_options.snapshot != nullptr
              ? reinterpret_cast<const SnapshotImpl*>(
                  read_options.snapshot)->number_
I
Igor Canadi 已提交
3592 3593
              : latest_snapshot;

3594
      ArenaWrappedDBIter* db_iter = NewArenaWrappedDbIterator(
3595
          env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
3596
          sv->mutable_cf_options.max_sequential_skip_in_iterations);
3597
      Iterator* internal_iter = NewInternalIterator(
3598
          read_options, cfd, sv, db_iter->GetArena());
3599 3600
      db_iter->SetIterUnderDBIter(internal_iter);
      iterators->push_back(db_iter);
I
Igor Canadi 已提交
3601 3602 3603 3604
    }
  }

  return Status::OK();
3605 3606
}

J
jorlow@chromium.org 已提交
3607
const Snapshot* DBImpl::GetSnapshot() {
3608 3609
  int64_t unix_time = 0;
  env_->GetCurrentTime(&unix_time);  // Ignore error
3610
  SnapshotImpl* s = new SnapshotImpl;
3611

3612
  InstrumentedMutexLock l(&mutex_);
3613
  // returns null if the underlying memtable does not support snapshot.
3614 3615 3616 3617 3618
  if (!is_snapshot_supported_) {
    delete s;
    return nullptr;
  }
  return snapshots_.New(s, versions_->LastSequence(), unix_time);
J
jorlow@chromium.org 已提交
3619 3620 3621
}

void DBImpl::ReleaseSnapshot(const Snapshot* s) {
3622 3623 3624 3625 3626 3627
  const SnapshotImpl* casted_s = reinterpret_cast<const SnapshotImpl*>(s);
  {
    InstrumentedMutexLock l(&mutex_);
    snapshots_.Delete(casted_s);
  }
  delete casted_s;
J
jorlow@chromium.org 已提交
3628 3629 3630
}

// Convenience methods
3631 3632
Status DBImpl::Put(const WriteOptions& o, ColumnFamilyHandle* column_family,
                   const Slice& key, const Slice& val) {
3633
  return DB::Put(o, column_family, key, val);
J
jorlow@chromium.org 已提交
3634 3635
}

3636 3637 3638
Status DBImpl::Merge(const WriteOptions& o, ColumnFamilyHandle* column_family,
                     const Slice& key, const Slice& val) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
3639
  if (!cfh->cfd()->ioptions()->merge_operator) {
3640 3641
    return Status::NotSupported("Provide a merge_operator when opening DB");
  } else {
3642
    return DB::Merge(o, column_family, key, val);
3643 3644 3645
  }
}

L
Lei Jin 已提交
3646
Status DBImpl::Delete(const WriteOptions& write_options,
3647
                      ColumnFamilyHandle* column_family, const Slice& key) {
L
Lei Jin 已提交
3648
  return DB::Delete(write_options, column_family, key);
J
jorlow@chromium.org 已提交
3649 3650
}

A
Andres Noetzli 已提交
3651 3652 3653 3654 3655 3656
Status DBImpl::SingleDelete(const WriteOptions& write_options,
                            ColumnFamilyHandle* column_family,
                            const Slice& key) {
  return DB::SingleDelete(write_options, column_family, key);
}

L
Lei Jin 已提交
3657
Status DBImpl::Write(const WriteOptions& write_options, WriteBatch* my_batch) {
A
agiardullo 已提交
3658 3659 3660
  return WriteImpl(write_options, my_batch, nullptr);
}

A
agiardullo 已提交
3661
#ifndef ROCKSDB_LITE
A
agiardullo 已提交
3662 3663 3664 3665 3666
Status DBImpl::WriteWithCallback(const WriteOptions& write_options,
                                 WriteBatch* my_batch,
                                 WriteCallback* callback) {
  return WriteImpl(write_options, my_batch, callback);
}
A
agiardullo 已提交
3667
#endif  // ROCKSDB_LITE
A
agiardullo 已提交
3668 3669 3670

Status DBImpl::WriteImpl(const WriteOptions& write_options,
                         WriteBatch* my_batch, WriteCallback* callback) {
S
Stanislau Hlebik 已提交
3671 3672 3673
  if (my_batch == nullptr) {
    return Status::Corruption("Batch is nullptr!");
  }
3674 3675 3676
  if (write_options.timeout_hint_us != 0) {
    return Status::InvalidArgument("timeout_hint_us is deprecated");
  }
A
agiardullo 已提交
3677 3678

  Status status;
A
agiardullo 已提交
3679 3680
  bool callback_failed = false;

A
agiardullo 已提交
3681 3682 3683 3684 3685 3686 3687 3688 3689 3690
  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;
  }

3691
  PERF_TIMER_GUARD(write_pre_and_post_process_time);
3692
  WriteThread::Writer w;
S
Stanislau Hlebik 已提交
3693
  w.batch = my_batch;
L
Lei Jin 已提交
3694 3695
  w.sync = write_options.sync;
  w.disableWAL = write_options.disableWAL;
S
Stanislau Hlebik 已提交
3696 3697
  w.in_batch_group = false;
  w.done = false;
A
agiardullo 已提交
3698
  w.has_callback = (callback != nullptr) ? true : false;
S
Stanislau Hlebik 已提交
3699

L
Lei Jin 已提交
3700
  if (!write_options.disableWAL) {
S
Stanislau Hlebik 已提交
3701 3702 3703
    RecordTick(stats_, WRITE_WITH_WAL);
  }

3704 3705
  StopWatch write_sw(env_, db_options_.statistics.get(), DB_WRITE);

3706 3707 3708 3709 3710 3711 3712 3713
  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 已提交
3714 3715
  WriteContext context;
  mutex_.Lock();
I
Igor Canadi 已提交
3716 3717 3718 3719 3720

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

S
Stanislau Hlebik 已提交
3721 3722
  RecordTick(stats_, WRITE_DONE_BY_SELF);
  default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_DONE_BY_SELF, 1);
3723

3724 3725 3726 3727
  // 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.
3728 3729 3730
  assert(!single_column_family_mode_ ||
         versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1);

3731
  uint64_t max_total_wal_size = (db_options_.max_total_wal_size == 0)
3732
                                    ? 4 * max_total_in_memory_state_
3733
                                    : db_options_.max_total_wal_size;
3734
  if (UNLIKELY(!single_column_family_mode_) &&
3735
      alive_log_files_.begin()->getting_flushed == false &&
I
Igor Canadi 已提交
3736
      total_log_size_ > max_total_wal_size) {
I
Igor Canadi 已提交
3737
    uint64_t flush_column_family_if_log_file = alive_log_files_.begin()->number;
I
Igor Canadi 已提交
3738
    alive_log_files_.begin()->getting_flushed = true;
3739
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
3740 3741 3742
        "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 已提交
3743 3744
    // no need to refcount because drop is happening in write thread, so can't
    // happen while we're in the write thread
3745
    for (auto cfd : *versions_->GetColumnFamilySet()) {
3746 3747 3748
      if (cfd->IsDropped()) {
        continue;
      }
I
Igor Canadi 已提交
3749
      if (cfd->GetLogNumber() <= flush_column_family_if_log_file) {
I
Igor Canadi 已提交
3750
        status = SwitchMemtable(cfd, &context);
I
Igor Canadi 已提交
3751 3752 3753
        if (!status.ok()) {
          break;
        }
S
Stanislau Hlebik 已提交
3754
        cfd->imm()->FlushRequested();
3755
        SchedulePendingFlush(cfd);
3756
      }
3757
    }
I
Igor Canadi 已提交
3758
    MaybeScheduleFlushOrCompaction();
3759 3760 3761 3762 3763 3764 3765 3766
  } else if (UNLIKELY(write_buffer_.ShouldFlush())) {
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
        "Flushing all column families. Write buffer is using %" PRIu64
        " bytes out of a total of %" PRIu64 ".",
        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
    for (auto cfd : *versions_->GetColumnFamilySet()) {
3767 3768 3769
      if (cfd->IsDropped()) {
        continue;
      }
3770
      if (!cfd->mem()->IsEmpty()) {
I
Igor Canadi 已提交
3771
        status = SwitchMemtable(cfd, &context);
3772 3773 3774 3775
        if (!status.ok()) {
          break;
        }
        cfd->imm()->FlushRequested();
3776
        SchedulePendingFlush(cfd);
3777 3778 3779
      }
    }
    MaybeScheduleFlushOrCompaction();
I
Igor Canadi 已提交
3780 3781 3782 3783 3784 3785 3786 3787 3788 3789
  }

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

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

S
sdong 已提交
3790 3791
  if (UNLIKELY(status.ok()) &&
      (write_controller_.IsStopped() || write_controller_.NeedsDelay())) {
3792 3793
    PERF_TIMER_STOP(write_pre_and_post_process_time);
    PERF_TIMER_GUARD(write_delay_time);
S
sdong 已提交
3794 3795 3796 3797
    // 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.
3798
    status = DelayWrite(last_batch_group_size_);
3799
    PERF_TIMER_START(write_pre_and_post_process_time);
I
Igor Canadi 已提交
3800 3801
  }

D
dgrogan@chromium.org 已提交
3802
  uint64_t last_sequence = versions_->LastSequence();
I
Igor Canadi 已提交
3803
  WriteThread::Writer* last_writer = &w;
A
agiardullo 已提交
3804
  autovector<WriteBatch*> write_batch_group;
3805 3806
  bool need_log_sync = !write_options.disableWAL && write_options.sync;
  bool need_log_dir_sync = need_log_sync && !log_dir_synced_;
A
agiardullo 已提交
3807

S
Stanislau Hlebik 已提交
3808
  if (status.ok()) {
3809 3810
    last_batch_group_size_ = write_thread_.EnterAsBatchGroupLeader(
        &w, &last_writer, &write_batch_group);
3811

3812
    if (need_log_sync) {
3813 3814 3815 3816 3817 3818 3819 3820 3821
      while (logs_.front().getting_synced) {
        log_sync_cv_.Wait();
      }
      for (auto& log : logs_) {
        assert(!log.getting_synced);
        log.getting_synced = true;
      }
    }

3822 3823 3824
    // 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
3825
    // into memtables
A
agiardullo 已提交
3826 3827 3828 3829 3830 3831 3832

    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 已提交
3833
      callback_failed = true;
A
agiardullo 已提交
3834 3835 3836 3837 3838 3839 3840 3841
    }
  } else {
    mutex_.Unlock();
  }

  // At this point the mutex is unlocked

  if (status.ok()) {
3842 3843 3844 3845 3846 3847 3848 3849 3850 3851
      WriteBatch* updates = nullptr;
      if (write_batch_group.size() == 1) {
        updates = write_batch_group[0];
      } else {
        updates = &tmp_batch_;
        for (size_t i = 0; i < write_batch_group.size(); ++i) {
          WriteBatchInternal::Append(updates, write_batch_group[i]);
        }
      }

3852 3853 3854 3855
      const SequenceNumber current_sequence = last_sequence + 1;
      WriteBatchInternal::SetSequence(updates, current_sequence);
      int my_batch_count = WriteBatchInternal::Count(updates);
      last_sequence += my_batch_count;
3856
      const uint64_t batch_size = WriteBatchInternal::ByteSize(updates);
3857
      // Record statistics
L
Lei Jin 已提交
3858
      RecordTick(stats_, NUMBER_KEYS_WRITTEN, my_batch_count);
S
sdong 已提交
3859
      RecordTick(stats_, BYTES_WRITTEN, batch_size);
L
Lei Jin 已提交
3860
      if (write_options.disableWAL) {
3861
        flush_on_destroy_ = true;
3862
      }
L
Lei Jin 已提交
3863
      PERF_TIMER_STOP(write_pre_and_post_process_time);
3864

3865
      uint64_t log_size = 0;
L
Lei Jin 已提交
3866
      if (!write_options.disableWAL) {
3867
        PERF_TIMER_GUARD(write_wal_time);
3868
        Slice log_entry = WriteBatchInternal::Contents(updates);
3869
        status = logs_.back().writer->AddRecord(log_entry);
I
Igor Canadi 已提交
3870 3871
        total_log_size_ += log_entry.size();
        alive_log_files_.back().AddSize(log_entry.size());
3872
        log_empty_ = false;
3873
        log_size = log_entry.size();
L
Lei Jin 已提交
3874
        RecordTick(stats_, WAL_FILE_BYTES, log_size);
3875
        if (status.ok() && need_log_sync) {
I
Igor Canadi 已提交
3876
          RecordTick(stats_, WAL_FILE_SYNCED);
3877
          StopWatch sw(env_, stats_, WAL_FILE_SYNC_MICROS);
3878 3879 3880 3881 3882 3883 3884 3885
          // 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_) {
3886
            status = log.writer->file()->Sync(db_options_.use_fsync);
3887 3888 3889 3890
            if (!status.ok()) {
              break;
            }
          }
3891
          if (status.ok() && need_log_dir_sync) {
3892 3893 3894 3895 3896
            // 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 已提交
3897
        }
3898 3899
      }
      if (status.ok()) {
3900
        PERF_TIMER_GUARD(write_memtable_time);
Y
Yueh-Hsuan Chiang 已提交
3901

3902
        status = WriteBatchInternal::InsertInto(
I
Igor Canadi 已提交
3903
            updates, column_family_memtables_.get(),
L
Lei Jin 已提交
3904
            write_options.ignore_missing_column_families, 0, this, false);
Y
Yueh-Hsuan Chiang 已提交
3905 3906 3907 3908 3909 3910 3911 3912
        // A non-OK status here indicates iteration failure (either in-memory
        // writebatch corruption (very bad), or the client specified invalid
        // column family).  This will later on trigger bg_error_.
        //
        // Note that existing logic was not sound. Any partial failure writing
        // into the memtable would result in a state that some write ops might
        // have succeeded in memtable but Status reports error for all writes.

L
Lei Jin 已提交
3913
        SetTickerCount(stats_, SEQUENCE_NUMBER, last_sequence);
3914
      }
L
Lei Jin 已提交
3915
      PERF_TIMER_START(write_pre_and_post_process_time);
3916 3917 3918
      if (updates == &tmp_batch_) {
        tmp_batch_.Clear();
      }
3919
      mutex_.Lock();
A
agiardullo 已提交
3920

3921 3922 3923
      // internal stats
      default_cf_internal_stats_->AddDBStats(
          InternalStats::BYTES_WRITTEN, batch_size);
S
sdong 已提交
3924 3925
      default_cf_internal_stats_->AddDBStats(InternalStats::NUMBER_KEYS_WRITTEN,
                                             my_batch_count);
L
Lei Jin 已提交
3926
      if (!write_options.disableWAL) {
3927 3928 3929 3930
        if (write_options.sync) {
          default_cf_internal_stats_->AddDBStats(InternalStats::WAL_FILE_SYNCED,
                                                 1);
        }
3931 3932 3933
        default_cf_internal_stats_->AddDBStats(
            InternalStats::WAL_FILE_BYTES, log_size);
      }
3934
      if (status.ok()) {
3935
        versions_->SetLastSequence(last_sequence);
3936
      }
A
agiardullo 已提交
3937 3938 3939
  } else {
    // Operation failed.  Make sure sure mutex is held for cleanup code below.
    mutex_.Lock();
3940
  }
A
agiardullo 已提交
3941

A
agiardullo 已提交
3942
  if (db_options_.paranoid_checks && !status.ok() && !callback_failed &&
3943
      !status.IsBusy() && bg_error_.ok()) {
I
Igor Canadi 已提交
3944 3945
    bg_error_ = status; // stop compaction & fail any further writes
  }
3946

A
agiardullo 已提交
3947
  mutex_.AssertHeld();
3948

3949 3950
  if (need_log_sync) {
    MarkLogsSynced(logfile_number_, need_log_dir_sync, status);
3951 3952
  }

3953 3954 3955 3956 3957 3958 3959 3960 3961
  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);
    }
  }
3962

I
Igor Canadi 已提交
3963
  mutex_.Unlock();
3964

3965 3966
  write_thread_.ExitAsBatchGroupLeader(&w, last_writer, status);

J
jorlow@chromium.org 已提交
3967 3968 3969
  return status;
}

3970 3971
// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
3972
Status DBImpl::DelayWrite(uint64_t num_bytes) {
S
sdong 已提交
3973 3974 3975 3976
  uint64_t time_delayed = 0;
  bool delayed = false;
  {
    StopWatch sw(env_, stats_, WRITE_STALL, &time_delayed);
S
sdong 已提交
3977 3978
    auto delay = write_controller_.GetDelay(env_, num_bytes);
    if (delay > 0) {
S
sdong 已提交
3979 3980
      mutex_.Unlock();
      delayed = true;
S
sdong 已提交
3981
      TEST_SYNC_POINT("DBImpl::DelayWrite:Sleep");
3982 3983
      // hopefully we don't have to sleep more than 2 billion microseconds
      env_->SleepForMicroseconds(static_cast<int>(delay));
S
sdong 已提交
3984 3985
      mutex_.Lock();
    }
3986

3987
    while (bg_error_.ok() && write_controller_.IsStopped()) {
S
sdong 已提交
3988
      delayed = true;
3989 3990
      TEST_SYNC_POINT("DBImpl::DelayWrite:Wait");
      bg_cv_.Wait();
3991 3992
    }
  }
S
sdong 已提交
3993 3994 3995 3996 3997
  if (delayed) {
    default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_STALL_MICROS,
                                           time_delayed);
    RecordTick(stats_, STALL_MICROS, time_delayed);
  }
I
Igor Canadi 已提交
3998 3999

  return bg_error_;
4000 4001
}

I
Igor Canadi 已提交
4002 4003 4004
Status DBImpl::ScheduleFlushes(WriteContext* context) {
  ColumnFamilyData* cfd;
  while ((cfd = flush_scheduler_.GetNextColumnFamily()) != nullptr) {
I
Igor Canadi 已提交
4005
    auto status = SwitchMemtable(cfd, context);
I
Igor Canadi 已提交
4006 4007 4008 4009 4010
    if (cfd->Unref()) {
      delete cfd;
    }
    if (!status.ok()) {
      return status;
S
Stanislau Hlebik 已提交
4011 4012
    }
  }
I
Igor Canadi 已提交
4013
  return Status::OK();
S
Stanislau Hlebik 已提交
4014 4015 4016 4017
}

// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
I
Igor Canadi 已提交
4018
Status DBImpl::SwitchMemtable(ColumnFamilyData* cfd, WriteContext* context) {
S
Stanislau Hlebik 已提交
4019 4020 4021 4022 4023 4024 4025
  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.
4026
  assert(versions_->prev_log_number() == 0);
S
Stanislau Hlebik 已提交
4027 4028 4029 4030
  bool creating_new_log = !log_empty_;
  uint64_t new_log_number =
      creating_new_log ? versions_->NewFileNumber() : logfile_number_;
  SuperVersion* new_superversion = nullptr;
4031
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
S
Stanislau Hlebik 已提交
4032 4033 4034 4035
  mutex_.Unlock();
  Status s;
  {
    if (creating_new_log) {
4036 4037
      EnvOptions opt_env_opt =
          env_->OptimizeForLogWrite(env_options_, db_options_);
4038
      s = env_->NewWritableFile(
4039
          LogFileName(db_options_.wal_dir, new_log_number), &lfile,
4040
          opt_env_opt);
S
Stanislau Hlebik 已提交
4041 4042 4043
      if (s.ok()) {
        // Our final size should be less than write_buffer_size
        // (compression, etc) but err on the side of caution.
L
Lei Jin 已提交
4044 4045
        lfile->SetPreallocationBlockSize(
            1.1 * mutable_cf_options.write_buffer_size);
4046 4047 4048
        unique_ptr<WritableFileWriter> file_writer(
            new WritableFileWriter(std::move(lfile), opt_env_opt));
        new_log = new log::Writer(std::move(file_writer));
I
Igor Canadi 已提交
4049
      }
S
Stanislau Hlebik 已提交
4050 4051 4052
    }

    if (s.ok()) {
A
agiardullo 已提交
4053 4054
      SequenceNumber seq = versions_->LastSequence();
      new_mem = cfd->ConstructNewMemtable(mutable_cf_options, seq);
S
Stanislau Hlebik 已提交
4055 4056 4057
      new_superversion = new SuperVersion();
    }
  }
4058
  Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
I
Igor Canadi 已提交
4059 4060
      "[%s] New memtable created with log file: #%" PRIu64 "\n",
      cfd->GetName().c_str(), new_log_number);
S
Stanislau Hlebik 已提交
4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072
  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;
4073
    log_dir_synced_ = false;
4074
    logs_.emplace_back(logfile_number_, new_log);
S
Stanislau Hlebik 已提交
4075
    alive_log_files_.push_back(LogFileNumberSize(logfile_number_));
I
Igor Canadi 已提交
4076
    for (auto loop_cfd : *versions_->GetColumnFamilySet()) {
S
Stanislau Hlebik 已提交
4077 4078 4079 4080
      // 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 已提交
4081
      if (loop_cfd->mem()->GetFirstSequenceNumber() == 0 &&
4082
          loop_cfd->imm()->NumNotFlushed() == 0) {
I
Igor Canadi 已提交
4083
        loop_cfd->SetLogNumber(logfile_number_);
4084
      }
4085 4086
    }
  }
S
Stanislau Hlebik 已提交
4087
  cfd->mem()->SetNextLogNumber(logfile_number_);
4088
  cfd->imm()->Add(cfd->mem(), &context->memtables_to_free_);
S
Stanislau Hlebik 已提交
4089 4090
  new_mem->Ref();
  cfd->SetMemtable(new_mem);
I
Igor Canadi 已提交
4091 4092
  context->superversions_to_free_.push_back(InstallSuperVersionAndScheduleWork(
      cfd, new_superversion, mutable_cf_options));
4093 4094 4095
  return s;
}

I
Igor Canadi 已提交
4096
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
4097 4098 4099 4100 4101
Status DBImpl::GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                        TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

4102 4103
  // Increment the ref count
  mutex_.Lock();
I
Igor Canadi 已提交
4104
  auto version = cfd->current();
4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfAllTables(props);

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

  return s;
}
I
Igor Canadi 已提交
4117
#endif  // ROCKSDB_LITE
4118

I
Igor Canadi 已提交
4119 4120 4121 4122
const std::string& DBImpl::GetName() const {
  return dbname_;
}

4123 4124 4125 4126
Env* DBImpl::GetEnv() const {
  return env_;
}

4127 4128
const Options& DBImpl::GetOptions(ColumnFamilyHandle* column_family) const {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
I
Igor Canadi 已提交
4129
  return *cfh->cfd()->options();
I
Igor Canadi 已提交
4130 4131
}

4132 4133
const DBOptions& DBImpl::GetDBOptions() const { return db_options_; }

4134
bool DBImpl::GetProperty(ColumnFamilyHandle* column_family,
4135
                         const Slice& property, std::string* value) {
4136 4137
  bool is_int_property = false;
  bool need_out_of_mutex = false;
4138 4139 4140
  DBPropertyType property_type =
      GetPropertyType(property, &is_int_property, &need_out_of_mutex);

4141
  value->clear();
4142 4143 4144 4145 4146
  if (is_int_property) {
    uint64_t int_value;
    bool ret_value = GetIntPropertyInternal(column_family, property_type,
                                            need_out_of_mutex, &int_value);
    if (ret_value) {
4147
      *value = ToString(int_value);
4148 4149 4150 4151 4152
    }
    return ret_value;
  } else {
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
    auto cfd = cfh->cfd();
4153
    InstrumentedMutexLock l(&mutex_);
4154 4155 4156
    return cfd->internal_stats()->GetStringProperty(property_type, property,
                                                    value);
  }
J
jorlow@chromium.org 已提交
4157 4158
}

4159 4160
bool DBImpl::GetIntProperty(ColumnFamilyHandle* column_family,
                            const Slice& property, uint64_t* value) {
4161 4162
  bool is_int_property = false;
  bool need_out_of_mutex = false;
4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174
  DBPropertyType property_type =
      GetPropertyType(property, &is_int_property, &need_out_of_mutex);
  if (!is_int_property) {
    return false;
  }
  return GetIntPropertyInternal(column_family, property_type, need_out_of_mutex,
                                value);
}

bool DBImpl::GetIntPropertyInternal(ColumnFamilyHandle* column_family,
                                    DBPropertyType property_type,
                                    bool need_out_of_mutex, uint64_t* value) {
4175 4176
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
4177 4178

  if (!need_out_of_mutex) {
4179
    InstrumentedMutexLock l(&mutex_);
4180
    return cfd->internal_stats()->GetIntProperty(property_type, value, this);
4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194
  } else {
    SuperVersion* sv = GetAndRefSuperVersion(cfd);

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

    ReturnAndCleanupSuperVersion(cfd, sv);

    return ret;
  }
}

SuperVersion* DBImpl::GetAndRefSuperVersion(ColumnFamilyData* cfd) {
  // TODO(ljin): consider using GetReferencedSuperVersion() directly
I
Igor Canadi 已提交
4195
  return cfd->GetThreadLocalSuperVersion(&mutex_);
4196 4197
}

A
agiardullo 已提交
4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209
// 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 已提交
4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225
// 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);
}

4226 4227
void DBImpl::ReturnAndCleanupSuperVersion(ColumnFamilyData* cfd,
                                          SuperVersion* sv) {
I
Igor Canadi 已提交
4228
  bool unref_sv = !cfd->ReturnThreadLocalSuperVersion(sv);
4229 4230 4231 4232 4233

  if (unref_sv) {
    // Release SuperVersion
    if (sv->Unref()) {
      {
4234
        InstrumentedMutexLock l(&mutex_);
4235 4236 4237 4238 4239 4240 4241
        sv->Cleanup();
      }
      delete sv;
      RecordTick(stats_, NUMBER_SUPERVERSION_CLEANUPS);
    }
    RecordTick(stats_, NUMBER_SUPERVERSION_RELEASES);
  }
4242 4243
}

A
agiardullo 已提交
4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255
// 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 已提交
4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271
// 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 已提交
4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283
// 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 已提交
4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297
// 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();
}

4298
void DBImpl::GetApproximateSizes(ColumnFamilyHandle* column_family,
4299 4300
                                 const Range* range, int n, uint64_t* sizes,
                                 bool include_memtable) {
J
jorlow@chromium.org 已提交
4301
  Version* v;
4302 4303
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
4304 4305
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
  v = sv->current;
J
jorlow@chromium.org 已提交
4306 4307 4308

  for (int i = 0; i < n; i++) {
    // Convert user_key into a corresponding internal key.
4309 4310 4311
    InternalKey k1(range[i].start, kMaxSequenceNumber, kValueTypeForSeek);
    InternalKey k2(range[i].limit, kMaxSequenceNumber, kValueTypeForSeek);
    sizes[i] = versions_->ApproximateSize(v, k1.Encode(), k2.Encode());
4312 4313 4314 4315
    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 已提交
4316 4317
  }

4318
  ReturnAndCleanupSuperVersion(cfd, sv);
J
jorlow@chromium.org 已提交
4319 4320
}

I
Igor Canadi 已提交
4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336
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 已提交
4337 4338 4339 4340 4341
#ifndef ROCKSDB_LITE
Status DBImpl::GetUpdatesSince(
    SequenceNumber seq, unique_ptr<TransactionLogIterator>* iter,
    const TransactionLogIterator::ReadOptions& read_options) {

L
Lei Jin 已提交
4342
  RecordTick(stats_, GET_UPDATES_SINCE_CALLS);
I
Igor Canadi 已提交
4343 4344 4345
  if (seq > versions_->LastSequence()) {
    return Status::NotFound("Requested sequence not yet written in the db");
  }
I
Igor Canadi 已提交
4346
  return wal_manager_.GetUpdatesSince(seq, iter, read_options, versions_.get());
I
Igor Canadi 已提交
4347 4348
}

4349 4350 4351
Status DBImpl::DeleteFile(std::string name) {
  uint64_t number;
  FileType type;
4352 4353 4354
  WalFileType log_type;
  if (!ParseFileName(name, &number, &type, &log_type) ||
      (type != kTableFile && type != kLogFile)) {
4355 4356
    Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
        "DeleteFile %s failed.\n", name.c_str());
4357 4358 4359
    return Status::InvalidArgument("Invalid file name");
  }

4360 4361 4362 4363
  Status status;
  if (type == kLogFile) {
    // Only allow deleting archived log files
    if (log_type != kArchivedLogFile) {
4364 4365
      Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
          "DeleteFile %s failed - not archived log.\n",
4366
          name.c_str());
4367 4368
      return Status::NotSupported("Delete only supported for archived logs");
    }
4369
    status = env_->DeleteFile(db_options_.wal_dir + "/" + name.c_str());
4370
    if (!status.ok()) {
4371 4372
      Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
          "DeleteFile %s failed -- %s.\n",
4373
          name.c_str(), status.ToString().c_str());
4374 4375 4376 4377
    }
    return status;
  }

4378
  int level;
I
Igor Canadi 已提交
4379
  FileMetaData* metadata;
4380
  ColumnFamilyData* cfd;
4381
  VersionEdit edit;
4382
  JobContext job_context(next_job_id_.fetch_add(1), true);
D
Dhruba Borthakur 已提交
4383
  {
4384
    InstrumentedMutexLock l(&mutex_);
4385
    status = versions_->GetMetadataForFile(number, &level, &metadata, &cfd);
D
Dhruba Borthakur 已提交
4386
    if (!status.ok()) {
4387 4388
      Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
          "DeleteFile %s failed. File not found\n", name.c_str());
I
Igor Canadi 已提交
4389
      job_context.Clean();
D
Dhruba Borthakur 已提交
4390 4391
      return Status::InvalidArgument("File not found");
    }
4392
    assert(level < cfd->NumberLevels());
4393

D
Dhruba Borthakur 已提交
4394
    // If the file is being compacted no need to delete.
4395
    if (metadata->being_compacted) {
4396
      Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
4397
          "DeleteFile %s Skipped. File about to be compacted\n", name.c_str());
I
Igor Canadi 已提交
4398
      job_context.Clean();
D
Dhruba Borthakur 已提交
4399
      return Status::OK();
4400 4401
    }

D
Dhruba Borthakur 已提交
4402 4403 4404
    // 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 已提交
4405
    auto* vstoreage = cfd->current()->storage_info();
I
Igor Canadi 已提交
4406
    for (int i = level + 1; i < cfd->NumberLevels(); i++) {
S
sdong 已提交
4407
      if (vstoreage->NumLevelFiles(i) != 0) {
4408
        Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
4409
            "DeleteFile %s FAILED. File not in last level\n", name.c_str());
I
Igor Canadi 已提交
4410
        job_context.Clean();
D
Dhruba Borthakur 已提交
4411 4412 4413
        return Status::InvalidArgument("File not in last level");
      }
    }
4414
    // if level == 0, it has to be the oldest file
S
sdong 已提交
4415 4416
    if (level == 0 &&
        vstoreage->LevelFiles(0).back()->fd.GetNumber() != number) {
4417 4418
      Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
          "DeleteFile %s failed ---"
L
Lei Jin 已提交
4419
          " target file in level 0 must be the oldest.", name.c_str());
I
Igor Canadi 已提交
4420
      job_context.Clean();
4421 4422 4423
      return Status::InvalidArgument("File in level 0, but not oldest");
    }
    edit.SetColumnFamily(cfd->GetID());
D
Dhruba Borthakur 已提交
4424
    edit.DeleteFile(level, number);
4425
    status = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
4426
                                    &edit, &mutex_, directories_.GetDbDir());
I
Igor Canadi 已提交
4427
    if (status.ok()) {
I
Igor Canadi 已提交
4428 4429
      InstallSuperVersionAndScheduleWorkWrapper(
          cfd, &job_context, *cfd->GetLatestMutableCFOptions());
I
Igor Canadi 已提交
4430
    }
I
Igor Canadi 已提交
4431 4432
    FindObsoleteFiles(&job_context, false);
  }  // lock released here
4433

4434
  LogFlush(db_options_.info_log);
I
Igor Canadi 已提交
4435
  // remove files outside the db-lock
I
Igor Canadi 已提交
4436
  if (job_context.HaveSomethingToDelete()) {
4437
    // Call PurgeObsoleteFiles() without holding mutex.
I
Igor Canadi 已提交
4438
    PurgeObsoleteFiles(job_context);
4439
  }
I
Igor Canadi 已提交
4440
  job_context.Clean();
4441 4442 4443
  return status;
}

4444
void DBImpl::GetLiveFilesMetaData(std::vector<LiveFileMetaData>* metadata) {
4445
  InstrumentedMutexLock l(&mutex_);
4446
  versions_->GetLiveFilesMetaData(metadata);
4447
}
4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458

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 已提交
4459
#endif  // ROCKSDB_LITE
4460

I
Igor Canadi 已提交
4461 4462 4463 4464 4465 4466 4467
Status DBImpl::CheckConsistency() {
  mutex_.AssertHeld();
  std::vector<LiveFileMetaData> metadata;
  versions_->GetLiveFilesMetaData(&metadata);

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

I
Igor Canadi 已提交
4471 4472 4473 4474 4475 4476
    uint64_t fsize = 0;
    Status s = env_->GetFileSize(file_path, &fsize);
    if (!s.ok()) {
      corruption_messages +=
          "Can't access " + md.name + ": " + s.ToString() + "\n";
    } else if (fsize != md.size) {
4477
      corruption_messages += "Sst file size mismatch: " + file_path +
I
Igor Canadi 已提交
4478
                             ". Size recorded in manifest " +
4479 4480
                             ToString(md.size) + ", actual size " +
                             ToString(fsize) + "\n";
I
Igor Canadi 已提交
4481 4482 4483 4484 4485 4486 4487 4488 4489
    }
  }
  if (corruption_messages.size() == 0) {
    return Status::OK();
  } else {
    return Status::Corruption(corruption_messages);
  }
}

4490
Status DBImpl::GetDbIdentity(std::string& identity) const {
4491 4492
  std::string idfilename = IdentityFileName(dbname_);
  const EnvOptions soptions;
4493 4494 4495 4496 4497 4498 4499 4500 4501
  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)));
4502
  }
4503

4504 4505 4506 4507 4508
  uint64_t file_size;
  s = env_->GetFileSize(idfilename, &file_size);
  if (!s.ok()) {
    return s;
  }
D
Dmitri Smirnov 已提交
4509
  char* buffer = reinterpret_cast<char*>(alloca(file_size));
4510
  Slice id;
4511
  s = id_file_reader->Read(static_cast<size_t>(file_size), &id, buffer);
4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522
  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 已提交
4523 4524
// Default implementations of convenience methods that subclasses of DB
// can call if they wish
4525
Status DB::Put(const WriteOptions& opt, ColumnFamilyHandle* column_family,
4526
               const Slice& key, const Slice& value) {
4527 4528 4529 4530
  // 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);
4531
  batch.Put(column_family, key, value);
J
jorlow@chromium.org 已提交
4532 4533 4534
  return Write(opt, &batch);
}

4535 4536
Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
J
jorlow@chromium.org 已提交
4537
  WriteBatch batch;
4538
  batch.Delete(column_family, key);
J
jorlow@chromium.org 已提交
4539 4540 4541
  return Write(opt, &batch);
}

A
Andres Noetzli 已提交
4542 4543 4544 4545 4546 4547 4548
Status DB::SingleDelete(const WriteOptions& opt,
                        ColumnFamilyHandle* column_family, const Slice& key) {
  WriteBatch batch;
  batch.SingleDelete(column_family, key);
  return Write(opt, &batch);
}

4549 4550
Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
4551
  WriteBatch batch;
4552
  batch.Merge(column_family, key, value);
4553 4554 4555
  return Write(opt, &batch);
}

4556
// Default implementation -- returns not supported status
L
Lei Jin 已提交
4557
Status DB::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
4558
                              const std::string& column_family_name,
4559
                              ColumnFamilyHandle** handle) {
4560
  return Status::NotSupported("");
4561
}
4562
Status DB::DropColumnFamily(ColumnFamilyHandle* column_family) {
4563
  return Status::NotSupported("");
4564 4565
}

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

J
Jim Paton 已提交
4568
Status DB::Open(const Options& options, const std::string& dbname, DB** dbptr) {
4569 4570 4571 4572
  DBOptions db_options(options);
  ColumnFamilyOptions cf_options(options);
  std::vector<ColumnFamilyDescriptor> column_families;
  column_families.push_back(
4573
      ColumnFamilyDescriptor(kDefaultColumnFamilyName, cf_options));
4574
  std::vector<ColumnFamilyHandle*> handles;
4575
  Status s = DB::Open(db_options, dbname, column_families, &handles, dbptr);
4576 4577 4578 4579 4580 4581 4582
  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;
4583 4584
}

4585 4586
Status DB::Open(const DBOptions& db_options, const std::string& dbname,
                const std::vector<ColumnFamilyDescriptor>& column_families,
4587
                std::vector<ColumnFamilyHandle*>* handles, DB** dbptr) {
4588
  Status s = SanitizeOptionsByTable(db_options, column_families);
4589 4590 4591
  if (!s.ok()) {
    return s;
  }
4592

4593 4594 4595 4596 4597 4598
  for (auto& cfd : column_families) {
    s = CheckCompressionSupported(cfd.options);
    if (!s.ok()) {
      return s;
    }
    if (db_options.db_paths.size() > 1) {
4599 4600
      if ((cfd.options.compaction_style != kCompactionStyleUniversal) &&
          (cfd.options.compaction_style != kCompactionStyleLevel)) {
4601 4602
        return Status::NotSupported(
            "More than one DB paths are only supported in "
4603
            "universal and level compaction styles. ");
4604 4605
      }
    }
4606
  }
4607

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

4613
  *dbptr = nullptr;
4614
  handles->clear();
J
jorlow@chromium.org 已提交
4615

I
Igor Canadi 已提交
4616 4617 4618 4619
  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);
4620
  }
4621

I
Igor Canadi 已提交
4622
  DBImpl* impl = new DBImpl(db_options, dbname);
4623
  s = impl->env_->CreateDirIfMissing(impl->db_options_.wal_dir);
4624
  if (s.ok()) {
4625
    for (auto db_path : impl->db_options_.db_paths) {
4626
      s = impl->env_->CreateDirIfMissing(db_path.path);
4627 4628 4629 4630 4631 4632
      if (!s.ok()) {
        break;
      }
    }
  }

4633 4634 4635 4636 4637 4638
  if (!s.ok()) {
    delete impl;
    return s;
  }

  s = impl->CreateArchivalDirectory();
4639 4640 4641 4642
  if (!s.ok()) {
    delete impl;
    return s;
  }
J
jorlow@chromium.org 已提交
4643
  impl->mutex_.Lock();
4644 4645
  // Handles create_if_missing, error_if_exists
  s = impl->Recover(column_families);
J
jorlow@chromium.org 已提交
4646
  if (s.ok()) {
4647
    uint64_t new_log_number = impl->versions_->NewFileNumber();
4648
    unique_ptr<WritableFile> lfile;
4649
    EnvOptions soptions(db_options);
4650 4651
    EnvOptions opt_env_options =
        impl->db_options_.env->OptimizeForLogWrite(soptions, impl->db_options_);
4652 4653
    s = impl->db_options_.env->NewWritableFile(
        LogFileName(impl->db_options_.wal_dir, new_log_number), &lfile,
4654
        opt_env_options);
J
jorlow@chromium.org 已提交
4655
    if (s.ok()) {
4656
      lfile->SetPreallocationBlockSize(1.1 * max_write_buffer_size);
4657
      impl->logfile_number_ = new_log_number;
4658 4659
      unique_ptr<WritableFileWriter> file_writer(
          new WritableFileWriter(std::move(lfile), opt_env_options));
4660 4661
      impl->logs_.emplace_back(new_log_number,
                               new log::Writer(std::move(file_writer)));
I
Igor Canadi 已提交
4662

4663 4664
      // set column family handles
      for (auto cf : column_families) {
I
Igor Canadi 已提交
4665 4666
        auto cfd =
            impl->versions_->GetColumnFamilySet()->GetColumnFamily(cf.name);
I
Igor Canadi 已提交
4667 4668 4669
        if (cfd != nullptr) {
          handles->push_back(
              new ColumnFamilyHandleImpl(cfd, impl, &impl->mutex_));
4670
          impl->NewThreadStatusCfInfo(cfd);
I
Igor Canadi 已提交
4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686
        } 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 已提交
4687
        }
4688
      }
I
Igor Canadi 已提交
4689 4690
    }
    if (s.ok()) {
4691
      for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
4692
        delete impl->InstallSuperVersionAndScheduleWork(
L
Lei Jin 已提交
4693
            cfd, nullptr, *cfd->GetLatestMutableCFOptions());
4694
      }
I
Igor Canadi 已提交
4695 4696
      impl->alive_log_files_.push_back(
          DBImpl::LogFileNumberSize(impl->logfile_number_));
J
jorlow@chromium.org 已提交
4697
      impl->DeleteObsoleteFiles();
4698
      s = impl->directories_.GetDbDir()->Fsync();
J
jorlow@chromium.org 已提交
4699 4700
    }
  }
4701

I
Igor Canadi 已提交
4702 4703
  if (s.ok()) {
    for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
S
sdong 已提交
4704
      if (cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
S
sdong 已提交
4705
        auto* vstorage = cfd->current()->storage_info();
4706
        for (int i = 1; i < vstorage->num_levels(); ++i) {
S
sdong 已提交
4707
          int num_files = vstorage->NumLevelFiles(i);
I
Igor Canadi 已提交
4708
          if (num_files > 0) {
I
Igor Canadi 已提交
4709 4710
            s = Status::InvalidArgument(
                "Not all files are at level 0. Cannot "
S
sdong 已提交
4711
                "open with FIFO compaction style.");
I
Igor Canadi 已提交
4712 4713 4714 4715
            break;
          }
        }
      }
S
sdong 已提交
4716 4717 4718
      if (!cfd->mem()->IsSnapshotSupported()) {
        impl->is_snapshot_supported_ = false;
      }
4719
      if (cfd->ioptions()->merge_operator != nullptr &&
4720 4721 4722 4723 4724
          !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 已提交
4725
      if (!s.ok()) {
4726 4727 4728 4729
        break;
      }
    }
  }
4730 4731 4732 4733 4734
  TEST_SYNC_POINT("DBImpl::Open:Opened");
  if (s.ok()) {
    impl->opened_successfully_ = true;
    impl->MaybeScheduleFlushOrCompaction();
  }
4735 4736
  impl->mutex_.Unlock();

J
jorlow@chromium.org 已提交
4737
  if (s.ok()) {
S
sdong 已提交
4738 4739
    Log(InfoLogLevel::INFO_LEVEL, impl->db_options_.info_log, "DB pointer %p",
        impl);
4740 4741
    LogFlush(impl->db_options_.info_log);

J
jorlow@chromium.org 已提交
4742 4743
    *dbptr = impl;
  } else {
Y
Yueh-Hsuan Chiang 已提交
4744
    for (auto* h : *handles) {
4745 4746
      delete h;
    }
4747
    handles->clear();
J
jorlow@chromium.org 已提交
4748 4749 4750 4751 4752
    delete impl;
  }
  return s;
}

4753 4754 4755
Status DB::ListColumnFamilies(const DBOptions& db_options,
                              const std::string& name,
                              std::vector<std::string>* column_families) {
I
Igor Canadi 已提交
4756
  return VersionSet::ListColumnFamilies(column_families, name, db_options.env);
4757 4758
}

4759 4760 4761
Snapshot::~Snapshot() {
}

J
jorlow@chromium.org 已提交
4762
Status DestroyDB(const std::string& dbname, const Options& options) {
4763
  const InternalKeyComparator comparator(options.comparator);
4764
  const Options& soptions(SanitizeOptions(dbname, &comparator, options));
4765
  Env* env = soptions.env;
J
jorlow@chromium.org 已提交
4766
  std::vector<std::string> filenames;
4767

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

J
jorlow@chromium.org 已提交
4771
  FileLock* lock;
4772 4773
  const std::string lockname = LockFileName(dbname);
  Status result = env->LockFile(lockname, &lock);
J
jorlow@chromium.org 已提交
4774 4775 4776
  if (result.ok()) {
    uint64_t number;
    FileType type;
4777
    InfoLogPrefix info_log_prefix(!options.db_log_dir.empty(), dbname);
D
dgrogan@chromium.org 已提交
4778
    for (size_t i = 0; i < filenames.size(); i++) {
4779
      if (ParseFileName(filenames[i], &number, info_log_prefix.prefix, &type) &&
4780
          type != kDBLockFile) {  // Lock file will be deleted at end
K
Kosie van der Merwe 已提交
4781
        Status del;
4782
        std::string path_to_delete = dbname + "/" + filenames[i];
K
Kosie van der Merwe 已提交
4783
        if (type == kMetaDatabase) {
4784 4785 4786
          del = DestroyDB(path_to_delete, options);
        } else if (type == kTableFile) {
          del = DeleteOrMoveToTrash(&options, path_to_delete);
K
Kosie van der Merwe 已提交
4787
        } else {
4788
          del = env->DeleteFile(path_to_delete);
K
Kosie van der Merwe 已提交
4789
        }
J
jorlow@chromium.org 已提交
4790 4791 4792 4793 4794
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
4795

4796 4797
    for (size_t path_id = 0; path_id < options.db_paths.size(); path_id++) {
      const auto& db_path = options.db_paths[path_id];
4798
      env->GetChildren(db_path.path, &filenames);
4799 4800 4801
      for (size_t i = 0; i < filenames.size(); i++) {
        if (ParseFileName(filenames[i], &number, &type) &&
            type == kTableFile) {  // Lock file will be deleted at end
4802 4803 4804 4805 4806 4807 4808
          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);
          }
4809 4810 4811 4812 4813 4814 4815
          if (result.ok() && !del.ok()) {
            result = del;
          }
        }
      }
    }

I
Igor Canadi 已提交
4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833
    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;
4834
    env->GetChildren(archivedir, &archiveFiles);
4835 4836
    // Delete archival files.
    for (size_t i = 0; i < archiveFiles.size(); ++i) {
4837 4838
      if (ParseFileName(archiveFiles[i], &number, &type) &&
          type == kLogFile) {
4839
        Status del = env->DeleteFile(archivedir + "/" + archiveFiles[i]);
4840 4841 4842 4843 4844
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
4845
    // ignore case where no archival directory is present.
4846
    env->DeleteDir(archivedir);
4847

J
jorlow@chromium.org 已提交
4848
    env->UnlockFile(lock);  // Ignore error since state is already gone
4849
    env->DeleteFile(lockname);
J
jorlow@chromium.org 已提交
4850
    env->DeleteDir(dbname);  // Ignore error in case dir contains other files
4851
    env->DeleteDir(soptions.wal_dir);
J
jorlow@chromium.org 已提交
4852 4853 4854 4855
  }
  return result;
}

Y
Yueh-Hsuan Chiang 已提交
4856
#if ROCKSDB_USING_THREAD_STATUS
4857

Y
Yueh-Hsuan Chiang 已提交
4858 4859
void DBImpl::NewThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
4860
  if (db_options_.enable_thread_tracking) {
4861
    ThreadStatusUtil::NewColumnFamilyInfo(this, cfd);
4862
  }
Y
Yueh-Hsuan Chiang 已提交
4863 4864 4865 4866
}

void DBImpl::EraseThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
4867
  if (db_options_.enable_thread_tracking) {
4868
    ThreadStatusUtil::EraseColumnFamilyInfo(cfd);
4869
  }
Y
Yueh-Hsuan Chiang 已提交
4870 4871 4872
}

void DBImpl::EraseThreadStatusDbInfo() const {
4873
  if (db_options_.enable_thread_tracking) {
4874
    ThreadStatusUtil::EraseDatabaseInfo(this);
4875
  }
Y
Yueh-Hsuan Chiang 已提交
4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890
}

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

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

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

4891 4892
//
// A global method that can dump out the build version
I
Igor Canadi 已提交
4893
void DumpRocksDBBuildVersion(Logger * log) {
I
Igor Canadi 已提交
4894
#if !defined(IOS_CROSS_COMPILE)
I
Igor Canadi 已提交
4895 4896
  // if we compile with Xcode, we don't run build_detect_vesion, so we don't
  // generate util/build_version.cc
4897 4898 4899 4900
  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 已提交
4901
#endif
4902 4903
}

A
agiardullo 已提交
4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982
#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
Status DBImpl::GetLatestSequenceForKeyFromMemtable(SuperVersion* sv,
                                                   const Slice& key,
                                                   SequenceNumber* seq) {
  Status s;
  std::string value;
  MergeContext merge_context;

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

  *seq = kMaxSequenceNumber;

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

  return Status::OK();
}
#endif  // ROCKSDB_LITE

4983
}  // namespace rocksdb