db_iter.cc 47.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
  if (!ParseInternalKey(iter_.key(), ikey)) {
J
jorlow@chromium.org 已提交
111
    status_ = Status::Corruption("corrupted internal key in DBIter");
112
    valid_ = false;
113
    ROCKS_LOG_ERROR(logger_, "corrupted internal key in DBIter: %s",
114
                    iter_.key().ToString(true).c_str());
J
jorlow@chromium.org 已提交
115 116 117 118 119 120
    return false;
  } else {
    return true;
  }
}

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

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

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

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

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

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

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

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

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

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

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

244
    if (TooManyInternalKeysSkipped()) {
245
      return false;
246 247
    }

Y
Yanqin Jin 已提交
248 249
    assert(ikey_.user_key.size() >= timestamp_size_);
    Slice ts;
250
    bool more_recent = false;
Y
Yanqin Jin 已提交
251 252 253
    if (timestamp_size_ > 0) {
      ts = ExtractTimestampFromUserKey(ikey_.user_key, timestamp_size_);
    }
254
    if (IsVisible(ikey_.sequence, ts, &more_recent)) {
255 256 257 258
      // 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.
259
      if (!is_prev_key_seqnum_zero && skipping_saved_key &&
260
          CompareKeyForSkip(ikey_.user_key, saved_key_.GetUserKey()) <= 0) {
261 262 263
        num_skipped++;  // skip this entry
        PERF_COUNTER_ADD(internal_key_skipped_count, 1);
      } else {
264
        assert(!skipping_saved_key ||
265
               CompareKeyForSkip(ikey_.user_key, saved_key_.GetUserKey()) > 0);
266
        num_skipped = 0;
267
        reseek_done = false;
268
        switch (ikey_.type) {
269 270 271 272
          case kTypeDeletion:
          case kTypeSingleDeletion:
            // Arrange to skip all upcoming entries for this key since
            // they are hidden by this deletion.
273 274 275
            // if iterartor specified start_seqnum we
            // 1) return internal key, including the type
            // 2) return ikey only if ikey.seqnum >= start_seqnum_
276
            // note that if deletion seqnum is < start_seqnum_ we
277 278 279
            // just skip it like in normal iterator.
            if (start_seqnum_ > 0 && ikey_.sequence >= start_seqnum_)  {
              saved_key_.SetInternalKey(ikey_);
280 281
              valid_ = true;
              return true;
282 283
            } else {
              saved_key_.SetUserKey(
284 285
                  ikey_.user_key, !pin_thru_lifetime_ ||
                                      !iter_.iter()->IsKeyPinned() /* copy */);
286
              skipping_saved_key = true;
287
              PERF_COUNTER_ADD(internal_delete_skipped_count, 1);
288
            }
289 290
            break;
          case kTypeValue:
Y
Yi Wu 已提交
291
          case kTypeBlobIndex:
292 293 294
            if (start_seqnum_ > 0) {
              // we are taking incremental snapshot here
              // incremental snapshots aren't supported on DB with range deletes
Y
Yanqin Jin 已提交
295
              assert(ikey_.type != kTypeBlobIndex);
296 297
              if (ikey_.sequence >= start_seqnum_) {
                saved_key_.SetInternalKey(ikey_);
Y
Yi Wu 已提交
298
                valid_ = true;
299
                return true;
300 301
              } else {
                // this key and all previous versions shouldn't be included,
302
                // skipping_saved_key
303 304 305 306
                saved_key_.SetUserKey(
                    ikey_.user_key,
                    !pin_thru_lifetime_ ||
                        !iter_.iter()->IsKeyPinned() /* copy */);
307
                skipping_saved_key = true;
Y
Yi Wu 已提交
308
              }
309
            } else {
310
              saved_key_.SetUserKey(
311 312
                  ikey_.user_key, !pin_thru_lifetime_ ||
                                      !iter_.iter()->IsKeyPinned() /* copy */);
313
              if (range_del_agg_.ShouldDelete(
314
                      ikey_, RangeDelPositioningMode::kForwardTraversal)) {
315 316
                // Arrange to skip all upcoming entries for this key since
                // they are hidden by this deletion.
317
                skipping_saved_key = true;
318
                num_skipped = 0;
319
                reseek_done = false;
320 321 322 323 324 325
                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 "
326
                      "ROCKSDB_NAMESPACE::blob_db::BlobDB instead.");
327
                  valid_ = false;
328
                  return false;
329
                }
330 331 332 333

                is_blob_ = true;
                valid_ = true;
                return true;
334 335
              } else {
                valid_ = true;
336
                return true;
337
              }
338 339 340
            }
            break;
          case kTypeMerge:
341
            saved_key_.SetUserKey(
342
                ikey_.user_key,
343
                !pin_thru_lifetime_ || !iter_.iter()->IsKeyPinned() /* copy */);
344
            if (range_del_agg_.ShouldDelete(
345
                    ikey_, RangeDelPositioningMode::kForwardTraversal)) {
346 347
              // Arrange to skip all upcoming entries for this key since
              // they are hidden by this deletion.
348
              skipping_saved_key = true;
349
              num_skipped = 0;
350
              reseek_done = false;
351 352 353 354 355 356
              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;
357
              return MergeValuesNewToOld();  // Go to a different state machine
358 359 360 361 362
            }
            break;
          default:
            assert(false);
            break;
363
        }
J
jorlow@chromium.org 已提交
364
      }
