summaryrefslogtreecommitdiff
path: root/src/mongo/db/repl/split_prepare_session_manager.h
blob: de221410a1966169c4b951f9ee7398ad55b704b1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/**
 *    Copyright (C) 2022-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
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    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 "mongo/db/session/internal_session_pool.h"
#include "mongo/db/session/logical_session_id.h"
#include <vector>

namespace mongo {
namespace repl {

using PooledSession = InternalSessionPool::Session;

/**
 * This struct contains information for a split session, including the split
 * session itself and the id of the requester who wants to acquire the split
 * session, which is usually a writer thread from the oplog applier.
 */
struct SplitSessionInfo {
    PooledSession session;
    uint32_t requesterId;

    SplitSessionInfo(PooledSession&& sess, uint32_t reqId)
        : session(std::move(sess)), requesterId(reqId) {}
};

/**
 * This class manages the sessions for split prepared transactions.
 *
 * Prepared transactions are split and applied in parallel on secondaries, and this class is
 * used to create split sessions and track the mapping of top-level sessions and their splits.
 * A primary can also see prepared transactions in the split state if it performed the split
 * and prepare without committing when it was still a secondary, so this class can be accessed
 * by both primaries and secondaries.
 */
class SplitPrepareSessionManager {
    SplitPrepareSessionManager(const SplitPrepareSessionManager&) = delete;
    SplitPrepareSessionManager& operator=(const SplitPrepareSessionManager&) = delete;

public:
    explicit SplitPrepareSessionManager(InternalSessionPool* sessionPool);

    /**
     * Creates split sessions for the given top-level session and track the mapping.
     *
     * The txnNumber is the txnNumber of the top-level session that needs to be split. It
     * servers as a sanity check: onces a session is split, it can not be split again for
     * another txnNumber until it releases the existing split sessions.
     *
     * The requesterIds is a sorted list of requesters (usually writer threads from the
     * oplog applier), each of whom wants to acquire a split session.
     *
     * Asserts if the given session is already split.
     */
    const std::vector<SplitSessionInfo>& splitSession(const LogicalSessionId& sessionId,
                                                      TxnNumber txnNumber,
                                                      const std::vector<uint32_t>& requesterIds);

    /**
     * Returns a vector of split sessions for the given top-level session, or nothing if
     * the given session has not been split.
     *
     * The txnNumber servers a sanity check to make sure it is the same as the one being
     * used for splitSession().
     */
    boost::optional<const std::vector<SplitSessionInfo>&> getSplitSessions(
        const LogicalSessionId& sessionId, TxnNumber txnNumber) const;

    /**
     * Returns true if the given session has been split, or false otherwise. This can be
     * used as an alternative to getSplitSessionIds() when the result is not needed.
     *
     * The txnNumber servers a sanity check to make sure it is the same as the one being
     * used for splitSession().
     */
    bool isSessionSplit(const LogicalSessionId& sessionId, TxnNumber txnNumber) const;

    /**
     * Releases all the split sessions of the give top-level session into the session pool
     * and stops tracking their mapping.
     *
     * The txnNumber servers a sanity check to make sure it is the same as the one being
     * used for splitSession().
     *
     * Asserts if the given session is not split.
     */
    void releaseSplitSessions(const LogicalSessionId& sessionId, TxnNumber txnNumber);

    /**
     * Release and remove all the tracked split sessions.
     */
    void releaseAllSplitSessions();

private:
    // Guards access to member variables.
    mutable Mutex _mutex = MONGO_MAKE_LATCH("SplitPrepareSessionManager::_mutex");

    // The global session pool storing reusable sessions, from which split sessions are acquired.
    InternalSessionPool* _sessionPool;

    // A map to track top-level sessions and their splits.
    LogicalSessionIdMap<std::pair<TxnNumber, std::vector<SplitSessionInfo>>> _splitSessionMap;
};

}  // namespace repl
}  // namespace mongo