/usr/include/mongo/s/balance.h is in mongodb-dev 1:2.4.9-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
| 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 | //@file balance.h
/**
*    Copyright (C) 2008 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/>.
*/
#pragma once
#include "mongo/pch.h"
#include "mongo/client/dbclientinterface.h"
#include "mongo/s/balancer_policy.h"
#include "mongo/util/background.h"
namespace mongo {
    /**
     * The balancer is a background task that tries to keep the number of chunks across all servers of the cluster even. Although
     * every mongos will have one balancer running, only one of them will be active at the any given point in time. The balancer
     * uses a 'DistributedLock' for that coordination.
     *
     * The balancer does act continuously but in "rounds". At a given round, it would decide if there is an imbalance by
     * checking the difference in chunks between the most and least loaded shards. It would issue a request for a chunk
     * migration per round, if it found so.
     */
    class Balancer : public BackgroundJob {
    public:
        Balancer();
        virtual ~Balancer();
        // BackgroundJob methods
        virtual void run();
        virtual string name() const { return "Balancer"; }
    private:
        typedef MigrateInfo CandidateChunk;
        typedef shared_ptr<CandidateChunk> CandidateChunkPtr;
        // hostname:port of my mongos
        string _myid;
        // time the Balancer started running
        time_t _started;
        // number of moved chunks in last round
        int _balancedLastTime;
        // decide which chunks to move; owned here.
        scoped_ptr<BalancerPolicy> _policy;
        
        /**
         * Checks that the balancer can connect to all servers it needs to do its job.
         *
         * @return true if balancing can be started
         *
         * This method throws on a network exception
         */
        bool _init();
        /**
         * Gathers all the necessary information about shards and chunks, and decides whether there are candidate chunks to
         * be moved.
         *
         * @param conn is the connection with the config server(s)
         * @param candidateChunks (IN/OUT) filled with candidate chunks, one per collection, that could possibly be moved
         */
        void _doBalanceRound( DBClientBase& conn, vector<CandidateChunkPtr>* candidateChunks );
        /**
         * Issues chunk migration request, one at a time.
         *
         * @param candidateChunks possible chunks to move
         * @param secondaryThrottle wait for secondaries to catch up before pushing more deletes
         * @param waitForDelete wait for deletes to complete after each chunk move
         * @return number of chunks effectively moved
         */
        int _moveChunks(const vector<CandidateChunkPtr>* candidateChunks,
                        bool secondaryThrottle,
                        bool waitForDelete);
        /**
         * Marks this balancer as being live on the config server(s).
         *
         * @param conn is the connection with the config server(s)
         */
        void _ping( DBClientBase& conn, bool waiting = false );
        /**
         * @return true if all the servers listed in configdb as being shards are reachable and are distinct processes
         */
        bool _checkOIDs();
    };
    extern Balancer balancer;
}
 |