summaryrefslogtreecommitdiff
path: root/src/mongo/db/repl/replica_set_config_checks.h
blob: ba7ad90f3fc117dbaa9f98c1c73daa5b420c4513 (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
/**
 *    Copyright 2014 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 "mongo/base/status_with.h"

namespace mongo {
namespace repl {

    class ReplicationCoordinatorExternalState;
    class ReplicaSetConfig;

    /**
     * Validates that "newConfig" is a legal configuration that the current
     * node can accept from its local storage during startup.
     *
     * Returns the index of the current node's member configuration in "newConfig",
     * on success, and an indicative error on failure.
     *
     * If "oldConfig" is valid, this method only succeds if "newConfig" is a legal
     * successor configuration.
     */
    StatusWith<int> validateConfigForStartUp(
            ReplicationCoordinatorExternalState* externalState,
            const ReplicaSetConfig& oldConfig,
            const ReplicaSetConfig& newConfig);

    /**
     * Validates that "newConfig" is a legal initial configuration that can be
     * initiated by the current node (identified via "externalState").
     *
     * Returns the index of the current node's member configuration in "newConfig",
     * on success, and an indicative error on failure.
     */
    StatusWith<int> validateConfigForInitiate(
            ReplicationCoordinatorExternalState* externalState,
            const ReplicaSetConfig& newConfig);

    /**
     * Validates that "newConfig" is a legal successor configuration to "oldConfig" that can be
     * initiated by the current node (identified via "externalState").
     *
     * If "force" is set to true, then compatibility with the old configuration and electability of
     * the current node in "newConfig" are not considered when determining if the reconfig is valid.
     *
     * Returns the index of the current node's member configuration in "newConfig",
     * on success, and an indicative error on failure.
     */
    StatusWith<int> validateConfigForReconfig(
            ReplicationCoordinatorExternalState* externalState,
            const ReplicaSetConfig& oldConfig,
            const ReplicaSetConfig& newConfig,
            bool force);

    /**
     * Validates that "newConfig" is an acceptable configuration when received in a heartbeat
     * reasponse.
     *
     * If the new configuration omits the current node, but is otherwise valid, returns
     * ErrorCodes::NodeNotFound.  If the configuration is wholly valid, returns Status::OK().
     * Otherwise, returns some other error status.
     */
    StatusWith<int> validateConfigForHeartbeatReconfig(
            ReplicationCoordinatorExternalState* externalState,
            const ReplicaSetConfig& newConfig);
}  // namespace repl
}  // namespace mongo