365
    } else {
366 367 368
      if (more_recent) {
        PERF_COUNTER_ADD(internal_recent_skipped_count, 1);
      }
369

370 371 372
      // 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 已提交
373 374
      int cmp = user_comparator_.CompareWithoutTimestamp(
          ikey_.user_key, saved_key_.GetUserKey());
Y
Yanqin Jin 已提交
375
      if (cmp == 0 || (skipping_saved_key && cmp < 0)) {
376 377
        num_skipped++;
      } else {
378
        saved_key_.SetUserKey(
379
            ikey_.user_key,
380
            !iter_.iter()->IsKeyPinned() || !pin_thru_lifetime_ /* copy */);
381
        skipping_saved_key = false;
382
        num_skipped = 0;
383
        reseek_done = false;
384
      }
J
jorlow@chromium.org 已提交
385
    }
386 387 388

    // If we have sequentially iterated via numerous equal keys, then it's
    // better to seek so that we can avoid too many key comparisons.
389 390 391 392 393
    //
    // 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 已提交
394
    // then it does not make sense to reseek as we would actually land further
395 396
    // away from the desired key. There is opportunity for optimization here.
    if (num_skipped > max_skip_ && !reseek_done) {
397
      is_key_seqnum_zero_ = false;
398
      num_skipped = 0;
399
      reseek_done = true;
400
      std::string last_key;
401
      if (skipping_saved_key) {
402 403 404
        // 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 已提交
405 406 407 408 409 410 411 412 413 414 415
        if (timestamp_size_ == 0) {
          AppendInternalKey(
              &last_key,
              ParsedInternalKey(saved_key_.GetUserKey(), 0, kTypeDeletion));
        } else {
          std::string min_ts(timestamp_size_, static_cast<char>(0));
          AppendInternalKeyWithDifferentTimestamp(
              &last_key,
              ParsedInternalKey(saved_key_.GetUserKey(), 0, kTypeDeletion),
              min_ts);
        }
416 417
        // Don't set skipping_saved_key = false because we may still see more
        // user-keys equal to saved_key_.
418 419 420 421 422 423
      } 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 已提交
424 425 426 427 428 429 430 431 432 433 434
        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_);
        }
435
      }
436
      iter_.Seek(last_key);
437 438
      RecordTick(statistics_, NUMBER_OF_RESEEKS_IN_ITERATION);
    } else {
439
      iter_.Next();
440
    }
441
  } while (iter_.Valid());
442

J
jorlow@chromium.org 已提交
443
  valid_ = false;
444
  return iter_.status().ok();
J
jorlow@chromium.org 已提交
445 446
}

447 448
// Merge values of the same user key starting from the current iter_ position
// Scan from the newer entries to older entries.
449
// PRE: iter_.key() points to the first merge type entry
450 451 452
//      saved_key_ stores the user key
// POST: saved_value_ has the merged value for the user key
//       iter_ points to the next entry (or invalid)
453
bool DBIter::MergeValuesNewToOld() {
454
  if (!merge_operator_) {
455
    ROCKS_LOG_ERROR(logger_, "Options::merge_operator is null.");
456
    status_ = Status::InvalidArgument("merge_operator_ must be set.");
457
    valid_ = false;
458
    return false;
D
Deon Nicholas 已提交
459
  }
460

461 462
  // Temporarily pin the blocks that hold merge operands
  TempPinData();
463
  merge_context_.Clear();
464
  // Start the merge process by pushing the first operand
465 466
  merge_context_.PushOperand(
      iter_.value(), iter_.iter()->IsValuePinned() /* operand_pinned */);
467
  TEST_SYNC_POINT("DBIter::MergeValuesNewToOld:PushedFirstOperand");
468 469

  ParsedInternalKey ikey;
470
  Status s;
471
  for (iter_.Next(); iter_.Valid(); iter_.Next()) {
472
    TEST_SYNC_POINT("DBIter::MergeValuesNewToOld:SteppedToNextOperand");
473
    if (!ParseKey(&ikey)) {
474
      return false;
475 476
    }

477
    if (!user_comparator_.Equal(ikey.user_key, saved_key_.GetUserKey())) {
478 479
      // hit the next user key, stop right here
      break;
A
Andrew Kryczka 已提交
480
    } else if (kTypeDeletion == ikey.type || kTypeSingleDeletion == ikey.type ||
481
               range_del_agg_.ShouldDelete(
482
                   ikey, RangeDelPositioningMode::kForwardTraversal)) {
483 484
      // hit a delete with the same user key, stop right here
      // iter_ is positioned after delete
485
      iter_.Next();
486
      break;
A
Andres Noetzli 已提交
487
    } else if (kTypeValue == ikey.type) {
488 489
      // hit a put, merge the put value with operands and store the
      // final result in saved_value_. We are done!
490
      const Slice val = iter_.value();
491 492
      s = MergeHelper::TimedFullMerge(
          merge_operator_, ikey.user_key, &val, merge_context_.GetOperands(),
493
          &saved_value_, logger_, statistics_, env_, &pinned_value_, true);
494
      if (!s.ok()) {
Y
Yi Wu 已提交
495
        valid_ = false;
496
        status_ = s;
497
        return false;
498
      }
499
      // iter_ is positioned after put
500 501
      iter_.Next();
      if (!iter_.status().ok()) {
502 503 504 505
        valid_ = false;
        return false;
      }
      return true;
A
Andres Noetzli 已提交
506
    } else if (kTypeMerge == ikey.type) {
507 508
      // hit a merge, add the value as an operand and run associative merge.
      // when complete, add result to operands and continue.
509 510
      merge_context_.PushOperand(
          iter_.value(), iter_.iter()->IsValuePinned() /* operand_pinned */);
511
      PERF_COUNTER_ADD(internal_merge_count, 1);
Y
Yi Wu 已提交
512 513 514 515 516
    } 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 "
517
            "ROCKSDB_NAMESPACE::blob_db::BlobDB instead.");
Y
Yi Wu 已提交
518 519 520 521 522
      } else {
        status_ =
            Status::NotSupported("Blob DB does not support merge operator.");
      }
      valid_ = false;
