summaryrefslogtreecommitdiff
path: root/src/mongo/s/stale_exception.h
blob: 36f30c7fecb0eafaea176666c3f9e87ae00a82ae (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
/**
*    Copyright (C) 2012 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 "mongo/db/jsobj.h"
#include "mongo/s/chunk_version.h"
#include "mongo/util/assert_util.h"
#include "mongo/util/mongoutils/str.h"

namespace mongo {

/**
 * Thrown whenever the config info for a given shard/chunk is out of date.
 */
class StaleConfigException : public AssertionException {
public:
    StaleConfigException(const std::string& ns,
                         const std::string& raw,
                         int code,
                         ChunkVersion received,
                         ChunkVersion wanted)
        : AssertionException(
              code,
              str::stream() << raw << " ( ns : " << ns << ", received : " << received.toString()
                            << ", wanted : "
                            << wanted.toString()
                            << ", "
                            << (code == ErrorCodes::SendStaleConfig ? "send" : "recv")
                            << " )"),
          _ns(ns),
          _received(received),
          _wanted(wanted) {}

    /** Preferred if we're rebuilding this from a thrown exception */
    StaleConfigException(const std::string& raw, int code, const BSONObj& error)
        : AssertionException(
              code,
              str::stream() << raw << " ( ns : " << (error["ns"].type() == String
                                                         ? error["ns"].String()
                                                         : std::string("<unknown>"))
                            << ", received : "
                            << ChunkVersion::fromBSON(error, "vReceived").toString()
                            << ", wanted : "
                            << ChunkVersion::fromBSON(error, "vWanted").toString()
                            << ", "
                            << (code == ErrorCodes::SendStaleConfig ? "send" : "recv")
                            << " )"),
          // For legacy reasons, we may not always get a namespace here
          _ns(error["ns"].type() == String ? error["ns"].String() : ""),
          _received(ChunkVersion::fromBSON(error, "vReceived")),
          _wanted(ChunkVersion::fromBSON(error, "vWanted")) {}

    /**
     * TODO: This constructor is only necessary, because ParallelSortClusteredCursor puts per-host
     * stale config exceptions in a map and this requires a default constructor.
     */
    StaleConfigException()
        : AssertionException(ErrorCodes::InternalError,
                             "initializing empty stale config exception object") {}

    virtual ~StaleConfigException() throw() {}

    std::string getns() const {
        return _ns;
    }

    ChunkVersion getVersionReceived() const {
        return _received;
    }

    ChunkVersion getVersionWanted() const {
        return _wanted;
    }

    /**
     * Returns true if this exception would require a full reload of config data to resolve.
     */
    bool requiresFullReload() const {
        return !_received.hasEqualEpoch(_wanted) || _received.isSet() != _wanted.isSet();
    }

private:
    std::string _ns;
    ChunkVersion _received;
    ChunkVersion _wanted;
};

class SendStaleConfigException : public StaleConfigException {
public:
    SendStaleConfigException(const std::string& ns,
                             const std::string& raw,
                             ChunkVersion received,
                             ChunkVersion wanted)
        : StaleConfigException(ns, raw, ErrorCodes::SendStaleConfig, received, wanted) {}
};

class RecvStaleConfigException : public StaleConfigException {
public:
    RecvStaleConfigException(const std::string& ns,
                             const std::string& raw,
                             ChunkVersion received,
                             ChunkVersion wanted)
        : StaleConfigException(ns, raw, ErrorCodes::RecvStaleConfig, received, wanted) {}

    RecvStaleConfigException(const std::string& raw, const BSONObj& error)
        : StaleConfigException(raw, ErrorCodes::RecvStaleConfig, error) {}
};

}  // namespace mongo