db_iter.cc 50.8 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 111 112 113
  Status s =
      ParseInternalKey(iter_.key(), ikey, false /* log_err_key */);  // TODO
  if (!s.ok()) {
    status_ = Status::Corruption("In DBIter: ", s.getState());
114
    valid_ = false;
115
    ROCKS_LOG_ERROR(logger_, "In DBIter: %s", status_.getState());
J
jorlow@chromium.org 已提交
116 117 118 119 120 121
    return false;
  } else {
    return true;
  }
}

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

126
  PERF_CPU_TIMER_GUARD(iter_next_cpu_nanos, env_);
127 128
  // Release temporarily pinned blocks from last operation
  ReleaseTempPinnedData();
129 130 131
  local_stats_.skip_count_ += num_internal_keys_skipped_;
  local_stats_.skip_count_--;
  num_internal_keys_skipped_ = 0;
132
  bool ok = true;
S
Stanislau Hlebik 已提交
133
  if (direction_ == kReverse) {
134
    is_key_seqnum_zero_ = false;
135 136 137
    if (!ReverseToForward()) {
      ok = false;
    }
138
  } else if (!current_entry_is_merged_) {
139 140 141 142 143
    // 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.
144 145
    assert(iter_.Valid());
    iter_.Next();
146
    PERF_COUNTER_ADD(internal_key_skipped_count, 1);
J
jorlow@chromium.org 已提交
147
  }
J
jorlow@chromium.org 已提交
148

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

168
// PRE: saved_key_ has the current user key if skipping_saved_key
169 170 171 172 173 174
// 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
175
//       a delete marker or a sequence number higher than sequence_
176
//       saved_key_ MUST have a proper user_key before calling this function
177
//
Y
Yanqin Jin 已提交
178
// The prefix parameter, if not null, indicates that we need to iterate
179 180 181
// 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) {
182
  PERF_TIMER_GUARD(find_next_user_entry_time);
183
  return FindNextUserEntryInternal(skipping_saved_key, prefix);
184 185 186
}

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

  // 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
197
  // sequence numbers were too high or because skipping_saved_key = true.
198
  // What saved_key_ contains throughout this method:
Y
Yanqin Jin 已提交
199 200 201 202 203 204 205 206
  //  - 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.
207
  uint64_t num_skipped = 0;
208 209 210 211 212
  // 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;
213

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

J
jorlow@chromium.org 已提交
216
  do {
217 218 219
    // 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_;
220
    if (!ParseKey(&ikey_)) {
221
      is_key_seqnum_zero_ = false;
222
      return false;
223
    }
224 225
    Slice user_key_without_ts =
        StripTimestampFromUserKey(ikey_.user_key, timestamp_size_);
226

227 228
    is_key_seqnum_zero_ = (ikey_.sequence == 0);

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

242 243
    assert(prefix == nullptr || prefix_extractor_ != nullptr);
    if (prefix != nullptr &&
244 245
        prefix_extractor_->Transform(user_key_without_ts).compare(*prefix) !=
            0) {
246
      assert(prefix_same_as_start_);
247 248 249
      break;
    }

250
    if (TooManyInternalKeysSkipped()) {
251
      return false;
252 253
    }

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

                is_blob_ = true;
                valid_ = true;
                return true;
364 365
              } else {
                valid_ = true;
366
                return true;
367
              }
368 369 370
            }
            break;
          case kTypeMerge:
371
            saved_key_.SetUserKey(
372
                ikey_.user_key,
373
                !pin_thru_lifetime_ || !iter_.iter()->IsKeyPinned() /* copy */);
374
            if (range_del_agg_.ShouldDelete(
375
                    ikey_, RangeDelPositioningMode::kForwardTraversal)) {
376 377
              // Arrange to skip all upcoming entries for this key since
              // they are hidden by this deletion.
378
              skipping_saved_key = true;
379
              num_skipped = 0;
380
              reseek_done = false;
381 382 383 384 385 386
              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;
387
              return MergeValuesNewToOld();  // Go to a different state machine
388 389 390
            }
            break;
          default:
391 392 393 394 395
            valid_ = false;
            status_ = Status::Corruption(
                "Unknown value type: " +
                std::to_string(static_cast<unsigned int>(ikey_.type)));
            return false;
396
        }
J
jorlow@chromium.org 已提交
397
      }
398
    } else {
399 400 401
      if (more_recent) {
        PERF_COUNTER_ADD(internal_recent_skipped_count, 1);
      }
402

403 404 405
      // 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 已提交
406 407
      int cmp = user_comparator_.CompareWithoutTimestamp(
          ikey_.user_key, saved_key_.GetUserKey());
Y
Yanqin Jin 已提交
408
      if (cmp == 0 || (skipping_saved_key && cmp < 0)) {
409 410
        num_skipped++;
      } else {
411
        saved_key_.SetUserKey(
412
            ikey_.user_key,
413
            !iter_.iter()->IsKeyPinned() || !pin_thru_lifetime_ /* copy */);
414
        skipping_saved_key = false;
415
        num_skipped = 0;
416
        reseek_done = false;
417
      }
J
jorlow@chromium.org 已提交
418
    }
419 420 421

    // If we have sequentially iterated via numerous equal keys, then it's
    // better to seek so that we can avoid too many key comparisons.
422 423 424 425 426
    //
    // 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 已提交
427
    // then it does not make sense to reseek as we would actually land further