523
      return false;
A
Andres Noetzli 已提交
524 525
    } else {
      assert(false);
526 527 528
    }
  }

529
  if (!iter_.status().ok()) {
530 531 532 533
    valid_ = false;
    return false;
  }

534 535 536 537
  // 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.
538 539 540
  s = MergeHelper::TimedFullMerge(merge_operator_, saved_key_.GetUserKey(),
                                  nullptr, merge_context_.GetOperands(),
                                  &saved_value_, logger_, statistics_, env_,
541
                                  &pinned_value_, true);
542
  if (!s.ok()) {
Y
Yi Wu 已提交
543
    valid_ = false;
544
    status_ = s;
545
    return false;
546
  }
547 548 549

  assert(status_.ok());
  return true;
550 551
}

J
jorlow@chromium.org 已提交
552
void DBIter::Prev() {
Y
Yanqin Jin 已提交
553 554 555 556 557 558 559
  if (timestamp_size_ > 0) {
    valid_ = false;
    status_ = Status::NotSupported(
        "SeekToLast/SeekForPrev/Prev currently not supported with timestamp.");
    return;
  }

J
jorlow@chromium.org 已提交
560
  assert(valid_);
561
  assert(status_.ok());
562 563

  PERF_CPU_TIMER_GUARD(iter_prev_cpu_nanos, env_);
564
  ReleaseTempPinnedData();
565
  ResetInternalKeysSkippedCounter();
566
  bool ok = true;
S
Stanislau Hlebik 已提交
567
  if (direction_ == kForward) {
568 569 570 571 572
    if (!ReverseToBackward()) {
      ok = false;
    }
  }
  if (ok) {
573 574 575 576 577 578
    Slice prefix;
    if (prefix_same_as_start_) {
      assert(prefix_extractor_ != nullptr);
      prefix = prefix_.GetUserKey();
    }
    PrevInternal(prefix_same_as_start_ ? &prefix : nullptr);
S
Stanislau Hlebik 已提交
579
  }
580

M
Manuel Ung 已提交
581
  if (statistics_ != nullptr) {
582
    local_stats_.prev_count_++;
M
Manuel Ung 已提交
583
    if (valid_) {
584 585
      local_stats_.prev_found_count_++;
      local_stats_.bytes_read_ += (key().size() + value().size());
M
Manuel Ung 已提交
586 587
    }
  }
S
Stanislau Hlebik 已提交
588
}
J
jorlow@chromium.org 已提交
589

590
bool DBIter::ReverseToForward() {
591
  assert(iter_.status().ok());
592 593 594 595

  // 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 已提交
596
  if (!expect_total_order_inner_iter() || !iter_.Valid()) {
597 598
    IterKey last_key;
    last_key.SetInternalKey(ParsedInternalKey(
599
        saved_key_.GetUserKey(), kMaxSequenceNumber, kValueTypeForSeek));
600
    iter_.Seek(last_key.GetInternalKey());
601
  }
602

603
  direction_ = kForward;
604
  // Skip keys less than the current key() (a.k.a. saved_key_).
605
  while (iter_.Valid()) {
606 607 608 609
    ParsedInternalKey ikey;
    if (!ParseKey(&ikey)) {
      return false;
    }
610
    if (user_comparator_.Compare(ikey.user_key, saved_key_.GetUserKey()) >= 0) {
611 612
      return true;
    }
613
    iter_.Next();
614 615
  }

616
  if (!iter_.status().ok()) {
617 618
    valid_ = false;
    return false;
619
  }
620 621

  return true;
622 623
}

624 625
// Move iter_ to the key before saved_key_.
bool DBIter::ReverseToBackward() {
626
  assert(iter_.status().ok());
627 628 629 630 631

  // 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 已提交
632
      (!expect_total_order_inner_iter() || !iter_.Valid())) {
633
    IterKey last_key;
634 635 636 637 638
    // 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 已提交
639
    if (!expect_total_order_inner_iter()) {
640
      iter_.SeekForPrev(last_key.GetInternalKey());
641 642 643 644 645
    } 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.
646 647 648
      iter_.Seek(last_key.GetInternalKey());
      if (!iter_.Valid() && iter_.status().ok()) {
        iter_.SeekToLast();
649
      }
650 651 652 653
    }
  }

  direction_ = kReverse;
654
  return FindUserKeyBeforeSavedKey();
655 656
}

