summaryrefslogtreecommitdiff
path: root/src/mongo/util/fail_point.cpp
blob: ef3c2111b2b3ff573d85e300ffa6299015fc84bf (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
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
/*
 *    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.
 */

#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kControl

#include "mongo/util/fail_point.h"

#include <boost/scoped_ptr.hpp>
#include <boost/thread.hpp>

#include "mongo/platform/random.h"
#include "mongo/util/concurrency/threadlocal.h"
#include "mongo/util/log.h"
#include "mongo/util/mongoutils/str.h"
#include "mongo/util/time_support.h"

namespace mongo {
namespace {

    /**
     * Type representing the per-thread PRNG used by fail-points.  Required because TSP_* macros,
     * below, only let you create one thread-specific object per type.
     */
    class FailPointPRNG {
    public:
        FailPointPRNG() :
            _prng(boost::scoped_ptr<SecureRandom>(SecureRandom::create())->nextInt64()) {}

        void resetSeed(int32_t seed) {
            _prng = PseudoRandom(seed);
        }

        int32_t nextPositiveInt32() {
            return _prng.nextInt32() & ~(1 << 31);
        }

    private:
        PseudoRandom _prng;
    };

}  // namespace


    TSP_DECLARE(FailPointPRNG, failPointPrng);
    TSP_DEFINE(FailPointPRNG, failPointPrng);

namespace {

    int32_t prngNextPositiveInt32() {
        return failPointPrng.getMake()->nextPositiveInt32();
    }

}  // namespace

    void FailPoint::setThreadPRNGSeed(int32_t seed) {
        failPointPrng.getMake()->resetSeed(seed);
    }

    FailPoint::FailPoint() : _fpInfo(0), _mode(off), _timesOrPeriod(0) {}

    void FailPoint::shouldFailCloseBlock() {
        _fpInfo.subtractAndFetch(1);
    }

    void FailPoint::setMode(Mode mode, ValType val, const BSONObj& extra) {
        /**
         * Outline:
         *
         * 1. Deactivates fail point to enter write-only mode
         * 2. Waits for all current readers of the fail point to finish
         * 3. Sets the new mode.
         */

        boost::lock_guard<boost::mutex> scoped(_modMutex);

        // Step 1
        disableFailPoint();

        // Step 2
        while (_fpInfo.load() != 0) {
            sleepmillis(50);
        }

        // Step 3
        uassert(16442, str::stream() << "mode not supported " << static_cast<int>(mode),
                mode >= off && mode < numModes);

        _mode = mode;
        _timesOrPeriod.store(val);

        _data = extra.copy();

        if (_mode != off) {
            enableFailPoint();
        }
    }

    const BSONObj& FailPoint::getData() const {
        return _data;
    }

    void FailPoint::enableFailPoint() {
        // TODO: Better to replace with a bitwise OR, once available for AU32
        ValType currentVal = _fpInfo.load();
        ValType expectedCurrentVal;
        ValType newVal;

        do {
            expectedCurrentVal = currentVal;
            newVal = expectedCurrentVal | ACTIVE_BIT;
            currentVal = _fpInfo.compareAndSwap(expectedCurrentVal, newVal);
        } while (expectedCurrentVal != currentVal);
    }

    void FailPoint::disableFailPoint() {
        // TODO: Better to replace with a bitwise AND, once available for AU32
        ValType currentVal = _fpInfo.load();
        ValType expectedCurrentVal;
        ValType newVal;

        do {
            expectedCurrentVal = currentVal;
            newVal = expectedCurrentVal & REF_COUNTER_MASK;
            currentVal = _fpInfo.compareAndSwap(expectedCurrentVal, newVal);
        } while (expectedCurrentVal != currentVal);
    }

    FailPoint::RetCode FailPoint::slowShouldFailOpenBlock() {
        ValType localFpInfo = _fpInfo.addAndFetch(1);

        if ((localFpInfo & ACTIVE_BIT) == 0) {
            return slowOff;
        }

        switch (_mode) {
        case alwaysOn:
            return slowOn;

        case random:
        {
            const AtomicInt32::WordType maxActivationValue = _timesOrPeriod.load();
            if (prngNextPositiveInt32() < maxActivationValue) {
                return slowOn;
            }
            return slowOff;
        }
        case nTimes:
        {
            AtomicInt32::WordType newVal = _timesOrPeriod.subtractAndFetch(1);

            if (newVal <= 0) {
                disableFailPoint();
            }

            return slowOn;
        }

        default:
            error() << "FailPoint Mode not supported: " << static_cast<int>(_mode);
            fassertFailed(16444);
        }
    }

    BSONObj FailPoint::toBSON() const {
        BSONObjBuilder builder;

        boost::lock_guard<boost::mutex> scoped(_modMutex);
        builder.append("mode", _mode);
        builder.append("data", _data);

        return builder.obj();
    }

    ScopedFailPoint::ScopedFailPoint(FailPoint* failPoint):
            _failPoint(failPoint),
            _once(false),
            _shouldClose(false) {
    }

    ScopedFailPoint::~ScopedFailPoint() {
        if (_shouldClose) {
            _failPoint->shouldFailCloseBlock();
        }
    }

    const BSONObj& ScopedFailPoint::getData() const {
        // Assert when attempting to get data without incrementing ref counter.
        fassert(16445, _shouldClose);
        return _failPoint->getData();
    }
}