428 429
    // away from the desired key. There is opportunity for optimization here.
    if (num_skipped > max_skip_ && !reseek_done) {
430
      is_key_seqnum_zero_ = false;
431
      num_skipped = 0;
432
      reseek_done = true;
433
      std::string last_key;
434
      if (skipping_saved_key) {
435 436 437
        // 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 已提交
438 439 440 441 442
        if (timestamp_size_ == 0) {
          AppendInternalKey(
              &last_key,
              ParsedInternalKey(saved_key_.GetUserKey(), 0, kTypeDeletion));
        } else {
443
          const std::string kTsMin(timestamp_size_, static_cast<char>(0));
Y
Yanqin Jin 已提交
444 445 446
          AppendInternalKeyWithDifferentTimestamp(
              &last_key,
              ParsedInternalKey(saved_key_.GetUserKey(), 0, kTypeDeletion),
447
              kTsMin);
Y
Yanqin Jin 已提交
448
        }
449 450
        // Don't set skipping_saved_key = false because we may still see more
        // user-keys equal to saved_key_.
451 452 453 454 455 456
      } 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 已提交
457 458 459 460 461 462 463 464 465 466 467
        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_);
        }
468
      }
469
      iter_.Seek(last_key);
470 471
      RecordTick(statistics_, NUMBER_OF_RESEEKS_IN_ITERATION);
    } else {
472
      iter_.Next();
473
    }
474
  } while (iter_.Valid());
475

J
jorlow@chromium.org 已提交
476
  valid_ = false;
477
  return iter_.status().ok();
J
jorlow@chromium.org 已提交
478 479
}

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

495 496
  // Temporarily pin the blocks that hold merge operands
  TempPinData();
497
  merge_context_.Clear();
498
  // Start the merge process by pushing the first operand
499 500
  merge_context_.PushOperand(
      iter_.value(), iter_.iter()->IsValuePinned() /* operand_pinned */);
501
  TEST_SYNC_POINT("DBIter::MergeValuesNewToOld:PushedFirstOperand");
502 503

  ParsedInternalKey ikey;
504
  Status s;
505
  for (iter_.Next(); iter_.Valid(); iter_.Next()) {
506
    TEST_SYNC_POINT("DBIter::MergeValuesNewToOld:SteppedToNextOperand");
507
    if (!ParseKey(&ikey)) {
508
      return false;
509 510
    }

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

    if (kTypeValue == ikey.type) {
529 530
      // hit a put, merge the put value with operands and store the
      // final result in saved_value_. We are done!
531
      const Slice val = iter_.value();
532 533
      s = MergeHelper::TimedFullMerge(
          merge_operator_, ikey.user_key, &val, merge_context_.GetOperands(),
534
          &saved_value_, logger_, statistics_, env_, &pinned_value_, true);
535
      if (!s.ok()) {
Y
Yi Wu 已提交
536
        valid_ = false;
537
        status_ = s;
538
        return false;
539
      }
540
      // iter_ is positioned after put
541 542
      iter_.Next();
      if (!iter_.status().ok()) {
543 544 545 546
        valid_ = false;
        return false;
      }
      return true;
A
Andres Noetzli 已提交
547
    } else if (kTypeMerge == ikey.type) {
548 549
      // hit a merge, add the value as an operand and run associative merge.
      // when complete, add result to operands and continue.
550 551
      merge_context_.PushOperand(
          iter_.value(), iter_.iter()->IsValuePinned() /* operand_pinned */);
552
      PERF_COUNTER_ADD(internal_merge_count, 1);
Y
Yi Wu 已提交
553 554 555 556 557
    } 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 "
558
            "ROCKSDB_NAMESPACE::blob_db::BlobDB instead.");
Y
Yi Wu 已提交
559 560 561 562 563
      } else {
        status_ =
            Status::NotSupported("Blob DB does not support merge operator.");
      }
      valid_ = false;
564
      return false;
A
Andres Noetzli 已提交
565
    } else {
566 567 568 569 570
      valid_ = false;
      status_ = Status::Corruption(
          "Unrecognized value type: " +
          std::to_string(static_cast<unsigned int>(ikey.type)));
      return false;
571 572 573
    }
  }

574
  if (!iter_.status().ok()) {
575 576 577 578
    valid_ = false;
    return false;
  }

579 580 581 582
  // 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.
583 584 585
  s = MergeHelper::TimedFullMerge(merge_operator_, saved_key_.GetUserKey(),
                                  nullptr, merge_context_.GetOperands(),
                                  &saved_value_, logger_, statistics_, env_,
586
                                  &pinned_value_, true);
587
  if (!s.ok()) {
Y
Yi Wu 已提交
588
    valid_ = false;
589
    status_ = s;
590
    return false;
591
  }
592 593 594

  assert(status_.ok());
  return true;
595 596
}