657
void DBIter::PrevInternal(const Slice* prefix) {
658
  while (iter_.Valid()) {
659
    saved_key_.SetUserKey(
660 661
        ExtractUserKey(iter_.key()),
        !iter_.iter()->IsKeyPinned() || !pin_thru_lifetime_ /* copy */);
662

663 664
    assert(prefix == nullptr || prefix_extractor_ != nullptr);
    if (prefix != nullptr &&
665
        prefix_extractor_->Transform(saved_key_.GetUserKey())
666 667
                .compare(*prefix) != 0) {
      assert(prefix_same_as_start_);
668 669 670 671 672
      // Current key does not have the same prefix as start
      valid_ = false;
      return;
    }

673 674 675 676
    assert(iterate_lower_bound_ == nullptr || iter_.MayBeOutOfLowerBound() ||
           user_comparator_.Compare(saved_key_.GetUserKey(),
                                    *iterate_lower_bound_) >= 0);
    if (iterate_lower_bound_ != nullptr && iter_.MayBeOutOfLowerBound() &&
677 678
        user_comparator_.Compare(saved_key_.GetUserKey(),
                                 *iterate_lower_bound_) < 0) {
679 680 681 682 683
      // We've iterated earlier than the user-specified lower bound.
      valid_ = false;
      return;
    }

684
    if (!FindValueForCurrentKey()) {  // assigns valid_
S
Stanislau Hlebik 已提交
685
      return;
J
jorlow@chromium.org 已提交
686
    }
687

688 689 690
    // Whether or not we found a value for current key, we need iter_ to end up
    // on a smaller key.
    if (!FindUserKeyBeforeSavedKey()) {
691 692 693
      return;
    }

694 695 696
    if (valid_) {
      // Found the value.
      return;
S
Stanislau Hlebik 已提交
697
    }
698 699 700

    if (TooManyInternalKeysSkipped(false)) {
      return;
S
Stanislau Hlebik 已提交
701 702
    }
  }
703

S
Stanislau Hlebik 已提交
704 705
  // We haven't found any key - iterator is not valid
  valid_ = false;
J
jorlow@chromium.org 已提交
706 707
}

708 709 710 711 712 713 714 715 716 717 718
// 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 已提交
719
bool DBIter::FindValueForCurrentKey() {
720
  assert(iter_.Valid());
721
  merge_context_.Clear();
722
  current_entry_is_merged_ = false;
A
Andres Noetzli 已提交
723 724
  // last entry before merge (could be kTypeDeletion, kTypeSingleDeletion or
  // kTypeValue)
S
Stanislau Hlebik 已提交
725 726
  ValueType last_not_merge_type = kTypeDeletion;
  ValueType last_key_entry_type = kTypeDeletion;
J
jorlow@chromium.org 已提交
727

728 729 730
  // Temporarily pin blocks that hold (merge operands / the value)
  ReleaseTempPinnedData();
  TempPinData();
S
Stanislau Hlebik 已提交
731
  size_t num_skipped = 0;
732
  while (iter_.Valid()) {
733 734 735 736 737
    ParsedInternalKey ikey;
    if (!ParseKey(&ikey)) {
      return false;
    }

Y
Yanqin Jin 已提交
738 739 740 741 742 743 744
    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) ||
745
        !user_comparator_.Equal(ikey.user_key, saved_key_.GetUserKey())) {
746 747
      break;
    }
748 749 750 751
    if (TooManyInternalKeysSkipped()) {
      return false;
    }

752 753 754
    // 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.
755
    if (num_skipped >= max_skip_) {
S
Stanislau Hlebik 已提交
756 757 758 759 760 761
      return FindValueForCurrentKeyUsingSeek();
    }

    last_key_entry_type = ikey.type;
    switch (last_key_entry_type) {
      case kTypeValue:
Y
Yi Wu 已提交
762
      case kTypeBlobIndex:
763
        if (range_del_agg_.ShouldDelete(
764
                ikey, RangeDelPositioningMode::kBackwardTraversal)) {
A
Andrew Kryczka 已提交
765 766 767
          last_key_entry_type = kTypeRangeDeletion;
          PERF_COUNTER_ADD(internal_delete_skipped_count, 1);
        } else {
768 769
          assert(iter_.iter()->IsValuePinned());
          pinned_value_ = iter_.value();
A
Andrew Kryczka 已提交
770
        }
771
        merge_context_.Clear();
A
Andrew Kryczka 已提交
772
        last_not_merge_type = last_key_entry_type;
S
Stanislau Hlebik 已提交
773 774
        break;
      case kTypeDeletion:
A
Andres Noetzli 已提交
775
      case kTypeSingleDeletion:
776
        merge_context_.Clear();
A
Andres Noetzli 已提交
777
        last_not_merge_type = last_key_entry_type;
778
        PERF_COUNTER_ADD(internal_delete_skipped_count, 1);
S
Stanislau Hlebik 已提交
779 780
        break;
      case kTypeMerge:
781
        if (range_del_agg_.ShouldDelete(
782
                ikey, RangeDelPositioningMode::kBackwardTraversal)) {
A
Andrew Kryczka 已提交
783 784 785 786 787 788 789
          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(
790 791
              iter_.value(),
              iter_.iter()->IsValuePinned() /* operand_pinned */);
792
          PERF_COUNTER_ADD(internal_merge_count, 1);
A
Andrew Kryczka 已提交
793
        }
S
Stanislau Hlebik 已提交
794 795 796 797 798
        break;
      default:
        assert(false);
    }

799
    PERF_COUNTER_ADD(internal_key_skipped_count, 1);
800
    iter_.Prev();
S
Stanislau Hlebik 已提交
801
    ++num_skipped;
