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
|
// grid.h
/**
* Copyright (C) 2010 10gen 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 <boost/date_time/posix_time/posix_time.hpp>
#include "mongo/util/time_support.h"
#include "mongo/util/concurrency/mutex.h"
#include "mongo/s/config.h" // DBConfigPtr
namespace mongo {
class SettingsType;
/**
* stores meta-information about the grid
* TODO: used shard_ptr for DBConfig pointers
*/
class Grid {
public:
Grid() : _lock( "Grid" ) , _allowLocalShard( true ) { }
/**
* gets the config the db.
* will return an empty DBConfig if not in db already
*/
DBConfigPtr getDBConfig( StringData ns , bool create=true , const std::string& shardNameHint="" );
/**
* removes db entry.
* on next getDBConfig call will fetch from db
*/
void removeDB( const std::string& db );
/**
* removes db entry - only this DBConfig object will be removed,
* other DBConfigs which may have been created in the meantime will not be harmed
* on next getDBConfig call will fetch from db
*
* Using this method avoids race conditions where multiple threads detect a database
* reload has failed.
*
* Example : N threads receive version exceptions and dbConfig.reload(), while
* simultaneously a dropDatabase is occurring. In the meantime, the dropDatabase call
* attempts to create a DBConfig object if one does not exist, to load the db info,
* but the config is repeatedly deleted as soon as it is created. Using this method
* prevents the deletion of configs we don't know about.
*
*/
void removeDBIfExists( const DBConfig& database );
/**
* @return true if shards and config servers are allowed to use 'localhost' in address
*/
bool allowLocalHost() const;
/**
* @param whether to allow shards and config servers to use 'localhost' in address
*/
void setAllowLocalHost( bool allow );
/**
*
* addShard will create a new shard in the grid. It expects a mongod process to be running
* on the provided address. Adding a shard that is a replica set is supported.
*
* @param name is an optional std::string with the name of the shard. if omitted, grid will
* generate one and update the parameter.
* @param servers is the connection std::string of the shard being added
* @param maxSize is the optional space quota in bytes. Zeros means there's no limitation to
* space usage
* @param errMsg is the error description in case the operation failed.
* @return true if shard was successfully added.
*/
bool addShard( std::string* name , const ConnectionString& servers , long long maxSize , std::string& errMsg );
/**
* @return true if the config database knows about a host 'name'
*/
bool knowAboutShard( const std::string& name ) const;
/**
* Returns true if the balancer should be running. Caller is responsible
* for making sure settings has the balancer key.
*/
bool shouldBalance(const SettingsType& balancerSettings) const;
/**
* Retrieve the balancer settings from the config server. Returns false if an error
* occurred while retrieving the document. If the balancer settings document does not
* exist, it is not considered as an error, but the "key" property of the settings
* output parameter will not be set.
*/
bool getBalancerSettings(SettingsType* settings, std::string* errMsg) const;
/**
* Returns true if the config server settings indicate that the balancer should be active.
*/
bool getConfigShouldBalance() const;
/**
* Returns true if the given collection can be balanced based on the config.collections
* document.
*/
bool getCollShouldBalance(const std::string& ns) const;
/**
*
* Obtain grid configuration and settings data.
*
* @param name identifies a particular type of configuration data.
* @return a BSON object containing the requested data.
*/
BSONObj getConfigSetting( const std::string& name ) const;
unsigned long long getNextOpTime() const;
void flushConfig();
// exposed methods below are for testing only
/**
* @param balancerDoc bson that may contain a window of time for the balancer to work
* format { ... , activeWindow: { start: "8:30" , stop: "19:00" } , ... }
* @return true if there is no window of time specified for the balancer or it we're currently in it
*/
static bool _inBalancingWindow( const BSONObj& balancerDoc , const boost::posix_time::ptime& now );
private:
mongo::mutex _lock; // protects _databases; TODO: change to r/w lock ??
std::map<std::string, DBConfigPtr > _databases; // maps ns to DBConfig's
bool _allowLocalShard; // can 'localhost' be used in shard addresses?
/**
* @param name is the chose name for the shard. Parameter is mandatory.
* @return true if it managed to generate a shard name. May return false if (currently)
* 10000 shard
*/
bool _getNewShardName( std::string* name ) const;
/**
* @return whether a give dbname is used for shard "local" databases (e.g., admin or local)
*/
static bool _isSpecialLocalDB( const std::string& dbName );
};
extern Grid grid;
} // namespace mongo
|