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
|
/**
* Copyright (C) 2022-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 <boost/filesystem.hpp>
#include <string>
#include "mongo/bson/timestamp.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/operation_context.h"
#include "mongo/util/uuid.h"
namespace mongo {
/**
* Represents the file blocks returned by the storage engine during both full and incremental
* backups. In the case of a full backup, each block is an entire file with offset=0 and
* length=fileSize. In the case of the first basis for future incremental backups, each block is
* an entire file with offset=0 and length=0. In the case of a subsequent incremental backup,
* each block reflects changes made to data files since the basis (named 'thisBackupName') and
* each block has a maximum size of 'blockSizeMB'.
*
* If a file is unchanged in a subsequent incremental backup, a single block is returned with
* offset=0 and length=0. This allows consumers of the backup API to safely truncate files that
* are not returned by the backup cursor.
*/
class BackupBlock final {
public:
using IdentToNamespaceAndUUIDMap =
stdx::unordered_map<std::string, std::pair<NamespaceString, UUID>>;
explicit BackupBlock(OperationContext* opCtx,
std::string filePath,
const IdentToNamespaceAndUUIDMap& identToNamespaceAndUUIDMap,
boost::optional<Timestamp> checkpointTimestamp,
std::uint64_t offset = 0,
std::uint64_t length = 0,
std::uint64_t fileSize = 0);
~BackupBlock() = default;
std::string filePath() const {
return _filePath;
}
std::string ns() const {
return _nss.toString();
}
std::uint64_t offset() const {
return _offset;
}
std::uint64_t length() const {
return _length;
}
std::uint64_t fileSize() const {
return _fileSize;
}
boost::optional<UUID> uuid() const {
return _uuid;
}
/**
* Returns whether the file must be copied regardless of choice for selective backups.
*/
bool isRequired() const;
private:
/**
* Sets '_nss' and '_uuid' that is representative of the ident at the checkpoint timestamp for:
* - collections
* - indexes, to the NSS/UUID of their respective collection
*
* The 'checkpointTimestamp' will be boost::none if the backup is being taken on a standalone
* node.
* A null opCtx is ignored. A null opCtx is exercised by FCBIS unit tests.
*/
void _initialize(OperationContext* opCtx,
const IdentToNamespaceAndUUIDMap& identToNamespaceAndUUIDMap,
boost::optional<Timestamp> checkpointTimestamp);
void _setNamespaceString(const NamespaceString& nss);
const std::string _filePath;
const std::uint64_t _offset;
const std::uint64_t _length;
const std::uint64_t _fileSize;
std::string _filenameStem;
NamespaceString _nss;
boost::optional<UUID> _uuid;
};
} // namespace mongo
|