J
jorlow@chromium.org 已提交
597
void DBIter::Prev() {
Y
Yanqin Jin 已提交
598 599 600 601 602 603 604
  if (timestamp_size_ > 0) {
    valid_ = false;
    status_ = Status::NotSupported(
        "SeekToLast/SeekForPrev/Prev currently not supported with timestamp.");
    return;
  }

J
jorlow@chromium.org 已提交
605
  assert(valid_);
606
  assert(status_.ok());
607 608

  PERF_CPU_TIMER_GUARD(iter_prev_cpu_nanos, env_);
609
  ReleaseTempPinnedData();
610
  ResetInternalKeysSkippedCounter();
611
  bool ok = true;
S
Stanislau Hlebik 已提交
612
  if (direction_ == kForward) {
613 614 615 616 617
    if (!ReverseToBackward()) {
      ok = false;
    }
  }
  if (ok) {
618 619 620 621 622 623
    Slice prefix;
    if (prefix_same_as_start_) {
      assert(prefix_extractor_ != nullptr);
      prefix = prefix_.GetUserKey();
    }
    PrevInternal(prefix_same_as_start_ ? &prefix : nullptr);
S
Stanislau Hlebik 已提交
624
  }
625

M
Manuel Ung 已提交
626
  if (statistics_ != nullptr) {
627
    local_stats_.prev_count_++;
M
Manuel Ung 已提交
628
    if (valid_) {
629 630
      local_stats_.prev_found_count_++;
      local_stats_.bytes_read_ += (key().size() + value().size());
M
Manuel Ung 已提交
631 632
    }
  }
S
Stanislau Hlebik 已提交
633
}
J
jorlow@chromium.org 已提交
634

635
bool DBIter::ReverseToForward() {
636
  assert(iter_.status().ok());
637 638 639 640

  // 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 已提交
641
  if (!expect_total_order_inner_iter() || !iter_.Valid()) {
642 643
    IterKey last_key;
    last_key.SetInternalKey(ParsedInternalKey(
644
        saved_key_.GetUserKey(), kMaxSequenceNumber, kValueTypeForSeek));
645
    iter_.Seek(last_key.GetInternalKey());
646
  }
647

648
  direction_ = kForward;
649
  // Skip keys less than the current key() (a.k.a. saved_key_).
650
  while (iter_.Valid()) {
651 652 653 654
    ParsedInternalKey ikey;
    if (!ParseKey(&ikey)) {
      return false;
    }
655
    if (user_comparator_.Compare(ikey.user_key, saved_key_.GetUserKey()) >= 0) {
656 657
      return true;
    }
658
    iter_.Next();
659 660
  }

661
  if (!iter_.status().ok()) {
662 663
    valid_ = false;
    return false;
664
  }
665 666

  return true;
667 668
}

669 670
// Move iter_ to the key before saved_key_.
bool DBIter::ReverseToBackward() {
671
  assert(iter_.status().ok());
672 673 674 675 676

  // 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 已提交
677
      (!expect_total_order_inner_iter() || !iter_.Valid())) {
678
    IterKey last_key;
679 680 681 682 683
    // 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 已提交
684
    if (!expect_total_order_inner_iter()) {
685
      iter_.SeekForPrev(last_key.GetInternalKey());
686 687 688 689 690
    } 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.
691 692 693
      iter_.Seek(last_key.GetInternalKey());
      if (!iter_.Valid() && iter_.status().ok()) {
        iter_.SeekToLast();
694
      }
695 696 697 698
    }
  }

  direction_ = kReverse;
699
  return FindUserKeyBeforeSavedKey();
700 701
}

702
void DBIter::PrevInternal(const Slice* prefix) {
703
  while (iter_.Valid()) {
704
    saved_key_.SetUserKey(
705 706
        ExtractUserKey(iter_.key()),
        !iter_.iter()->IsKeyPinned() || !pin_thru_lifetime_ /* copy */);
707

708 709
    assert(prefix == nullptr || prefix_extractor_ != nullptr);
    if (prefix != nullptr &&
710 711 712
        prefix_extractor_
                ->Transform(StripTimestampFromUserKey(saved_key_.GetUserKey(),
                                                      timestamp_size_))
713 714
                .compare(*prefix) != 0) {
      assert(prefix_same_as_start_);
715 716 717 718 719
      // Current key does not have the same prefix as start
      valid_ = false;
      return;
    }

720 721 722 723
    assert(iterate_lower_bound_ == nullptr || iter_.MayBeOutOfLowerBound() ||
           user_comparator_.Compare(saved_key_.GetUserKey(),
                                    *iterate_lower_bound_) >= 0);
    if (iterate_lower_bound_ != nullptr && iter_.MayBeOutOfLowerBound() &&
724 725
        user_comparator_.Compare(saved_key_.GetUserKey(),
                                 *iterate_lower_bound_) < 0) {
726 727 728 729 730
      // We've iterated earlier than the user-specified lower bound.
      valid_ = false;
      return;
    }

731
    if (!FindValueForCurrentKey()) {  // assigns valid_
S
Stanislau Hlebik 已提交
732
      return;
J
jorlow@chromium.org 已提交
733
    }
734

735 736 737
    // Whether or not we found a value for current key, we need iter_ to end up
    // on a smaller key.
    if (!FindUserKeyBeforeSavedKey()) {
738 739 740
      return;
    }

741 742 743
    if (valid_) {
      // Found the value.
      return;
S
Stanislau Hlebik 已提交
744
    }
745 746 747

    if (TooManyInternalKeysSkipped(false)) {
      return;
S
Stanislau Hlebik 已提交
748 749
    }
  }
750

S
Stanislau Hlebik 已提交
751 752
  // We haven't found any key - iterator is not valid
  valid_ = false;
J
jorlow@chromium.org 已提交
753 754
}

