summaryrefslogtreecommitdiff
path: root/src/mongo/s/write_ops/batch_write_exec.h
blob: b7fd6c51e43776f17151b94ec0dc40388cfebe9e (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
/**
 *    Copyright (C) 2013 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 <map>
#include <string>

#include "mongo/base/disallow_copying.h"
#include "mongo/bson/timestamp.h"
#include "mongo/s/ns_targeter.h"
#include "mongo/s/shard_resolver.h"
#include "mongo/s/write_ops/batched_command_request.h"
#include "mongo/s/write_ops/batched_command_response.h"

namespace mongo {

    class BatchWriteExecStats;
    class MultiCommandDispatch;

    /**
     * The BatchWriteExec is able to execute client batch write requests, resulting in a batch
     * response to send back to the client.
     *
     * There are two main interfaces the exec uses to "run" the batch:
     *
     *  - the "targeter" used to generate child batch operations to send to particular shards
     *
     *  - the "dispatcher" used to send child batches to several shards at once, and retrieve the
     *    results
     *
     * Both the targeter and dispatcher are assumed to be dedicated to this particular
     * BatchWriteExec instance.
     *
     */
    class BatchWriteExec {
        MONGO_DISALLOW_COPYING (BatchWriteExec);
    public:

        BatchWriteExec( NSTargeter* targeter,
                        ShardResolver* resolver,
                        MultiCommandDispatch* dispatcher );

        /**
         * Executes a client batch write request by sending child batches to several shard
         * endpoints, and returns a client batch write response.
         *
         * This function does not throw, any errors are reported via the clientResponse.
         */
        void executeBatch( const BatchedCommandRequest& clientRequest,
                           BatchedCommandResponse* clientResponse );

        const BatchWriteExecStats& getStats();

        BatchWriteExecStats* releaseStats();

    private:

        // Not owned here
        NSTargeter* _targeter;

        // Not owned here
        ShardResolver* _resolver;

        // Not owned here
        MultiCommandDispatch* _dispatcher;

        // Stats
        std::unique_ptr<BatchWriteExecStats> _stats;
    };

    struct HostOpTime {
        HostOpTime(Timestamp ot, OID e) : opTime(ot), electionId(e) {};
        HostOpTime() {};
        Timestamp opTime;
        OID electionId;
    };

    typedef std::map<ConnectionString, HostOpTime> HostOpTimeMap;

    class BatchWriteExecStats {
    public:

        BatchWriteExecStats() :
           numRounds( 0 ), numTargetErrors( 0 ), numResolveErrors( 0 ), numStaleBatches( 0 ) {
        }

        void noteWriteAt(const ConnectionString& host, Timestamp opTime, const OID& electionId);

        const HostOpTimeMap& getWriteOpTimes() const;

        // Expose via helpers if this gets more complex

        // Number of round trips required for the batch
        int numRounds;
        // Number of times targeting failed
        int numTargetErrors;
        // Number of times host resolution failed
        int numResolveErrors;
        // Number of stale batches
        int numStaleBatches;

    private:

        HostOpTimeMap _writeOpTimes;
    };
}