802 803
  }

804
  if (!iter_.status().ok()) {
805 806
    valid_ = false;
    return false;
S
Stanislau Hlebik 已提交
807 808
  }

809
  Status s;
Y
Yi Wu 已提交
810
  is_blob_ = false;
S
Stanislau Hlebik 已提交
811 812
  switch (last_key_entry_type) {
    case kTypeDeletion:
A
Andres Noetzli 已提交
813
    case kTypeSingleDeletion:
A
Andrew Kryczka 已提交
814
    case kTypeRangeDeletion:
S
Stanislau Hlebik 已提交
815
      valid_ = false;
816
      return true;
S
Stanislau Hlebik 已提交
817
    case kTypeMerge:
818
      current_entry_is_merged_ = true;
A
Aaron Gao 已提交
819
      if (last_not_merge_type == kTypeDeletion ||
A
Andrew Kryczka 已提交
820 821
          last_not_merge_type == kTypeSingleDeletion ||
          last_not_merge_type == kTypeRangeDeletion) {
822 823 824
        s = MergeHelper::TimedFullMerge(
            merge_operator_, saved_key_.GetUserKey(), nullptr,
            merge_context_.GetOperands(), &saved_value_, logger_, statistics_,
825
            env_, &pinned_value_, true);
Y
Yi Wu 已提交
826 827 828 829 830
      } 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 "
831
              "ROCKSDB_NAMESPACE::blob_db::BlobDB instead.");
Y
Yi Wu 已提交
832 833 834 835 836
        } else {
          status_ =
              Status::NotSupported("Blob DB does not support merge operator.");
        }
        valid_ = false;
837
        return false;
838
      } else {
S
Stanislau Hlebik 已提交
839
        assert(last_not_merge_type == kTypeValue);
840
        s = MergeHelper::TimedFullMerge(
841
            merge_operator_, saved_key_.GetUserKey(), &pinned_value_,
842
            merge_context_.GetOperands(), &saved_value_, logger_, statistics_,
843
            env_, &pinned_value_, true);
844
      }
S
Stanislau Hlebik 已提交
845 846
      break;
    case kTypeValue:
847
      // do nothing - we've already has value in pinned_value_
S
Stanislau Hlebik 已提交
848
      break;
Y
Yi Wu 已提交
849 850 851 852 853
    case kTypeBlobIndex:
      if (!allow_blob_) {
        ROCKS_LOG_ERROR(logger_, "Encounter unexpected blob index.");
        status_ = Status::NotSupported(
            "Encounter unexpected blob index. Please open DB with "
854
            "ROCKSDB_NAMESPACE::blob_db::BlobDB instead.");
Y
Yi Wu 已提交
855
        valid_ = false;
856
        return false;
Y
Yi Wu 已提交
857 858 859
      }
      is_blob_ = true;
      break;
S
Stanislau Hlebik 已提交
860 861 862
    default:
      assert(false);
      break;
J
jorlow@chromium.org 已提交
863
  }
864
  if (!s.ok()) {
Y
Yi Wu 已提交
865
    valid_ = false;
866
    status_ = s;
867
    return false;
868
  }
869
  valid_ = true;
S
Stanislau Hlebik 已提交
870 871
  return true;
}
J
jorlow@chromium.org 已提交
872

S
Stanislau Hlebik 已提交
873 874
// This function is used in FindValueForCurrentKey.
// We use Seek() function instead of Prev() to find necessary value
875 876
// TODO: This is very similar to FindNextUserEntry() and MergeValuesNewToOld().
//       Would be nice to reuse some code.
S
Stanislau Hlebik 已提交
877
bool DBIter::FindValueForCurrentKeyUsingSeek() {
878 879 880
  // FindValueForCurrentKey will enable pinning before calling
  // FindValueForCurrentKeyUsingSeek()
  assert(pinned_iters_mgr_.PinningEnabled());
S
Stanislau Hlebik 已提交
881
  std::string last_key;
882 883
  AppendInternalKey(&last_key, ParsedInternalKey(saved_key_.GetUserKey(),
                                                 sequence_, kValueTypeForSeek));
884
  iter_.Seek(last_key);
S
Stanislau Hlebik 已提交
885 886
  RecordTick(statistics_, NUMBER_OF_RESEEKS_IN_ITERATION);

887 888
  // In case read_callback presents, the value we seek to may not be visible.
  // Find the next value that's visible.
S
Stanislau Hlebik 已提交
889
  ParsedInternalKey ikey;
890
  is_blob_ = false;
891
  while (true) {
892
    if (!iter_.Valid()) {
893
      valid_ = false;
894
      return iter_.status().ok();
895 896 897 898 899
    }

    if (!ParseKey(&ikey)) {
      return false;
    }
Y
Yanqin Jin 已提交
900 901 902 903 904 905 906
    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_);
    }

907
    if (!user_comparator_.Equal(ikey.user_key, saved_key_.GetUserKey())) {
908 909 910 911 912 913 914
      // 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 已提交
915
    if (IsVisible(ikey.sequence, ts)) {
916 917
      break;
    }
918

919
    iter_.Next();
920
  }
S
Stanislau Hlebik 已提交
921

A
Andrew Kryczka 已提交
922
  if (ikey.type == kTypeDeletion || ikey.type == kTypeSingleDeletion ||
923
      range_del_agg_.ShouldDelete(
924
          ikey, RangeDelPositioningMode::kBackwardTraversal)) {
J
jorlow@chromium.org 已提交
925
    valid_ = false;
926
    return true;
S
Stanislau Hlebik 已提交
927
  }