755 756 757 758 759 760 761 762 763 764 765
// 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 已提交
766
bool DBIter::FindValueForCurrentKey() {
767
  assert(iter_.Valid());
768
  merge_context_.Clear();
769
  current_entry_is_merged_ = false;
A
Andres Noetzli 已提交
770 771
  // last entry before merge (could be kTypeDeletion, kTypeSingleDeletion or
  // kTypeValue)
S
Stanislau Hlebik 已提交
772 773
  ValueType last_not_merge_type = kTypeDeletion;
  ValueType last_key_entry_type = kTypeDeletion;
J
jorlow@chromium.org 已提交
774

775 776 777
  // Temporarily pin blocks that hold (merge operands / the value)
  ReleaseTempPinnedData();
  TempPinData();
S
Stanislau Hlebik 已提交
778
  size_t num_skipped = 0;
779
  while (iter_.Valid()) {
780 781 782 783 784
    ParsedInternalKey ikey;
    if (!ParseKey(&ikey)) {
      return false;
    }

Y
Yanqin Jin 已提交
785 786 787 788 789 790 791
    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) ||
792
        !user_comparator_.Equal(ikey.user_key, saved_key_.GetUserKey())) {
793 794
      break;
    }
795 796 797 798
    if (TooManyInternalKeysSkipped()) {
      return false;
    }

799 800 801
    // 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.
802
    if (num_skipped >= max_skip_) {
S
Stanislau Hlebik 已提交
803 804 805
      return FindValueForCurrentKeyUsingSeek();
    }

806 807 808 809 810
    if (!iter_.PrepareValue()) {
      valid_ = false;
      return false;
    }

S
Stanislau Hlebik 已提交
811 812 813
    last_key_entry_type = ikey.type;
    switch (last_key_entry_type) {
      case kTypeValue:
Y
Yi Wu 已提交
814
      case kTypeBlobIndex:
815
        if (range_del_agg_.ShouldDelete(
816
                ikey, RangeDelPositioningMode::kBackwardTraversal)) {
A
Andrew Kryczka 已提交
817 818
          last_key_entry_type = kTypeRangeDeletion;
          PERF_COUNTER_ADD(internal_delete_skipped_count, 1);
819
        } else if (iter_.iter()->IsValuePinned()) {
820
          pinned_value_ = iter_.value();
821 822 823 824 825
        } else {
          valid_ = false;
          status_ = Status::NotSupported(
              "Backward iteration not supported if underlying iterator's value "
              "cannot be pinned.");
A
Andrew Kryczka 已提交
826
        }
827
        merge_context_.Clear();
A
Andrew Kryczka 已提交
828
        last_not_merge_type = last_key_entry_type;
829 830 831
        if (!status_.ok()) {
          return false;
        }
S
Stanislau Hlebik 已提交
832 833
        break;
      case kTypeDeletion:
A
Andres Noetzli 已提交
834
      case kTypeSingleDeletion:
835
        merge_context_.Clear();
A
Andres Noetzli 已提交
836
        last_not_merge_type = last_key_entry_type;
837
        PERF_COUNTER_ADD(internal_delete_skipped_count, 1);
S
Stanislau Hlebik 已提交
838 839
        break;
      case kTypeMerge:
840
        if (range_del_agg_.ShouldDelete(
841
                ikey, RangeDelPositioningMode::kBackwardTraversal)) {
A
Andrew Kryczka 已提交
842 843 844 845 846 847 848
          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(
849 850
              iter_.value(),
              iter_.iter()->IsValuePinned() /* operand_pinned */);
851
          PERF_COUNTER_ADD(internal_merge_count, 1);
A
Andrew Kryczka 已提交
852
        }
S
Stanislau Hlebik 已提交
853 854
        break;
      default:
855 856 857 858 859
        valid_ = false;
        status_ = Status::Corruption(
            "Unknown value type: " +
            std::to_string(static_cast<unsigned int>(last_key_entry_type)));
        return false;
S
Stanislau Hlebik 已提交
860 861
    }

862
    PERF_COUNTER_ADD(internal_key_skipped_count, 1);
863
    iter_.Prev();
S
Stanislau Hlebik 已提交
864
    ++num_skipped;
865 866
  }

867
  if (!iter_.status().ok()) {
868 869
    valid_ = false;
    return false;
S
Stanislau Hlebik 已提交
870 871
  }

872
  Status s;
S
sdong 已提交
873
  s.PermitUncheckedError();
Y
Yi Wu 已提交
874
  is_blob_ = false;
S
Stanislau Hlebik 已提交
875 876
  switch (last_key_entry_type) {
    case kTypeDeletion:
A
Andres Noetzli 已提交
877
    case kTypeSingleDeletion:
A
Andrew Kryczka 已提交
878
    case kTypeRangeDeletion:
S
Stanislau Hlebik 已提交
879
      valid_ = false;
880
      return true;
S
Stanislau Hlebik 已提交
881
    case kTypeMerge:
882
      current_entry_is_merged_ = true;
A
Aaron Gao 已提交
883
      if (last_not_merge_type == kTypeDeletion ||
A
Andrew Kryczka 已提交
884 885
          last_not_merge_type == kTypeSingleDeletion ||
          last_not_merge_type == kTypeRangeDeletion) {
886 887 888
        s = MergeHelper::TimedFullMerge(
            merge_operator_, saved_key_.GetUserKey(), nullptr,
            merge_context_.GetOperands(), &saved_value_, logger_, statistics_,
889
            env_, &pinned_value_, true);
Y
Yi Wu 已提交
890 891 892 893 894
      } 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 "
895
              "ROCKSDB_NAMESPACE::blob_db::BlobDB instead.");
