summaryrefslogtreecommitdiff
path: root/src/mongo/db/repl/oplog_entry_or_grouped_inserts.h
blob: 2c70c46eb2c3f00d306a5c9dd226f9cf21d2fb29 (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
134
/**
 *    Copyright (C) 2019-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/bson/bsonobj.h"
#include "mongo/db/repl/oplog_entry.h"
#include "mongo/db/session/internal_session_pool.h"

namespace mongo {
namespace repl {

enum class ApplicationInstruction {
    // Apply a normal oplog entry.
    applyOplogEntry,
    // Apply a prepared txn that is split from a top-level txn.
    applySplitPreparedTxnOp,
    // Apply a top-level prepared txn that can have multiple splits.
    applyTopLevelPreparedTxnOp,
};

struct ApplierOperation {
    const OplogEntry* op;
    ApplicationInstruction instruction;
    boost::optional<const InternalSessionPool::Session&> subSession;
    boost::optional<std::vector<const OplogEntry*>> preparedTxnOps;

    ApplierOperation(const OplogEntry* op,
                     ApplicationInstruction instruction = ApplicationInstruction::applyOplogEntry,
                     boost::optional<const InternalSessionPool::Session&> subSession = boost::none,
                     boost::optional<std::vector<const OplogEntry*>> preparedTxnOps = boost::none)
        : op(op),
          instruction(instruction),
          subSession(subSession),
          preparedTxnOps(preparedTxnOps) {}

    ApplierOperation(const OplogEntry* op,
                     ApplicationInstruction instruction,
                     const std::vector<OplogEntry>& preparedTxnOps)
        : op(op), instruction(instruction) {

        this->preparedTxnOps.emplace();
        this->preparedTxnOps->reserve(preparedTxnOps.size());
        std::transform(preparedTxnOps.begin(),
                       preparedTxnOps.end(),
                       std::back_inserter(*this->preparedTxnOps),
                       [](const auto& op) -> const OplogEntry* { return &op; });
    }

    const OplogEntry* operator->() const {
        return op;
    }

    const OplogEntry& operator*() const {
        return *op;
    }
};

/**
 * This is a class for a single oplog entry or grouped inserts to be applied in
 * applyOplogEntryOrGroupedInserts. This class is immutable and can only be initialized using
 * either a single oplog entry or a range of grouped inserts.
 */
class OplogEntryOrGroupedInserts {
public:
    using ConstIterator = std::vector<ApplierOperation>::const_iterator;

    OplogEntryOrGroupedInserts() = delete;

    // This initializes it as a single oplog entry.
    OplogEntryOrGroupedInserts(ApplierOperation op) : _entryOrGroupedInserts({std::move(op)}) {}

    // This initializes it as grouped inserts.
    OplogEntryOrGroupedInserts(ConstIterator begin, ConstIterator end)
        : _entryOrGroupedInserts(begin, end) {
        // Performs sanity checks to confirm that the batch is valid.
        invariant(!_entryOrGroupedInserts.empty());
        for (const auto& op : _entryOrGroupedInserts) {
            // Every oplog entry must be an insert.
            invariant(op->getOpType() == OpTypeEnum::kInsert);
            // Every oplog entry must be in the same namespace.
            invariant(op->getNss() == _entryOrGroupedInserts.front()->getNss());
        }
    }

    // Return the oplog entry to be applied or the first oplog entry of the grouped inserts.
    const ApplierOperation& getOp() const {
        return _entryOrGroupedInserts.front();
    }

    bool isGroupedInserts() const {
        return _entryOrGroupedInserts.size() > 1;
    }

    const std::vector<ApplierOperation>& getGroupedInserts() const {
        invariant(isGroupedInserts());
        return _entryOrGroupedInserts;
    }

    // Returns a BSONObj for message logging purpose.
    BSONObj toBSON() const;

private:
    // A single oplog entry or a batch of grouped insert oplog entries to be applied.
    std::vector<ApplierOperation> _entryOrGroupedInserts;
};
}  // namespace repl
}  // namespace mongo