db_impl_write.cc 73.7 KB
Newer Older
S
Siying Dong 已提交
1
//  Copyright (c) 2011-present, Facebook, Inc.  All rights reserved.
S
Siying Dong 已提交
2 3 4
//  This source code is licensed under both the GPLv2 (found in the
//  COPYING file in the root directory) and Apache 2.0 License
//  (found in the LICENSE.Apache file in the root directory).
S
Siying Dong 已提交
5 6 7 8
//
// 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.
9
#include <cinttypes>
10 11

#include "db/db_impl/db_impl.h"
12
#include "db/error_handler.h"
13
#include "db/event_helpers.h"
14
#include "monitoring/perf_context_imp.h"
S
Siying Dong 已提交
15
#include "options/options_helper.h"
16
#include "test_util/sync_point.h"
17
#include "util/cast_util.h"
S
Siying Dong 已提交
18

19
namespace ROCKSDB_NAMESPACE {
S
Siying Dong 已提交
20 21 22 23 24 25 26 27
// Convenience methods
Status DBImpl::Put(const WriteOptions& o, ColumnFamilyHandle* column_family,
                   const Slice& key, const Slice& val) {
  return DB::Put(o, column_family, key, val);
}

Status DBImpl::Merge(const WriteOptions& o, ColumnFamilyHandle* column_family,
                     const Slice& key, const Slice& val) {
28
  auto cfh = static_cast_with_check<ColumnFamilyHandleImpl>(column_family);
S
Siying Dong 已提交
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
  if (!cfh->cfd()->ioptions()->merge_operator) {
    return Status::NotSupported("Provide a merge_operator when opening DB");
  } else {
    return DB::Merge(o, column_family, key, val);
  }
}

Status DBImpl::Delete(const WriteOptions& write_options,
                      ColumnFamilyHandle* column_family, const Slice& key) {
  return DB::Delete(write_options, column_family, key);
}

Status DBImpl::SingleDelete(const WriteOptions& write_options,
                            ColumnFamilyHandle* column_family,
                            const Slice& key) {
  return DB::SingleDelete(write_options, column_family, key);
}

47 48 49 50 51
void DBImpl::SetRecoverableStatePreReleaseCallback(
    PreReleaseCallback* callback) {
  recoverable_state_pre_release_callback_.reset(callback);
}

S
Siying Dong 已提交
52 53 54 55 56 57 58 59 60 61 62 63
Status DBImpl::Write(const WriteOptions& write_options, WriteBatch* my_batch) {
  return WriteImpl(write_options, my_batch, nullptr, nullptr);
}

#ifndef ROCKSDB_LITE
Status DBImpl::WriteWithCallback(const WriteOptions& write_options,
                                 WriteBatch* my_batch,
                                 WriteCallback* callback) {
  return WriteImpl(write_options, my_batch, callback, nullptr);
}
#endif  // ROCKSDB_LITE

64 65 66
// The main write queue. This is the only write queue that updates LastSequence.
// When using one write queue, the same sequence also indicates the last
// published sequence.
S
Siying Dong 已提交
67 68 69
Status DBImpl::WriteImpl(const WriteOptions& write_options,
                         WriteBatch* my_batch, WriteCallback* callback,
                         uint64_t* log_used, uint64_t log_ref,
70
                         bool disable_memtable, uint64_t* seq_used,
71
                         size_t batch_cnt,
72
                         PreReleaseCallback* pre_release_callback) {
73
  assert(!seq_per_batch_ || batch_cnt != 0);
S
Siying Dong 已提交
74 75 76
  if (my_batch == nullptr) {
    return Status::Corruption("Batch is nullptr!");
  }
77 78 79
  if (tracer_) {
    InstrumentedMutexLock lock(&trace_mutex_);
    if (tracer_) {
80 81
      // TODO: maybe handle the tracing status?
      tracer_->Write(my_batch).PermitUncheckedError();
82 83
    }
  }
84 85 86
  if (write_options.sync && write_options.disableWAL) {
    return Status::InvalidArgument("Sync writes has to enable WAL.");
  }
87
  if (two_write_queues_ && immutable_db_options_.enable_pipelined_write) {
88 89 90
    return Status::NotSupported(
        "pipelined_writes is not compatible with concurrent prepares");
  }
91
  if (seq_per_batch_ && immutable_db_options_.enable_pipelined_write) {
92
    // TODO(yiwu): update pipeline write with seq_per_batch and batch_cnt
93 94 95
    return Status::NotSupported(
        "pipelined_writes is not compatible with seq_per_batch");
  }
M
Maysam Yabandeh 已提交
96 97 98 99 100
  if (immutable_db_options_.unordered_write &&
      immutable_db_options_.enable_pipelined_write) {
    return Status::NotSupported(
        "pipelined_writes is not compatible with unordered_write");
  }
101 102 103
  // Otherwise IsLatestPersistentState optimization does not make sense
  assert(!WriteBatchInternal::IsLatestPersistentState(my_batch) ||
         disable_memtable);
S
Siying Dong 已提交
104

105
  if (write_options.low_pri) {
106 107 108
    Status s = ThrottleLowPriWritesIfNeeded(write_options, my_batch);
    if (!s.ok()) {
      return s;
109 110 111
    }
  }

112
  if (two_write_queues_ && disable_memtable) {
M
Maysam Yabandeh 已提交
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
    AssignOrder assign_order =
        seq_per_batch_ ? kDoAssignOrder : kDontAssignOrder;
    // Otherwise it is WAL-only Prepare batches in WriteCommitted policy and
    // they don't consume sequence.
    return WriteImplWALOnly(&nonmem_write_thread_, write_options, my_batch,
                            callback, log_used, log_ref, seq_used, batch_cnt,
                            pre_release_callback, assign_order,
                            kDontPublishLastSeq, disable_memtable);
  }

  if (immutable_db_options_.unordered_write) {
    const size_t sub_batch_cnt = batch_cnt != 0
                                     ? batch_cnt
                                     // every key is a sub-batch consuming a seq
                                     : WriteBatchInternal::Count(my_batch);
Y
Yanqin Jin 已提交
128
    uint64_t seq = 0;
M
Maysam Yabandeh 已提交
129 130
    // Use a write thread to i) optimize for WAL write, ii) publish last
    // sequence in in increasing order, iii) call pre_release_callback serially
131 132 133 134
    Status status = WriteImplWALOnly(
        &write_thread_, write_options, my_batch, callback, log_used, log_ref,
        &seq, sub_batch_cnt, pre_release_callback, kDoAssignOrder,
        kDoPublishLastSeq, disable_memtable);
135
    TEST_SYNC_POINT("DBImpl::WriteImpl:UnorderedWriteAfterWriteWAL");
M
Maysam Yabandeh 已提交
136 137 138 139 140 141 142
    if (!status.ok()) {
      return status;
    }
    if (seq_used) {
      *seq_used = seq;
    }
    if (!disable_memtable) {
143
      TEST_SYNC_POINT("DBImpl::WriteImpl:BeforeUnorderedWriteMemtable");
M
Maysam Yabandeh 已提交
144 145 146 147
      status = UnorderedWriteMemtable(write_options, my_batch, callback,
                                      log_ref, seq, sub_batch_cnt);
    }
    return status;
148 149
  }

150 151
  if (immutable_db_options_.enable_pipelined_write) {
    return PipelinedWriteImpl(write_options, my_batch, callback, log_used,
152
                              log_ref, disable_memtable, seq_used);
153 154
  }

S
Siying Dong 已提交
155 156
  PERF_TIMER_GUARD(write_pre_and_post_process_time);
  WriteThread::Writer w(write_options, my_batch, callback, log_ref,
157
                        disable_memtable, batch_cnt, pre_release_callback);
S
Siying Dong 已提交
158 159 160 161 162 163 164 165

  if (!write_options.disableWAL) {
    RecordTick(stats_, WRITE_WITH_WAL);
  }

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

  write_thread_.JoinBatchGroup(&w);
166
  Status status;
167
  if (w.state == WriteThread::STATE_PARALLEL_MEMTABLE_WRITER) {
S
Siying Dong 已提交
168 169 170
    // we are a non-leader in a parallel group

    if (w.ShouldWriteToMemtable()) {
171 172 173
      PERF_TIMER_STOP(write_pre_and_post_process_time);
      PERF_TIMER_GUARD(write_memtable_time);

S
Siying Dong 已提交
174 175 176
      ColumnFamilyMemTablesImpl column_family_memtables(
          versions_->GetColumnFamilySet());
      w.status = WriteBatchInternal::InsertInto(
Y
Yi Wu 已提交
177
          &w, w.sequence, &column_family_memtables, &flush_scheduler_,
178
          &trim_history_scheduler_,
S
Siying Dong 已提交
179
          write_options.ignore_missing_column_families, 0 /*log_number*/, this,
180
          true /*concurrent_memtable_writes*/, seq_per_batch_, w.batch_cnt,
181
          batch_per_txn_, write_options.memtable_insert_hint_per_batch);
182 183

      PERF_TIMER_START(write_pre_and_post_process_time);
S
Siying Dong 已提交
184 185
    }

186
    if (write_thread_.CompleteParallelMemTableWriter(&w)) {
Y
Yi Wu 已提交
187
      // we're responsible for exit batch group
188
      // TODO(myabandeh): propagate status to write_group
189
      auto last_sequence = w.write_group->last_sequence;
S
Siying Dong 已提交
190
      versions_->SetLastSequence(last_sequence);
191
      MemTableInsertStatusCheck(w.status);
Y
Yi Wu 已提交
192
      write_thread_.ExitAsBatchGroupFollower(&w);
S
Siying Dong 已提交
193 194 195 196 197 198 199 200 201 202
    }
    assert(w.state == WriteThread::STATE_COMPLETED);
    // STATE_COMPLETED conditional below handles exit

    status = w.FinalStatus();
  }
  if (w.state == WriteThread::STATE_COMPLETED) {
    if (log_used != nullptr) {
      *log_used = w.log_used;
    }
203 204 205
    if (seq_used != nullptr) {
      *seq_used = w.sequence;
    }
S
Siying Dong 已提交
206
    // write is complete and leader has updated sequence
207 208
    // Should we handle it?
    status.PermitUncheckedError();
S
Siying Dong 已提交
209 210 211 212 213 214 215 216 217 218
    return w.FinalStatus();
  }
  // else we are the leader of the write batch group
  assert(w.state == WriteThread::STATE_GROUP_LEADER);

  // 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.
  WriteContext write_context;
219
  WriteThread::WriteGroup write_group;
Y
Yi Wu 已提交
220
  bool in_parallel_group = false;
S
Siying Dong 已提交
221
  uint64_t last_sequence = kMaxSequenceNumber;
S
Siying Dong 已提交
222 223 224

  mutex_.Lock();

225
  bool need_log_sync = write_options.sync;
S
Siying Dong 已提交
226
  bool need_log_dir_sync = need_log_sync && !log_dir_synced_;
227
  if (!two_write_queues_ || !disable_memtable) {
228 229 230
    // With concurrent writes we do preprocess only in the write thread that
    // also does write to memtable to avoid sync issue on shared data structure
    // with the other thread
231 232 233 234

    // PreprocessWrite does its own perf timing.
    PERF_TIMER_STOP(write_pre_and_post_process_time);

235
    status = PreprocessWrite(write_options, &need_log_sync, &write_context);
236 237 238 239 240
    if (!two_write_queues_) {
      // Assign it after ::PreprocessWrite since the sequence might advance
      // inside it by WriteRecoverableState
      last_sequence = versions_->LastSequence();
    }
241 242

    PERF_TIMER_START(write_pre_and_post_process_time);
243 244
  }
  log::Writer* log_writer = logs_.back().writer;
S
Siying Dong 已提交
245 246 247 248 249 250 251 252

  mutex_.Unlock();

  // 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
  // into memtables

253
  TEST_SYNC_POINT("DBImpl::WriteImpl:BeforeLeaderEnters");
S
Siying Dong 已提交
254
  last_batch_group_size_ =
255
      write_thread_.EnterAsBatchGroupLeader(&w, &write_group);
S
Siying Dong 已提交
256

257
  IOStatus io_s;
S
Siying Dong 已提交
258 259 260 261
  if (status.ok()) {
    // Rules for when we can update the memtable concurrently
    // 1. supported by memtable
    // 2. Puts are not okay if inplace_update_support
262
    // 3. Merges are not okay
S
Siying Dong 已提交
263
    //
264
    // Rules 1..2 are enforced by checking the options
S
Siying Dong 已提交
265 266
    // during startup (CheckConcurrentWritesSupported), so if
    // options.allow_concurrent_memtable_write is true then they can be
267 268
    // assumed to be true.  Rule 3 is checked for each batch.  We could
    // relax rules 2 if we could prevent write batches from referring
S
Siying Dong 已提交
269 270
    // more than once to a particular key.
    bool parallel = immutable_db_options_.allow_concurrent_memtable_write &&
271
                    write_group.size > 1;
272
    size_t total_count = 0;
273
    size_t valid_batches = 0;
274
    size_t total_byte_size = 0;
275
    size_t pre_release_callback_cnt = 0;
276
    for (auto* writer : write_group) {
S
Siying Dong 已提交
277
      if (writer->CheckCallback(this)) {
278
        valid_batches += writer->batch_cnt;
S
Siying Dong 已提交
279 280 281 282
        if (writer->ShouldWriteToMemtable()) {
          total_count += WriteBatchInternal::Count(writer->batch);
          parallel = parallel && !writer->batch->HasMerge();
        }
I
Igor Canadi 已提交
283 284
        total_byte_size = WriteBatchInternal::AppendedByteSize(
            total_byte_size, WriteBatchInternal::ByteSize(writer->batch));
285 286 287
        if (writer->pre_release_callback) {
          pre_release_callback_cnt++;
        }
S
Siying Dong 已提交
288 289
      }
    }
290 291 292 293 294 295 296
    // Note about seq_per_batch_: either disableWAL is set for the entire write
    // group or not. In either case we inc seq for each write batch with no
    // failed callback. This means that there could be a batch with
    // disalbe_memtable in between; although we do not write this batch to
    // memtable it still consumes a seq. Otherwise, if !seq_per_batch_, we inc
    // the seq per valid written key to mem.
    size_t seq_inc = seq_per_batch_ ? valid_batches : total_count;
S
Siying Dong 已提交
297

298
    const bool concurrent_update = two_write_queues_;
S
Siying Dong 已提交
299 300 301
    // Update stats while we are an exclusive group leader, so we know
    // that nobody else can be writing to these particular stats.
    // We're optimistic, updating the stats before we successfully
Y
Yi Wu 已提交
302
    // commit.  That lets us release our leader status early.
S
Siying Dong 已提交
303
    auto stats = default_cf_internal_stats_;
304
    stats->AddDBStats(InternalStats::kIntStatsNumKeysWritten, total_count,
305
                      concurrent_update);
S
Siying Dong 已提交
306
    RecordTick(stats_, NUMBER_KEYS_WRITTEN, total_count);
307
    stats->AddDBStats(InternalStats::kIntStatsBytesWritten, total_byte_size,
308
                      concurrent_update);
S
Siying Dong 已提交
309
    RecordTick(stats_, BYTES_WRITTEN, total_byte_size);
310 311
    stats->AddDBStats(InternalStats::kIntStatsWriteDoneBySelf, 1,
                      concurrent_update);
S
Siying Dong 已提交
312
    RecordTick(stats_, WRITE_DONE_BY_SELF);
313
    auto write_done_by_other = write_group.size - 1;
S
Siying Dong 已提交
314
    if (write_done_by_other > 0) {
315 316
      stats->AddDBStats(InternalStats::kIntStatsWriteDoneByOther,
                        write_done_by_other, concurrent_update);
S
Siying Dong 已提交
317 318
      RecordTick(stats_, WRITE_DONE_BY_OTHER, write_done_by_other);
    }
S
Siying Dong 已提交
319
    RecordInHistogram(stats_, BYTES_PER_WRITE, total_byte_size);
S
Siying Dong 已提交
320 321 322 323 324 325 326

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

    PERF_TIMER_STOP(write_pre_and_post_process_time);

327
    if (!two_write_queues_) {
328 329
      if (status.ok() && !write_options.disableWAL) {
        PERF_TIMER_GUARD(write_wal_time);
330 331
        io_s = WriteToWAL(write_group, log_writer, log_used, need_log_sync,
                          need_log_dir_sync, last_sequence + 1);
332 333 334 335
      }
    } else {
      if (status.ok() && !write_options.disableWAL) {
        PERF_TIMER_GUARD(write_wal_time);
336
        // LastAllocatedSequence is increased inside WriteToWAL under
337
        // wal_write_mutex_ to ensure ordered events in WAL
338 339
        io_s = ConcurrentWriteToWAL(write_group, log_used, &last_sequence,
                                    seq_inc);
340 341
      } else {
        // Otherwise we inc seq number for memtable writes
342
        last_sequence = versions_->FetchAddLastAllocatedSequence(seq_inc);
S
Siying Dong 已提交
343 344
      }
    }
345
    status = io_s;
S
Siying Dong 已提交
346
    assert(last_sequence != kMaxSequenceNumber);
347
    const SequenceNumber current_sequence = last_sequence + 1;
348
    last_sequence += seq_inc;
S
Siying Dong 已提交
349

350 351 352
    // PreReleaseCallback is called after WAL write and before memtable write
    if (status.ok()) {
      SequenceNumber next_sequence = current_sequence;
353
      size_t index = 0;
354 355 356 357 358 359 360 361 362 363
      // Note: the logic for advancing seq here must be consistent with the
      // logic in WriteBatchInternal::InsertInto(write_group...) as well as
      // with WriteBatchInternal::InsertInto(write_batch...) that is called on
      // the merged batch during recovery from the WAL.
      for (auto* writer : write_group) {
        if (writer->CallbackFailed()) {
          continue;
        }
        writer->sequence = next_sequence;
        if (writer->pre_release_callback) {
364
          Status ws = writer->pre_release_callback->Callback(
365 366
              writer->sequence, disable_memtable, writer->log_used, index++,
              pre_release_callback_cnt);
367 368 369 370 371 372 373 374 375 376 377 378 379 380
          if (!ws.ok()) {
            status = ws;
            break;
          }
        }
        if (seq_per_batch_) {
          assert(writer->batch_cnt);
          next_sequence += writer->batch_cnt;
        } else if (writer->ShouldWriteToMemtable()) {
          next_sequence += WriteBatchInternal::Count(writer->batch);
        }
      }
    }

S
Siying Dong 已提交
381 382 383 384
    if (status.ok()) {
      PERF_TIMER_GUARD(write_memtable_time);

      if (!parallel) {
385
        // w.sequence will be set inside InsertInto
Y
Yi Wu 已提交
386
        w.status = WriteBatchInternal::InsertInto(
S
Siying Dong 已提交
387
            write_group, current_sequence, column_family_memtables_.get(),
388 389
            &flush_scheduler_, &trim_history_scheduler_,
            write_options.ignore_missing_column_families,
390 391
            0 /*recovery_log_number*/, this, parallel, seq_per_batch_,
            batch_per_txn_);
S
Siying Dong 已提交
392
      } else {
393 394
        write_group.last_sequence = last_sequence;
        write_thread_.LaunchParallelMemTableWriters(&write_group);
Y
Yi Wu 已提交
395
        in_parallel_group = true;
S
Siying Dong 已提交
396

397 398
        // Each parallel follower is doing each own writes. The leader should
        // also do its own.
S
Siying Dong 已提交
399 400 401 402 403
        if (w.ShouldWriteToMemtable()) {
          ColumnFamilyMemTablesImpl column_family_memtables(
              versions_->GetColumnFamilySet());
          assert(w.sequence == current_sequence);
          w.status = WriteBatchInternal::InsertInto(
Y
Yi Wu 已提交
404
              &w, w.sequence, &column_family_memtables, &flush_scheduler_,
405
              &trim_history_scheduler_,
S
Siying Dong 已提交
406
              write_options.ignore_missing_column_families, 0 /*log_number*/,
407
              this, true /*concurrent_memtable_writes*/, seq_per_batch_,
408 409
              w.batch_cnt, batch_per_txn_,
              write_options.memtable_insert_hint_per_batch);
S
Siying Dong 已提交
410
        }
411 412 413
      }
      if (seq_used != nullptr) {
        *seq_used = w.sequence;
S
Siying Dong 已提交
414 415 416 417 418
      }
    }
  }
  PERF_TIMER_START(write_pre_and_post_process_time);

419
  if (!w.CallbackFailed()) {
420 421 422 423 424
    if (!io_s.ok()) {
      IOStatusCheck(io_s);
    } else {
      WriteStatusCheck(status);
    }
S
Siying Dong 已提交
425 426
  }

427
  if (need_log_sync) {
S
Siying Dong 已提交
428
    mutex_.Lock();
429 430 431 432 433
    if (status.ok()) {
      status = MarkLogsSynced(logfile_number_, need_log_dir_sync);
    } else {
      MarkLogsNotSynced(logfile_number_);
    }
S
Siying Dong 已提交
434
    mutex_.Unlock();
435
    // Requesting sync with two_write_queues_ is expected to be very rare. We
436
    // hence provide a simple implementation that is not necessarily efficient.
437
    if (two_write_queues_) {
438 439 440 441 442 443
      if (manual_wal_flush_) {
        status = FlushWAL(true);
      } else {
        status = SyncWAL();
      }
    }
S
Siying Dong 已提交
444 445
  }

Y
Yi Wu 已提交
446 447 448 449
  bool should_exit_batch_group = true;
  if (in_parallel_group) {
    // CompleteParallelWorker returns true if this thread should
    // handle exit, false means somebody else did
450
    should_exit_batch_group = write_thread_.CompleteParallelMemTableWriter(&w);
Y
Yi Wu 已提交
451 452
  }
  if (should_exit_batch_group) {
453
    if (status.ok()) {
454 455
      // Note: if we are to resume after non-OK statuses we need to revisit how
      // we reacts to non-OK statuses here.
456 457
      versions_->SetLastSequence(last_sequence);
    }
458
    MemTableInsertStatusCheck(w.status);
459
    write_thread_.ExitAsBatchGroupLeader(write_group, status);
S
Siying Dong 已提交
460 461
  }

Y
Yi Wu 已提交
462 463 464
  if (status.ok()) {
    status = w.FinalStatus();
  }
S
Siying Dong 已提交
465 466 467
  return status;
}

468 469 470
Status DBImpl::PipelinedWriteImpl(const WriteOptions& write_options,
                                  WriteBatch* my_batch, WriteCallback* callback,
                                  uint64_t* log_used, uint64_t log_ref,
471
                                  bool disable_memtable, uint64_t* seq_used) {
472 473 474 475 476 477 478 479
  PERF_TIMER_GUARD(write_pre_and_post_process_time);
  StopWatch write_sw(env_, immutable_db_options_.statistics.get(), DB_WRITE);

  WriteContext write_context;

  WriteThread::Writer w(write_options, my_batch, callback, log_ref,
                        disable_memtable);
  write_thread_.JoinBatchGroup(&w);
480
  TEST_SYNC_POINT("DBImplWrite::PipelinedWriteImpl:AfterJoinBatchGroup");
481 482 483 484 485 486 487 488
  if (w.state == WriteThread::STATE_GROUP_LEADER) {
    WriteThread::WriteGroup wal_write_group;
    if (w.callback && !w.callback->AllowWriteBatching()) {
      write_thread_.WaitForMemTableWriters();
    }
    mutex_.Lock();
    bool need_log_sync = !write_options.disableWAL && write_options.sync;
    bool need_log_dir_sync = need_log_sync && !log_dir_synced_;
489 490
    // PreprocessWrite does its own perf timing.
    PERF_TIMER_STOP(write_pre_and_post_process_time);
491
    w.status = PreprocessWrite(write_options, &need_log_sync, &write_context);
492
    PERF_TIMER_START(write_pre_and_post_process_time);
493
    log::Writer* log_writer = logs_.back().writer;
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
    mutex_.Unlock();

    // This can set non-OK status if callback fail.
    last_batch_group_size_ =
        write_thread_.EnterAsBatchGroupLeader(&w, &wal_write_group);
    const SequenceNumber current_sequence =
        write_thread_.UpdateLastSequence(versions_->LastSequence()) + 1;
    size_t total_count = 0;
    size_t total_byte_size = 0;

    if (w.status.ok()) {
      SequenceNumber next_sequence = current_sequence;
      for (auto writer : wal_write_group) {
        if (writer->CheckCallback(this)) {
          if (writer->ShouldWriteToMemtable()) {
            writer->sequence = next_sequence;
            size_t count = WriteBatchInternal::Count(writer->batch);
            next_sequence += count;
            total_count += count;
          }
          total_byte_size = WriteBatchInternal::AppendedByteSize(
              total_byte_size, WriteBatchInternal::ByteSize(writer->batch));
        }
      }
      if (w.disable_wal) {
        has_unpersisted_data_.store(true, std::memory_order_relaxed);
      }
      write_thread_.UpdateLastSequence(current_sequence + total_count - 1);
    }

    auto stats = default_cf_internal_stats_;
525
    stats->AddDBStats(InternalStats::kIntStatsNumKeysWritten, total_count);
526
    RecordTick(stats_, NUMBER_KEYS_WRITTEN, total_count);
527
    stats->AddDBStats(InternalStats::kIntStatsBytesWritten, total_byte_size);
528
    RecordTick(stats_, BYTES_WRITTEN, total_byte_size);
S
Siying Dong 已提交
529
    RecordInHistogram(stats_, BYTES_PER_WRITE, total_byte_size);
530 531 532

    PERF_TIMER_STOP(write_pre_and_post_process_time);

533
    IOStatus io_s;
534
    if (w.status.ok() && !write_options.disableWAL) {
535
      PERF_TIMER_GUARD(write_wal_time);
536
      stats->AddDBStats(InternalStats::kIntStatsWriteDoneBySelf, 1);
537 538
      RecordTick(stats_, WRITE_DONE_BY_SELF, 1);
      if (wal_write_group.size > 1) {
539
        stats->AddDBStats(InternalStats::kIntStatsWriteDoneByOther,
540 541 542
                          wal_write_group.size - 1);
        RecordTick(stats_, WRITE_DONE_BY_OTHER, wal_write_group.size - 1);
      }
543 544 545
      io_s = WriteToWAL(wal_write_group, log_writer, log_used, need_log_sync,
                        need_log_dir_sync, current_sequence);
      w.status = io_s;
546 547 548
    }

    if (!w.CallbackFailed()) {
549 550 551 552 553
      if (!io_s.ok()) {
        IOStatusCheck(io_s);
      } else {
        WriteStatusCheck(w.status);
      }
554 555 556 557
    }

    if (need_log_sync) {
      mutex_.Lock();
558 559 560 561 562
      if (w.status.ok()) {
        w.status = MarkLogsSynced(logfile_number_, need_log_dir_sync);
      } else {
        MarkLogsNotSynced(logfile_number_);
      }
563 564 565 566 567 568 569 570 571
      mutex_.Unlock();
    }

    write_thread_.ExitAsBatchGroupLeader(wal_write_group, w.status);
  }

  WriteThread::WriteGroup memtable_write_group;
  if (w.state == WriteThread::STATE_MEMTABLE_WRITER_LEADER) {
    PERF_TIMER_GUARD(write_memtable_time);
572
    assert(w.ShouldWriteToMemtable());
573 574 575 576 577 578 579
    write_thread_.EnterAsMemTableWriter(&w, &memtable_write_group);
    if (memtable_write_group.size > 1 &&
        immutable_db_options_.allow_concurrent_memtable_write) {
      write_thread_.LaunchParallelMemTableWriters(&memtable_write_group);
    } else {
      memtable_write_group.status = WriteBatchInternal::InsertInto(
          memtable_write_group, w.sequence, column_family_memtables_.get(),
580 581 582
          &flush_scheduler_, &trim_history_scheduler_,
          write_options.ignore_missing_column_families, 0 /*log_number*/, this,
          false /*concurrent_memtable_writes*/, seq_per_batch_, batch_per_txn_);
583 584 585 586 587 588 589 590 591 592
      versions_->SetLastSequence(memtable_write_group.last_sequence);
      write_thread_.ExitAsMemTableWriter(&w, memtable_write_group);
    }
  }

  if (w.state == WriteThread::STATE_PARALLEL_MEMTABLE_WRITER) {
    assert(w.ShouldWriteToMemtable());
    ColumnFamilyMemTablesImpl column_family_memtables(
        versions_->GetColumnFamilySet());
    w.status = WriteBatchInternal::InsertInto(
Y
Yi Wu 已提交
593
        &w, w.sequence, &column_family_memtables, &flush_scheduler_,
594
        &trim_history_scheduler_, write_options.ignore_missing_column_families,
595 596 597
        0 /*log_number*/, this, true /*concurrent_memtable_writes*/,
        false /*seq_per_batch*/, 0 /*batch_cnt*/, true /*batch_per_txn*/,
        write_options.memtable_insert_hint_per_batch);
598 599 600 601 602 603
    if (write_thread_.CompleteParallelMemTableWriter(&w)) {
      MemTableInsertStatusCheck(w.status);
      versions_->SetLastSequence(w.write_group->last_sequence);
      write_thread_.ExitAsMemTableWriter(&w, *w.write_group);
    }
  }
604 605 606
  if (seq_used != nullptr) {
    *seq_used = w.sequence;
  }
607 608

  assert(w.state == WriteThread::STATE_COMPLETED);
609 610 611
  return w.FinalStatus();
}

M
Maysam Yabandeh 已提交
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
Status DBImpl::UnorderedWriteMemtable(const WriteOptions& write_options,
                                      WriteBatch* my_batch,
                                      WriteCallback* callback, uint64_t log_ref,
                                      SequenceNumber seq,
                                      const size_t sub_batch_cnt) {
  PERF_TIMER_GUARD(write_pre_and_post_process_time);
  StopWatch write_sw(env_, immutable_db_options_.statistics.get(), DB_WRITE);

  WriteThread::Writer w(write_options, my_batch, callback, log_ref,
                        false /*disable_memtable*/);

  if (w.CheckCallback(this) && w.ShouldWriteToMemtable()) {
    w.sequence = seq;
    size_t total_count = WriteBatchInternal::Count(my_batch);
    InternalStats* stats = default_cf_internal_stats_;
627
    stats->AddDBStats(InternalStats::kIntStatsNumKeysWritten, total_count);
M
Maysam Yabandeh 已提交
628 629 630 631 632 633
    RecordTick(stats_, NUMBER_KEYS_WRITTEN, total_count);

    ColumnFamilyMemTablesImpl column_family_memtables(
        versions_->GetColumnFamilySet());
    w.status = WriteBatchInternal::InsertInto(
        &w, w.sequence, &column_family_memtables, &flush_scheduler_,
634 635
        &trim_history_scheduler_, write_options.ignore_missing_column_families,
        0 /*log_number*/, this, true /*concurrent_memtable_writes*/,
636 637
        seq_per_batch_, sub_batch_cnt, true /*batch_per_txn*/,
        write_options.memtable_insert_hint_per_batch);
M
Maysam Yabandeh 已提交
638 639 640 641 642 643 644
    if (write_options.disableWAL) {
      has_unpersisted_data_.store(true, std::memory_order_relaxed);
    }
  }

  size_t pending_cnt = pending_memtable_writes_.fetch_sub(1) - 1;
  if (pending_cnt == 0) {
645 646 647 648 649
    // switch_cv_ waits until pending_memtable_writes_ = 0. Locking its mutex
    // before notify ensures that cv is in waiting state when it is notified
    // thus not missing the update to pending_memtable_writes_ even though it is
    // not modified under the mutex.
    std::lock_guard<std::mutex> lck(switch_mutex_);
M
Maysam Yabandeh 已提交
650 651
    switch_cv_.notify_all();
  }
652
  WriteStatusCheck(w.status);
M
Maysam Yabandeh 已提交
653 654 655 656 657 658 659

  if (!w.FinalStatus().ok()) {
    return w.FinalStatus();
  }
  return Status::OK();
}

660 661 662
// The 2nd write queue. If enabled it will be used only for WAL-only writes.
// This is the only queue that updates LastPublishedSequence which is only
// applicable in a two-queue setting.
M
Maysam Yabandeh 已提交
663 664 665 666 667 668
Status DBImpl::WriteImplWALOnly(
    WriteThread* write_thread, const WriteOptions& write_options,
    WriteBatch* my_batch, WriteCallback* callback, uint64_t* log_used,
    const uint64_t log_ref, uint64_t* seq_used, const size_t sub_batch_cnt,
    PreReleaseCallback* pre_release_callback, const AssignOrder assign_order,
    const PublishLastSeq publish_last_seq, const bool disable_memtable) {
669 670
  PERF_TIMER_GUARD(write_pre_and_post_process_time);
  WriteThread::Writer w(write_options, my_batch, callback, log_ref,
M
Maysam Yabandeh 已提交
671
                        disable_memtable, sub_batch_cnt, pre_release_callback);
672 673
  RecordTick(stats_, WRITE_WITH_WAL);
  StopWatch write_sw(env_, immutable_db_options_.statistics.get(), DB_WRITE);
674

M
Maysam Yabandeh 已提交
675
  write_thread->JoinBatchGroup(&w);
676 677 678 679 680
  assert(w.state != WriteThread::STATE_PARALLEL_MEMTABLE_WRITER);
  if (w.state == WriteThread::STATE_COMPLETED) {
    if (log_used != nullptr) {
      *log_used = w.log_used;
    }
681 682 683
    if (seq_used != nullptr) {
      *seq_used = w.sequence;
    }
684 685 686 687
    return w.FinalStatus();
  }
  // else we are the leader of the write batch group
  assert(w.state == WriteThread::STATE_GROUP_LEADER);
M
Maysam Yabandeh 已提交
688 689

  if (publish_last_seq == kDoPublishLastSeq) {
690 691
    Status status;

M
Maysam Yabandeh 已提交
692 693 694 695 696 697 698 699 700 701 702 703
    // Currently we only use kDoPublishLastSeq in unordered_write
    assert(immutable_db_options_.unordered_write);
    WriteContext write_context;
    if (error_handler_.IsDBStopped()) {
      status = error_handler_.GetBGError();
    }
    // TODO(myabandeh): Make preliminary checks thread-safe so we could do them
    // without paying the cost of obtaining the mutex.
    if (status.ok()) {
      InstrumentedMutexLock l(&mutex_);
      bool need_log_sync = false;
      status = PreprocessWrite(write_options, &need_log_sync, &write_context);
704
      WriteStatusCheckOnLocked(status);
M
Maysam Yabandeh 已提交
705 706 707 708 709 710 711 712 713
    }
    if (!status.ok()) {
      WriteThread::WriteGroup write_group;
      write_thread->EnterAsBatchGroupLeader(&w, &write_group);
      write_thread->ExitAsBatchGroupLeader(write_group, status);
      return status;
    }
  }

714 715
  WriteThread::WriteGroup write_group;
  uint64_t last_sequence;
M
Maysam Yabandeh 已提交
716
  write_thread->EnterAsBatchGroupLeader(&w, &write_group);
717 718 719
  // Note: no need to update last_batch_group_size_ here since the batch writes
  // to WAL only

720
  size_t pre_release_callback_cnt = 0;
721
  size_t total_byte_size = 0;
722 723 724 725
  for (auto* writer : write_group) {
    if (writer->CheckCallback(this)) {
      total_byte_size = WriteBatchInternal::AppendedByteSize(
          total_byte_size, WriteBatchInternal::ByteSize(writer->batch));
726 727 728
      if (writer->pre_release_callback) {
        pre_release_callback_cnt++;
      }
729 730 731
    }
  }

732
  const bool concurrent_update = true;
733 734 735 736 737
  // Update stats while we are an exclusive group leader, so we know
  // that nobody else can be writing to these particular stats.
  // We're optimistic, updating the stats before we successfully
  // commit.  That lets us release our leader status early.
  auto stats = default_cf_internal_stats_;
738
  stats->AddDBStats(InternalStats::kIntStatsBytesWritten, total_byte_size,
739
                    concurrent_update);
740
  RecordTick(stats_, BYTES_WRITTEN, total_byte_size);
741 742
  stats->AddDBStats(InternalStats::kIntStatsWriteDoneBySelf, 1,
                    concurrent_update);
743 744 745
  RecordTick(stats_, WRITE_DONE_BY_SELF);
  auto write_done_by_other = write_group.size - 1;
  if (write_done_by_other > 0) {
746 747
    stats->AddDBStats(InternalStats::kIntStatsWriteDoneByOther,
                      write_done_by_other, concurrent_update);
748 749
    RecordTick(stats_, WRITE_DONE_BY_OTHER, write_done_by_other);
  }
S
Siying Dong 已提交
750
  RecordInHistogram(stats_, BYTES_PER_WRITE, total_byte_size);
751 752 753 754

  PERF_TIMER_STOP(write_pre_and_post_process_time);

  PERF_TIMER_GUARD(write_wal_time);
755
  // LastAllocatedSequence is increased inside WriteToWAL under
756
  // wal_write_mutex_ to ensure ordered events in WAL
757
  size_t seq_inc = 0 /* total_count */;
M
Maysam Yabandeh 已提交
758
  if (assign_order == kDoAssignOrder) {
759 760
    size_t total_batch_cnt = 0;
    for (auto* writer : write_group) {
M
Maysam Yabandeh 已提交
761 762 763 764
      assert(writer->batch_cnt || !seq_per_batch_);
      if (!writer->CallbackFailed()) {
        total_batch_cnt += writer->batch_cnt;
      }
765 766 767
    }
    seq_inc = total_batch_cnt;
  }
768
  Status status;
769
  IOStatus io_s;
M
Maysam Yabandeh 已提交
770
  if (!write_options.disableWAL) {
771 772
    io_s = ConcurrentWriteToWAL(write_group, log_used, &last_sequence, seq_inc);
    status = io_s;
M
Maysam Yabandeh 已提交
773 774 775 776
  } else {
    // Otherwise we inc seq number to do solely the seq allocation
    last_sequence = versions_->FetchAddLastAllocatedSequence(seq_inc);
  }
M
Maysam Yabandeh 已提交
777 778

  size_t memtable_write_cnt = 0;
779 780
  auto curr_seq = last_sequence + 1;
  for (auto* writer : write_group) {
781 782
    if (writer->CallbackFailed()) {
      continue;
783
    }
784
    writer->sequence = curr_seq;
M
Maysam Yabandeh 已提交
785 786
    if (assign_order == kDoAssignOrder) {
      assert(writer->batch_cnt || !seq_per_batch_);
787
      curr_seq += writer->batch_cnt;
788
    }
M
Maysam Yabandeh 已提交
789 790 791
    if (!writer->disable_memtable) {
      memtable_write_cnt++;
    }
792
    // else seq advances only by memtable writes
793
  }
794
  if (status.ok() && write_options.sync) {
M
Maysam Yabandeh 已提交
795
    assert(!write_options.disableWAL);
796
    // Requesting sync with two_write_queues_ is expected to be very rare. We
797 798 799 800 801 802 803 804 805 806
    // hance provide a simple implementation that is not necessarily efficient.
    if (manual_wal_flush_) {
      status = FlushWAL(true);
    } else {
      status = SyncWAL();
    }
  }
  PERF_TIMER_START(write_pre_and_post_process_time);

  if (!w.CallbackFailed()) {
807 808 809 810 811
    if (!io_s.ok()) {
      IOStatusCheck(io_s);
    } else {
      WriteStatusCheck(status);
    }
812
  }
813
  if (status.ok()) {
814
    size_t index = 0;
815 816 817
    for (auto* writer : write_group) {
      if (!writer->CallbackFailed() && writer->pre_release_callback) {
        assert(writer->sequence != kMaxSequenceNumber);
818
        Status ws = writer->pre_release_callback->Callback(
819 820
            writer->sequence, disable_memtable, writer->log_used, index++,
            pre_release_callback_cnt);
821 822 823 824 825 826 827
        if (!ws.ok()) {
          status = ws;
          break;
        }
      }
    }
  }
M
Maysam Yabandeh 已提交
828 829 830 831 832 833 834 835 836
  if (publish_last_seq == kDoPublishLastSeq) {
    versions_->SetLastSequence(last_sequence + seq_inc);
    // Currently we only use kDoPublishLastSeq in unordered_write
    assert(immutable_db_options_.unordered_write);
  }
  if (immutable_db_options_.unordered_write && status.ok()) {
    pending_memtable_writes_ += memtable_write_cnt;
  }
  write_thread->ExitAsBatchGroupLeader(write_group, status);
837 838 839
  if (status.ok()) {
    status = w.FinalStatus();
  }
840 841 842
  if (seq_used != nullptr) {
    *seq_used = w.sequence;
  }
843
  return status;
844 845
}

846 847 848 849
void DBImpl::WriteStatusCheckOnLocked(const Status& status) {
  // Is setting bg_error_ enough here?  This will at least stop
  // compaction and fail any further writes.
  // Caller must hold mutex_.
850
  assert(!status.IsIOFenced() || !error_handler_.GetBGError().ok());
851 852 853
  mutex_.AssertHeld();
  if (immutable_db_options_.paranoid_checks && !status.ok() &&
      !status.IsBusy() && !status.IsIncomplete()) {
854
    // Maybe change the return status to void?
855
    error_handler_.SetBGError(status, BackgroundErrorReason::kWriteCallback);
856 857 858
  }
}

859
void DBImpl::WriteStatusCheck(const Status& status) {
860 861
  // Is setting bg_error_ enough here?  This will at least stop
  // compaction and fail any further writes.
862
  assert(!status.IsIOFenced() || !error_handler_.GetBGError().ok());
863 864 865
  if (immutable_db_options_.paranoid_checks && !status.ok() &&
      !status.IsBusy() && !status.IsIncomplete()) {
    mutex_.Lock();
866
    // Maybe change the return status to void?
867
    error_handler_.SetBGError(status, BackgroundErrorReason::kWriteCallback);
868 869 870 871
    mutex_.Unlock();
  }
}

872 873 874
void DBImpl::IOStatusCheck(const IOStatus& io_status) {
  // Is setting bg_error_ enough here?  This will at least stop
  // compaction and fail any further writes.
875 876 877
  if ((immutable_db_options_.paranoid_checks && !io_status.ok() &&
       !io_status.IsBusy() && !io_status.IsIncomplete()) ||
      io_status.IsIOFenced()) {
878
    mutex_.Lock();
879
    // Maybe change the return status to void?
880
    error_handler_.SetBGError(io_status, BackgroundErrorReason::kWriteCallback);
881 882 883 884
    mutex_.Unlock();
  }
}

885
void DBImpl::MemTableInsertStatusCheck(const Status& status) {
Y
Yi Wu 已提交
886 887 888 889 890
  // A non-OK status here indicates that the state implied by the
  // WAL has diverged from the in-memory state.  This could be
  // because of a corrupt write_batch (very bad), or because the
  // client specified an invalid column family and didn't specify
  // ignore_missing_column_families.
891
  if (!status.ok()) {
Y
Yi Wu 已提交
892
    mutex_.Lock();
893
    assert(!error_handler_.IsBGWorkStopped());
894
    // Maybe change the return status to void?
895 896
    error_handler_.SetBGError(status, BackgroundErrorReason::kMemTable)
        .PermitUncheckedError();
Y
Yi Wu 已提交
897 898 899 900
    mutex_.Unlock();
  }
}

S
Siying Dong 已提交
901
Status DBImpl::PreprocessWrite(const WriteOptions& write_options,
902
                               bool* need_log_sync,
S
Siying Dong 已提交
903 904
                               WriteContext* write_context) {
  mutex_.AssertHeld();
905
  assert(write_context != nullptr && need_log_sync != nullptr);
S
Siying Dong 已提交
906 907
  Status status;

908 909 910 911
  if (error_handler_.IsDBStopped()) {
    status = error_handler_.GetBGError();
  }

912 913
  PERF_TIMER_GUARD(write_scheduling_flushes_compactions_time);

S
Siying Dong 已提交
914 915 916 917
  assert(!single_column_family_mode_ ||
         versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1);
  if (UNLIKELY(status.ok() && !single_column_family_mode_ &&
               total_log_size_ > GetMaxTotalWalSize())) {
M
Maysam Yabandeh 已提交
918
    WaitForPendingWrites();
919
    status = SwitchWAL(write_context);
S
Siying Dong 已提交
920 921 922 923 924 925 926 927
  }

  if (UNLIKELY(status.ok() && write_buffer_manager_->ShouldFlush())) {
    // Before a new memtable is added in SwitchMemtable(),
    // write_buffer_manager_->ShouldFlush() will keep returning true. If another
    // thread is writing to another DB with the same write buffer, they may also
    // be flushed. We may end up with flushing much more DBs than needed. It's
    // suboptimal but still correct.
M
Maysam Yabandeh 已提交
928
    WaitForPendingWrites();
S
Siying Dong 已提交
929 930 931
    status = HandleWriteBufferFull(write_context);
  }

932 933 934 935
  if (UNLIKELY(status.ok() && !trim_history_scheduler_.Empty())) {
    status = TrimMemtableHistory(write_context);
  }

S
Siying Dong 已提交
936
  if (UNLIKELY(status.ok() && !flush_scheduler_.Empty())) {
M
Maysam Yabandeh 已提交
937
    WaitForPendingWrites();
S
Siying Dong 已提交
938 939 940
    status = ScheduleFlushes(write_context);
  }

941 942 943
  PERF_TIMER_STOP(write_scheduling_flushes_compactions_time);
  PERF_TIMER_GUARD(write_pre_and_post_process_time);

S
Siying Dong 已提交
944 945
  if (UNLIKELY(status.ok() && (write_controller_.IsStopped() ||
                               write_controller_.NeedsDelay()))) {
946
    PERF_TIMER_STOP(write_pre_and_post_process_time);
S
Siying Dong 已提交
947 948 949 950 951 952
    PERF_TIMER_GUARD(write_delay_time);
    // 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.
    status = DelayWrite(last_batch_group_size_, write_options);
953
    PERF_TIMER_START(write_pre_and_post_process_time);
S
Siying Dong 已提交
954 955
  }

956
  if (status.ok() && *need_log_sync) {
957 958 959 960 961 962 963
    // Wait until the parallel syncs are finished. Any sync process has to sync
    // the front log too so it is enough to check the status of front()
    // We do a while loop since log_sync_cv_ is signalled when any sync is
    // finished
    // Note: there does not seem to be a reason to wait for parallel sync at
    // this early step but it is not important since parallel sync (SyncWAL) and
    // need_log_sync are usually not used together.
S
Siying Dong 已提交
964 965 966 967 968
    while (logs_.front().getting_synced) {
      log_sync_cv_.Wait();
    }
    for (auto& log : logs_) {
      assert(!log.getting_synced);
969 970 971 972 973
      // This is just to prevent the logs to be synced by a parallel SyncWAL
      // call. We will do the actual syncing later after we will write to the
      // WAL.
      // Note: there does not seem to be a reason to set this early before we
      // actually write to the WAL
S
Siying Dong 已提交
974 975
      log.getting_synced = true;
    }
976 977
  } else {
    *need_log_sync = false;
S
Siying Dong 已提交
978 979 980 981 982
  }

  return status;
}

983
WriteBatch* DBImpl::MergeBatch(const WriteThread::WriteGroup& write_group,
984 985
                               WriteBatch* tmp_batch, size_t* write_with_wal,
                               WriteBatch** to_be_cached_state) {
986 987
  assert(write_with_wal != nullptr);
  assert(tmp_batch != nullptr);
988
  assert(*to_be_cached_state == nullptr);
S
Siying Dong 已提交
989
  WriteBatch* merged_batch = nullptr;
990
  *write_with_wal = 0;
991
  auto* leader = write_group.leader;
992 993
  assert(!leader->disable_wal);  // Same holds for all in the batch group
  if (write_group.size == 1 && !leader->CallbackFailed() &&
994
      leader->batch->GetWalTerminationPoint().is_cleared()) {
S
Siying Dong 已提交
995 996 997
    // we simply write the first WriteBatch to WAL if the group only
    // contains one batch, that batch should be written to the WAL,
    // and the batch is not wanting to be truncated
998
    merged_batch = leader->batch;
999 1000 1001
    if (WriteBatchInternal::IsLatestPersistentState(merged_batch)) {
      *to_be_cached_state = merged_batch;
    }
1002
    *write_with_wal = 1;
S
Siying Dong 已提交
1003 1004 1005 1006
  } else {
    // WAL needs all of the batches flattened into a single batch.
    // We could avoid copying here with an iov-like AddRecord
    // interface
1007
    merged_batch = tmp_batch;
S
Siying Dong 已提交
1008
    for (auto writer : write_group) {
1009
      if (!writer->CallbackFailed()) {
1010 1011 1012 1013
        Status s = WriteBatchInternal::Append(merged_batch, writer->batch,
                                              /*WAL_only*/ true);
        // Always returns Status::OK.
        assert(s.ok());
1014 1015 1016 1017
        if (WriteBatchInternal::IsLatestPersistentState(writer->batch)) {
          // We only need to cache the last of such write batch
          *to_be_cached_state = writer->batch;
        }
1018
        (*write_with_wal)++;
S
Siying Dong 已提交
1019 1020 1021
      }
    }
  }
1022 1023
  return merged_batch;
}
S
Siying Dong 已提交
1024

1025
// When two_write_queues_ is disabled, this function is called from the only
1026
// write thread. Otherwise this must be called holding log_write_mutex_.
1027 1028 1029
IOStatus DBImpl::WriteToWAL(const WriteBatch& merged_batch,
                            log::Writer* log_writer, uint64_t* log_used,
                            uint64_t* log_size) {
1030 1031 1032
  assert(log_size != nullptr);
  Slice log_entry = WriteBatchInternal::Contents(&merged_batch);
  *log_size = log_entry.size();
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
  // When two_write_queues_ WriteToWAL has to be protected from concurretn calls
  // from the two queues anyway and log_write_mutex_ is already held. Otherwise
  // if manual_wal_flush_ is enabled we need to protect log_writer->AddRecord
  // from possible concurrent calls via the FlushWAL by the application.
  const bool needs_locking = manual_wal_flush_ && !two_write_queues_;
  // Due to performance cocerns of missed branch prediction penalize the new
  // manual_wal_flush_ feature (by UNLIKELY) instead of the more common case
  // when we do not need any locking.
  if (UNLIKELY(needs_locking)) {
    log_write_mutex_.Lock();
  }
1044 1045
  IOStatus io_s = log_writer->AddRecord(log_entry);

1046 1047 1048
  if (UNLIKELY(needs_locking)) {
    log_write_mutex_.Unlock();
  }
1049 1050 1051
  if (log_used != nullptr) {
    *log_used = logfile_number_;
  }
S
Siying Dong 已提交
1052
  total_log_size_ += log_entry.size();
1053 1054
  // TODO(myabandeh): it might be unsafe to access alive_log_files_.back() here
  // since alive_log_files_ might be modified concurrently
S
Siying Dong 已提交
1055 1056
  alive_log_files_.back().AddSize(log_entry.size());
  log_empty_ = false;
1057
  return io_s;
1058 1059
}

1060 1061 1062 1063 1064
IOStatus DBImpl::WriteToWAL(const WriteThread::WriteGroup& write_group,
                            log::Writer* log_writer, uint64_t* log_used,
                            bool need_log_sync, bool need_log_dir_sync,
                            SequenceNumber sequence) {
  IOStatus io_s;
1065 1066
  assert(!write_group.leader->disable_wal);
  // Same holds for all in the batch group
1067
  size_t write_with_wal = 0;
1068 1069 1070
  WriteBatch* to_be_cached_state = nullptr;
  WriteBatch* merged_batch = MergeBatch(write_group, &tmp_batch_,
                                        &write_with_wal, &to_be_cached_state);
M
Maysam Yabandeh 已提交
1071 1072 1073 1074 1075 1076 1077
  if (merged_batch == write_group.leader->batch) {
    write_group.leader->log_used = logfile_number_;
  } else if (write_with_wal > 1) {
    for (auto writer : write_group) {
      writer->log_used = logfile_number_;
    }
  }
1078 1079 1080 1081

  WriteBatchInternal::SetSequence(merged_batch, sequence);

  uint64_t log_size;
1082
  io_s = WriteToWAL(*merged_batch, log_writer, log_used, &log_size);
1083 1084
  if (to_be_cached_state) {
    cached_recoverable_state_ = *to_be_cached_state;
1085
    cached_recoverable_state_empty_ = false;
1086
  }
S
Siying Dong 已提交
1087

1088
  if (io_s.ok() && need_log_sync) {
S
Siying Dong 已提交
1089 1090 1091 1092 1093 1094 1095 1096 1097
    StopWatch sw(env_, stats_, WAL_FILE_SYNC_MICROS);
    // It's safe to access logs_ with unlocked mutex_ here because:
    //  - we've set getting_synced=true for all logs,
    //    so other threads won't pop from logs_ while we're here,
    //  - only writer thread can push to logs_, and we're in
    //    writer thread, so no one will push to logs_,
    //  - as long as other threads don't modify it, it's safe to read
    //    from std::deque from multiple threads concurrently.
    for (auto& log : logs_) {
1098 1099
      io_s = log.writer->file()->Sync(immutable_db_options_.use_fsync);
      if (!io_s.ok()) {
S
Siying Dong 已提交
1100 1101 1102
        break;
      }
    }
1103 1104

    if (io_s.ok() && need_log_dir_sync) {
S
Siying Dong 已提交
1105 1106 1107
      // 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.
1108
      io_s = directories_.GetWalDir()->Fsync(IOOptions(), nullptr);
S
Siying Dong 已提交
1109 1110 1111 1112 1113 1114
    }
  }

  if (merged_batch == &tmp_batch_) {
    tmp_batch_.Clear();
  }
1115
  if (io_s.ok()) {
S
Siying Dong 已提交
1116 1117
    auto stats = default_cf_internal_stats_;
    if (need_log_sync) {
1118
      stats->AddDBStats(InternalStats::kIntStatsWalFileSynced, 1);
S
Siying Dong 已提交
1119 1120
      RecordTick(stats_, WAL_FILE_SYNCED);
    }
1121
    stats->AddDBStats(InternalStats::kIntStatsWalFileBytes, log_size);
S
Siying Dong 已提交
1122
    RecordTick(stats_, WAL_FILE_BYTES, log_size);
1123
    stats->AddDBStats(InternalStats::kIntStatsWriteWithWal, write_with_wal);
S
Siying Dong 已提交
1124 1125
    RecordTick(stats_, WRITE_WITH_WAL, write_with_wal);
  }
1126
  return io_s;
S
Siying Dong 已提交
1127 1128
}

1129 1130 1131 1132
IOStatus DBImpl::ConcurrentWriteToWAL(
    const WriteThread::WriteGroup& write_group, uint64_t* log_used,
    SequenceNumber* last_sequence, size_t seq_inc) {
  IOStatus io_s;
1133

1134 1135
  assert(!write_group.leader->disable_wal);
  // Same holds for all in the batch group
1136 1137
  WriteBatch tmp_batch;
  size_t write_with_wal = 0;
1138
  WriteBatch* to_be_cached_state = nullptr;
1139
  WriteBatch* merged_batch =
1140
      MergeBatch(write_group, &tmp_batch, &write_with_wal, &to_be_cached_state);
1141 1142 1143 1144

  // We need to lock log_write_mutex_ since logs_ and alive_log_files might be
  // pushed back concurrently
  log_write_mutex_.Lock();
M
Maysam Yabandeh 已提交
1145 1146 1147 1148 1149 1150 1151
  if (merged_batch == write_group.leader->batch) {
    write_group.leader->log_used = logfile_number_;
  } else if (write_with_wal > 1) {
    for (auto writer : write_group) {
      writer->log_used = logfile_number_;
    }
  }
1152
  *last_sequence = versions_->FetchAddLastAllocatedSequence(seq_inc);
1153 1154 1155 1156 1157
  auto sequence = *last_sequence + 1;
  WriteBatchInternal::SetSequence(merged_batch, sequence);

  log::Writer* log_writer = logs_.back().writer;
  uint64_t log_size;
1158
  io_s = WriteToWAL(*merged_batch, log_writer, log_used, &log_size);
1159 1160
  if (to_be_cached_state) {
    cached_recoverable_state_ = *to_be_cached_state;
1161
    cached_recoverable_state_empty_ = false;
1162
  }
1163 1164
  log_write_mutex_.Unlock();

1165
  if (io_s.ok()) {
1166
    const bool concurrent = true;
1167
    auto stats = default_cf_internal_stats_;
1168 1169
    stats->AddDBStats(InternalStats::kIntStatsWalFileBytes, log_size,
                      concurrent);
1170
    RecordTick(stats_, WAL_FILE_BYTES, log_size);
1171
    stats->AddDBStats(InternalStats::kIntStatsWriteWithWal, write_with_wal,
1172
                      concurrent);
1173 1174
    RecordTick(stats_, WRITE_WITH_WAL, write_with_wal);
  }
1175
  return io_s;
1176 1177
}

1178 1179 1180 1181 1182
Status DBImpl::WriteRecoverableState() {
  mutex_.AssertHeld();
  if (!cached_recoverable_state_empty_) {
    bool dont_care_bool;
    SequenceNumber next_seq;
1183
    if (two_write_queues_) {
1184 1185
      log_write_mutex_.Lock();
    }
1186 1187 1188 1189 1190 1191
    SequenceNumber seq;
    if (two_write_queues_) {
      seq = versions_->FetchAddLastAllocatedSequence(0);
    } else {
      seq = versions_->LastSequence();
    }
1192
    WriteBatchInternal::SetSequence(&cached_recoverable_state_, seq + 1);
1193 1194
    auto status = WriteBatchInternal::InsertInto(
        &cached_recoverable_state_, column_family_memtables_.get(),
1195 1196 1197
        &flush_scheduler_, &trim_history_scheduler_, true,
        0 /*recovery_log_number*/, this, false /* concurrent_memtable_writes */,
        &next_seq, &dont_care_bool, seq_per_batch_);
1198 1199 1200
    auto last_seq = next_seq - 1;
    if (two_write_queues_) {
      versions_->FetchAddLastAllocatedSequence(last_seq - seq);
1201
      versions_->SetLastPublishedSequence(last_seq);
1202 1203
    }
    versions_->SetLastSequence(last_seq);
1204
    if (two_write_queues_) {
1205 1206
      log_write_mutex_.Unlock();
    }
1207 1208 1209 1210
    if (status.ok() && recoverable_state_pre_release_callback_) {
      const bool DISABLE_MEMTABLE = true;
      for (uint64_t sub_batch_seq = seq + 1;
           sub_batch_seq < next_seq && status.ok(); sub_batch_seq++) {
1211
        uint64_t const no_log_num = 0;
1212 1213 1214
        // Unlock it since the callback might end up locking mutex. e.g.,
        // AddCommitted -> AdvanceMaxEvictedSeq -> GetSnapshotListFromDB
        mutex_.Unlock();
1215
        status = recoverable_state_pre_release_callback_->Callback(
1216
            sub_batch_seq, !DISABLE_MEMTABLE, no_log_num, 0, 1);
1217
        mutex_.Lock();
1218 1219
      }
    }
1220 1221 1222 1223 1224 1225 1226 1227 1228
    if (status.ok()) {
      cached_recoverable_state_.Clear();
      cached_recoverable_state_empty_ = true;
    }
    return status;
  }
  return Status::OK();
}

Y
Yanqin Jin 已提交
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243
void DBImpl::SelectColumnFamiliesForAtomicFlush(
    autovector<ColumnFamilyData*>* cfds) {
  for (ColumnFamilyData* cfd : *versions_->GetColumnFamilySet()) {
    if (cfd->IsDropped()) {
      continue;
    }
    if (cfd->imm()->NumNotFlushed() != 0 || !cfd->mem()->IsEmpty() ||
        !cached_recoverable_state_empty_.load()) {
      cfds->push_back(cfd);
    }
  }
}

// Assign sequence number for atomic flush.
void DBImpl::AssignAtomicFlushSeq(const autovector<ColumnFamilyData*>& cfds) {
1244
  assert(immutable_db_options_.atomic_flush);
Y
Yanqin Jin 已提交
1245 1246 1247 1248 1249 1250
  auto seq = versions_->LastSequence();
  for (auto cfd : cfds) {
    cfd->imm()->AssignAtomicFlushSeq(seq);
  }
}

1251
Status DBImpl::SwitchWAL(WriteContext* write_context) {
S
Siying Dong 已提交
1252 1253 1254 1255 1256 1257 1258 1259 1260
  mutex_.AssertHeld();
  assert(write_context != nullptr);
  Status status;

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

  auto oldest_alive_log = alive_log_files_.begin()->number;
S
Siying Dong 已提交
1261 1262
  bool flush_wont_release_oldest_log = false;
  if (allow_2pc()) {
F
Faustin Lammler 已提交
1263
    auto oldest_log_with_uncommitted_prep =
S
Siying Dong 已提交
1264 1265
        logs_with_prep_tracker_.FindMinLogContainingOutstandingPrep();

F
Faustin Lammler 已提交
1266 1267 1268 1269
    assert(oldest_log_with_uncommitted_prep == 0 ||
           oldest_log_with_uncommitted_prep >= oldest_alive_log);
    if (oldest_log_with_uncommitted_prep > 0 &&
        oldest_log_with_uncommitted_prep == oldest_alive_log) {
S
Siying Dong 已提交
1270
      if (unable_to_release_oldest_log_) {
S
Siying Dong 已提交
1271
        // we already attempted to flush all column families dependent on
F
Faustin Lammler 已提交
1272
        // the oldest alive log but the log still contained uncommitted
S
Siying Dong 已提交
1273
        // transactions so there is still nothing that we can do.
S
Siying Dong 已提交
1274
        return status;
S
Siying Dong 已提交
1275 1276 1277
      } else {
        ROCKS_LOG_WARN(
            immutable_db_options_.info_log,
F
Faustin Lammler 已提交
1278
            "Unable to release oldest log due to uncommitted transaction");
S
Siying Dong 已提交
1279 1280 1281
        unable_to_release_oldest_log_ = true;
        flush_wont_release_oldest_log = true;
      }
S
Siying Dong 已提交
1282
    }
S
Siying Dong 已提交
1283 1284
  }
  if (!flush_wont_release_oldest_log) {
S
Siying Dong 已提交
1285 1286
    // we only mark this log as getting flushed if we have successfully
    // flushed all data in this log. If this log contains outstanding prepared
1287 1288
    // transactions then we cannot flush this log until those transactions are
    // commited.
S
Siying Dong 已提交
1289
    unable_to_release_oldest_log_ = false;
S
Siying Dong 已提交
1290 1291 1292
    alive_log_files_.begin()->getting_flushed = true;
  }

1293 1294 1295 1296 1297
  ROCKS_LOG_INFO(
      immutable_db_options_.info_log,
      "Flushing all column families with data in WAL number %" PRIu64
      ". Total log size is %" PRIu64 " while max_total_wal_size is %" PRIu64,
      oldest_alive_log, total_log_size_.load(), GetMaxTotalWalSize());
S
Siying Dong 已提交
1298 1299
  // no need to refcount because drop is happening in write thread, so can't
  // happen while we're in the write thread
Y
Yanqin Jin 已提交
1300
  autovector<ColumnFamilyData*> cfds;
1301
  if (immutable_db_options_.atomic_flush) {
Y
Yanqin Jin 已提交
1302 1303 1304 1305 1306
    SelectColumnFamiliesForAtomicFlush(&cfds);
  } else {
    for (auto cfd : *versions_->GetColumnFamilySet()) {
      if (cfd->IsDropped()) {
        continue;
S
Siying Dong 已提交
1307
      }
Y
Yanqin Jin 已提交
1308 1309 1310 1311
      if (cfd->OldestLogToKeep() <= oldest_alive_log) {
        cfds.push_back(cfd);
      }
    }
1312
    MaybeFlushStatsCF(&cfds);
Y
Yanqin Jin 已提交
1313
  }
1314 1315 1316 1317 1318
  WriteThread::Writer nonmem_w;
  if (two_write_queues_) {
    nonmem_write_thread_.EnterUnbatched(&nonmem_w, &mutex_);
  }

Y
Yanqin Jin 已提交
1319 1320 1321
  for (const auto cfd : cfds) {
    cfd->Ref();
    status = SwitchMemtable(cfd, write_context);
1322
    cfd->UnrefAndTryDelete();
Y
Yanqin Jin 已提交
1323 1324
    if (!status.ok()) {
      break;
S
Siying Dong 已提交
1325 1326
    }
  }
1327 1328 1329 1330
  if (two_write_queues_) {
    nonmem_write_thread_.ExitUnbatched(&nonmem_w);
  }

1331
  if (status.ok()) {
1332
    if (immutable_db_options_.atomic_flush) {
Y
Yanqin Jin 已提交
1333 1334 1335 1336
      AssignAtomicFlushSeq(cfds);
    }
    for (auto cfd : cfds) {
      cfd->imm()->FlushRequested();
1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
      if (!immutable_db_options_.atomic_flush) {
        FlushRequest flush_req;
        GenerateFlushRequest({cfd}, &flush_req);
        SchedulePendingFlush(flush_req, FlushReason::kWriteBufferManager);
      }
    }
    if (immutable_db_options_.atomic_flush) {
      FlushRequest flush_req;
      GenerateFlushRequest(cfds, &flush_req);
      SchedulePendingFlush(flush_req, FlushReason::kWriteBufferManager);
Y
Yanqin Jin 已提交
1347
    }
1348 1349
    MaybeScheduleFlushOrCompaction();
  }
S
Siying Dong 已提交
1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364
  return status;
}

Status DBImpl::HandleWriteBufferFull(WriteContext* write_context) {
  mutex_.AssertHeld();
  assert(write_context != nullptr);
  Status status;

  // Before a new memtable is added in SwitchMemtable(),
  // write_buffer_manager_->ShouldFlush() will keep returning true. If another
  // thread is writing to another DB with the same write buffer, they may also
  // be flushed. We may end up with flushing much more DBs than needed. It's
  // suboptimal but still correct.
  ROCKS_LOG_INFO(
      immutable_db_options_.info_log,
1365
      "Flushing column family with oldest memtable entry. Write buffer is "
1366
      "using %" ROCKSDB_PRIszt " bytes out of a total of %" ROCKSDB_PRIszt ".",
S
Siying Dong 已提交
1367 1368 1369 1370
      write_buffer_manager_->memory_usage(),
      write_buffer_manager_->buffer_size());
  // no need to refcount because drop is happening in write thread, so can't
  // happen while we're in the write thread
Y
Yanqin Jin 已提交
1371
  autovector<ColumnFamilyData*> cfds;
1372
  if (immutable_db_options_.atomic_flush) {
Y
Yanqin Jin 已提交
1373 1374 1375 1376
    SelectColumnFamiliesForAtomicFlush(&cfds);
  } else {
    ColumnFamilyData* cfd_picked = nullptr;
    SequenceNumber seq_num_for_cf_picked = kMaxSequenceNumber;
S
Siying Dong 已提交
1377

Y
Yanqin Jin 已提交
1378 1379 1380
    for (auto cfd : *versions_->GetColumnFamilySet()) {
      if (cfd->IsDropped()) {
        continue;
S
Siying Dong 已提交
1381
      }
Y
Yanqin Jin 已提交
1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393
      if (!cfd->mem()->IsEmpty()) {
        // We only consider active mem table, hoping immutable memtable is
        // already in the process of flushing.
        uint64_t seq = cfd->mem()->GetCreationSeq();
        if (cfd_picked == nullptr || seq < seq_num_for_cf_picked) {
          cfd_picked = cfd;
          seq_num_for_cf_picked = seq;
        }
      }
    }
    if (cfd_picked != nullptr) {
      cfds.push_back(cfd_picked);
S
Siying Dong 已提交
1394
    }
1395
    MaybeFlushStatsCF(&cfds);
S
Siying Dong 已提交
1396
  }
1397

1398 1399 1400 1401
  WriteThread::Writer nonmem_w;
  if (two_write_queues_) {
    nonmem_write_thread_.EnterUnbatched(&nonmem_w, &mutex_);
  }
1402
  for (const auto cfd : cfds) {
1403 1404 1405
    if (cfd->mem()->IsEmpty()) {
      continue;
    }
1406 1407
    cfd->Ref();
    status = SwitchMemtable(cfd, write_context);
1408
    cfd->UnrefAndTryDelete();
1409 1410
    if (!status.ok()) {
      break;
S
Siying Dong 已提交
1411
    }
1412
  }
1413 1414 1415 1416
  if (two_write_queues_) {
    nonmem_write_thread_.ExitUnbatched(&nonmem_w);
  }

1417
  if (status.ok()) {
1418
    if (immutable_db_options_.atomic_flush) {
Y
Yanqin Jin 已提交
1419 1420 1421 1422
      AssignAtomicFlushSeq(cfds);
    }
    for (const auto cfd : cfds) {
      cfd->imm()->FlushRequested();
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432
      if (!immutable_db_options_.atomic_flush) {
        FlushRequest flush_req;
        GenerateFlushRequest({cfd}, &flush_req);
        SchedulePendingFlush(flush_req, FlushReason::kWriteBufferFull);
      }
    }
    if (immutable_db_options_.atomic_flush) {
      FlushRequest flush_req;
      GenerateFlushRequest(cfds, &flush_req);
      SchedulePendingFlush(flush_req, FlushReason::kWriteBufferFull);
Y
Yanqin Jin 已提交
1433
    }
1434
    MaybeScheduleFlushOrCompaction();
S
Siying Dong 已提交
1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456
  }
  return status;
}

uint64_t DBImpl::GetMaxTotalWalSize() const {
  mutex_.AssertHeld();
  return mutable_db_options_.max_total_wal_size == 0
             ? 4 * max_total_in_memory_state_
             : mutable_db_options_.max_total_wal_size;
}

// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
Status DBImpl::DelayWrite(uint64_t num_bytes,
                          const WriteOptions& write_options) {
  uint64_t time_delayed = 0;
  bool delayed = false;
  {
    StopWatch sw(env_, stats_, WRITE_STALL, &time_delayed);
    uint64_t delay = write_controller_.GetDelay(env_, num_bytes);
    if (delay > 0) {
      if (write_options.no_slowdown) {
1457
        return Status::Incomplete("Write stall");
S
Siying Dong 已提交
1458 1459 1460
      }
      TEST_SYNC_POINT("DBImpl::DelayWrite:Sleep");

1461 1462 1463 1464
      // Notify write_thread_ about the stall so it can setup a barrier and
      // fail any pending writers with no_slowdown
      write_thread_.BeginWriteStall();
      TEST_SYNC_POINT("DBImpl::DelayWrite:BeginWriteStallDone");
S
Siying Dong 已提交
1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480
      mutex_.Unlock();
      // We will delay the write until we have slept for delay ms or
      // we don't need a delay anymore
      const uint64_t kDelayInterval = 1000;
      uint64_t stall_end = sw.start_time() + delay;
      while (write_controller_.NeedsDelay()) {
        if (env_->NowMicros() >= stall_end) {
          // We already delayed this write `delay` microseconds
          break;
        }

        delayed = true;
        // Sleep for 0.001 seconds
        env_->SleepForMicroseconds(kDelayInterval);
      }
      mutex_.Lock();
1481
      write_thread_.EndWriteStall();
S
Siying Dong 已提交
1482 1483
    }

1484 1485 1486 1487 1488
    // Don't wait if there's a background error, even if its a soft error. We
    // might wait here indefinitely as the background compaction may never
    // finish successfully, resulting in the stall condition lasting
    // indefinitely
    while (error_handler_.GetBGError().ok() && write_controller_.IsStopped()) {
S
Siying Dong 已提交
1489
      if (write_options.no_slowdown) {
1490
        return Status::Incomplete("Write stall");
S
Siying Dong 已提交
1491 1492
      }
      delayed = true;
1493 1494 1495 1496

      // Notify write_thread_ about the stall so it can setup a barrier and
      // fail any pending writers with no_slowdown
      write_thread_.BeginWriteStall();
S
Siying Dong 已提交
1497 1498
      TEST_SYNC_POINT("DBImpl::DelayWrite:Wait");
      bg_cv_.Wait();
1499
      write_thread_.EndWriteStall();
S
Siying Dong 已提交
1500 1501 1502 1503
    }
  }
  assert(!delayed || !write_options.no_slowdown);
  if (delayed) {
1504 1505
    default_cf_internal_stats_->AddDBStats(
        InternalStats::kIntStatsWriteStallMicros, time_delayed);
S
Siying Dong 已提交
1506 1507 1508
    RecordTick(stats_, STALL_MICROS, time_delayed);
  }

1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
  // If DB is not in read-only mode and write_controller is not stopping
  // writes, we can ignore any background errors and allow the write to
  // proceed
  Status s;
  if (write_controller_.IsStopped()) {
    // If writes are still stopped, it means we bailed due to a background
    // error
    s = Status::Incomplete(error_handler_.GetBGError().ToString());
  }
  if (error_handler_.IsDBStopped()) {
    s = error_handler_.GetBGError();
  }
  return s;
S
Siying Dong 已提交
1522 1523
}

1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537
Status DBImpl::ThrottleLowPriWritesIfNeeded(const WriteOptions& write_options,
                                            WriteBatch* my_batch) {
  assert(write_options.low_pri);
  // This is called outside the DB mutex. Although it is safe to make the call,
  // the consistency condition is not guaranteed to hold. It's OK to live with
  // it in this case.
  // If we need to speed compaction, it means the compaction is left behind
  // and we start to limit low pri writes to a limit.
  if (write_controller_.NeedSpeedupCompaction()) {
    if (allow_2pc() && (my_batch->HasCommit() || my_batch->HasRollback())) {
      // For 2PC, we only rate limit prepare, not commit.
      return Status::OK();
    }
    if (write_options.no_slowdown) {
1538
      return Status::Incomplete("Low priority write stall");
1539 1540 1541 1542 1543 1544
    } else {
      assert(my_batch != nullptr);
      // Rate limit those writes. The reason that we don't completely wait
      // is that in case the write is heavy, low pri writes may never have
      // a chance to run. Now we guarantee we are still slowly making
      // progress.
1545
      PERF_TIMER_GUARD(write_delay_time);
1546 1547 1548
      write_controller_.low_pri_rate_limiter()->Request(
          my_batch->GetDataSize(), Env::IO_HIGH, nullptr /* stats */,
          RateLimiter::OpType::kWrite);
1549 1550 1551 1552 1553
    }
  }
  return Status::OK();
}

1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587
void DBImpl::MaybeFlushStatsCF(autovector<ColumnFamilyData*>* cfds) {
  assert(cfds != nullptr);
  if (!cfds->empty() && immutable_db_options_.persist_stats_to_disk) {
    ColumnFamilyData* cfd_stats =
        versions_->GetColumnFamilySet()->GetColumnFamily(
            kPersistentStatsColumnFamilyName);
    if (cfd_stats != nullptr && !cfd_stats->mem()->IsEmpty()) {
      for (ColumnFamilyData* cfd : *cfds) {
        if (cfd == cfd_stats) {
          // stats CF already included in cfds
          return;
        }
      }
      // force flush stats CF when its log number is less than all other CF's
      // log numbers
      bool force_flush_stats_cf = true;
      for (auto* loop_cfd : *versions_->GetColumnFamilySet()) {
        if (loop_cfd == cfd_stats) {
          continue;
        }
        if (loop_cfd->GetLogNumber() <= cfd_stats->GetLogNumber()) {
          force_flush_stats_cf = false;
        }
      }
      if (force_flush_stats_cf) {
        cfds->push_back(cfd_stats);
        ROCKS_LOG_INFO(immutable_db_options_.info_log,
                       "Force flushing stats CF with automated flush "
                       "to avoid holding old logs");
      }
    }
  }
}

1588 1589 1590 1591 1592 1593 1594 1595 1596
Status DBImpl::TrimMemtableHistory(WriteContext* context) {
  autovector<ColumnFamilyData*> cfds;
  ColumnFamilyData* tmp_cfd;
  while ((tmp_cfd = trim_history_scheduler_.TakeNextColumnFamily()) !=
         nullptr) {
    cfds.push_back(tmp_cfd);
  }
  for (auto& cfd : cfds) {
    autovector<MemTable*> to_delete;
1597 1598
    bool trimmed = cfd->imm()->TrimHistory(
        &to_delete, cfd->mem()->ApproximateMemoryUsage());
1599 1600 1601 1602
    if (!to_delete.empty()) {
      for (auto m : to_delete) {
        delete m;
      }
1603 1604
    }
    if (trimmed) {
1605 1606 1607
      context->superversion_context.NewSuperVersion();
      assert(context->superversion_context.new_superversion.get() != nullptr);
      cfd->InstallSuperVersion(&context->superversion_context, &mutex_);
1608 1609
    }

1610
    if (cfd->UnrefAndTryDelete()) {
1611 1612 1613 1614 1615 1616
      cfd = nullptr;
    }
  }
  return Status::OK();
}

S
Siying Dong 已提交
1617
Status DBImpl::ScheduleFlushes(WriteContext* context) {
Y
Yanqin Jin 已提交
1618
  autovector<ColumnFamilyData*> cfds;
1619
  if (immutable_db_options_.atomic_flush) {
Y
Yanqin Jin 已提交
1620 1621 1622 1623 1624 1625 1626 1627 1628 1629
    SelectColumnFamiliesForAtomicFlush(&cfds);
    for (auto cfd : cfds) {
      cfd->Ref();
    }
    flush_scheduler_.Clear();
  } else {
    ColumnFamilyData* tmp_cfd;
    while ((tmp_cfd = flush_scheduler_.TakeNextColumnFamily()) != nullptr) {
      cfds.push_back(tmp_cfd);
    }
1630
    MaybeFlushStatsCF(&cfds);
Y
Yanqin Jin 已提交
1631
  }
1632
  Status status;
1633 1634 1635 1636 1637
  WriteThread::Writer nonmem_w;
  if (two_write_queues_) {
    nonmem_write_thread_.EnterUnbatched(&nonmem_w, &mutex_);
  }

Y
Yanqin Jin 已提交
1638
  for (auto& cfd : cfds) {
1639 1640 1641
    if (!cfd->mem()->IsEmpty()) {
      status = SwitchMemtable(cfd, context);
    }
1642
    if (cfd->UnrefAndTryDelete()) {
Y
Yanqin Jin 已提交
1643
      cfd = nullptr;
S
Siying Dong 已提交
1644 1645
    }
    if (!status.ok()) {
1646 1647
      break;
    }
S
Siying Dong 已提交
1648
  }
1649 1650 1651 1652 1653

  if (two_write_queues_) {
    nonmem_write_thread_.ExitUnbatched(&nonmem_w);
  }

1654
  if (status.ok()) {
1655
    if (immutable_db_options_.atomic_flush) {
Y
Yanqin Jin 已提交
1656
      AssignAtomicFlushSeq(cfds);
1657 1658 1659 1660 1661 1662 1663 1664 1665
      FlushRequest flush_req;
      GenerateFlushRequest(cfds, &flush_req);
      SchedulePendingFlush(flush_req, FlushReason::kWriteBufferFull);
    } else {
      for (auto* cfd : cfds) {
        FlushRequest flush_req;
        GenerateFlushRequest({cfd}, &flush_req);
        SchedulePendingFlush(flush_req, FlushReason::kWriteBufferFull);
      }
Y
Yanqin Jin 已提交
1666
    }
1667 1668 1669
    MaybeScheduleFlushOrCompaction();
  }
  return status;
S
Siying Dong 已提交
1670 1671 1672
}

#ifndef ROCKSDB_LITE
A
Andrew Kryczka 已提交
1673
void DBImpl::NotifyOnMemTableSealed(ColumnFamilyData* /*cfd*/,
S
Siying Dong 已提交
1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689
                                    const MemTableInfo& mem_table_info) {
  if (immutable_db_options_.listeners.size() == 0U) {
    return;
  }
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }

  for (auto listener : immutable_db_options_.listeners) {
    listener->OnMemTableSealed(mem_table_info);
  }
}
#endif  // ROCKSDB_LITE

// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
1690 1691
// REQUIRES: this thread is currently at the front of the 2nd writer queue if
// two_write_queues_ is true (This is to simplify the reasoning.)
1692
Status DBImpl::SwitchMemtable(ColumnFamilyData* cfd, WriteContext* context) {
S
Siying Dong 已提交
1693
  mutex_.AssertHeld();
M
Maysam Yabandeh 已提交
1694
  WriteThread::Writer nonmem_w;
1695
  std::unique_ptr<WritableFile> lfile;
S
Siying Dong 已提交
1696 1697
  log::Writer* new_log = nullptr;
  MemTable* new_mem = nullptr;
1698
  IOStatus io_s;
S
Siying Dong 已提交
1699

1700 1701 1702 1703 1704 1705 1706
  // Recoverable state is persisted in WAL. After memtable switch, WAL might
  // be deleted, so we write the state to memtable to be persisted as well.
  Status s = WriteRecoverableState();
  if (!s.ok()) {
    return s;
  }

S
Siying Dong 已提交
1707 1708 1709
  // Attempt to switch to a new memtable and trigger flush of old.
  // Do this without holding the dbmutex lock.
  assert(versions_->prev_log_number() == 0);
1710
  if (two_write_queues_) {
1711 1712
    log_write_mutex_.Lock();
  }
S
Siying Dong 已提交
1713
  bool creating_new_log = !log_empty_;
1714
  if (two_write_queues_) {
1715 1716
    log_write_mutex_.Unlock();
  }
S
Siying Dong 已提交
1717 1718
  uint64_t recycle_log_number = 0;
  if (creating_new_log && immutable_db_options_.recycle_log_file_num &&
1719 1720
      !log_recycle_files_.empty()) {
    recycle_log_number = log_recycle_files_.front();
S
Siying Dong 已提交
1721 1722 1723 1724 1725
  }
  uint64_t new_log_number =
      creating_new_log ? versions_->NewFileNumber() : logfile_number_;
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();

F
follitude 已提交
1726
  // Set memtable_info for memtable sealed callback
S
Siying Dong 已提交
1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738
#ifndef ROCKSDB_LITE
  MemTableInfo memtable_info;
  memtable_info.cf_name = cfd->GetName();
  memtable_info.first_seqno = cfd->mem()->GetFirstSequenceNumber();
  memtable_info.earliest_seqno = cfd->mem()->GetEarliestSequenceNumber();
  memtable_info.num_entries = cfd->mem()->num_entries();
  memtable_info.num_deletes = cfd->mem()->num_deletes();
#endif  // ROCKSDB_LITE
  // Log this later after lock release. It may be outdated, e.g., if background
  // flush happens before logging, but that should be ok.
  int num_imm_unflushed = cfd->imm()->NumNotFlushed();
  const auto preallocate_block_size =
1739
      GetWalPreallocateBlockSize(mutable_cf_options.write_buffer_size);
S
Siying Dong 已提交
1740
  mutex_.Unlock();
1741 1742 1743
  if (creating_new_log) {
    // TODO: Write buffer size passed in should be max of all CF's instead
    // of mutable_cf_options.write_buffer_size.
1744 1745 1746 1747 1748
    io_s = CreateWAL(new_log_number, recycle_log_number, preallocate_block_size,
                     &new_log);
    if (s.ok()) {
      s = io_s;
    }
1749 1750 1751 1752 1753
  }
  if (s.ok()) {
    SequenceNumber seq = versions_->LastSequence();
    new_mem = cfd->ConstructNewMemtable(mutable_cf_options, seq);
    context->superversion_context.NewSuperVersion();
S
Siying Dong 已提交
1754 1755 1756 1757 1758 1759
  }
  ROCKS_LOG_INFO(immutable_db_options_.info_log,
                 "[%s] New memtable created with log file: #%" PRIu64
                 ". Immutable memtables: %d.\n",
                 cfd->GetName().c_str(), new_log_number, num_imm_unflushed);
  mutex_.Lock();
1760 1761 1762 1763 1764 1765 1766 1767
  if (recycle_log_number != 0) {
    // Since renaming the file is done outside DB mutex, we need to ensure
    // concurrent full purges don't delete the file while we're recycling it.
    // To achieve that we hold the old log number in the recyclable list until
    // after it has been renamed.
    assert(log_recycle_files_.front() == recycle_log_number);
    log_recycle_files_.pop_front();
  }
1768
  if (s.ok() && creating_new_log) {
M
Maysam Yabandeh 已提交
1769
    log_write_mutex_.Lock();
S
Siying Dong 已提交
1770
    assert(new_log != nullptr);
1771 1772 1773
    if (!logs_.empty()) {
      // Alway flush the buffer of the last log before switching to a new one
      log::Writer* cur_log_writer = logs_.back().writer;
1774 1775 1776 1777
      io_s = cur_log_writer->WriteBuffer();
      if (s.ok()) {
        s = io_s;
      }
1778 1779 1780
      if (!s.ok()) {
        ROCKS_LOG_WARN(immutable_db_options_.info_log,
                       "[%s] Failed to switch from #%" PRIu64 " to #%" PRIu64
1781
                       "  WAL file\n",
1782 1783 1784
                       cfd->GetName().c_str(), cur_log_writer->get_log_number(),
                       new_log_number);
      }
1785
    }
1786 1787 1788 1789 1790 1791 1792
    if (s.ok()) {
      logfile_number_ = new_log_number;
      log_empty_ = true;
      log_dir_synced_ = false;
      logs_.emplace_back(logfile_number_, new_log);
      alive_log_files_.push_back(LogFileNumberSize(logfile_number_));
    }
1793
    log_write_mutex_.Unlock();
S
Siying Dong 已提交
1794
  }
1795 1796 1797 1798

  if (!s.ok()) {
    // how do we fail if we're not creating new log?
    assert(creating_new_log);
1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811
    if (new_mem) {
      delete new_mem;
    }
    if (new_log) {
      delete new_log;
    }
    SuperVersion* new_superversion =
        context->superversion_context.new_superversion.release();
    if (new_superversion != nullptr) {
      delete new_superversion;
    }
    // We may have lost data from the WritableFileBuffer in-memory buffer for
    // the current log, so treat it as a fatal error and set bg_error
1812
    if (!io_s.ok()) {
1813
      error_handler_.SetBGError(io_s, BackgroundErrorReason::kMemTable);
1814
    } else {
1815
      error_handler_.SetBGError(s, BackgroundErrorReason::kMemTable);
1816
    }
1817 1818
    // Read back bg_error in order to get the right severity
    s = error_handler_.GetBGError();
1819 1820 1821
    return s;
  }

1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878
  bool empty_cf_updated = false;
  if (immutable_db_options_.track_and_verify_wals_in_manifest &&
      !immutable_db_options_.allow_2pc && creating_new_log) {
    // In non-2pc mode, WALs become obsolete if they do not contain unflushed
    // data. Updating the empty CF's log number might cause some WALs to become
    // obsolete. So we should track the WAL obsoletion event before actually
    // updating the empty CF's log number.
    uint64_t min_wal_number_to_keep =
        versions_->PreComputeMinLogNumberWithUnflushedData(logfile_number_);
    if (min_wal_number_to_keep >
        versions_->GetWalSet().GetMinWalNumberToKeep()) {
      // Get a snapshot of the empty column families.
      // LogAndApply may release and reacquire db
      // mutex, during that period, column family may become empty (e.g. its
      // flush succeeds), then it affects the computed min_log_number_to_keep,
      // so we take a snapshot for consistency of column family data
      // status. If a column family becomes non-empty afterwards, its active log
      // should still be the created new log, so the min_log_number_to_keep is
      // not affected.
      autovector<ColumnFamilyData*> empty_cfs;
      for (auto cf : *versions_->GetColumnFamilySet()) {
        if (cf->IsEmpty()) {
          empty_cfs.push_back(cf);
        }
      }

      VersionEdit wal_deletion;
      wal_deletion.DeleteWalsBefore(min_wal_number_to_keep);
      s = versions_->LogAndApplyToDefaultColumnFamily(&wal_deletion, &mutex_);
      if (!s.ok() && versions_->io_status().IsIOError()) {
        s = error_handler_.SetBGError(versions_->io_status(),
                                      BackgroundErrorReason::kManifestWrite);
      }
      if (!s.ok()) {
        return s;
      }

      for (auto cf : empty_cfs) {
        if (cf->IsEmpty()) {
          cf->SetLogNumber(logfile_number_);
          cf->mem()->SetCreationSeq(versions_->LastSequence());
        }  // cf may become non-empty.
      }
      empty_cf_updated = true;
    }
  }
  if (!empty_cf_updated) {
    for (auto cf : *versions_->GetColumnFamilySet()) {
      // all this is just optimization to delete logs that
      // are no longer needed -- if CF is empty, that means it
      // doesn't need that particular log to stay alive, so we just
      // advance the log number. no need to persist this in the manifest
      if (cf->IsEmpty()) {
        if (creating_new_log) {
          cf->SetLogNumber(logfile_number_);
        }
        cf->mem()->SetCreationSeq(versions_->LastSequence());
S
Siying Dong 已提交
1879 1880 1881 1882 1883 1884 1885 1886
      }
    }
  }

  cfd->mem()->SetNextLogNumber(logfile_number_);
  cfd->imm()->Add(cfd->mem(), &context->memtables_to_free_);
  new_mem->Ref();
  cfd->SetMemtable(new_mem);
1887
  InstallSuperVersionAndScheduleWork(cfd, &context->superversion_context,
1888
                                     mutable_cf_options);
1889 1890 1891 1892 1893 1894 1895
#ifndef ROCKSDB_LITE
  mutex_.Unlock();
  // Notify client that memtable is sealed, now that we have successfully
  // installed a new memtable
  NotifyOnMemTableSealed(cfd, memtable_info);
  mutex_.Lock();
#endif  // ROCKSDB_LITE
1896 1897 1898 1899
  // It is possible that we got here without checking the value of i_os, but
  // that is okay.  If we did, it most likely means that s was already an error.
  // In any case, ignore any unchecked error for i_os here.
  io_s.PermitUncheckedError();
S
Siying Dong 已提交
1900 1901 1902 1903 1904
  return s;
}