Y
Yi Wu 已提交
896 897 898 899 900
        } else {
          status_ =
              Status::NotSupported("Blob DB does not support merge operator.");
        }
        valid_ = false;
901
        return false;
902
      } else {
S
Stanislau Hlebik 已提交
903
        assert(last_not_merge_type == kTypeValue);
904
        s = MergeHelper::TimedFullMerge(
905
            merge_operator_, saved_key_.GetUserKey(), &pinned_value_,
906
            merge_context_.GetOperands(), &saved_value_, logger_, statistics_,
907
            env_, &pinned_value_, true);
908
      }
S
Stanislau Hlebik 已提交
909 910
      break;
    case kTypeValue:
911
      // do nothing - we've already has value in pinned_value_
S
Stanislau Hlebik 已提交
912
      break;
Y
Yi Wu 已提交
913 914 915 916 917
    case kTypeBlobIndex:
      if (!allow_blob_) {
        ROCKS_LOG_ERROR(logger_, "Encounter unexpected blob index.");
        status_ = Status::NotSupported(
            "Encounter unexpected blob index. Please open DB with "
918
            "ROCKSDB_NAMESPACE::blob_db::BlobDB instead.");
Y
Yi Wu 已提交
919
        valid_ = false;
920
        return false;
Y
Yi Wu 已提交
921 922 923
      }
      is_blob_ = true;
      break;
S
Stanislau Hlebik 已提交
924
    default:
925 926 927 928 929
      valid_ = false;
      status_ = Status::Corruption(
          "Unknown value type: " +
          std::to_string(static_cast<unsigned int>(last_key_entry_type)));
      return false;
J
jorlow@chromium.org 已提交
930
  }
931
  if (!s.ok()) {
Y
Yi Wu 已提交
932
    valid_ = false;
933
    status_ = s;
934
    return false;
935
  }
936
  valid_ = true;
S
Stanislau Hlebik 已提交
937 938
  return true;
}
J
jorlow@chromium.org 已提交
939

S
Stanislau Hlebik 已提交
940 941
// This function is used in FindValueForCurrentKey.
// We use Seek() function instead of Prev() to find necessary value
942 943
// TODO: This is very similar to FindNextUserEntry() and MergeValuesNewToOld().
//       Would be nice to reuse some code.
S
Stanislau Hlebik 已提交
944
bool DBIter::FindValueForCurrentKeyUsingSeek() {
945 946 947
  // FindValueForCurrentKey will enable pinning before calling
  // FindValueForCurrentKeyUsingSeek()
  assert(pinned_iters_mgr_.PinningEnabled());
S
Stanislau Hlebik 已提交
948
  std::string last_key;
949 950
  AppendInternalKey(&last_key, ParsedInternalKey(saved_key_.GetUserKey(),
                                                 sequence_, kValueTypeForSeek));
951
  iter_.Seek(last_key);
S
Stanislau Hlebik 已提交
952 953
  RecordTick(statistics_, NUMBER_OF_RESEEKS_IN_ITERATION);

954 955
  // In case read_callback presents, the value we seek to may not be visible.
  // Find the next value that's visible.
S
Stanislau Hlebik 已提交
956
  ParsedInternalKey ikey;
957
  is_blob_ = false;
958
  while (true) {
959
    if (!iter_.Valid()) {
960
      valid_ = false;
961
      return iter_.status().ok();
962 963 964 965 966
    }

    if (!ParseKey(&ikey)) {
      return false;
    }
Y
Yanqin Jin 已提交
967 968 969 970 971 972 973
    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_);
    }

974
    if (!user_comparator_.Equal(ikey.user_key, saved_key_.GetUserKey())) {
975 976 977 978 979 980 981
      // 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 已提交
982
    if (IsVisible(ikey.sequence, ts)) {
983 984
      break;
    }
985

986
    iter_.Next();
987
  }
S
Stanislau Hlebik 已提交
988

A
Andrew Kryczka 已提交
989
  if (ikey.type == kTypeDeletion || ikey.type == kTypeSingleDeletion ||
990
      range_del_agg_.ShouldDelete(
991
          ikey, RangeDelPositioningMode::kBackwardTraversal)) {
J
jorlow@chromium.org 已提交
992
    valid_ = false;
993
    return true;
S
Stanislau Hlebik 已提交
994
  }
Y
Yi Wu 已提交
995 996 997 998
  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 "
999
        "ROCKSDB_NAMESPACE::blob_db::BlobDB instead.");
Y
Yi Wu 已提交
1000
    valid_ = false;
1001
    return false;
Y
Yi Wu 已提交
1002
  }
1003 1004 1005 1006
  if (!iter_.PrepareValue()) {
    valid_ = false;
    return false;
  }
Y
Yi Wu 已提交
1007
  if (ikey.type == kTypeValue || ikey.type == kTypeBlobIndex) {
1008 1009
    assert(iter_.iter()->IsValuePinned());
    pinned_value_ = iter_.value();
1010
    is_blob_ = (ikey.type == kTypeBlobIndex);
A
Andrew Kryczka 已提交
1011 1012 1013
    valid_ = true;
    return true;
  }
S
Stanislau Hlebik 已提交
1014 1015 1016

  // kTypeMerge. We need to collect all kTypeMerge values and save them
  // in operands
1017
  assert(ikey.type == kTypeMerge);
1018
  current_entry_is_merged_ = true;
1019
  merge_context_.Clear();
