db_iter.cc 50.4 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 226
    is_key_seqnum_zero_ = (ikey_.sequence == 0);

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

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

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

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

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

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

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

J
jorlow@chromium.org 已提交
473
  valid_ = false;
474
  return iter_.status().ok();
J
jorlow@chromium.org 已提交
475 476
}

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

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

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

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

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

571
  if (!iter_.status().ok()) {
572 573 574 575
    valid_ = false;
    return false;
  }

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

  assert(status_.ok());
  return true;
592 593
}

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

J
jorlow@chromium.org 已提交
602
  assert(valid_);
603
  assert(status_.ok());
604 605

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

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

632
bool DBIter::ReverseToForward() {
633
  assert(iter_.status().ok());
634 635 636 637

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

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

658
  if (!iter_.status().ok()) {
659 660
    valid_ = false;
    return false;
661
  }
662 663

  return true;
664 665
}

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

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

  direction_ = kReverse;
696
  return FindUserKeyBeforeSavedKey();
697 698
}

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

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

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

726
    if (!FindValueForCurrentKey()) {  // assigns valid_
S
Stanislau Hlebik 已提交
727
      return;
J
jorlow@chromium.org 已提交
728
    }
729

730 731 732
    // Whether or not we found a value for current key, we need iter_ to end up
    // on a smaller key.
    if (!FindUserKeyBeforeSavedKey()) {
733 734 735
      return;
    }

736 737 738
    if (valid_) {
      // Found the value.
      return;
S
Stanislau Hlebik 已提交
739
    }
740 741 742

    if (TooManyInternalKeysSkipped(false)) {
      return;
S
Stanislau Hlebik 已提交
743 744
    }
  }
745

S
Stanislau Hlebik 已提交
746 747
  // We haven't found any key - iterator is not valid
  valid_ = false;
J
jorlow@chromium.org 已提交
748 749
}

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

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

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

794 795 796
    // 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.
797
    if (num_skipped >= max_skip_) {
S
Stanislau Hlebik 已提交
798 799 800
      return FindValueForCurrentKeyUsingSeek();
    }

801 802 803 804 805
    if (!iter_.PrepareValue()) {
      valid_ = false;
      return false;
    }

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

857
    PERF_COUNTER_ADD(internal_key_skipped_count, 1);
858
    iter_.Prev();
S
Stanislau Hlebik 已提交
859
    ++num_skipped;
860 861
  }

862
  if (!iter_.status().ok()) {
863 864
    valid_ = false;
    return false;
S
Stanislau Hlebik 已提交
865 866
  }

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

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

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

    if (!ParseKey(&ikey)) {
      return false;
    }
Y
Yanqin Jin 已提交
962 963 964 965 966 967 968
    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_);
    }

969
    if (!user_comparator_.Equal(ikey.user_key, saved_key_.GetUserKey())) {
970 971 972 973 974 975 976
      // 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 已提交
977
    if (IsVisible(ikey.sequence, ts)) {
978 979
      break;
    }
980

981
    iter_.Next();
982
  }
S
Stanislau Hlebik 已提交
983

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

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

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

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

1081 1082 1083 1084 1085
  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 已提交
1086
    valid_ = false;
1087
    status_ = s;
1088
    return false;
1089
  }
S
Stanislau Hlebik 已提交
1090

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

  valid_ = true;
  return true;
S
Stanislau Hlebik 已提交
1108 1109
}

1110 1111 1112 1113
// 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 已提交
1114
  size_t num_skipped = 0;
1115
  while (iter_.Valid()) {
1116 1117 1118
    ParsedInternalKey ikey;
    if (!ParseKey(&ikey)) {
      return false;
1119 1120
    }

1121
    if (user_comparator_.Compare(ikey.user_key, saved_key_.GetUserKey()) < 0) {
1122 1123 1124 1125 1126
      return true;
    }

    if (TooManyInternalKeysSkipped()) {
      return false;
S
Stanislau Hlebik 已提交
1127
    }
1128

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

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

1158
    iter_.Prev();
S
Stanislau Hlebik 已提交
1159
  }
1160

1161
  if (!iter_.status().ok()) {
1162 1163 1164 1165 1166
    valid_ = false;
    return false;
  }

  return true;
S
Stanislau Hlebik 已提交
1167 1168
}

