summaryrefslogtreecommitdiff
path: root/src/mongo/db/repl/repl_sync_shared_data.h
blob: 6ffc69f4390e0a05af148f25feb43b2189f5cbfa (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
/**
 *    Copyright (C) 2020-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 <mutex>

#include "mongo/base/status.h"
#include "mongo/base/string_data.h"
#include "mongo/db/wire_version.h"
#include "mongo/platform/mutex.h"
#include "mongo/util/clock_source.h"
#include "mongo/util/concurrency/with_lock.h"
#include "mongo/util/uuid.h"

namespace mongo {
namespace repl {
class ReplSyncSharedData {
public:
    ReplSyncSharedData(ClockSource* clock) : _clock(clock) {}
    virtual ~ReplSyncSharedData() {}

    ClockSource* getClock() const {
        return _clock;
    }

    /**
     * BasicLockable C++ methods; they merely delegate to the mutex.
     * The presence of these methods means we can use stdx::unique_lock<ReplSyncSharedData> and
     * stdx::lock_guard<ReplSyncSharedData>.
     */
    void lock();

    void unlock();

    /**
     * In all cases below, the lock must be a lock on this object itself for access to be valid.
     */

    Status getStatus(WithLock lk);

    void setStatus(WithLock lk, Status newStatus);

    /**
     * Sets the status to the new status if and only if the old status is "OK".
     */
    void setStatusIfOK(WithLock lk, Status newStatus);

private:
    // Clock source used for timing outages and recording stats.
    ClockSource* const _clock;

    mutable Mutex _mutex = MONGO_MAKE_LATCH("ReplSyncSharedData::_mutex"_sd);

    // Status of the entire sync process.  All syncing tasks should exit if this becomes non-OK.
    Status _status = Status::OK();
};
}  // namespace repl
}  // namespace mongo