db_iter.cc 49.2 KB
Newer Older
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).
5
//
J
jorlow@chromium.org 已提交
6 7 8 9 10
// 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_iter.h"
S
Stanislau Hlebik 已提交
11
#include <string>
12
#include <iostream>
S
Stanislau Hlebik 已提交
13
#include <limits>
J
jorlow@chromium.org 已提交
14 15

#include "db/dbformat.h"
16
#include "db/merge_context.h"
17
#include "db/merge_helper.h"
18
#include "db/pinned_iterators_manager.h"
19
#include "file/filename.h"
20
#include "logging/logging.h"
21
#include "memory/arena.h"
22
#include "monitoring/perf_context_imp.h"
23 24 25
#include "rocksdb/env.h"
#include "rocksdb/iterator.h"
#include "rocksdb/merge_operator.h"
26
#include "rocksdb/options.h"
S
sdong 已提交
27
#include "table/internal_iterator.h"
28
#include "table/iterator_wrapper.h"
29
#include "trace_replay/trace_replay.h"
J
jorlow@chromium.org 已提交
30
#include "util/mutexlock.h"
31
#include "util/string_util.h"
32
#include "util/user_comparator_wrapper.h"
J
jorlow@chromium.org 已提交
33

34
namespace ROCKSDB_NAMESPACE {
J
jorlow@chromium.org 已提交
35

36
DBIter::DBIter(Env* _env, const ReadOptions& read_options,
37 38 39 40 41 42 43 44
               const ImmutableCFOptions& cf_options,
               const MutableCFOptions& mutable_cf_options,
               const Comparator* cmp, InternalIterator* iter, SequenceNumber s,
               bool arena_mode, uint64_t max_sequential_skip_in_iterations,
               ReadCallback* read_callback, DBImpl* db_impl,
               ColumnFamilyData* cfd, bool allow_blob)
    : prefix_extractor_(mutable_cf_options.prefix_extractor.get()),
      env_(_env),
45 46 47 48 49 50 51
      logger_(cf_options.info_log),
      user_comparator_(cmp),
      merge_operator_(cf_options.merge_operator),
      iter_(iter),
      read_callback_(read_callback),
      sequence_(s),
      statistics_(cf_options.statistics),
Y
Yanqin Jin 已提交
52 53
      max_skip_(max_sequential_skip_in_iterations),
      max_skippable_internal_keys_(read_options.max_skippable_internal_keys),
54 55 56 57 58 59 60
      num_internal_keys_skipped_(0),
      iterate_lower_bound_(read_options.iterate_lower_bound),
      iterate_upper_bound_(read_options.iterate_upper_bound),
      direction_(kForward),
      valid_(false),
      current_entry_is_merged_(false),
      is_key_seqnum_zero_(false),
61 62 63
      prefix_same_as_start_(mutable_cf_options.prefix_extractor
                                ? read_options.prefix_same_as_start
                                : false),
64
      pin_thru_lifetime_(read_options.pin_data),
S
sdong 已提交
65 66 67
      expect_total_order_inner_iter_(prefix_extractor_ == nullptr ||
                                     read_options.total_order_seek ||
                                     read_options.auto_prefix_mode),
68 69 70 71 72 73
      allow_blob_(allow_blob),
      is_blob_(false),
      arena_mode_(arena_mode),
      range_del_agg_(&cf_options.internal_comparator, s),
      db_impl_(db_impl),
      cfd_(cfd),
Y
Yanqin Jin 已提交
74 75
      start_seqnum_(read_options.iter_start_seqnum),
      timestamp_ub_(read_options.timestamp),
76
      timestamp_lb_(read_options.iter_start_ts),
Y
Yanqin Jin 已提交
77
      timestamp_size_(timestamp_ub_ ? timestamp_ub_->size() : 0) {
78 79 80 81 82
  RecordTick(statistics_, NO_ITERATOR_CREATED);
  if (pin_thru_lifetime_) {
    pinned_iters_mgr_.StartPinning();
  }
  if (iter_.iter()) {
83
    iter_.iter()->SetPinnedItersMgr(&pinned_iters_mgr_);
J
jorlow@chromium.org 已提交
84
  }
Y
Yanqin Jin 已提交
85
  assert(timestamp_size_ == user_comparator_.timestamp_size());
86
}
87

88 89 90
Status DBIter::GetProperty(std::string prop_name, std::string* prop) {
  if (prop == nullptr) {
    return Status::InvalidArgument("prop is nullptr");
91
  }
92 93 94 95
  if (prop_name == "rocksdb.iterator.super-version-number") {
    // First try to pass the value returned from inner iterator.
    return iter_.iter()->GetProperty(prop_name, prop);
  } else if (prop_name == "rocksdb.iterator.is-key-pinned") {
96
    if (valid_) {
97 98 99
      *prop = (pin_thru_lifetime_ && saved_key_.IsKeyPinned()) ? "1" : "0";
    } else {
      *prop = "Iterator is not valid.";
100
    }
101 102 103 104
    return Status::OK();
  } else if (prop_name == "rocksdb.iterator.internal-key") {
    *prop = saved_key_.GetUserKey().ToString();
    return Status::OK();
105
  }
106 107
  return Status::InvalidArgument("Unidentified property.");
}
108

109
bool DBIter::ParseKey(ParsedInternalKey* ikey) {
110
  if (!ParseInternalKey(iter_.key(), ikey)) {
J
jorlow@chromium.org 已提交
111
    status_ = Status::Corruption("corrupted internal key in DBIter");
112
    valid_ = false;
113
    ROCKS_LOG_ERROR(logger_, "corrupted internal key in DBIter: %s",
114
                    iter_.key().ToString(true).c_str());
J
jorlow@chromium.org 已提交
115 116 117 118 119 120
    return false;
  } else {
    return true;
  }
}

J
jorlow@chromium.org 已提交
121 122
void DBIter::Next() {
  assert(valid_);
123
  assert(status_.ok());
J
jorlow@chromium.org 已提交
124

125
  PERF_CPU_TIMER_GUARD(iter_next_cpu_nanos, env_);
126 127
  // Release temporarily pinned blocks from last operation
  ReleaseTempPinnedData();
128 129 130
  local_stats_.skip_count_ += num_internal_keys_skipped_;
  local_stats_.skip_count_--;
  num_internal_keys_skipped_ = 0;
131
  bool ok = true;
S
Stanislau Hlebik 已提交
132
  if (direction_ == kReverse) {
133
    is_key_seqnum_zero_ = false;
134 135 136
    if (!ReverseToForward()) {
      ok = false;
    }
137
  } else if (!current_entry_is_merged_) {
138 139 140 141 142
    // If the current value is not a merge, the iter position is the
    // current key, which is already returned. We can safely issue a
    // Next() without checking the current key.
    // If the current key is a merge, very likely iter already points
    // to the next internal position.
143 144
    assert(iter_.Valid());
    iter_.Next();
145
    PERF_COUNTER_ADD(internal_key_skipped_count, 1);
J
jorlow@chromium.org 已提交
146
  }
J
jorlow@chromium.org 已提交
147

148
  local_stats_.next_count_++;
149
  if (ok && iter_.Valid()) {
150 151 152 153 154
    Slice prefix;
    if (prefix_same_as_start_) {
      assert(prefix_extractor_ != nullptr);
      prefix = prefix_.GetUserKey();
    }
155
    FindNextUserEntry(true /* skipping the current user key */,
156
                      prefix_same_as_start_ ? &prefix : nullptr);
157
  } else {
158
    is_key_seqnum_zero_ = false;
159 160
    valid_ = false;
  }
161 162 163 164
  if (statistics_ != nullptr && valid_) {
    local_stats_.next_found_count_++;
    local_stats_.bytes_read_ += (key().size() + value().size());
  }
J
jorlow@chromium.org 已提交
165 166
}

167
// PRE: saved_key_ has the current user key if skipping_saved_key
168 169 170 171 172 173
// POST: saved_key_ should have the next user key if valid_,
//       if the current entry is a result of merge
//           current_entry_is_merged_ => true
//           saved_value_             => the merged value
//
// NOTE: In between, saved_key_ can point to a user key that has
174
//       a delete marker or a sequence number higher than sequence_
175
//       saved_key_ MUST have a proper user_key before calling this function
176
//
Y
Yanqin Jin 已提交
177
// The prefix parameter, if not null, indicates that we need to iterate
178 179 180
// within the prefix, and the iterator needs to be made invalid, if no
// more entry for the prefix can be found.
bool DBIter::FindNextUserEntry(bool skipping_saved_key, const Slice* prefix) {
181
  PERF_TIMER_GUARD(find_next_user_entry_time);
182
  return FindNextUserEntryInternal(skipping_saved_key, prefix);
183 184 185
}

// Actual implementation of DBIter::FindNextUserEntry()
186 187
bool DBIter::FindNextUserEntryInternal(bool skipping_saved_key,
                                       const Slice* prefix) {
J
jorlow@chromium.org 已提交
188
  // Loop until we hit an acceptable entry to yield
189
  assert(iter_.Valid());
190
  assert(status_.ok());
J
jorlow@chromium.org 已提交
191
  assert(direction_ == kForward);
192
  current_entry_is_merged_ = false;
193 194 195

  // How many times in a row we have skipped an entry with user key less than
  // or equal to saved_key_. We could skip these entries either because
196
  // sequence numbers were too high or because skipping_saved_key = true.
197
  // What saved_key_ contains throughout this method:
Y
Yanqin Jin 已提交
198 199 200 201 202 203 204 205
  //  - if skipping_saved_key : saved_key_ contains the key that we need
  //                            to skip, and we haven't seen any keys greater
  //                            than that,
  //  - if num_skipped > 0    : saved_key_ contains the key that we have skipped
  //                            num_skipped times, and we haven't seen any keys
  //                            greater than that,
  //  - none of the above     : saved_key_ can contain anything, it doesn't
  //                            matter.
206
  uint64_t num_skipped = 0;
207 208 209 210 211
  // For write unprepared, the target sequence number in reseek could be larger
  // than the snapshot, and thus needs to be skipped again. This could result in
  // an infinite loop of reseeks. To avoid that, we limit the number of reseeks
  // to one.
  bool reseek_done = false;
212

Y
Yi Wu 已提交
213 214
  is_blob_ = false;

J
jorlow@chromium.org 已提交
215
  do {
216 217 218
    // Will update is_key_seqnum_zero_ as soon as we parsed the current key
    // but we need to save the previous value to be used in the loop.
    bool is_prev_key_seqnum_zero = is_key_seqnum_zero_;
219
    if (!ParseKey(&ikey_)) {
220
      is_key_seqnum_zero_ = false;
221
      return false;
222
    }
223

224 225
    is_key_seqnum_zero_ = (ikey_.sequence == 0);

226 227
    assert(iterate_upper_bound_ == nullptr ||
           iter_.UpperBoundCheckResult() != IterBoundCheck::kInbound ||
Y
Yanqin Jin 已提交
228 229 230
           user_comparator_.CompareWithoutTimestamp(
               ikey_.user_key, /*a_has_ts=*/true, *iterate_upper_bound_,
               /*b_has_ts=*/false) < 0);
231 232
    if (iterate_upper_bound_ != nullptr &&
        iter_.UpperBoundCheckResult() != IterBoundCheck::kInbound &&
Y
Yanqin Jin 已提交
233 234 235
        user_comparator_.CompareWithoutTimestamp(
            ikey_.user_key, /*a_has_ts=*/true, *iterate_upper_bound_,
            /*b_has_ts=*/false) >= 0) {
236 237
      break;
    }
238

239 240 241 242
    assert(prefix == nullptr || prefix_extractor_ != nullptr);
    if (prefix != nullptr &&
        prefix_extractor_->Transform(ikey_.user_key).compare(*prefix) != 0) {
      assert(prefix_same_as_start_);
243 244 245
      break;
    }

246
    if (TooManyInternalKeysSkipped()) {
247
      return false;
248 249
    }

Y
Yanqin Jin 已提交
250
    assert(ikey_.user_key.size() >= timestamp_size_);
251 252 253
    Slice ts = timestamp_size_ > 0 ? ExtractTimestampFromUserKey(
                                         ikey_.user_key, timestamp_size_)
                                   : Slice();
254 255
    bool more_recent = false;
    if (IsVisible(ikey_.sequence, ts, &more_recent)) {
256 257 258 259
      // If the previous entry is of seqnum 0, the current entry will not
      // possibly be skipped. This condition can potentially be relaxed to
      // prev_key.seq <= ikey_.sequence. We are cautious because it will be more
      // prone to bugs causing the same user key with the same sequence number.
260 261
      // Note that with current timestamp implementation, the same user key can
      // have different timestamps and zero sequence number on the bottommost
Y
Yanqin Jin 已提交
262
      // level. This may change in the future.
263 264
      if ((!is_prev_key_seqnum_zero || timestamp_size_ > 0) &&
          skipping_saved_key &&
265
          CompareKeyForSkip(ikey_.user_key, saved_key_.GetUserKey()) <= 0) {
266 267 268
        num_skipped++;  // skip this entry
        PERF_COUNTER_ADD(internal_key_skipped_count, 1);
      } else {
269
        assert(!skipping_saved_key ||
270
               CompareKeyForSkip(ikey_.user_key, saved_key_.GetUserKey()) > 0);
271 272 273 274 275
        if (!iter_.PrepareValue()) {
          assert(!iter_.status().ok());
          valid_ = false;
          return false;
        }
276
        num_skipped = 0;
277
        reseek_done = false;
278
        switch (ikey_.type) {
279
          case kTypeDeletion:
Y
Yanqin Jin 已提交
280
          case kTypeDeletionWithTimestamp:
281 282 283
          case kTypeSingleDeletion:
            // Arrange to skip all upcoming entries for this key since
            // they are hidden by this deletion.
284 285 286
            // if iterartor specified start_seqnum we
            // 1) return internal key, including the type
            // 2) return ikey only if ikey.seqnum >= start_seqnum_
287
            // note that if deletion seqnum is < start_seqnum_ we
288
            // just skip it like in normal iterator.
289 290 291 292 293 294 295 296 297 298 299 300 301 302
            if (start_seqnum_ > 0) {
              if (ikey_.sequence >= start_seqnum_) {
                saved_key_.SetInternalKey(ikey_);
                valid_ = true;
                return true;
              } else {
                saved_key_.SetUserKey(
                    ikey_.user_key,
                    !pin_thru_lifetime_ ||
                        !iter_.iter()->IsKeyPinned() /* copy */);
                skipping_saved_key = true;
                PERF_COUNTER_ADD(internal_delete_skipped_count, 1);
              }
            } else if (timestamp_lb_) {
303
              saved_key_.SetInternalKey(ikey_);
304 305
              valid_ = true;
              return true;
306 307
            } else {
              saved_key_.SetUserKey(
308 309
                  ikey_.user_key, !pin_thru_lifetime_ ||
                                      !iter_.iter()->IsKeyPinned() /* copy */);
310
              skipping_saved_key = true;
311
              PERF_COUNTER_ADD(internal_delete_skipped_count, 1);
312
            }
313 314
            break;
          case kTypeValue:
Y
Yi Wu 已提交
315
          case kTypeBlobIndex:
316 317
            if (start_seqnum_ > 0) {
              if (ikey_.sequence >= start_seqnum_) {
318
                assert(ikey_.type != kTypeBlobIndex);
319
                saved_key_.SetInternalKey(ikey_);
Y
Yi Wu 已提交
320
                valid_ = true;
321
                return true;
322 323
              } else {
                // this key and all previous versions shouldn't be included,
324
                // skipping_saved_key
325 326 327 328
                saved_key_.SetUserKey(
                    ikey_.user_key,
                    !pin_thru_lifetime_ ||
                        !iter_.iter()->IsKeyPinned() /* copy */);
329
                skipping_saved_key = true;
Y
Yi Wu 已提交
330
              }
331 332 333 334
            } else if (timestamp_lb_) {
              saved_key_.SetInternalKey(ikey_);
              valid_ = true;
              return true;
335
            } else {
336
              saved_key_.SetUserKey(
337 338
                  ikey_.user_key, !pin_thru_lifetime_ ||
                                      !iter_.iter()->IsKeyPinned() /* copy */);
339
              if (range_del_agg_.ShouldDelete(
340
                      ikey_, RangeDelPositioningMode::kForwardTraversal)) {
341 342
                // Arrange to skip all upcoming entries for this key since
                // they are hidden by this deletion.
343
                skipping_saved_key = true;
344
                num_skipped = 0;
345
                reseek_done = false;
346 347 348 349 350 351
                PERF_COUNTER_ADD(internal_delete_skipped_count, 1);
              } else if (ikey_.type == kTypeBlobIndex) {
                if (!allow_blob_) {
                  ROCKS_LOG_ERROR(logger_, "Encounter unexpected blob index.");
                  status_ = Status::NotSupported(
                      "Encounter unexpected blob index. Please open DB with "
352
                      "ROCKSDB_NAMESPACE::blob_db::BlobDB instead.");
353
                  valid_ = false;
354
                  return false;
355
                }
356 357 358 359

                is_blob_ = true;
                valid_ = true;
                return true;
360 361
              } else {
                valid_ = true;
362
                return true;
363
              }
364 365 366
            }
            break;
          case kTypeMerge:
367
            saved_key_.SetUserKey(
368
                ikey_.user_key,
369
                !pin_thru_lifetime_ || !iter_.iter()->IsKeyPinned() /* copy */);
370
            if (range_del_agg_.ShouldDelete(
371
                    ikey_, RangeDelPositioningMode::kForwardTraversal)) {
372 373
              // Arrange to skip all upcoming entries for this key since
              // they are hidden by this deletion.
374
              skipping_saved_key = true;
375
              num_skipped = 0;
376
              reseek_done = false;
377 378 379 380 381 382
              PERF_COUNTER_ADD(internal_delete_skipped_count, 1);
            } else {
              // By now, we are sure the current ikey is going to yield a
              // value
              current_entry_is_merged_ = true;
              valid_ = true;
383
              return MergeValuesNewToOld();  // Go to a different state machine
384 385 386 387 388
            }
            break;
          default:
            assert(false);
            break;
389
        }
J
jorlow@chromium.org 已提交
390
      }
391
    } else {
392 393 394
      if (more_recent) {
        PERF_COUNTER_ADD(internal_recent_skipped_count, 1);
      }
395

396 397 398
      // This key was inserted after our snapshot was taken or skipped by
      // timestamp range. If this happens too many times in a row for the same
      // user key, we want to seek to the target sequence number.
Y
Yanqin Jin 已提交
399 400
      int cmp = user_comparator_.CompareWithoutTimestamp(
          ikey_.user_key, saved_key_.GetUserKey());
Y
Yanqin Jin 已提交
401
      if (cmp == 0 || (skipping_saved_key && cmp < 0)) {
402 403
        num_skipped++;
      } else {
404
        saved_key_.SetUserKey(
405
            ikey_.user_key,
406
            !iter_.iter()->IsKeyPinned() || !pin_thru_lifetime_ /* copy */);
407
        skipping_saved_key = false;
408
        num_skipped = 0;
409
        reseek_done = false;
410
      }
J
jorlow@chromium.org 已提交
411
    }
412 413 414

    // If we have sequentially iterated via numerous equal keys, then it's
    // better to seek so that we can avoid too many key comparisons.
415 416 417 418 419
    //
    // To avoid infinite loops, do not reseek if we have already attempted to
    // reseek previously.
    //
    // TODO(lth): If we reseek to sequence number greater than ikey_.sequence,
Y
Yanqin Jin 已提交
420
    // then it does not make sense to reseek as we would actually land further
421 422
    // away from the desired key. There is opportunity for optimization here.
    if (num_skipped > max_skip_ && !reseek_done) {
423
      is_key_seqnum_zero_ = false;
424
      num_skipped = 0;
425
      reseek_done = true;
426
      std::string last_key;
427
      if (skipping_saved_key) {
428 429 430
        // We're looking for the next user-key but all we see are the same
        // user-key with decreasing sequence numbers. Fast forward to
        // sequence number 0 and type deletion (the smallest type).
Y
Yanqin Jin 已提交
431 432 433 434 435 436 437 438 439 440 441
        if (timestamp_size_ == 0) {
          AppendInternalKey(
              &last_key,
              ParsedInternalKey(saved_key_.GetUserKey(), 0, kTypeDeletion));
        } else {
          std::string min_ts(timestamp_size_, static_cast<char>(0));
          AppendInternalKeyWithDifferentTimestamp(
              &last_key,
              ParsedInternalKey(saved_key_.GetUserKey(), 0, kTypeDeletion),
              min_ts);
        }
442 443
        // Don't set skipping_saved_key = false because we may still see more
        // user-keys equal to saved_key_.
444 445 446 447 448 449
      } else {
        // We saw multiple entries with this user key and sequence numbers
        // higher than sequence_. Fast forward to sequence_.
        // Note that this only covers a case when a higher key was overwritten
        // many times since our snapshot was taken, not the case when a lot of
        // different keys were inserted after our snapshot was taken.
Y
Yanqin Jin 已提交
450 451 452 453 454 455 456 457 458 459 460
        if (timestamp_size_ == 0) {
          AppendInternalKey(
              &last_key, ParsedInternalKey(saved_key_.GetUserKey(), sequence_,
                                           kValueTypeForSeek));
        } else {
          AppendInternalKeyWithDifferentTimestamp(
              &last_key,
              ParsedInternalKey(saved_key_.GetUserKey(), sequence_,
                                kValueTypeForSeek),
              *timestamp_ub_);
        }
461
      }
462
      iter_.Seek(last_key);
463 464
      RecordTick(statistics_, NUMBER_OF_RESEEKS_IN_ITERATION);
    } else {
465
      iter_.Next();
466
    }
467
  } while (iter_.Valid());
468

J
jorlow@chromium.org 已提交
469
  valid_ = false;
470
  return iter_.status().ok();
J
jorlow@chromium.org 已提交
471 472
}

473 474
// Merge values of the same user key starting from the current iter_ position
// Scan from the newer entries to older entries.
475
// PRE: iter_.key() points to the first merge type entry
476
//      saved_key_ stores the user key
477
//      iter_.PrepareValue() has been called
478 479
// POST: saved_value_ has the merged value for the user key
//       iter_ points to the next entry (or invalid)
480
bool DBIter::MergeValuesNewToOld() {
481
  if (!merge_operator_) {
482
    ROCKS_LOG_ERROR(logger_, "Options::merge_operator is null.");
483
    status_ = Status::InvalidArgument("merge_operator_ must be set.");
484
    valid_ = false;
485
    return false;
D
Deon Nicholas 已提交
486
  }
487

488 489
  // Temporarily pin the blocks that hold merge operands
  TempPinData();
490
  merge_context_.Clear();
491
  // Start the merge process by pushing the first operand
492 493
  merge_context_.PushOperand(
      iter_.value(), iter_.iter()->IsValuePinned() /* operand_pinned */);
494
  TEST_SYNC_POINT("DBIter::MergeValuesNewToOld:PushedFirstOperand");
495 496

  ParsedInternalKey ikey;
497
  Status s;
498
  for (iter_.Next(); iter_.Valid(); iter_.Next()) {
499
    TEST_SYNC_POINT("DBIter::MergeValuesNewToOld:SteppedToNextOperand");
500
    if (!ParseKey(&ikey)) {
501
      return false;
502 503
    }

504
    if (!user_comparator_.Equal(ikey.user_key, saved_key_.GetUserKey())) {
505 506
      // hit the next user key, stop right here
      break;
507 508
    }
    if (kTypeDeletion == ikey.type || kTypeSingleDeletion == ikey.type ||
509
               range_del_agg_.ShouldDelete(
510
                   ikey, RangeDelPositioningMode::kForwardTraversal)) {
511 512
      // hit a delete with the same user key, stop right here
      // iter_ is positioned after delete
513
      iter_.Next();
514
      break;
515 516 517 518 519 520 521
    }
    if (!iter_.PrepareValue()) {
      valid_ = false;
      return false;
    }

    if (kTypeValue == ikey.type) {
522 523
      // hit a put, merge the put value with operands and store the
      // final result in saved_value_. We are done!
524
      const Slice val = iter_.value();
525 526
      s = MergeHelper::TimedFullMerge(
          merge_operator_, ikey.user_key, &val, merge_context_.GetOperands(),
527
          &saved_value_, logger_, statistics_, env_, &pinned_value_, true);
528
      if (!s.ok()) {
Y
Yi Wu 已提交
529
        valid_ = false;
530
        status_ = s;
531
        return false;
532
      }
533
      // iter_ is positioned after put
534 535
      iter_.Next();
      if (!iter_.status().ok()) {
536 537 538 539
        valid_ = false;
        return false;
      }
      return true;
A
Andres Noetzli 已提交
540
    } else if (kTypeMerge == ikey.type) {
541 542
      // hit a merge, add the value as an operand and run associative merge.
      // when complete, add result to operands and continue.
543 544
      merge_context_.PushOperand(
          iter_.value(), iter_.iter()->IsValuePinned() /* operand_pinned */);
545
      PERF_COUNTER_ADD(internal_merge_count, 1);
Y
Yi Wu 已提交
546 547 548 549 550
    } else if (kTypeBlobIndex == ikey.type) {
      if (!allow_blob_) {
        ROCKS_LOG_ERROR(logger_, "Encounter unexpected blob index.");
        status_ = Status::NotSupported(
            "Encounter unexpected blob index. Please open DB with "
551
            "ROCKSDB_NAMESPACE::blob_db::BlobDB instead.");
Y
Yi Wu 已提交
552 553 554 555 556
      } else {
        status_ =
            Status::NotSupported("Blob DB does not support merge operator.");
      }
      valid_ = false;
557
      return false;
A
Andres Noetzli 已提交
558 559
    } else {
      assert(false);
560 561 562
    }
  }

563
  if (!iter_.status().ok()) {
564 565 566 567
    valid_ = false;
    return false;
  }

568 569 570 571
  // we either exhausted all internal keys under this user key, or hit
  // a deletion marker.
  // feed null as the existing value to the merge operator, such that
  // client can differentiate this scenario and do things accordingly.
572 573 574
  s = MergeHelper::TimedFullMerge(merge_operator_, saved_key_.GetUserKey(),
                                  nullptr, merge_context_.GetOperands(),
                                  &saved_value_, logger_, statistics_, env_,
575
                                  &pinned_value_, true);
576
  if (!s.ok()) {
Y
Yi Wu 已提交
577
    valid_ = false;
578
    status_ = s;
579
    return false;
580
  }
581 582 583

  assert(status_.ok());
  return true;
584 585
}

J
jorlow@chromium.org 已提交
586
void DBIter::Prev() {
Y
Yanqin Jin 已提交
587 588 589 590 591 592 593
  if (timestamp_size_ > 0) {
    valid_ = false;
    status_ = Status::NotSupported(
        "SeekToLast/SeekForPrev/Prev currently not supported with timestamp.");
    return;
  }

J
jorlow@chromium.org 已提交
594
  assert(valid_);
595
  assert(status_.ok());
596 597

  PERF_CPU_TIMER_GUARD(iter_prev_cpu_nanos, env_);
598
  ReleaseTempPinnedData();
599
  ResetInternalKeysSkippedCounter();
600
  bool ok = true;
S
Stanislau Hlebik 已提交
601
  if (direction_ == kForward) {
602 603 604 605 606
    if (!ReverseToBackward()) {
      ok = false;
    }
  }
  if (ok) {
607 608 609 610 611 612
    Slice prefix;
    if (prefix_same_as_start_) {
      assert(prefix_extractor_ != nullptr);
      prefix = prefix_.GetUserKey();
    }
    PrevInternal(prefix_same_as_start_ ? &prefix : nullptr);
S
Stanislau Hlebik 已提交
613
  }
614

M
Manuel Ung 已提交
615
  if (statistics_ != nullptr) {
616
    local_stats_.prev_count_++;
M
Manuel Ung 已提交
617
    if (valid_) {
618 619
      local_stats_.prev_found_count_++;
      local_stats_.bytes_read_ += (key().size() + value().size());
M
Manuel Ung 已提交
620 621
    }
  }
S
Stanislau Hlebik 已提交
622
}
J
jorlow@chromium.org 已提交
623

624
bool DBIter::ReverseToForward() {
625
  assert(iter_.status().ok());
626 627 628 629

  // When moving backwards, iter_ is positioned on _previous_ key, which may
  // not exist or may have different prefix than the current key().
  // If that's the case, seek iter_ to current key.
S
sdong 已提交
630
  if (!expect_total_order_inner_iter() || !iter_.Valid()) {
631 632
    IterKey last_key;
    last_key.SetInternalKey(ParsedInternalKey(
633
        saved_key_.GetUserKey(), kMaxSequenceNumber, kValueTypeForSeek));
634
    iter_.Seek(last_key.GetInternalKey());
635
  }
636

637
  direction_ = kForward;
638
  // Skip keys less than the current key() (a.k.a. saved_key_).
639
  while (iter_.Valid()) {
640 641 642 643
    ParsedInternalKey ikey;
    if (!ParseKey(&ikey)) {
      return false;
    }
644
    if (user_comparator_.Compare(ikey.user_key, saved_key_.GetUserKey()) >= 0) {
645 646
      return true;
    }
647
    iter_.Next();
648 649
  }

650
  if (!iter_.status().ok()) {
651 652
    valid_ = false;
    return false;
653
  }
654 655

  return true;
656 657
}

658 659
// Move iter_ to the key before saved_key_.
bool DBIter::ReverseToBackward() {
660
  assert(iter_.status().ok());
661 662 663 664 665

  // When current_entry_is_merged_ is true, iter_ may be positioned on the next
  // key, which may not exist or may have prefix different from current.
  // If that's the case, seek to saved_key_.
  if (current_entry_is_merged_ &&
S
sdong 已提交
666
      (!expect_total_order_inner_iter() || !iter_.Valid())) {
667
    IterKey last_key;
668 669 670 671 672
    // Using kMaxSequenceNumber and kValueTypeForSeek
    // (not kValueTypeForSeekForPrev) to seek to a key strictly smaller
    // than saved_key_.
    last_key.SetInternalKey(ParsedInternalKey(
        saved_key_.GetUserKey(), kMaxSequenceNumber, kValueTypeForSeek));
S
sdong 已提交
673
    if (!expect_total_order_inner_iter()) {
674
      iter_.SeekForPrev(last_key.GetInternalKey());
675 676 677 678 679
    } else {
      // Some iterators may not support SeekForPrev(), so we avoid using it
      // when prefix seek mode is disabled. This is somewhat expensive
      // (an extra Prev(), as well as an extra change of direction of iter_),
      // so we may need to reconsider it later.
680 681 682
      iter_.Seek(last_key.GetInternalKey());
      if (!iter_.Valid() && iter_.status().ok()) {
        iter_.SeekToLast();
683
      }
684 685 686 687
    }
  }

  direction_ = kReverse;
688
  return FindUserKeyBeforeSavedKey();
689 690
}

691
void DBIter::PrevInternal(const Slice* prefix) {
692
  while (iter_.Valid()) {
693
    saved_key_.SetUserKey(
694 695
        ExtractUserKey(iter_.key()),
        !iter_.iter()->IsKeyPinned() || !pin_thru_lifetime_ /* copy */);
696

697 698
    assert(prefix == nullptr || prefix_extractor_ != nullptr);
    if (prefix != nullptr &&
699
        prefix_extractor_->Transform(saved_key_.GetUserKey())
700 701
                .compare(*prefix) != 0) {
      assert(prefix_same_as_start_);
702 703 704 705 706
      // Current key does not have the same prefix as start
      valid_ = false;
      return;
    }

707 708 709 710
    assert(iterate_lower_bound_ == nullptr || iter_.MayBeOutOfLowerBound() ||
           user_comparator_.Compare(saved_key_.GetUserKey(),
                                    *iterate_lower_bound_) >= 0);
    if (iterate_lower_bound_ != nullptr && iter_.MayBeOutOfLowerBound() &&
711 712
        user_comparator_.Compare(saved_key_.GetUserKey(),
                                 *iterate_lower_bound_) < 0) {
713 714 715 716 717
      // We've iterated earlier than the user-specified lower bound.
      valid_ = false;
      return;
    }

718
    if (!FindValueForCurrentKey()) {  // assigns valid_
S
Stanislau Hlebik 已提交
719
      return;
J
jorlow@chromium.org 已提交
720
    }
721

722 723 724
    // Whether or not we found a value for current key, we need iter_ to end up
    // on a smaller key.
    if (!FindUserKeyBeforeSavedKey()) {
725 726 727
      return;
    }

728 729 730
    if (valid_) {
      // Found the value.
      return;
S
Stanislau Hlebik 已提交
731
    }
732 733 734

    if (TooManyInternalKeysSkipped(false)) {
      return;
S
Stanislau Hlebik 已提交
735 736
    }
  }
737

S
Stanislau Hlebik 已提交
738 739
  // We haven't found any key - iterator is not valid
  valid_ = false;
J
jorlow@chromium.org 已提交
740 741
}

742 743 744 745 746 747 748 749 750 751 752
// Used for backwards iteration.
// Looks at the entries with user key saved_key_ and finds the most up-to-date
// value for it, or executes a merge, or determines that the value was deleted.
// Sets valid_ to true if the value is found and is ready to be presented to
// the user through value().
// Sets valid_ to false if the value was deleted, and we should try another key.
// Returns false if an error occurred, and !status().ok() and !valid_.
//
// PRE: iter_ is positioned on the last entry with user key equal to saved_key_.
// POST: iter_ is positioned on one of the entries equal to saved_key_, or on
//       the entry just before them, or on the entry just after them.
S
Stanislau Hlebik 已提交
753
bool DBIter::FindValueForCurrentKey() {
754
  assert(iter_.Valid());
755
  merge_context_.Clear();
756
  current_entry_is_merged_ = false;
A
Andres Noetzli 已提交
757 758
  // last entry before merge (could be kTypeDeletion, kTypeSingleDeletion or
  // kTypeValue)
S
Stanislau Hlebik 已提交
759 760
  ValueType last_not_merge_type = kTypeDeletion;
  ValueType last_key_entry_type = kTypeDeletion;
J
jorlow@chromium.org 已提交
761

762 763 764
  // Temporarily pin blocks that hold (merge operands / the value)
  ReleaseTempPinnedData();
  TempPinData();
S
Stanislau Hlebik 已提交
765
  size_t num_skipped = 0;
766
  while (iter_.Valid()) {
767 768 769 770 771
    ParsedInternalKey ikey;
    if (!ParseKey(&ikey)) {
      return false;
    }

Y
Yanqin Jin 已提交
772 773 774 775 776 777 778
    assert(ikey.user_key.size() >= timestamp_size_);
    Slice ts;
    if (timestamp_size_ > 0) {
      ts = Slice(ikey.user_key.data() + ikey.user_key.size() - timestamp_size_,
                 timestamp_size_);
    }
    if (!IsVisible(ikey.sequence, ts) ||
779
        !user_comparator_.Equal(ikey.user_key, saved_key_.GetUserKey())) {
780 781
      break;
    }
782 783 784 785
    if (TooManyInternalKeysSkipped()) {
      return false;
    }

786 787 788
    // This user key has lots of entries.
    // We're going from old to new, and it's taking too long. Let's do a Seek()
    // and go from new to old. This helps when a key was overwritten many times.
789
    if (num_skipped >= max_skip_) {
S
Stanislau Hlebik 已提交
790 791 792
      return FindValueForCurrentKeyUsingSeek();
    }

793 794 795 796 797
    if (!iter_.PrepareValue()) {
      valid_ = false;
      return false;
    }

S
Stanislau Hlebik 已提交
798 799 800
    last_key_entry_type = ikey.type;
    switch (last_key_entry_type) {
      case kTypeValue:
Y
Yi Wu 已提交
801
      case kTypeBlobIndex:
802
        if (range_del_agg_.ShouldDelete(
803
                ikey, RangeDelPositioningMode::kBackwardTraversal)) {
A
Andrew Kryczka 已提交
804 805 806
          last_key_entry_type = kTypeRangeDeletion;
          PERF_COUNTER_ADD(internal_delete_skipped_count, 1);
        } else {
807 808
          assert(iter_.iter()->IsValuePinned());
          pinned_value_ = iter_.value();
A
Andrew Kryczka 已提交
809
        }
810
        merge_context_.Clear();
A
Andrew Kryczka 已提交
811
        last_not_merge_type = last_key_entry_type;
S
Stanislau Hlebik 已提交
812 813
        break;
      case kTypeDeletion:
A
Andres Noetzli 已提交
814
      case kTypeSingleDeletion:
815
        merge_context_.Clear();
A
Andres Noetzli 已提交
816
        last_not_merge_type = last_key_entry_type;
817
        PERF_COUNTER_ADD(internal_delete_skipped_count, 1);
S
Stanislau Hlebik 已提交
818 819
        break;
      case kTypeMerge:
820
        if (range_del_agg_.ShouldDelete(
821
                ikey, RangeDelPositioningMode::kBackwardTraversal)) {
A
Andrew Kryczka 已提交
822 823 824 825 826 827 828
          merge_context_.Clear();
          last_key_entry_type = kTypeRangeDeletion;
          last_not_merge_type = last_key_entry_type;
          PERF_COUNTER_ADD(internal_delete_skipped_count, 1);
        } else {
          assert(merge_operator_ != nullptr);
          merge_context_.PushOperandBack(
829 830
              iter_.value(),
              iter_.iter()->IsValuePinned() /* operand_pinned */);
831
          PERF_COUNTER_ADD(internal_merge_count, 1);
A
Andrew Kryczka 已提交
832
        }
S
Stanislau Hlebik 已提交
833 834 835 836 837
        break;
      default:
        assert(false);
    }

838
    PERF_COUNTER_ADD(internal_key_skipped_count, 1);
839
    iter_.Prev();
S
Stanislau Hlebik 已提交
840
    ++num_skipped;
841 842
  }

843
  if (!iter_.status().ok()) {
844 845
    valid_ = false;
    return false;
S
Stanislau Hlebik 已提交
846 847
  }

848
  Status s;
Y
Yi Wu 已提交
849
  is_blob_ = false;
S
Stanislau Hlebik 已提交
850 851
  switch (last_key_entry_type) {
    case kTypeDeletion:
A
Andres Noetzli 已提交
852
    case kTypeSingleDeletion:
A
Andrew Kryczka 已提交
853
    case kTypeRangeDeletion:
S
Stanislau Hlebik 已提交
854
      valid_ = false;
855
      return true;
S
Stanislau Hlebik 已提交
856
    case kTypeMerge:
857
      current_entry_is_merged_ = true;
A
Aaron Gao 已提交
858
      if (last_not_merge_type == kTypeDeletion ||
A
Andrew Kryczka 已提交
859 860
          last_not_merge_type == kTypeSingleDeletion ||
          last_not_merge_type == kTypeRangeDeletion) {
861 862 863
        s = MergeHelper::TimedFullMerge(
            merge_operator_, saved_key_.GetUserKey(), nullptr,
            merge_context_.GetOperands(), &saved_value_, logger_, statistics_,
864
            env_, &pinned_value_, true);
Y
Yi Wu 已提交
865 866 867 868 869
      } else if (last_not_merge_type == kTypeBlobIndex) {
        if (!allow_blob_) {
          ROCKS_LOG_ERROR(logger_, "Encounter unexpected blob index.");
          status_ = Status::NotSupported(
              "Encounter unexpected blob index. Please open DB with "
870
              "ROCKSDB_NAMESPACE::blob_db::BlobDB instead.");
Y
Yi Wu 已提交
871 872 873 874 875
        } else {
          status_ =
              Status::NotSupported("Blob DB does not support merge operator.");
        }
        valid_ = false;
876
        return false;
877
      } else {
S
Stanislau Hlebik 已提交
878
        assert(last_not_merge_type == kTypeValue);
879
        s = MergeHelper::TimedFullMerge(
880
            merge_operator_, saved_key_.GetUserKey(), &pinned_value_,
881
            merge_context_.GetOperands(), &saved_value_, logger_, statistics_,
882
            env_, &pinned_value_, true);
883
      }
S
Stanislau Hlebik 已提交
884 885
      break;
    case kTypeValue:
886
      // do nothing - we've already has value in pinned_value_
S
Stanislau Hlebik 已提交
887
      break;
Y
Yi Wu 已提交
888 889 890 891 892
    case kTypeBlobIndex:
      if (!allow_blob_) {
        ROCKS_LOG_ERROR(logger_, "Encounter unexpected blob index.");
        status_ = Status::NotSupported(
            "Encounter unexpected blob index. Please open DB with "
893
            "ROCKSDB_NAMESPACE::blob_db::BlobDB instead.");
Y
Yi Wu 已提交
894
        valid_ = false;
895
        return false;
Y
Yi Wu 已提交
896 897 898
      }
      is_blob_ = true;
      break;
S
Stanislau Hlebik 已提交
899 900 901
    default:
      assert(false);
      break;
J
jorlow@chromium.org 已提交
902
  }
903
  if (!s.ok()) {
Y
Yi Wu 已提交
904
    valid_ = false;
905
    status_ = s;
906
    return false;
907
  }
908
  valid_ = true;
S
Stanislau Hlebik 已提交
909 910
  return true;
}
J
jorlow@chromium.org 已提交
911

S
Stanislau Hlebik 已提交
912 913
// This function is used in FindValueForCurrentKey.
// We use Seek() function instead of Prev() to find necessary value
914 915
// TODO: This is very similar to FindNextUserEntry() and MergeValuesNewToOld().
//       Would be nice to reuse some code.
S
Stanislau Hlebik 已提交
916
bool DBIter::FindValueForCurrentKeyUsingSeek() {
917 918 919
  // FindValueForCurrentKey will enable pinning before calling
  // FindValueForCurrentKeyUsingSeek()
  assert(pinned_iters_mgr_.PinningEnabled());
S
Stanislau Hlebik 已提交
920
  std::string last_key;
921 922
  AppendInternalKey(&last_key, ParsedInternalKey(saved_key_.GetUserKey(),
                                                 sequence_, kValueTypeForSeek));
923
  iter_.Seek(last_key);
S
Stanislau Hlebik 已提交
924 925
  RecordTick(statistics_, NUMBER_OF_RESEEKS_IN_ITERATION);

926 927
  // In case read_callback presents, the value we seek to may not be visible.
  // Find the next value that's visible.
S
Stanislau Hlebik 已提交
928
  ParsedInternalKey ikey;
929
  is_blob_ = false;
930
  while (true) {
931
    if (!iter_.Valid()) {
932
      valid_ = false;
933
      return iter_.status().ok();
934 935 936 937 938
    }

    if (!ParseKey(&ikey)) {
      return false;
    }
Y
Yanqin Jin 已提交
939 940 941 942 943 944 945
    assert(ikey.user_key.size() >= timestamp_size_);
    Slice ts;
    if (timestamp_size_ > 0) {
      ts = Slice(ikey.user_key.data() + ikey.user_key.size() - timestamp_size_,
                 timestamp_size_);
    }

946
    if (!user_comparator_.Equal(ikey.user_key, saved_key_.GetUserKey())) {
947 948 949 950 951 952 953
      // No visible values for this key, even though FindValueForCurrentKey()
      // has seen some. This is possible if we're using a tailing iterator, and
      // the entries were discarded in a compaction.
      valid_ = false;
      return true;
    }

Y
Yanqin Jin 已提交
954
    if (IsVisible(ikey.sequence, ts)) {
955 956
      break;
    }
957

958
    iter_.Next();
959
  }
S
Stanislau Hlebik 已提交
960

A
Andrew Kryczka 已提交
961
  if (ikey.type == kTypeDeletion || ikey.type == kTypeSingleDeletion ||
962
      range_del_agg_.ShouldDelete(
963
          ikey, RangeDelPositioningMode::kBackwardTraversal)) {
J
jorlow@chromium.org 已提交
964
    valid_ = false;
965
    return true;
S
Stanislau Hlebik 已提交
966
  }
Y
Yi Wu 已提交
967 968 969 970
  if (ikey.type == kTypeBlobIndex && !allow_blob_) {
    ROCKS_LOG_ERROR(logger_, "Encounter unexpected blob index.");
    status_ = Status::NotSupported(
        "Encounter unexpected blob index. Please open DB with "
971
        "ROCKSDB_NAMESPACE::blob_db::BlobDB instead.");
Y
Yi Wu 已提交
972
    valid_ = false;
973
    return false;
Y
Yi Wu 已提交
974
  }
975 976 977 978
  if (!iter_.PrepareValue()) {
    valid_ = false;
    return false;
  }
Y
Yi Wu 已提交
979
  if (ikey.type == kTypeValue || ikey.type == kTypeBlobIndex) {
980 981
    assert(iter_.iter()->IsValuePinned());
    pinned_value_ = iter_.value();
982
    is_blob_ = (ikey.type == kTypeBlobIndex);
A
Andrew Kryczka 已提交
983 984 985
    valid_ = true;
    return true;
  }
S
Stanislau Hlebik 已提交
986 987 988

  // kTypeMerge. We need to collect all kTypeMerge values and save them
  // in operands
989
  assert(ikey.type == kTypeMerge);
990
  current_entry_is_merged_ = true;
991
  merge_context_.Clear();
992 993
  merge_context_.PushOperand(
      iter_.value(), iter_.iter()->IsValuePinned() /* operand_pinned */);
994
  while (true) {
995
    iter_.Next();
S
Stanislau Hlebik 已提交
996

997 998
    if (!iter_.Valid()) {
      if (!iter_.status().ok()) {
999 1000 1001 1002
        valid_ = false;
        return false;
      }
      break;
S
Stanislau Hlebik 已提交
1003
    }
1004 1005 1006
    if (!ParseKey(&ikey)) {
      return false;
    }
1007
    if (!user_comparator_.Equal(ikey.user_key, saved_key_.GetUserKey())) {
1008 1009 1010 1011
      break;
    }
    if (ikey.type == kTypeDeletion || ikey.type == kTypeSingleDeletion ||
        range_del_agg_.ShouldDelete(
1012
            ikey, RangeDelPositioningMode::kForwardTraversal)) {
1013
      break;
1014 1015 1016 1017 1018 1019 1020
    }
    if (!iter_.PrepareValue()) {
      valid_ = false;
      return false;
    }

    if (ikey.type == kTypeValue) {
1021
      const Slice val = iter_.value();
1022 1023 1024 1025 1026 1027 1028 1029 1030
      Status s = MergeHelper::TimedFullMerge(
          merge_operator_, saved_key_.GetUserKey(), &val,
          merge_context_.GetOperands(), &saved_value_, logger_, statistics_,
          env_, &pinned_value_, true);
      if (!s.ok()) {
        valid_ = false;
        status_ = s;
        return false;
      }
Y
Yi Wu 已提交
1031
      valid_ = true;
1032 1033
      return true;
    } else if (ikey.type == kTypeMerge) {
1034 1035
      merge_context_.PushOperand(
          iter_.value(), iter_.iter()->IsValuePinned() /* operand_pinned */);
1036 1037 1038 1039 1040 1041
      PERF_COUNTER_ADD(internal_merge_count, 1);
    } else if (ikey.type == kTypeBlobIndex) {
      if (!allow_blob_) {
        ROCKS_LOG_ERROR(logger_, "Encounter unexpected blob index.");
        status_ = Status::NotSupported(
            "Encounter unexpected blob index. Please open DB with "
1042
            "ROCKSDB_NAMESPACE::blob_db::BlobDB instead.");
1043 1044 1045 1046
      } else {
        status_ =
            Status::NotSupported("Blob DB does not support merge operator.");
      }
Y
Yi Wu 已提交
1047
      valid_ = false;
1048 1049 1050
      return false;
    } else {
      assert(false);
1051
    }
S
Stanislau Hlebik 已提交
1052 1053
  }

1054 1055 1056 1057 1058
  Status s = MergeHelper::TimedFullMerge(
      merge_operator_, saved_key_.GetUserKey(), nullptr,
      merge_context_.GetOperands(), &saved_value_, logger_, statistics_, env_,
      &pinned_value_, true);
  if (!s.ok()) {
Y
Yi Wu 已提交
1059
    valid_ = false;
1060
    status_ = s;
1061
    return false;
1062
  }
S
Stanislau Hlebik 已提交
1063

1064 1065 1066
  // Make sure we leave iter_ in a good state. If it's valid and we don't care
  // about prefixes, that's already good enough. Otherwise it needs to be
  // seeked to the current key.
S
sdong 已提交
1067 1068
  if (!expect_total_order_inner_iter() || !iter_.Valid()) {
    if (!expect_total_order_inner_iter()) {
1069
      iter_.SeekForPrev(last_key);
1070
    } else {
1071 1072 1073
      iter_.Seek(last_key);
      if (!iter_.Valid() && iter_.status().ok()) {
        iter_.SeekToLast();
1074 1075 1076
      }
    }
    RecordTick(statistics_, NUMBER_OF_RESEEKS_IN_ITERATION);
S
Stanislau Hlebik 已提交
1077
  }
1078 1079 1080

  valid_ = true;
  return true;
S
Stanislau Hlebik 已提交
1081 1082
}

1083 1084 1085 1086
// Move backwards until the key smaller than saved_key_.
// Changes valid_ only if return value is false.
bool DBIter::FindUserKeyBeforeSavedKey() {
  assert(status_.ok());
S
Stanislau Hlebik 已提交
1087
  size_t num_skipped = 0;
1088
  while (iter_.Valid()) {
1089 1090 1091
    ParsedInternalKey ikey;
    if (!ParseKey(&ikey)) {
      return false;
1092 1093
    }

1094
    if (user_comparator_.Compare(ikey.user_key, saved_key_.GetUserKey()) < 0) {
1095 1096 1097 1098 1099
      return true;
    }

    if (TooManyInternalKeysSkipped()) {
      return false;
S
Stanislau Hlebik 已提交
1100
    }
1101

S
Siying Dong 已提交
1102
    assert(ikey.sequence != kMaxSequenceNumber);
Y
Yanqin Jin 已提交
1103 1104 1105 1106 1107 1108 1109
    assert(ikey.user_key.size() >= timestamp_size_);
    Slice ts;
    if (timestamp_size_ > 0) {
      ts = Slice(ikey.user_key.data() + ikey.user_key.size() - timestamp_size_,
                 timestamp_size_);
    }
    if (!IsVisible(ikey.sequence, ts)) {
1110 1111 1112 1113
      PERF_COUNTER_ADD(internal_recent_skipped_count, 1);
    } else {
      PERF_COUNTER_ADD(internal_key_skipped_count, 1);
    }
1114

1115
    if (num_skipped >= max_skip_) {
1116 1117 1118 1119 1120 1121
      num_skipped = 0;
      IterKey last_key;
      last_key.SetInternalKey(ParsedInternalKey(
          saved_key_.GetUserKey(), kMaxSequenceNumber, kValueTypeForSeek));
      // It would be more efficient to use SeekForPrev() here, but some
      // iterators may not support it.
1122
      iter_.Seek(last_key.GetInternalKey());
1123
      RecordTick(statistics_, NUMBER_OF_RESEEKS_IN_ITERATION);
1124
      if (!iter_.Valid()) {
1125 1126 1127 1128 1129 1130
        break;
      }
    } else {
      ++num_skipped;
    }

1131
    iter_.Prev();
S
Stanislau Hlebik 已提交
1132
  }
1133

1134
  if (!iter_.status().ok()) {
1135 1136 1137 1138 1139
    valid_ = false;
    return false;
  }

  return true;
S
Stanislau Hlebik 已提交
1140 1141
}

1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
bool DBIter::TooManyInternalKeysSkipped(bool increment) {
  if ((max_skippable_internal_keys_ > 0) &&
      (num_internal_keys_skipped_ > max_skippable_internal_keys_)) {
    valid_ = false;
    status_ = Status::Incomplete("Too many internal keys skipped.");
    return true;
  } else if (increment) {
    num_internal_keys_skipped_++;
  }
  return false;
}

1154 1155
bool DBIter::IsVisible(SequenceNumber sequence, const Slice& ts,
                       bool* more_recent) {
Y
Yanqin Jin 已提交
1156
  // Remember that comparator orders preceding timestamp as larger.
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
  // TODO(yanqin): support timestamp in read_callback_.
  bool visible_by_seq = (read_callback_ == nullptr)
                            ? sequence <= sequence_
                            : read_callback_->IsVisible(sequence);

  bool visible_by_ts =
      (timestamp_ub_ == nullptr ||
       user_comparator_.CompareTimestamp(ts, *timestamp_ub_) <= 0) &&
      (timestamp_lb_ == nullptr ||
       user_comparator_.CompareTimestamp(ts, *timestamp_lb_) >= 0);

  if (more_recent) {
    *more_recent = !visible_by_seq;
1170
  }
1171
  return visible_by_seq && visible_by_ts;
1172
}
1173

1174
void DBIter::SetSavedKeyToSeekTarget(const Slice& target) {
1175
  is_key_seqnum_zero_ = false;
1176
  SequenceNumber seq = sequence_;
1177
  saved_key_.Clear();
Y
Yanqin Jin 已提交
1178
  saved_key_.SetInternalKey(target, seq, kValueTypeForSeek, timestamp_ub_);
1179

Z
zhangjinpeng1987 已提交
1180
  if (iterate_lower_bound_ != nullptr &&
Y
Yanqin Jin 已提交
1181 1182 1183
      user_comparator_.CompareWithoutTimestamp(
          saved_key_.GetUserKey(), /*a_has_ts=*/true, *iterate_lower_bound_,
          /*b_has_ts=*/false) < 0) {
1184
    // Seek key is smaller than the lower bound.
Z
zhangjinpeng1987 已提交
1185
    saved_key_.Clear();
Y
Yanqin Jin 已提交
1186 1187
    saved_key_.SetInternalKey(*iterate_lower_bound_, seq, kValueTypeForSeek,
                              timestamp_ub_);
Z
zhangjinpeng1987 已提交
1188
  }
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218
}

void DBIter::SetSavedKeyToSeekForPrevTarget(const Slice& target) {
  is_key_seqnum_zero_ = false;
  saved_key_.Clear();
  // now saved_key is used to store internal key.
  saved_key_.SetInternalKey(target, 0 /* sequence_number */,
                            kValueTypeForSeekForPrev);

  if (iterate_upper_bound_ != nullptr &&
      user_comparator_.Compare(saved_key_.GetUserKey(),
                               *iterate_upper_bound_) >= 0) {
    saved_key_.Clear();
    saved_key_.SetInternalKey(*iterate_upper_bound_, kMaxSequenceNumber);
  }
}

void DBIter::Seek(const Slice& target) {
  PERF_CPU_TIMER_GUARD(iter_seek_cpu_nanos, env_);
  StopWatch sw(env_, statistics_, DB_SEEK);

#ifndef ROCKSDB_LITE
  if (db_impl_ != nullptr && cfd_ != nullptr) {
    db_impl_->TraceIteratorSeek(cfd_->GetID(), target);
  }
#endif  // ROCKSDB_LITE

  status_ = Status::OK();
  ReleaseTempPinnedData();
  ResetInternalKeysSkippedCounter();
Z
zhangjinpeng1987 已提交
1219

1220
  // Seek the inner iterator based on the target key.
1221 1222
  {
    PERF_TIMER_GUARD(seek_internal_seek_time);
1223 1224

    SetSavedKeyToSeekTarget(target);
1225
    iter_.Seek(saved_key_.GetInternalKey());
1226

1227
    range_del_agg_.InvalidateRangeDelMapPositions();
1228
    RecordTick(statistics_, NUMBER_DB_SEEK);
1229
  }
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242
  if (!iter_.Valid()) {
    valid_ = false;
    return;
  }
  direction_ = kForward;

  // Now the inner iterator is placed to the target position. From there,
  // we need to find out the next key that is visible to the user.
  ClearSavedValue();
  if (prefix_same_as_start_) {
    // The case where the iterator needs to be invalidated if it has exausted
    // keys within the same prefix of the seek key.
    assert(prefix_extractor_ != nullptr);
Y
Yanqin Jin 已提交
1243
    Slice target_prefix = prefix_extractor_->Transform(target);
1244 1245 1246
    FindNextUserEntry(false /* not skipping saved_key */,
                      &target_prefix /* prefix */);
    if (valid_) {
Y
Yanqin Jin 已提交
1247
      // Remember the prefix of the seek key for the future Next() call to
1248 1249
      // check.
      prefix_.SetUserKey(target_prefix);
M
Manuel Ung 已提交
1250
    }
J
jorlow@chromium.org 已提交
1251
  } else {
1252 1253 1254 1255
    FindNextUserEntry(false /* not skipping saved_key */, nullptr);
  }
  if (!valid_) {
    return;
J
jorlow@chromium.org 已提交
1256
  }
1257

1258 1259 1260 1261 1262
  // Updating stats and perf context counters.
  if (statistics_ != nullptr) {
    // Decrement since we don't want to count this key as skipped
    RecordTick(statistics_, NUMBER_DB_SEEK_FOUND);
    RecordTick(statistics_, ITER_BYTES_READ, key().size() + value().size());
1263
  }
1264
  PERF_COUNTER_ADD(iter_read_bytes, key().size() + value().size());
J
jorlow@chromium.org 已提交
1265
}
J
jorlow@chromium.org 已提交
1266

A
Aaron Gao 已提交
1267
void DBIter::SeekForPrev(const Slice& target) {
1268
  PERF_CPU_TIMER_GUARD(iter_seek_cpu_nanos, env_);
A
Aaron Gao 已提交
1269
  StopWatch sw(env_, statistics_, DB_SEEK);
1270 1271 1272 1273 1274 1275 1276

#ifndef ROCKSDB_LITE
  if (db_impl_ != nullptr && cfd_ != nullptr) {
    db_impl_->TraceIteratorSeekForPrev(cfd_->GetID(), target);
  }
#endif  // ROCKSDB_LITE

Y
Yanqin Jin 已提交
1277 1278 1279 1280 1281 1282 1283
  if (timestamp_size_ > 0) {
    valid_ = false;
    status_ = Status::NotSupported(
        "SeekToLast/SeekForPrev/Prev currently not supported with timestamp.");
    return;
  }

1284
  status_ = Status::OK();
A
Aaron Gao 已提交
1285
  ReleaseTempPinnedData();
1286
  ResetInternalKeysSkippedCounter();
Z
zhangjinpeng1987 已提交
1287

1288
  // Seek the inner iterator based on the target key.
A
Aaron Gao 已提交
1289 1290
  {
    PERF_TIMER_GUARD(seek_internal_seek_time);
1291
    SetSavedKeyToSeekForPrevTarget(target);
1292
    iter_.SeekForPrev(saved_key_.GetInternalKey());
1293
    range_del_agg_.InvalidateRangeDelMapPositions();
1294
    RecordTick(statistics_, NUMBER_DB_SEEK);
A
Aaron Gao 已提交
1295
  }
1296 1297 1298
  if (!iter_.Valid()) {
    valid_ = false;
    return;
1299
  }
1300
  direction_ = kReverse;
1301

1302 1303 1304 1305 1306 1307 1308 1309
  // Now the inner iterator is placed to the target position. From there,
  // we need to find out the first key that is visible to the user in the
  // backward direction.
  ClearSavedValue();
  if (prefix_same_as_start_) {
    // The case where the iterator needs to be invalidated if it has exausted
    // keys within the same prefix of the seek key.
    assert(prefix_extractor_ != nullptr);
Y
Yanqin Jin 已提交
1310
    Slice target_prefix = prefix_extractor_->Transform(target);
1311 1312 1313 1314 1315
    PrevInternal(&target_prefix);
    if (valid_) {
      // Remember the prefix of the seek key for the future Prev() call to
      // check.
      prefix_.SetUserKey(target_prefix);
A
Aaron Gao 已提交
1316 1317
    }
  } else {
1318
    PrevInternal(nullptr);
A
Aaron Gao 已提交
1319
  }
1320 1321 1322 1323 1324 1325

  // Report stats and perf context.
  if (statistics_ != nullptr && valid_) {
    RecordTick(statistics_, NUMBER_DB_SEEK_FOUND);
    RecordTick(statistics_, ITER_BYTES_READ, key().size() + value().size());
    PERF_COUNTER_ADD(iter_read_bytes, key().size() + value().size());
A
Aaron Gao 已提交
1326 1327 1328
  }
}

J
jorlow@chromium.org 已提交
1329
void DBIter::SeekToFirst() {
1330 1331 1332 1333
  if (iterate_lower_bound_ != nullptr) {
    Seek(*iterate_lower_bound_);
    return;
  }
1334
  PERF_CPU_TIMER_GUARD(iter_seek_cpu_nanos, env_);
1335 1336
  // Don't use iter_::Seek() if we set a prefix extractor
  // because prefix seek will be used.
S
sdong 已提交
1337
  if (!expect_total_order_inner_iter()) {
1338 1339 1340
    max_skip_ = std::numeric_limits<uint64_t>::max();
  }
  status_ = Status::OK();
J
jorlow@chromium.org 已提交
1341
  direction_ = kForward;
1342
  ReleaseTempPinnedData();
1343
  ResetInternalKeysSkippedCounter();
J
jorlow@chromium.org 已提交
1344
  ClearSavedValue();
1345
  is_key_seqnum_zero_ = false;
1346 1347 1348

  {
    PERF_TIMER_GUARD(seek_internal_seek_time);
1349
    iter_.SeekToFirst();
1350
    range_del_agg_.InvalidateRangeDelMapPositions();
1351 1352
  }

M
Manuel Ung 已提交
1353
  RecordTick(statistics_, NUMBER_DB_SEEK);
1354
  if (iter_.Valid()) {
1355
    saved_key_.SetUserKey(
1356 1357
        ExtractUserKey(iter_.key()),
        !iter_.iter()->IsKeyPinned() || !pin_thru_lifetime_ /* copy */);
1358 1359
    FindNextUserEntry(false /* not skipping saved_key */,
                      nullptr /* no prefix check */);
M
Manuel Ung 已提交
1360 1361 1362 1363
    if (statistics_ != nullptr) {
      if (valid_) {
        RecordTick(statistics_, NUMBER_DB_SEEK_FOUND);
        RecordTick(statistics_, ITER_BYTES_READ, key().size() + value().size());
1364
        PERF_COUNTER_ADD(iter_read_bytes, key().size() + value().size());
M
Manuel Ung 已提交
1365 1366
      }
    }
J
jorlow@chromium.org 已提交
1367 1368
  } else {
    valid_ = false;
J
jorlow@chromium.org 已提交
1369
  }
1370 1371 1372
  if (valid_ && prefix_same_as_start_) {
    assert(prefix_extractor_ != nullptr);
    prefix_.SetUserKey(prefix_extractor_->Transform(saved_key_.GetUserKey()));
1373
  }
J
jorlow@chromium.org 已提交
1374 1375
}

J
jorlow@chromium.org 已提交
1376
void DBIter::SeekToLast() {
Y
Yanqin Jin 已提交
1377 1378 1379 1380 1381 1382 1383
  if (timestamp_size_ > 0) {
    valid_ = false;
    status_ = Status::NotSupported(
        "SeekToLast/SeekForPrev/Prev currently not supported with timestamp.");
    return;
  }

1384 1385 1386
  if (iterate_upper_bound_ != nullptr) {
    // Seek to last key strictly less than ReadOptions.iterate_upper_bound.
    SeekForPrev(*iterate_upper_bound_);
1387
    if (Valid() && user_comparator_.Equal(*iterate_upper_bound_, key())) {
1388
      ReleaseTempPinnedData();
1389
      PrevInternal(nullptr);
1390 1391 1392 1393
    }
    return;
  }

1394
  PERF_CPU_TIMER_GUARD(iter_seek_cpu_nanos, env_);
S
Stanislau Hlebik 已提交
1395
  // Don't use iter_::Seek() if we set a prefix extractor
1396
  // because prefix seek will be used.
S
sdong 已提交
1397
  if (!expect_total_order_inner_iter()) {
S
Stanislau Hlebik 已提交
1398 1399
    max_skip_ = std::numeric_limits<uint64_t>::max();
  }
1400
  status_ = Status::OK();
J
jorlow@chromium.org 已提交
1401
  direction_ = kReverse;
1402
  ReleaseTempPinnedData();
1403
  ResetInternalKeysSkippedCounter();
J
jorlow@chromium.org 已提交
1404
  ClearSavedValue();
1405
  is_key_seqnum_zero_ = false;
1406 1407 1408

  {
    PERF_TIMER_GUARD(seek_internal_seek_time);
1409
    iter_.SeekToLast();
1410
    range_del_agg_.InvalidateRangeDelMapPositions();
1411
  }
1412
  PrevInternal(nullptr);
M
Manuel Ung 已提交
1413 1414 1415 1416 1417
  if (statistics_ != nullptr) {
    RecordTick(statistics_, NUMBER_DB_SEEK);
    if (valid_) {
      RecordTick(statistics_, NUMBER_DB_SEEK_FOUND);
      RecordTick(statistics_, ITER_BYTES_READ, key().size() + value().size());
1418
      PERF_COUNTER_ADD(iter_read_bytes, key().size() + value().size());
M
Manuel Ung 已提交
1419 1420
    }
  }
1421 1422 1423
  if (valid_ && prefix_same_as_start_) {
    assert(prefix_extractor_ != nullptr);
    prefix_.SetUserKey(prefix_extractor_->Transform(saved_key_.GetUserKey()));
1424
  }
J
jorlow@chromium.org 已提交
1425 1426
}

1427 1428
Iterator* NewDBIterator(Env* env, const ReadOptions& read_options,
                        const ImmutableCFOptions& cf_options,
1429
                        const MutableCFOptions& mutable_cf_options,
1430 1431 1432
                        const Comparator* user_key_comparator,
                        InternalIterator* internal_iter,
                        const SequenceNumber& sequence,
Y
Yi Wu 已提交
1433
                        uint64_t max_sequential_skip_in_iterations,
1434 1435 1436 1437 1438 1439
                        ReadCallback* read_callback, DBImpl* db_impl,
                        ColumnFamilyData* cfd, bool allow_blob) {
  DBIter* db_iter = new DBIter(
      env, read_options, cf_options, mutable_cf_options, user_key_comparator,
      internal_iter, sequence, false, max_sequential_skip_in_iterations,
      read_callback, db_impl, cfd, allow_blob);
1440
  return db_iter;
1441 1442
}

1443
}  // namespace ROCKSDB_NAMESPACE