1020 1021
  merge_context_.PushOperand(
      iter_.value(), iter_.iter()->IsValuePinned() /* operand_pinned */);
1022
  while (true) {
1023
    iter_.Next();
S
Stanislau Hlebik 已提交
1024

1025 1026
    if (!iter_.Valid()) {
      if (!iter_.status().ok()) {
1027 1028 1029 1030
        valid_ = false;
        return false;
      }
      break;
S
Stanislau Hlebik 已提交
1031
    }
1032 1033 1034
    if (!ParseKey(&ikey)) {
      return false;
    }
1035
    if (!user_comparator_.Equal(ikey.user_key, saved_key_.GetUserKey())) {
1036 1037 1038 1039
      break;
    }
    if (ikey.type == kTypeDeletion || ikey.type == kTypeSingleDeletion ||
        range_del_agg_.ShouldDelete(
1040
            ikey, RangeDelPositioningMode::kForwardTraversal)) {
1041
      break;
1042 1043 1044 1045 1046 1047 1048
    }
    if (!iter_.PrepareValue()) {
      valid_ = false;
      return false;
    }

    if (ikey.type == kTypeValue) {
1049
      const Slice val = iter_.value();
1050 1051 1052 1053 1054 1055 1056 1057 1058
      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 已提交
1059
      valid_ = true;
1060 1061
      return true;
    } else if (ikey.type == kTypeMerge) {
1062 1063
      merge_context_.PushOperand(
          iter_.value(), iter_.iter()->IsValuePinned() /* operand_pinned */);
1064 1065 1066 1067 1068 1069
      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 "
1070
            "ROCKSDB_NAMESPACE::blob_db::BlobDB instead.");
1071 1072 1073 1074
      } else {
        status_ =
            Status::NotSupported("Blob DB does not support merge operator.");
      }
Y
Yi Wu 已提交
1075
      valid_ = false;
1076 1077
      return false;
    } else {
1078 1079 1080 1081 1082
      valid_ = false;
      status_ = Status::Corruption(
          "Unknown value type: " +
          std::to_string(static_cast<unsigned int>(ikey.type)));
      return false;
1083
    }
S
Stanislau Hlebik 已提交
1084 1085
  }

1086 1087 1088 1089 1090
  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 已提交
1091
    valid_ = false;
1092
    status_ = s;
1093
    return false;
1094
  }
S
Stanislau Hlebik 已提交
1095

1096 1097 1098
  // 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 已提交
1099 1100
  if (!expect_total_order_inner_iter() || !iter_.Valid()) {
    if (!expect_total_order_inner_iter()) {
1101
      iter_.SeekForPrev(last_key);
1102
    } else {
1103 1104 1105
      iter_.Seek(last_key);
      if (!iter_.Valid() && iter_.status().ok()) {
        iter_.SeekToLast();
1106 1107 1108
      }
    }
    RecordTick(statistics_, NUMBER_OF_RESEEKS_IN_ITERATION);
S
Stanislau Hlebik 已提交
1109
  }
1110 1111 1112

  valid_ = true;
  return true;
S
Stanislau Hlebik 已提交
1113 1114
}

1115 1116 1117 1118
// 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 已提交
1119
  size_t num_skipped = 0;
1120
  while (iter_.Valid()) {
1121 1122 1123
    ParsedInternalKey ikey;
    if (!ParseKey(&ikey)) {
      return false;
1124 1125
    }

1126
    if (user_comparator_.Compare(ikey.user_key, saved_key_.GetUserKey()) < 0) {
1127 1128 1129 1130 1131
      return true;
    }

    if (TooManyInternalKeysSkipped()) {
      return false;
S
Stanislau Hlebik 已提交
1132
    }
1133

S
Siying Dong 已提交
1134
    assert(ikey.sequence != kMaxSequenceNumber);
Y
Yanqin Jin 已提交
1135 1136 1137 1138 1139 1140 1141
    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)) {
1142 1143 1144 1145
      PERF_COUNTER_ADD(internal_recent_skipped_count, 1);
    } else {
      PERF_COUNTER_ADD(internal_key_skipped_count, 1);
    }
1146

1147
    if (num_skipped >= max_skip_) {
1148 1149 1150 1151 1152 1153
      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.
1154
      iter_.Seek(last_key.GetInternalKey());
1155
      RecordTick(statistics_, NUMBER_OF_RESEEKS_IN_ITERATION);
1156
      if (!iter_.Valid()) {
1157 1158 1159 1160 1161 1162
        break;
      }
    } else {
      ++num_skipped;
    }

1163
    iter_.Prev();
S
Stanislau Hlebik 已提交
1164
  }
1165

1166
  if (!iter_.status().ok()) {
1167 1168 1169 1170 1171
    valid_ = false;
    return false;
  }

  return true;
S
Stanislau Hlebik 已提交
1172 1173
}

1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185
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;
}

1186 1187
bool DBIter::IsVisible(SequenceNumber sequence, const Slice& ts,
                       bool* more_recent) {
Y
Yanqin Jin 已提交
1188
  // Remember that comparator orders preceding timestamp as larger.
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
  // 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;
1202
  }
1203
  return visible_by_seq && visible_by_ts;
1204
}
1205

