/** * Copyright (C) 2018-present MongoDB, Inc. * * This program is free software: you can redistribute it and/or modify * it under the terms of the Server Side Public License, version 1, * as published by MongoDB, Inc. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * Server Side Public License for more details. * * You should have received a copy of the Server Side Public License * along with this program. If not, see * . * * As a special exception, the copyright holders give permission to link the * code of portions of this program with the OpenSSL library under certain * conditions as described in each individual source file and distribute * linked combinations including the program with the OpenSSL library. You * must comply with the Server Side Public License in all respects for * all of the code used other than as permitted herein. If you modify file(s) * with this exception, you may extend this exception to your version of the * file(s), but you are not obligated to do so. If you do not wish to do so, * delete this exception statement from your version. If you delete this * exception statement from all source files in the program, then also delete * it in the license file. */ #pragma once #include #include #include "mongo/base/status_with.h" #include "mongo/db/logical_session_id_gen.h" #include "mongo/stdx/unordered_set.h" #include "mongo/util/uuid.h" namespace mongo { using TxnNumber = std::int64_t; using StmtId = std::int32_t; using TxnRetryCounter = std::int32_t; // Default value for unassigned statementId. const StmtId kUninitializedStmtId = -1; // Used as a substitute statementId for oplog entries that were truncated and lost. const StmtId kIncompleteHistoryStmtId = -2; const TxnNumber kUninitializedTxnNumber = -1; const TxnRetryCounter kUninitializedTxnRetryCounter = -1; class BSONObjBuilder; class OperationContext; // The constant kLocalLogicalSessionTimeoutMinutesDefault comes from the generated // header logical_session_id_gen.h. constexpr Minutes kLogicalSessionDefaultTimeout = Minutes(kLocalLogicalSessionTimeoutMinutesDefault); inline bool operator==(const LogicalSessionId& lhs, const LogicalSessionId& rhs) { return (lhs.getId() == rhs.getId()) && (lhs.getTxnNumber() == rhs.getTxnNumber()) && (lhs.getTxnUUID() == rhs.getTxnUUID()) && (lhs.getUid() == rhs.getUid()); } inline bool operator!=(const LogicalSessionId& lhs, const LogicalSessionId& rhs) { return !(lhs == rhs); } inline bool operator==(const LogicalSessionRecord& lhs, const LogicalSessionRecord& rhs) { return lhs.getId() == rhs.getId(); } inline bool operator!=(const LogicalSessionRecord& lhs, const LogicalSessionRecord& rhs) { return !(lhs == rhs); } LogicalSessionId makeLogicalSessionIdForTest(); LogicalSessionId makeLogicalSessionIdWithTxnNumberAndUUIDForTest( boost::optional parentLsid = boost::none, boost::optional parentTxnNumber = boost::none); LogicalSessionId makeLogicalSessionIdWithTxnUUIDForTest( boost::optional parentLsid = boost::none); LogicalSessionRecord makeLogicalSessionRecordForTest(); struct LogicalSessionIdHash { std::size_t operator()(const LogicalSessionId& lsid) const { // Due to internal sessions having the same _id, we want to hash by its txnUUID and // txnNumber to discourage hash key collision. if (auto txnUUID = lsid.getTxnUUID()) { auto hash = _hasher(*txnUUID); if (lsid.getTxnNumber()) { boost::hash_combine(hash, *lsid.getTxnNumber()); } return hash; } return _hasher(lsid.getId()); } private: UUID::Hash _hasher; }; struct LogicalSessionRecordHash { std::size_t operator()(const LogicalSessionRecord& lsid) const { return LogicalSessionIdHash{}(lsid.getId()); } private: UUID::Hash _hasher; }; inline std::ostream& operator<<(std::ostream& s, const LogicalSessionId& lsid) { return (s << lsid.getId() << " - " << lsid.getUid() << " - " << (lsid.getTxnNumber() ? std::to_string(*lsid.getTxnNumber()) : "") << " - " << (lsid.getTxnUUID() ? lsid.getTxnUUID()->toString() : "")); } inline StringBuilder& operator<<(StringBuilder& s, const LogicalSessionId& lsid) { return (s << lsid.getId().toString() << " - " << lsid.getUid().toString() << " - " << (lsid.getTxnNumber() ? std::to_string(*lsid.getTxnNumber()) : "") << " - " << (lsid.getTxnUUID() ? lsid.getTxnUUID()->toString() : "")); } inline std::ostream& operator<<(std::ostream& s, const LogicalSessionFromClient& lsid) { return (s << lsid.getId() << " - " << (lsid.getUid() ? lsid.getUid()->toString() : "") << " - " << (lsid.getTxnNumber() ? std::to_string(*lsid.getTxnNumber()) : "") << " - " << (lsid.getTxnUUID() ? lsid.getTxnUUID()->toString() : "")); } inline StringBuilder& operator<<(StringBuilder& s, const LogicalSessionFromClient& lsid) { return (s << lsid.getId() << " - " << (lsid.getUid() ? lsid.getUid()->toString() : "") << " - " << (lsid.getTxnNumber() ? std::to_string(*lsid.getTxnNumber()) : "") << " - " << (lsid.getTxnUUID() ? lsid.getTxnUUID()->toString() : "")); } /** * An alias for sets of session ids. */ using LogicalSessionIdSet = stdx::unordered_set; using LogicalSessionRecordSet = stdx::unordered_set; template using LogicalSessionIdMap = stdx::unordered_map; class TxnNumberAndRetryCounter { public: TxnNumberAndRetryCounter(TxnNumber txnNumber, boost::optional txnRetryCounter) : _txnNumber(txnNumber), _txnRetryCounter(txnRetryCounter) {} TxnNumberAndRetryCounter(TxnNumber txnNumber) : _txnNumber(txnNumber), _txnRetryCounter(boost::none) {} BSONObj toBSON() const { BSONObjBuilder bob; bob.append(OperationSessionInfo::kTxnNumberFieldName, _txnNumber); if (_txnRetryCounter) { bob.append(OperationSessionInfo::kTxnRetryCounterFieldName, *_txnRetryCounter); } return bob.obj(); } TxnNumber getTxnNumber() const { return _txnNumber; } boost::optional getTxnRetryCounter() const { return _txnRetryCounter; } void setTxnNumber(const TxnNumber txnNumber) { _txnNumber = txnNumber; } void setTxnRetryCounter(const boost::optional txnRetryCounter) { _txnRetryCounter = txnRetryCounter; } private: TxnNumber _txnNumber; boost::optional _txnRetryCounter; }; inline bool operator==(const TxnNumberAndRetryCounter& l, const TxnNumberAndRetryCounter& r) { return l.getTxnNumber() == r.getTxnNumber() && l.getTxnRetryCounter() == r.getTxnRetryCounter(); } inline bool operator!=(const TxnNumberAndRetryCounter& l, const TxnNumberAndRetryCounter& r) { return !(l == r); } } // namespace mongo