size_t DBImpl::GetWalPreallocateBlockSize(uint64_t write_buffer_size) const {
  mutex_.AssertHeld();
1905 1906
  size_t bsize =
      static_cast<size_t>(write_buffer_size / 10 + write_buffer_size);
S
Siying Dong 已提交
1907 1908 1909
  // Some users might set very high write_buffer_size and rely on
  // max_total_wal_size or other parameters to control the WAL size.
  if (mutable_db_options_.max_total_wal_size > 0) {
1910 1911
    bsize = std::min<size_t>(
        bsize, static_cast<size_t>(mutable_db_options_.max_total_wal_size));
S
Siying Dong 已提交
1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928
  }
  if (immutable_db_options_.db_write_buffer_size > 0) {
    bsize = std::min<size_t>(bsize, immutable_db_options_.db_write_buffer_size);
  }
  if (immutable_db_options_.write_buffer_manager &&
      immutable_db_options_.write_buffer_manager->enabled()) {
    bsize = std::min<size_t>(
        bsize, immutable_db_options_.write_buffer_manager->buffer_size());
  }

  return bsize;
}

// Default implementations of convenience methods that subclasses of DB
// can call if they wish
Status DB::Put(const WriteOptions& opt, ColumnFamilyHandle* column_family,
               const Slice& key, const Slice& value) {
1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939
  if (nullptr == opt.timestamp) {
    // 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);
    Status s = batch.Put(column_family, key, value);
    if (!s.ok()) {
      return s;
    }
    return Write(opt, &batch);
  }
1940 1941 1942
  const Slice* ts = opt.timestamp;
  assert(nullptr != ts);
  size_t ts_sz = ts->size();
1943 1944
  assert(column_family->GetComparator());
  assert(ts_sz == column_family->GetComparator()->timestamp_size());
1945 1946 1947
  WriteBatch batch(key.size() + ts_sz + value.size() + 24, /*max_bytes=*/0,
                   ts_sz);
  Status s = batch.Put(column_family, key, value);
1948 1949 1950
  if (!s.ok()) {
    return s;
  }
1951
  s = batch.AssignTimestamp(*ts);
1952 1953 1954
  if (!s.ok()) {
    return s;
  }
S
Siying Dong 已提交
1955 1956 1957 1958 1959
  return Write(opt, &batch);
}

Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
Y
Yanqin Jin 已提交
1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983
  if (nullptr == opt.timestamp) {
    WriteBatch batch;
    Status s = batch.Delete(column_family, key);
    if (!s.ok()) {
      return s;
    }
    return Write(opt, &batch);
  }
  const Slice* ts = opt.timestamp;
  assert(ts != nullptr);
  const size_t ts_sz = ts->size();
  constexpr size_t kKeyAndValueLenSize = 11;
  constexpr size_t kWriteBatchOverhead =
      WriteBatchInternal::kHeader + sizeof(ValueType) + kKeyAndValueLenSize;
  WriteBatch batch(key.size() + ts_sz + kWriteBatchOverhead, /*max_bytes=*/0,
                   ts_sz);
  Status s = batch.Delete(column_family, key);
  if (!s.ok()) {
    return s;
  }
  s = batch.AssignTimestamp(*ts);
  if (!s.ok()) {
    return s;
  }