1206
void DBIter::SetSavedKeyToSeekTarget(const Slice& target) {
1207
  is_key_seqnum_zero_ = false;
1208
  SequenceNumber seq = sequence_;
1209
  saved_key_.Clear();
Y
Yanqin Jin 已提交
1210
  saved_key_.SetInternalKey(target, seq, kValueTypeForSeek, timestamp_ub_);
1211

Z
zhangjinpeng1987 已提交
1212
  if (iterate_lower_bound_ != nullptr &&
Y
Yanqin Jin 已提交
1213 1214 1215
      user_comparator_.CompareWithoutTimestamp(
          saved_key_.GetUserKey(), /*a_has_ts=*/true, *iterate_lower_bound_,
          /*b_has_ts=*/false) < 0) {
1216
    // Seek key is smaller than the lower bound.
Z
zhangjinpeng1987 已提交
1217
    saved_key_.Clear();
Y
Yanqin Jin 已提交
1218 1219
    saved_key_.SetInternalKey(*iterate_lower_bound_, seq, kValueTypeForSeek,
                              timestamp_ub_);
Z
zhangjinpeng1987 已提交
1220
  }
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243
}

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) {
1244 1245
    // TODO: What do we do if this returns an error?
    db_impl_->TraceIteratorSeek(cfd_->GetID(), target).PermitUncheckedError();
1246 1247 1248 1249 1250 1251
  }
#endif  // ROCKSDB_LITE

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

1253
  // Seek the inner iterator based on the target key.
1254 1255
  {
    PERF_TIMER_GUARD(seek_internal_seek_time);
1256 1257

    SetSavedKeyToSeekTarget(target);
1258
    iter_.Seek(saved_key_.GetInternalKey());
1259

1260
    range_del_agg_.InvalidateRangeDelMapPositions();
1261
    RecordTick(statistics_, NUMBER_DB_SEEK);
1262
  }
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275
  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 已提交
1276
    Slice target_prefix = prefix_extractor_->Transform(target);
1277 1278 1279
    FindNextUserEntry(false /* not skipping saved_key */,
                      &target_prefix /* prefix */);
    if (valid_) {
Y
Yanqin Jin 已提交
1280
      // Remember the prefix of the seek key for the future Next() call to
1281 1282
      // check.
      prefix_.SetUserKey(target_prefix);
M
Manuel Ung 已提交
1283
    }
J
jorlow@chromium.org 已提交
1284
  } else {
1285 1286 1287 1288
    FindNextUserEntry(false /* not skipping saved_key */, nullptr);
  }
  if (!valid_) {
    return;
J
jorlow@chromium.org 已提交
1289
  }
1290

1291 1292 1293 1294 1295
  // 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());
1296
  }
1297
  PERF_COUNTER_ADD(iter_read_bytes, key().size() + value().size());
J
jorlow@chromium.org 已提交
1298
}
J
jorlow@chromium.org 已提交
1299

A
Aaron Gao 已提交
1300
void DBIter::SeekForPrev(const Slice& target) {
1301
  PERF_CPU_TIMER_GUARD(iter_seek_cpu_nanos, env_);
A
Aaron Gao 已提交
1302
  StopWatch sw(env_, statistics_, DB_SEEK);
1303 1304 1305

#ifndef ROCKSDB_LITE
  if (db_impl_ != nullptr && cfd_ != nullptr) {
1306 1307 1308
    // TODO: What do we do if this returns an error?
    db_impl_->TraceIteratorSeekForPrev(cfd_->GetID(), target)
        .PermitUncheckedError();
1309 1310 1311
  }
#endif  // ROCKSDB_LITE

Y
Yanqin Jin 已提交
1312 1313 1314 1315 1316 1317 1318
  if (timestamp_size_ > 0) {
    valid_ = false;
    status_ = Status::NotSupported(
        "SeekToLast/SeekForPrev/Prev currently not supported with timestamp.");
    return;
  }

1319
  status_ = Status::OK();
A
Aaron Gao 已提交
1320
  ReleaseTempPinnedData();
1321
  ResetInternalKeysSkippedCounter();
Z
zhangjinpeng1987 已提交
1322

1323
  // Seek the inner iterator based on the target key.
A
Aaron Gao 已提交
1324 1325
  {
    PERF_TIMER_GUARD(seek_internal_seek_time);
1326
    SetSavedKeyToSeekForPrevTarget(target);
1327
    iter_.SeekForPrev(saved_key_.GetInternalKey());
1328
    range_del_agg_.InvalidateRangeDelMapPositions();
1329
    RecordTick(statistics_, NUMBER_DB_SEEK);
A
Aaron Gao 已提交
1330
  }
1331 1332 1333
  if (!iter_.Valid()) {
    valid_ = false;
    return;
1334
  }
1335
  direction_ = kReverse;
1336

1337 1338 1339 1340 1341 1342 1343 1344
  // 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 已提交
1345
    Slice target_prefix = prefix_extractor_->Transform(target);
1346 1347 1348 1349 1350
    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 已提交
1351 1352
    }
  } else {
1353
    PrevInternal(nullptr);
A
Aaron Gao 已提交
1354
  }
1355 1356 1357 1358 1359 1360

  // 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 已提交
1361 1362 1363
  }
}

