summaryrefslogtreecommitdiff
path: root/src/mongo/client/replica_set_monitor_internal.h
blob: 0d74e69b322b54ff3c72bcc452d1236774891f92 (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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
/*    Copyright 2014 MongoDB Inc.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

/**
 * This is an internal header.
 * This should only be included by replica_set_monitor.cpp and replica_set_monitor_test.cpp.
 * This should never be included by any header.
 */

#pragma once

#include <deque>
#include <string>
#include <vector>
#include <set>

#include "mongo/base/disallow_copying.h"
#include "mongo/client/dbclient_rs.h" // for TagSet and ReadPreferenceSettings
#include "mongo/client/replica_set_monitor.h"
#include "mongo/db/jsobj.h"
#include "mongo/platform/cstdint.h"
#include "mongo/platform/random.h"
#include "mongo/util/net/hostandport.h"

namespace mongo {
    struct ReplicaSetMonitor::IsMasterReply {
        IsMasterReply() : ok(false) {}
        IsMasterReply(const HostAndPort& host, int64_t latencyMicros, const BSONObj& reply)
                : ok(false)
                , host(host)
                , latencyMicros(latencyMicros) {
            parse(reply);
        }

        /**
         * Never throws. If parsing fails for any reason, sets ok to false.
         */
        void parse(const BSONObj& obj);

        bool ok; // if false, ignore all other fields
        BSONObj raw; // Always owned. Other fields are allowed to be a view into this.
        std::string setName;
        bool isMaster;
        bool secondary;
        bool hidden;
        HostAndPort primary; // empty if not present
        std::set<HostAndPort> normalHosts; // both "hosts" and "passives"
        BSONObj tags;

        // remaining fields aren't in isMaster reply, but are known to caller.
        HostAndPort host;
        int64_t latencyMicros; // ignored if negative
    };

    struct ReplicaSetMonitor::SetState {
        MONGO_DISALLOW_COPYING(SetState);
    public:

        // A single node in the replicaSet
        struct Node {
            explicit Node(const HostAndPort& host)
                    : host(host)
                    , latencyMicros(unknownLatency) {
                markFailed();
            }

            void markFailed() {
                isUp = false;
                isMaster = false;
            }

            bool matches(const ReadPreference& pref) const;

            /**
             * Checks if the given tag matches the tag attached to this node.
             *
             * Example:
             *
             * Tag of this node: { "dc": "nyc", "region": "na", "rack": "4" }
             *
             * match: {}
             * match: { "dc": "nyc", "rack": 4 }
             * match: { "region": "na", "dc": "nyc" }
             * not match: { "dc": "nyc", "rack": 2 }
             * not match: { "dc": "sf" }
             */
            bool matches(const BSONObj& tag) const;

            /**
             * Updates this Node based on information in reply. The reply must be from this host.
             */
            void update(const IsMasterReply& reply);

            // Intentionally chosen to compare worse than all known latencies.
            static const int64_t unknownLatency; // = numeric_limits<int64_t>::max()

            HostAndPort host;
            bool isUp;
            bool isMaster; // implies isUp
            int64_t latencyMicros; // unknownLatency if unknown
            BSONObj tags; // owned
        };
        typedef std::vector<Node> Nodes;

        /**
         * seedNodes must not be empty
         */
        SetState(StringData name, const std::set<HostAndPort>& seedNodes);

        /**
         * Returns a host matching criteria or an empty host if no known host matches.
         *
         * Note: Uses only local data and does not go over the network.
         */
        HostAndPort getMatchingHost(const ReadPreferenceSetting& criteria) const;

        /**
         * Returns the Node with the given host, or NULL if no Node has that host.
         */
        Node* findNode(const HostAndPort& host);

        /**
         * Returns the Node with the given host, or creates one if no Node has that host.
         * Maintains the sorted order of nodes.
         */
        Node* findOrCreateNode(const HostAndPort& host);

        void updateNodeIfInNodes(const IsMasterReply& reply);

        std::string getServerAddress() const;

        /**
         * Before unlocking, do DEV checkInvariants();
         */
        void checkInvariants() const;

        static ConfigChangeHook configChangeHook;

        boost::mutex mutex; // must hold this to access any other member or method (except name).

        // If Refresher::getNextStep returns WAIT, you should wait on the condition_variable,
        // releasing mutex. It will be notified when either getNextStep will return something other
        // than WAIT, or a new host is available for consideration by getMatchingHost. Essentially,
        // this will be hit whenever the _refreshUntilMatches loop has the potential to make
        // progress.
        // TODO consider splitting cv into two: one for when looking for a master, one for all other
        // cases.
        boost::condition_variable cv;

        const std::string name; // safe to read outside lock since it is const
        int consecutiveFailedScans;
        std::set<HostAndPort> seedNodes; // updated whenever a master reports set membership changes
        HostAndPort lastSeenMaster; // empty if we have never seen a master. can be same as current
        Nodes nodes; // maintained sorted and unique by host
        ScanStatePtr currentScan; // NULL if no scan in progress
        int64_t latencyThresholdMicros;
        mutable PseudoRandom rand; // only used for host selection to balance load
        mutable int roundRobin; // used when useDeterministicHostSelection is true
    };

    struct ReplicaSetMonitor::ScanState {
        MONGO_DISALLOW_COPYING(ScanState);
    public:
        ScanState() : foundUpMaster(false), foundAnyUpNodes(false) {}

        /**
         * Adds all hosts in container that aren't in triedHosts to hostsToScan, then shuffles the
         * queue.
         */
        template <typename Container>
        void enqueAllUntriedHosts(const Container& container, PseudoRandom& rand);

        // Access to fields is guarded by associated SetState's mutex.
        bool foundUpMaster;
        bool foundAnyUpNodes;
        std::deque<HostAndPort> hostsToScan; // Work queue.
        std::set<HostAndPort> possibleNodes; // Nodes reported by non-primary hosts.
        std::set<HostAndPort> waitingFor; // Hosts we have dispatched but haven't replied yet.
        std::set<HostAndPort> triedHosts; // Hosts that have been returned from getNextStep.

        // All responses go here until we find a master.
        typedef std::vector<IsMasterReply> UnconfirmedReplies;
        UnconfirmedReplies unconfirmedReplies;
    };
}