S
Siying Dong 已提交
1984 1985 1986 1987 1988 1989
  return Write(opt, &batch);
}

Status DB::SingleDelete(const WriteOptions& opt,
                        ColumnFamilyHandle* column_family, const Slice& key) {
  WriteBatch batch;
1990 1991 1992 1993
  Status s = batch.SingleDelete(column_family, key);
  if (!s.ok()) {
    return s;
  }
S
Siying Dong 已提交
1994 1995 1996 1997 1998 1999 2000
  return Write(opt, &batch);
}

Status DB::DeleteRange(const WriteOptions& opt,
                       ColumnFamilyHandle* column_family,
                       const Slice& begin_key, const Slice& end_key) {
  WriteBatch batch;
2001 2002 2003 2004
  Status s = batch.DeleteRange(column_family, begin_key, end_key);
  if (!s.ok()) {
    return s;
  }
S
Siying Dong 已提交
2005 2006 2007 2008 2009 2010
  return Write(opt, &batch);
}

Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
  WriteBatch batch;
2011 2012 2013 2014
  Status s = batch.Merge(column_family, key, value);
  if (!s.ok()) {
    return s;
  }
S
Siying Dong 已提交
2015 2016
  return Write(opt, &batch);
}
2017
}  // namespace ROCKSDB_NAMESPACE