Y
Yi Wu 已提交
928 929 930 931
  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 "
932
        "ROCKSDB_NAMESPACE::blob_db::BlobDB instead.");
Y
Yi Wu 已提交
933
    valid_ = false;
934
    return false;
Y
Yi Wu 已提交
935 936
  }
  if (ikey.type == kTypeValue || ikey.type == kTypeBlobIndex) {
937 938
    assert(iter_.iter()->IsValuePinned());
    pinned_value_ = iter_.value();
939
    is_blob_ = (ikey.type == kTypeBlobIndex);
A
Andrew Kryczka 已提交
940 941 942
    valid_ = true;
    return true;
  }
S
Stanislau Hlebik 已提交
943 944 945

  // kTypeMerge. We need to collect all kTypeMerge values and save them
  // in operands
946
  assert(ikey.type == kTypeMerge);
947
  current_entry_is_merged_ = true;
948
  merge_context_.Clear();
949 950
  merge_context_.PushOperand(
      iter_.value(), iter_.iter()->IsValuePinned() /* operand_pinned */);
951
  while (true) {
952
    iter_.Next();
S
Stanislau Hlebik 已提交
953

954 955
    if (!iter_.Valid()) {
      if (!iter_.status().ok()) {
956 957 958 959
        valid_ = false;
        return false;
      }
      break;
S
Stanislau Hlebik 已提交
960
    }
961 962 963
    if (!ParseKey(&ikey)) {
      return false;
    }
964
    if (!user_comparator_.Equal(ikey.user_key, saved_key_.GetUserKey())) {
965 966 967 968 969
      break;
    }

    if (ikey.type == kTypeDeletion || ikey.type == kTypeSingleDeletion ||
        range_del_agg_.ShouldDelete(
970
            ikey, RangeDelPositioningMode::kForwardTraversal)) {
971 972
      break;
    } else if (ikey.type == kTypeValue) {
973
      const Slice val = iter_.value();
974 975 976 977 978 979 980 981 982
      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 已提交
983
      valid_ = true;
984 985
      return true;
    } else if (ikey.type == kTypeMerge) {
986 987
      merge_context_.PushOperand(
          iter_.value(), iter_.iter()->IsValuePinned() /* operand_pinned */);
988 989 990 991 992 993
      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 "
994
            "ROCKSDB_NAMESPACE::blob_db::BlobDB instead.");
995 996 997 998
      } else {
        status_ =
            Status::NotSupported("Blob DB does not support merge operator.");
      }
Y
Yi Wu 已提交
999
      valid_ = false;
1000 1001 1002
      return false;
    } else {
      assert(false);
1003
    }
S
Stanislau Hlebik 已提交
1004 1005
  }

1006 1007 1008 1009 1010
  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 已提交
1011
    valid_ = false;
1012
    status_ = s;
1013
    return false;
1014
  }
S
Stanislau Hlebik 已提交
1015

1016 1017 1018
  // 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 已提交
1019 1020
  if (!expect_total_order_inner_iter() || !iter_.Valid()) {
    if (!expect_total_order_inner_iter()) {
1021
      iter_.SeekForPrev(last_key);
1022
    } else {
1023 1024 1025
      iter_.Seek(last_key);
      if (!iter_.Valid() && iter_.status().ok()) {
        iter_.SeekToLast();
1026 1027 1028
      }
    }
    RecordTick(statistics_, NUMBER_OF_RESEEKS_IN_ITERATION);
S
Stanislau Hlebik 已提交
1029
  }
1030 1031 1032

  valid_ = true;
  return true;
S
Stanislau Hlebik 已提交
1033 1034
}

1035 1036 1037 1038
// 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 已提交
1039
  size_t num_skipped = 0;
1040
  while (iter_.Valid()) {
1041 1042 1043
    ParsedInternalKey ikey;
    if (!ParseKey(&ikey)) {
      return false;
1044 1045
    }

1046
    if (user_comparator_.Compare(ikey.user_key, saved_key_.GetUserKey()) < 0) {
1047 1048 1049 1050 1051
      return true;
    }

    if (TooManyInternalKeysSkipped()) {
      return false;
S
Stanislau Hlebik 已提交
1052
    }
1053

S
Siying Dong 已提交
1054
    assert(ikey.sequence != kMaxSequenceNumber);
Y
Yanqin Jin 已提交
1055 1056 1057 1058 1059 1060 1061
    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)) {
1062 1063 1064 1065
      PERF_COUNTER_ADD(internal_recent_skipped_count, 1);
    } else {
      PERF_COUNTER_ADD(internal_key_skipped_count, 1);
    }
1066

1067
    if (num_skipped >= max_skip_) {
1068 1069 1070 1071 1072 1073
      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.
1074
      iter_.Seek(last_key.GetInternalKey());
1075
      RecordTick(statistics_, NUMBER_OF_RESEEKS_IN_ITERATION);
1076
      if (!iter_.Valid()) {
1077 1078 1079 1080 1081 1082
        break;
      }
    } else {
      ++num_skipped;
    }

1083
    iter_.Prev();
S
Stanislau Hlebik 已提交
1084
  }
1085

1086
  if (!iter_.status().ok()) {
1087 1088 1089 1090 1091
    valid_ = false;
    return false;
  }

  return true;
