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
|
/**
* 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.
*/
/**
* Should NOT be included by other header files. Include only in source files.
*/
#pragma once
#include "mongo/base/status.h"
#include "mongo/stdx/unordered_map.h"
#include "mongo/util/fail_point.h"
namespace mongo {
/**
* Class for storing FailPoint instances.
*/
class FailPointRegistry {
public:
FailPointRegistry();
/**
* Adds a new fail point to this registry. Duplicate names are not allowed.
*
* @return the status code under these circumstances:
* OK - if successful.
* 51006 - if the given name already exists in this registry.
* CannotMutateObject - if this registry is already frozen.
*/
Status add(const std::string& name, FailPoint* failPoint);
/**
* @return the fail point object registered, or nullptr if it was not registered.
*/
FailPoint* find(const std::string& name) const;
/**
* Freezes this registry from being modified.
*/
void freeze();
/**
* Creates a new FailPointServerParameter for each failpoint in the registry. This allows the
* failpoint to be set on the command line via --setParameter, but is only allowed when
* running with '--setParameter enableTestCommands=1'.
*/
void registerAllFailPointsAsServerParameters();
private:
bool _frozen;
stdx::unordered_map<std::string, FailPoint*> _fpMap;
};
} // namespace mongo
|