summaryrefslogtreecommitdiff
path: root/src/mongo/db/operation_id.h
blob: 44c2a28663da2d745300d9ad796c6ed885a96810 (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
135
136
137
138
139
140
141
142
143
144
145
/**
 *    Copyright (C) 2021-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/platform/mutex.h"
#include "mongo/stdx/unordered_set.h"

namespace mongo {

/**
 * Every OperationContext is expected to have a unique OperationId within the domain of its
 * ServiceContext. Generally speaking, OperationId is used for forming maps of OperationContexts and
 * directing metaoperations like killop.
 */
using OperationId = uint32_t;

/**
 * This class issues guaranteed unique OperationIds for a given instance of this class.
 */
class UniqueOperationIdRegistry : public std::enable_shared_from_this<UniqueOperationIdRegistry> {
public:
    /**
     * This class represents a slot issued by a UniqueOperationIdRegistry.
     * It functions as an RAII wrapper for a unique OperationId.
     */
    class OperationIdSlot {
    public:
        explicit OperationIdSlot(OperationId id) : _id(id), _registry() {}

        OperationIdSlot(OperationId id, std::weak_ptr<UniqueOperationIdRegistry> registry)
            : _id(id), _registry(std::move(registry)) {}

        OperationIdSlot(OperationIdSlot&& other) = default;

        OperationIdSlot& operator=(OperationIdSlot&& other) noexcept {
            if (&other == this) {
                return *this;
            }
            _releaseSlot();
            _id = std::exchange(other._id, {});
            _registry = std::exchange(other._registry, {});
            return *this;
        }

        // Disable copies.
        OperationIdSlot(const OperationIdSlot&) = delete;
        OperationIdSlot& operator=(const OperationIdSlot&) = delete;

        ~OperationIdSlot() {
            _releaseSlot();
        }

        /**
         * Get the contained ID.
         */
        OperationId getId() const {
            return _id;
        }

    private:
        void _releaseSlot() {
            if (auto registry = _registry.lock()) {
                registry->_releaseSlot(_id);
            }
        }

        OperationId _id;
        std::weak_ptr<UniqueOperationIdRegistry> _registry;
    };

    /**
     * Public factory function.
     */
    static std::shared_ptr<UniqueOperationIdRegistry> create() {
        return std::shared_ptr<UniqueOperationIdRegistry>(new UniqueOperationIdRegistry());
    }

    /**
     * Gets a unique OperationIdSlot which will clear itself from the map when destroyed.
     */
    OperationIdSlot acquireSlot();

    /**
     * A helper class for exposing test functions.
     */
    class UniqueOperationIdRegistryTestHarness {
    public:
        /**
         * Returns true if the given operation ID exists.
         */
        static bool isActive(UniqueOperationIdRegistry& registry, OperationId id) {
            stdx::lock_guard lk(registry._mutex);
            return registry._activeIds.find(id) != registry._activeIds.end();
        }

        static void setNextOpId(UniqueOperationIdRegistry& registry, OperationId id) {
            stdx::lock_guard lk(registry._mutex);
            registry._nextOpId = id;
        }
    };

private:
    UniqueOperationIdRegistry() = default;

    /**
     * Clears a unique ID from the set.
     */
    void _releaseSlot(OperationId id);

    Mutex _mutex = MONGO_MAKE_LATCH("UniqueOperationIdRegistry::_mutex");
    stdx::unordered_set<OperationId> _activeIds;

    OperationId _nextOpId = 1U;
};

using OperationIdSlot = UniqueOperationIdRegistry::OperationIdSlot;

}  // namespace mongo