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
|
/**
* Copyright (C) 2018-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* 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
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* 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 Server Side 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/base/init.h"
#include "mongo/util/fail_point.h"
#include "mongo/util/fail_point_registry.h"
namespace mongo {
/**
* @return the global fail point registry.
*/
FailPointRegistry* getGlobalFailPointRegistry();
/**
* Signals or waits inline.
*/
void syncNow(const BSONObj& cmdObj);
/**
* Set a fail point in the global registry to a given value via BSON
* @throw DBException If no failpoint called failPointName exists.
*/
void setGlobalFailPoint(const std::string& failPointName, const BSONObj& cmdObj);
/**
* Convenience macro for defining a fail point. Must be used at namespace scope.
* Note: that means never at local scope (inside functions) or class scope.
* NOTE: Never use in header files, only sources.
*/
#define MONGO_FAIL_POINT_DEFINE(fp) \
::mongo::FailPoint fp; \
MONGO_INITIALIZER_GENERAL(fp, ("FailPointRegistry"), ("AllFailPointsRegistered")) \
(::mongo::InitializerContext * context) { \
return ::mongo::getGlobalFailPointRegistry()->addFailPoint(#fp, &fp); \
}
/**
* Convenience macro for declaring a fail point in a header.
*/
#define MONGO_FAIL_POINT_DECLARE(fp) extern ::mongo::FailPoint fp;
/**
* Convenience class for enabling a failpoint and disabling it as this goes out of scope.
*/
class FailPointEnableBlock {
public:
FailPointEnableBlock(const std::string& failPointName);
FailPointEnableBlock(const std::string& failPointName, const BSONObj& cmdObj);
~FailPointEnableBlock();
private:
FailPoint* _failPoint;
const std::string _failPointName;
};
} // namespace mongo
|