J
jorlow@chromium.org 已提交
1364
void DBIter::SeekToFirst() {
1365 1366 1367 1368
  if (iterate_lower_bound_ != nullptr) {
    Seek(*iterate_lower_bound_);
    return;
  }
1369
  PERF_CPU_TIMER_GUARD(iter_seek_cpu_nanos, env_);
1370 1371
  // Don't use iter_::Seek() if we set a prefix extractor
  // because prefix seek will be used.
S
sdong 已提交
1372
  if (!expect_total_order_inner_iter()) {
1373 1374 1375
    max_skip_ = std::numeric_limits<uint64_t>::max();
  }
  status_ = Status::OK();
J
jorlow@chromium.org 已提交
1376
  direction_ = kForward;
1377
  ReleaseTempPinnedData();
1378
  ResetInternalKeysSkippedCounter();
J
jorlow@chromium.org 已提交
1379
  ClearSavedValue();
1380
  is_key_seqnum_zero_ = false;
1381 1382 1383

  {
    PERF_TIMER_GUARD(seek_internal_seek_time);
1384
    iter_.SeekToFirst();
1385
    range_del_agg_.InvalidateRangeDelMapPositions();
1386 1387
  }

M
Manuel Ung 已提交
1388
  RecordTick(statistics_, NUMBER_DB_SEEK);
1389
  if (iter_.Valid()) {
1390
    saved_key_.SetUserKey(
1391 1392
        ExtractUserKey(iter_.key()),
        !iter_.iter()->IsKeyPinned() || !pin_thru_lifetime_ /* copy */);
1393 1394
    FindNextUserEntry(false /* not skipping saved_key */,
                      nullptr /* no prefix check */);
M
Manuel Ung 已提交
1395 1396 1397 1398
    if (statistics_ != nullptr) {
      if (valid_) {
        RecordTick(statistics_, NUMBER_DB_SEEK_FOUND);
        RecordTick(statistics_, ITER_BYTES_READ, key().size() + value().size());
1399
        PERF_COUNTER_ADD(iter_read_bytes, key().size() + value().size());
M
Manuel Ung 已提交
1400 1401
      }
    }
J
jorlow@chromium.org 已提交
1402 1403
  } else {
    valid_ = false;
J
jorlow@chromium.org 已提交
1404
  }
1405 1406
  if (valid_ && prefix_same_as_start_) {
    assert(prefix_extractor_ != nullptr);
1407 1408
    prefix_.SetUserKey(prefix_extractor_->Transform(
        StripTimestampFromUserKey(saved_key_.GetUserKey(), timestamp_size_)));
1409
  }
J
jorlow@chromium.org 已提交
1410 1411
}

J
jorlow@chromium.org 已提交
1412
void DBIter::SeekToLast() {
Y
Yanqin Jin 已提交
1413 1414 1415 1416 1417 1418 1419
  if (timestamp_size_ > 0) {
    valid_ = false;
    status_ = Status::NotSupported(
        "SeekToLast/SeekForPrev/Prev currently not supported with timestamp.");
    return;
  }

1420 1421 1422
  if (iterate_upper_bound_ != nullptr) {
    // Seek to last key strictly less than ReadOptions.iterate_upper_bound.
    SeekForPrev(*iterate_upper_bound_);
1423
    if (Valid() && user_comparator_.Equal(*iterate_upper_bound_, key())) {
1424
      ReleaseTempPinnedData();
1425
      PrevInternal(nullptr);
1426 1427 1428 1429
    }
    return;
  }

1430
  PERF_CPU_TIMER_GUARD(iter_seek_cpu_nanos, env_);
S
Stanislau Hlebik 已提交
1431
  // Don't use iter_::Seek() if we set a prefix extractor
1432
  // because prefix seek will be used.
S
sdong 已提交
1433
  if (!expect_total_order_inner_iter()) {
S
Stanislau Hlebik 已提交
1434 1435
    max_skip_ = std::numeric_limits<uint64_t>::max();
  }
1436
  status_ = Status::OK();
J
jorlow@chromium.org 已提交
1437
  direction_ = kReverse;
1438
  ReleaseTempPinnedData();
1439
  ResetInternalKeysSkippedCounter();
J
jorlow@chromium.org 已提交
1440
  ClearSavedValue();
1441
  is_key_seqnum_zero_ = false;
1442 1443 1444

  {
    PERF_TIMER_GUARD(seek_internal_seek_time);
1445
    iter_.SeekToLast();
1446
    range_del_agg_.InvalidateRangeDelMapPositions();
1447
  }
1448
  PrevInternal(nullptr);
M
Manuel Ung 已提交
1449 1450 1451 1452 1453
  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());
1454
      PERF_COUNTER_ADD(iter_read_bytes, key().size() + value().size());
M
Manuel Ung 已提交
1455 1456
    }
  }
1457 1458
  if (valid_ && prefix_same_as_start_) {
    assert(prefix_extractor_ != nullptr);
1459 1460
    prefix_.SetUserKey(prefix_extractor_->Transform(
        StripTimestampFromUserKey(saved_key_.GetUserKey(), timestamp_size_)));
1461
  }
J
jorlow@chromium.org 已提交
1462 1463
}

1464 1465
Iterator* NewDBIterator(Env* env, const ReadOptions& read_options,
                        const ImmutableCFOptions& cf_options,
1466
                        const MutableCFOptions& mutable_cf_options,
1467 1468 1469
                        const Comparator* user_key_comparator,
                        InternalIterator* internal_iter,
                        const SequenceNumber& sequence,
Y
Yi Wu 已提交
1470
                        uint64_t max_sequential_skip_in_iterations,
1471 1472 1473 1474 1475 1476
                        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);
1477
  return db_iter;
1478 1479
}

1480
}  // namespace ROCKSDB_NAMESPACE