1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
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;
}

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

1201
void DBIter::SetSavedKeyToSeekTarget(const Slice& target) {
1202
  is_key_seqnum_zero_ = false;
1203
  SequenceNumber seq = sequence_;
1204
  saved_key_.Clear();
Y
Yanqin Jin 已提交
1205
  saved_key_.SetInternalKey(target, seq, kValueTypeForSeek, timestamp_ub_);
1206

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

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) {
1239 1240
    // TODO: What do we do if this returns an error?
    db_impl_->TraceIteratorSeek(cfd_->GetID(), target).PermitUncheckedError();
1241 1242 1243 1244 1245 1246
  }
#endif  // ROCKSDB_LITE

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

1248
  // Seek the inner iterator based on the target key.
1249 1250
  {
    PERF_TIMER_GUARD(seek_internal_seek_time);
1251 1252

    SetSavedKeyToSeekTarget(target);
1253
    iter_.Seek(saved_key_.GetInternalKey());
1254

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

1286 1287 1288 1289 1290
  // 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());
1291
  }
1292
  PERF_COUNTER_ADD(iter_read_bytes, key().size() + value().size());
J
jorlow@chromium.org 已提交
1293
}
J
jorlow@chromium.org 已提交
1294

A
Aaron Gao 已提交
1295
void DBIter::SeekForPrev(const Slice& target) {
1296
  PERF_CPU_TIMER_GUARD(iter_seek_cpu_nanos, env_);
A
Aaron Gao 已提交
1297
  StopWatch sw(env_, statistics_, DB_SEEK);
1298 1299 1300

#ifndef ROCKSDB_LITE
  if (db_impl_ != nullptr && cfd_ != nullptr) {
1301 1302 1303
    // TODO: What do we do if this returns an error?
    db_impl_->TraceIteratorSeekForPrev(cfd_->GetID(), target)
        .PermitUncheckedError();
1304 1305 1306
  }
#endif  // ROCKSDB_LITE

Y
Yanqin Jin 已提交
1307 1308 1309 1310 1311 1312 1313
  if (timestamp_size_ > 0) {
    valid_ = false;
    status_ = Status::NotSupported(
        "SeekToLast/SeekForPrev/Prev currently not supported with timestamp.");
    return;
  }

1314
  status_ = Status::OK();
A
Aaron Gao 已提交
1315
  ReleaseTempPinnedData();
1316
  ResetInternalKeysSkippedCounter();
Z
zhangjinpeng1987 已提交
1317

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

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

  // 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 已提交
1356 1357 1358
  }
}

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

  {
    PERF_TIMER_GUARD(seek_internal_seek_time);
1379
    iter_.SeekToFirst();
1380
    range_del_agg_.InvalidateRangeDelMapPositions();
1381 1382
  }

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

J
jorlow@chromium.org 已提交
1406
void DBIter::SeekToLast() {
Y
Yanqin Jin 已提交
1407 1408 1409 1410 1411 1412 1413
  if (timestamp_size_ > 0) {
    valid_ = false;
    status_ = Status::NotSupported(
        "SeekToLast/SeekForPrev/Prev currently not supported with timestamp.");
    return;
  }

1414 1415 1416
  if (iterate_upper_bound_ != nullptr) {
    // Seek to last key strictly less than ReadOptions.iterate_upper_bound.
    SeekForPrev(*iterate_upper_bound_);
1417
    if (Valid() && user_comparator_.Equal(*iterate_upper_bound_, key())) {
1418
      ReleaseTempPinnedData();
1419
      PrevInternal(nullptr);
1420 1421 1422 1423
    }
    return;
  }

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

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

1457 1458
Iterator* NewDBIterator(Env* env, const ReadOptions& read_options,
                        const ImmutableCFOptions& cf_options,
1459
                        const MutableCFOptions& mutable_cf_options,
1460 1461 1462
                        const Comparator* user_key_comparator,
                        InternalIterator* internal_iter,
                        const SequenceNumber& sequence,
Y
Yi Wu 已提交
1463
                        uint64_t max_sequential_skip_in_iterations,
1464 1465 1466 1467 1468 1469
                        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);
1470
  return db_iter;
1471 1472
}

1473
}  // namespace ROCKSDB_NAMESPACE