S
Stanislau Hlebik 已提交
1092 1093
}

1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
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;
}

1106 1107
bool DBIter::IsVisible(SequenceNumber sequence, const Slice& ts,
                       bool* more_recent) {
Y
Yanqin Jin 已提交
1108
  // Remember that comparator orders preceding timestamp as larger.
1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
  // 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;
1122
  }
1123
  return visible_by_seq && visible_by_ts;
1124
}
1125

1126
void DBIter::SetSavedKeyToSeekTarget(const Slice& target) {
1127
  is_key_seqnum_zero_ = false;
1128
  SequenceNumber seq = sequence_;
1129
  saved_key_.Clear();
Y
Yanqin Jin 已提交
1130
  saved_key_.SetInternalKey(target, seq, kValueTypeForSeek, timestamp_ub_);
1131

Z
zhangjinpeng1987 已提交
1132
  if (iterate_lower_bound_ != nullptr &&
Y
Yanqin Jin 已提交
1133 1134 1135
      user_comparator_.CompareWithoutTimestamp(
          saved_key_.GetUserKey(), /*a_has_ts=*/true, *iterate_lower_bound_,
          /*b_has_ts=*/false) < 0) {
1136
    // Seek key is smaller than the lower bound.
Z
zhangjinpeng1987 已提交
1137
    saved_key_.Clear();
Y
Yanqin Jin 已提交
1138 1139
    saved_key_.SetInternalKey(*iterate_lower_bound_, seq, kValueTypeForSeek,
                              timestamp_ub_);
Z
zhangjinpeng1987 已提交
1140
  }
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170
}

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

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

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

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

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

1172
  // Seek the inner iterator based on the target key.
1173 1174
  {
    PERF_TIMER_GUARD(seek_internal_seek_time);
1175 1176

    SetSavedKeyToSeekTarget(target);
1177
    iter_.Seek(saved_key_.GetInternalKey());
1178

1179
    range_del_agg_.InvalidateRangeDelMapPositions();
1180
    RecordTick(statistics_, NUMBER_DB_SEEK);
1181
  }
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194
  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 已提交
1195
    Slice target_prefix = prefix_extractor_->Transform(target);
1196 1197 1198
    FindNextUserEntry(false /* not skipping saved_key */,
                      &target_prefix /* prefix */);
    if (valid_) {
Y
Yanqin Jin 已提交
1199
      // Remember the prefix of the seek key for the future Next() call to
1200 1201
      // check.
      prefix_.SetUserKey(target_prefix);
M
Manuel Ung 已提交
1202
    }
J
jorlow@chromium.org 已提交
1203
  } else {
1204 1205 1206 1207
    FindNextUserEntry(false /* not skipping saved_key */, nullptr);
  }
  if (!valid_) {
    return;
J
jorlow@chromium.org 已提交
1208
  }
1209

1210 1211 1212 1213 1214
  // 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());
1215
  }
1216
  PERF_COUNTER_ADD(iter_read_bytes, key().size() + value().size());
J
jorlow@chromium.org 已提交
1217
}
J
jorlow@chromium.org 已提交
1218

A
Aaron Gao 已提交
1219
void DBIter::SeekForPrev(const Slice& target) {
1220
  PERF_CPU_TIMER_GUARD(iter_seek_cpu_nanos, env_);
A
Aaron Gao 已提交
1221
  StopWatch sw(env_, statistics_, DB_SEEK);
1222 1223 1224 1225 1226 1227 1228

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

Y
Yanqin Jin 已提交
1229 1230 1231 1232 1233 1234 1235
  if (timestamp_size_ > 0) {
    valid_ = false;
    status_ = Status::NotSupported(
        "SeekToLast/SeekForPrev/Prev currently not supported with timestamp.");
    return;
  }

1236
  status_ = Status::OK();
A
Aaron Gao 已提交
1237
  ReleaseTempPinnedData();
1238
  ResetInternalKeysSkippedCounter();
Z
zhangjinpeng1987 已提交
1239

1240
  // Seek the inner iterator based on the target key.
A
Aaron Gao 已提交
1241 1242
  {
    PERF_TIMER_GUARD(seek_internal_seek_time);
1243
    SetSavedKeyToSeekForPrevTarget(target);
1244
    iter_.SeekForPrev(saved_key_.GetInternalKey());
1245
    range_del_agg_.InvalidateRangeDelMapPositions();
1246
    RecordTick(statistics_, NUMBER_DB_SEEK);
A
Aaron Gao 已提交
1247
  }
1248 1249 1250
  if (!iter_.Valid()) {
    valid_ = false;
    return;
1251
  }
1252
  direction_ = kReverse;
1253

1254 1255 1256 1257 1258 1259 1260 1261
  // 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 已提交
1262
    Slice target_prefix = prefix_extractor_->Transform(target);
1263 1264 1265 1266 1267
    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 已提交
1268 1269
    }
  } else {
1270
    PrevInternal(nullptr);
A
Aaron Gao 已提交
1271
  }
1272 1273 1274 1275 1276 1277

  // 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 已提交
1278 1279 1280
  }
}

