YugabyteDB (2.13.1.0-b60, 21121d69985fbf76aa6958d8f04a9bfa936293b5)

// Copyright (c) 2011-present, Facebook, Inc.  All rights reserved.

// This source code is licensed under the BSD-style license found in the

// LICENSE file in the root directory of this source tree. An additional grant

// of patent rights can be found in the PATENTS file in the same directory.

//

// The following only applies to changes made to this file as part of YugaByte development.

//

// Portions Copyright (c) YugaByte, Inc.

//

// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except

// in compliance with the License.  You may obtain a copy of the License at

//

// http://www.apache.org/licenses/LICENSE-2.0

//

// Unless required by applicable law or agreed to in writing, software distributed under the License

// is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express

// or implied.  See the License for the specific language governing permissions and limitations

// under the License.

//

#pragma once

#ifndef ROCKSDB_LITE

#include <string>

#include <unordered_map>

#include "yb/rocksdb/db.h"

#include "yb/util/slice.h"

#include "yb/rocksdb/status.h"

#include "yb/rocksdb/types.h"

namespace rocksdb {

struct TransactionKeyMapInfo {

  // Earliest sequence number that is relevant to this transaction for this key

  SequenceNumber seq;

  uint32_t num_writes;

  uint32_t num_reads;

  explicit TransactionKeyMapInfo(SequenceNumber seq_no)

      : seq(seq_no), num_writes(0), num_reads(0) {}

};

using TransactionKeyMap =

    std::unordered_map<uint32_t,

                       std::unordered_map<std::string, TransactionKeyMapInfo>>;

class DBImpl;

struct SuperVersion;

class WriteBatchWithIndex;

class TransactionUtil {

 public:

  // Verifies there have been no writes to this key in the db since this

  // sequence number.

  //

  // If cache_only is true, then this function will not attempt to read any

  // SST files.  This will make it more likely this function will

  // return an error if it is unable to determine if there are any conflicts.

  //

  // Returns OK on success, BUSY if there is a conflicting write, or other error

  // status for any unexpected errors.

  static Status CheckKeyForConflicts(DBImpl* db_impl,

                                     ColumnFamilyHandle* column_family,

                                     const std::string& key,

                                     SequenceNumber key_seq, bool cache_only);

  // For each key,SequenceNumber pair in the TransactionKeyMap, this function

  // will verify there have been no writes to the key in the db since that

  // sequence number.

  //

  // Returns OK on success, BUSY if there is a conflicting write, or other error

  // status for any unexpected errors.

  //

  // REQUIRED: this function should only be called on the write thread or if the

  // mutex is held.

  static Status CheckKeysForConflicts(DBImpl* db_impl,

                                      const TransactionKeyMap& keys,

                                      bool cache_only);

 private:

  static Status CheckKey(DBImpl* db_impl, SuperVersion* sv,

                         SequenceNumber earliest_seq, SequenceNumber key_seq,

                         const std::string& key, bool cache_only);

};

}  // namespace rocksdb

#endif  // ROCKSDB_LITE