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
|
/**
* 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
* <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 <boost/optional.hpp>
#include "mongo/base/disallow_copying.h"
#include "mongo/db/concurrency/d_concurrency.h"
#include "mongo/util/time_support.h"
namespace mongo {
namespace repl {
/**
* This object handles acquiring the RSTL for replication state transitions, as well as any actions
* that need to happen in between enqueuing the RSTL request and waiting for it to be granted.
*/
class ReplicationStateTransitionLockGuard {
MONGO_DISALLOW_COPYING(ReplicationStateTransitionLockGuard);
public:
struct Args {
// How long to wait for the RSTL in mode X.
Date_t lockDeadline = Date_t::max();
// If true, will kill all user operations in between enqueuing the RSTL request and waiting
// for it to be granted.
bool killUserOperations = false;
};
/**
* Acquires the RSTL in mode X.
*/
ReplicationStateTransitionLockGuard(OperationContext* opCtx);
/**
* Acquires the RSTL in mode X and performs any other required actions according to the Args
* provided.
*/
ReplicationStateTransitionLockGuard(OperationContext* opCtx, const Args& args);
~ReplicationStateTransitionLockGuard();
/**
* Temporarily releases the RSTL in mode X. Must be followed by a call to reacquireRSTL().
*/
void releaseRSTL();
/**
* Re-acquires the RSTL in mode X after it was released via a call to releaseRSTL. Ignores
* the configured 'lockDeadline' and instead waits forever for the lock to be acquired.
*/
void reacquireRSTL();
private:
OperationContext* const _opCtx;
Args _args;
};
} // namespace repl
} // namespace mongo
|
