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
|
/**
* 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 <memory>
#include "mongo/base/string_data.h"
#include "mongo/db/service_context.h"
#include "mongo/db/storage/storage_engine.h"
#include "mongo/stdx/utility.h"
namespace mongo {
/**
* Valid flags to pass to initializeStorageEngine. Used as a bitfield.
*/
enum class StorageEngineInitFlags {
kAllowNoLockFile = 1 << 0,
kSkipMetadataFile = 1 << 1,
kForRestart = 1 << 2, // Used by reinitialzeStorageEngine only.
};
constexpr StorageEngineInitFlags operator&(StorageEngineInitFlags a,
StorageEngineInitFlags b) noexcept {
return StorageEngineInitFlags{stdx::to_underlying(a) & stdx::to_underlying(b)};
}
constexpr StorageEngineInitFlags operator|(StorageEngineInitFlags a,
StorageEngineInitFlags b) noexcept {
return StorageEngineInitFlags{stdx::to_underlying(a) | stdx::to_underlying(b)};
}
/**
* Initializes the storage engine on "service".
*/
StorageEngine::LastShutdownState initializeStorageEngine(OperationContext* opCtx,
StorageEngineInitFlags initFlags);
/**
* Shuts down storage engine cleanly and releases any locks on mongod.lock.
*/
void shutdownGlobalStorageEngineCleanly(ServiceContext* service);
/**
* Changes the storage engine for the given service by shutting down the old one and starting
* up a new one. Kills all opCtxs on the service context which have a storage recovery unit,
* except the one passed in which has its recovery unit replaced.
*
* Changes to the configuration (e.g. to storageGlobalParams.dbpath) which need to happen while
* no storage engine is active may be made in the changeConfigurationCallback. At that point the
* opCtx will have a no op recovery unit and any access to storage is not allowed.
*/
StorageEngine::LastShutdownState reinitializeStorageEngine(
OperationContext* opCtx,
StorageEngineInitFlags initFlags,
std::function<void()> changeConfigurationCallback = [] {});
/**
* Registers a storage engine onto the given "service".
*/
void registerStorageEngine(ServiceContext* service,
std::unique_ptr<StorageEngine::Factory> factory);
/**
* Returns true if "name" refers to a registered storage engine.
*/
bool isRegisteredStorageEngine(ServiceContext* service, StringData name);
/**
* Returns an unowned pointer to the factory for the named storage engine, or nullptr.
*
* NOTE: Exposed only for use in legacy testing scenarios.
*/
StorageEngine::Factory* getFactoryForStorageEngine(ServiceContext* context, StringData name);
/*
* Extracts the storageEngine bson from the CollectionOptions provided. Loops through each
* provided storageEngine and asks the matching registered storage engine if the
* collection/index options are valid. Returns an error if the collection/index options are
* invalid.
* If no matching registered storage engine is found, return an error.
* Validation function 'func' must be either:
* - &StorageEngine::Factory::validateCollectionStorageOptions; or
* - &StorageEngine::Factory::validateIndexStorageOptions
*/
Status validateStorageOptions(
ServiceContext* service,
const BSONObj& storageEngineOptions,
std::function<Status(const StorageEngine::Factory* const, const BSONObj&)> validateFunc);
/*
* Appends a the list of available storage engines to a BSONObjBuilder for reporting purposes.
*/
void appendStorageEngineList(ServiceContext* service, BSONObjBuilder* result);
} // namespace mongo
|