summaryrefslogtreecommitdiff
path: root/src/mongo/s/grid.h
blob: 059925e28570c83f8c814e45a3bdbe391dda7b27 (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
// 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 <boost/scoped_ptr.hpp>
#include <boost/shared_ptr.hpp>
#include <string>
#include <vector>

#include "mongo/s/config.h"

namespace mongo {

    class CatalogCache;
    class CatalogManager;
    class DBConfig;
    class SettingsType;
    template<typename T> class StatusWith;


    /**
     * Holds the global sharding context. Single instance exists for a running server. Exists on
     * both MongoD and MongoS.
     */
    class Grid {
    public:
        Grid();

        /**
         * Called at startup time so the catalog manager can be set.
         *
         * Returns whether the catalog manager has been initialized successfully. Must be called
         * only once.
         */
        bool initCatalogManager(const std::vector<std::string>& configHosts);

        /**
         * Implicitly creates the specified database as non-sharded.
         */
        StatusWith<boost::shared_ptr<DBConfig>> implicitCreateDb(const std::string& dbName);

        /**
         * @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 );

        /**
         * @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;

        CatalogManager* catalogManager() const { return _catalogManager.get(); }
        CatalogCache* catalogCache() const { return _catalogCache.get(); }

        /**
         * 
         * 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;

        // 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:
        boost::scoped_ptr<CatalogManager> _catalogManager;
        boost::scoped_ptr<CatalogCache> _catalogCache;

        // can 'localhost' be used in shard addresses?
        bool _allowLocalShard;
    };

    extern Grid grid;

} // namespace mongo