summaryrefslogtreecommitdiff
path: root/src/mongo/db/repl/snapshot_thread.h
blob: 71aeede08d8e1d790610a0dd53765de7673b2bd9 (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
/*
*    Copyright (C) 2015 MongoDB Inc.
*
*    This program is free software: you can redistribute it and/or  modify
*    it under the terms of the GNU Affero General Public License, version 3,
*    as published by the Free Software Foundation.
*
*    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
*    GNU Affero General Public License for more details.
*
*    You should have received a copy of the GNU Affero General Public License
*    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*
*    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 GNU Affero General 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 <functional>

#include "mongo/base/disallow_copying.h"
#include "mongo/db/service_context.h"
#include "mongo/db/storage/snapshot_manager.h"
#include "mongo/stdx/thread.h"

namespace mongo {
namespace repl {

/**
 * The thread that makes storage snapshots periodically to enable majority committed reads.
 *
 * Currently the implementation must live in oplog.cpp because it uses newOpMutex.
 * TODO find a better home for this.
 */
class SnapshotThread {
    MONGO_DISALLOW_COPYING(SnapshotThread);

public:
    using Callback = std::function<void(SnapshotName)>;

    /**
     * Starts a thread to take periodic snapshots if supported by the storageEngine.
     *
     * If the current storage engine doesn't support snapshots, a null pointer will be returned.
     *
     * The passed-in callback will be called every time a snapshot is created. It will be called
     * with the global lock held in MODE_IS continuously since creating the snapshot.
     */
    static std::unique_ptr<SnapshotThread> start(ServiceContext* service,
                                                 Callback onSnapshotCreate);

    /**
     * Signals the thread to stop and waits for it to finish.
     * This must be called exactly once before exitCleanly() takes the global X lock.
     */
    void shutdown();

    /**
     * Forces a new snapshot to be taken even if the global timestamp hasn't changed.
     *
     * Does not wait for the snapshot to be taken.
     */
    void forceSnapshot();

private:
    SnapshotThread(SnapshotManager* manager, Callback&& onSnapshotCreate);
    void run();

    SnapshotManager* const _manager;
    bool _inShutdown = false;             // guarded by newOpMutex in oplog.cpp.
    bool _forcedSnapshotPending = false;  // guarded by newOpMutex in oplog.cpp.
    const Callback _onSnapshotCreate;
    stdx::thread _thread;
};

}  // namespace repl
}  // namespace mongo