J
jorlow@chromium.org 已提交
1281
void DBIter::SeekToFirst() {
1282 1283 1284 1285
  if (iterate_lower_bound_ != nullptr) {
    Seek(*iterate_lower_bound_);
    return;
  }
1286
  PERF_CPU_TIMER_GUARD(iter_seek_cpu_nanos, env_);
1287 1288
  // Don't use iter_::Seek() if we set a prefix extractor
  // because prefix seek will be used.
S
sdong 已提交
1289
  if (!expect_total_order_inner_iter()) {
1290 1291 1292
    max_skip_ = std::numeric_limits<uint64_t>::max();
  }
  status_ = Status::OK();
J
jorlow@chromium.org 已提交
1293
  direction_ = kForward;
1294
  ReleaseTempPinnedData();
1295
  ResetInternalKeysSkippedCounter();
J
jorlow@chromium.org 已提交
1296
  ClearSavedValue();
1297
  is_key_seqnum_zero_ = false;
1298 1299 1300

  {
    PERF_TIMER_GUARD(seek_internal_seek_time);
1301
    iter_.SeekToFirst();
1302
    range_del_agg_.InvalidateRangeDelMapPositions();
1303 1304
  }

M
Manuel Ung 已提交
1305
  RecordTick(statistics_, NUMBER_DB_SEEK);
1306
  if (iter_.Valid()) {
1307
    saved_key_.SetUserKey(
1308 1309
        ExtractUserKey(iter_.key()),
        !iter_.iter()->IsKeyPinned() || !pin_thru_lifetime_ /* copy */);
1310 1311
    FindNextUserEntry(false /* not skipping saved_key */,
                      nullptr /* no prefix check */);
M
Manuel Ung 已提交
1312 1313 1314 1315
    if (statistics_ != nullptr) {
      if (valid_) {
        RecordTick(statistics_, NUMBER_DB_SEEK_FOUND);
        RecordTick(statistics_, ITER_BYTES_READ, key().size() + value().size());
1316
        PERF_COUNTER_ADD(iter_read_bytes, key().size() + value().size());
M
Manuel Ung 已提交
1317 1318
      }
    }
J
jorlow@chromium.org 已提交
1319 1320
  } else {
    valid_ = false;
J
jorlow@chromium.org 已提交
1321
  }
1322 1323 1324
  if (valid_ && prefix_same_as_start_) {
    assert(prefix_extractor_ != nullptr);
    prefix_.SetUserKey(prefix_extractor_->Transform(saved_key_.GetUserKey()));
1325
  }
J
jorlow@chromium.org 已提交
1326 1327
}

J
jorlow@chromium.org 已提交
1328
void DBIter::SeekToLast() {
Y
Yanqin Jin 已提交
1329 1330 1331 1332 1333 1334 1335
  if (timestamp_size_ > 0) {
    valid_ = false;
    status_ = Status::NotSupported(
        "SeekToLast/SeekForPrev/Prev currently not supported with timestamp.");
    return;
  }

1336 1337 1338
  if (iterate_upper_bound_ != nullptr) {
    // Seek to last key strictly less than ReadOptions.iterate_upper_bound.
    SeekForPrev(*iterate_upper_bound_);
1339
    if (Valid() && user_comparator_.Equal(*iterate_upper_bound_, key())) {
1340
      ReleaseTempPinnedData();
1341
      PrevInternal(nullptr);
1342 1343 1344 1345
    }
    return;
  }

1346
  PERF_CPU_TIMER_GUARD(iter_seek_cpu_nanos, env_);
S
Stanislau Hlebik 已提交
1347
  // Don't use iter_::Seek() if we set a prefix extractor
1348
  // because prefix seek will be used.
S
sdong 已提交
1349
  if (!expect_total_order_inner_iter()) {
S
Stanislau Hlebik 已提交
1350 1351
    max_skip_ = std::numeric_limits<uint64_t>::max();
  }
1352
  status_ = Status::OK();
J
jorlow@chromium.org 已提交
1353
  direction_ = kReverse;
1354
  ReleaseTempPinnedData();
1355
  ResetInternalKeysSkippedCounter();
J
jorlow@chromium.org 已提交
1356
  ClearSavedValue();
1357
  is_key_seqnum_zero_ = false;
1358 1359 1360

  {
    PERF_TIMER_GUARD(seek_internal_seek_time);
1361
    iter_.SeekToLast();
1362
    range_del_agg_.InvalidateRangeDelMapPositions();
1363
  }
1364
  PrevInternal(nullptr);
M
Manuel Ung 已提交
1365 1366 1367 1368 1369
  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());
1370
      PERF_COUNTER_ADD(iter_read_bytes, key().size() + value().size());
M
Manuel Ung 已提交
1371 1372
    }
  }
1373 1374 1375
  if (valid_ && prefix_same_as_start_) {
    assert(prefix_extractor_ != nullptr);
    prefix_.SetUserKey(prefix_extractor_->Transform(saved_key_.GetUserKey()));
1376
  }
J
jorlow@chromium.org 已提交
1377 1378
}

1379 1380
Iterator* NewDBIterator(Env* env, const ReadOptions& read_options,
                        const ImmutableCFOptions& cf_options,
1381
                        const MutableCFOptions& mutable_cf_options,
1382 1383 1384
                        const Comparator* user_key_comparator,
                        InternalIterator* internal_iter,
                        const SequenceNumber& sequence,
Y
Yi Wu 已提交
1385
                        uint64_t max_sequential_skip_in_iterations,
1386 1387 1388 1389 1390 1391
                        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);
1392
  return db_iter;
1393 1394
}

1395
}  // namespace ROCKSDB_NAMESPACE