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
|
/**
* 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.
*/
#include "mongo/db/record_id_helpers.h"
#include <limits>
#include "mongo/bson/bson_validate.h"
#include "mongo/bson/timestamp.h"
#include "mongo/db/catalog/clustered_collection_util.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/query/collation/collation_index_key.h"
#include "mongo/db/record_id.h"
#include "mongo/db/storage/key_string.h"
#include "mongo/logv2/redaction.h"
#include "mongo/util/debug_util.h"
#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kStorage
namespace mongo {
namespace record_id_helpers {
StatusWith<RecordId> keyForOptime(const Timestamp& opTime, const KeyFormat keyFormat) {
switch (keyFormat) {
case KeyFormat::Long: {
// Make sure secs and inc wouldn't be negative if treated as signed. This ensures that
// they don't sort differently when put in a RecordId. It also avoids issues with
// Null/Invalid RecordIds
if (opTime.getSecs() > uint32_t(std::numeric_limits<int32_t>::max()))
return {ErrorCodes::BadValue, "ts secs too high"};
if (opTime.getInc() > uint32_t(std::numeric_limits<int32_t>::max()))
return {ErrorCodes::BadValue, "ts inc too high"};
auto out = RecordId(opTime.getSecs(), opTime.getInc());
if (out <= RecordId::minLong())
return {ErrorCodes::BadValue, "ts too low"};
if (out >= RecordId::maxLong())
return {ErrorCodes::BadValue, "ts too high"};
return {std::move(out)};
}
case KeyFormat::String: {
KeyString::Builder keyBuilder(KeyString::Version::kLatestVersion);
keyBuilder.appendTimestamp(opTime);
return RecordId(keyBuilder.getBuffer(), keyBuilder.getSize());
}
default: {
MONGO_UNREACHABLE_TASSERT(6521004);
}
}
MONGO_UNREACHABLE_TASSERT(6521005);
}
/**
* data and len must be the arguments from RecordStore::insert() on an oplog collection.
*/
StatusWith<RecordId> extractKeyOptime(const char* data, int len) {
// Use the latest BSON validation version. Oplog entries are allowed to contain decimal data
// even if decimal is disabled.
if (kDebugBuild)
invariant(validateBSON(data, len).isOK());
const BSONObj obj(data);
const BSONElement elem = obj["ts"];
if (elem.eoo())
return {ErrorCodes::BadValue, "no ts field"};
if (elem.type() != bsonTimestamp)
return {ErrorCodes::BadValue, "ts must be a Timestamp"};
return keyForOptime(elem.timestamp(), KeyFormat::Long);
}
StatusWith<RecordId> keyForDoc(const BSONObj& doc,
const ClusteredIndexSpec& indexSpec,
const CollatorInterface* collator) {
// Get the collection's cluster key field name
const auto clusterKeyField = clustered_util::getClusterKeyFieldName(indexSpec);
// Build a RecordId using the cluster key.
const BSONElement keyElement = doc.getField(clusterKeyField);
if (keyElement.eoo()) {
return {ErrorCodes::BadValue,
str::stream() << "Document " << redact(doc) << " is missing the '"
<< clusterKeyField << "' field"};
}
if (collator) {
BSONObjBuilder out;
CollationIndexKey::collationAwareIndexKeyAppend(keyElement, collator, &out);
return keyForElem(out.done().firstElement());
}
return keyForElem(keyElement);
}
RecordId keyForElem(const BSONElement& elem) {
// Intentionally discard the TypeBits since the type information will be stored in the cluster
// key of the original document. The consequence of this behavior is that cluster key values
// that compare similarly, but are of different types may not be used concurrently.
KeyString::Builder keyBuilder(KeyString::Version::kLatestVersion);
keyBuilder.appendBSONElement(elem);
return RecordId(keyBuilder.getBuffer(), keyBuilder.getSize());
}
RecordId keyForObj(const BSONObj& obj) {
return keyForElem(obj.firstElement());
}
RecordId keyForOID(OID oid) {
KeyString::Builder keyBuilder(KeyString::Version::kLatestVersion);
keyBuilder.appendOID(oid);
return RecordId(keyBuilder.getBuffer(), keyBuilder.getSize());
}
RecordId keyForDate(Date_t date) {
KeyString::Builder keyBuilder(KeyString::Version::kLatestVersion);
keyBuilder.appendDate(date);
return RecordId(keyBuilder.getBuffer(), keyBuilder.getSize());
}
void appendToBSONAs(const RecordId& rid, BSONObjBuilder* builder, StringData fieldName) {
rid.withFormat([&](RecordId::Null) { builder->appendNull(fieldName); },
[&](int64_t val) { builder->append(fieldName, val); },
[&](const char* str, int len) {
KeyString::appendSingleFieldToBSONAs(str, len, fieldName, builder);
});
}
BSONObj toBSONAs(const RecordId& rid, StringData fieldName) {
BSONObjBuilder builder;
appendToBSONAs(rid, &builder, fieldName);
return builder.obj();
}
namespace {
static constexpr int64_t kMinReservedLong = RecordId::kMaxRepr - (1024 * 1024);
// All RecordId strings that start with FF are considered reserved. This also happens to be an
// invalid start byte for a KeyString sequence, which is used to encode RecordId binary strings.
static constexpr char kReservedStrPrefix = static_cast<char>(0xFF);
} // namespace
RecordId reservedIdFor(ReservationId res, KeyFormat keyFormat) {
// There is only one reservation at the moment.
invariant(res == ReservationId::kWildcardMultikeyMetadataId);
if (keyFormat == KeyFormat::Long) {
return RecordId(kMinReservedLong);
} else {
invariant(keyFormat == KeyFormat::String);
constexpr char reservation[] = {
kReservedStrPrefix, static_cast<char>(ReservationId::kWildcardMultikeyMetadataId)};
return RecordId(reservation, sizeof(reservation));
}
}
RecordId maxRecordId(KeyFormat keyFormat) {
if (keyFormat == KeyFormat::Long) {
return RecordId::maxLong();
} else {
invariant(keyFormat == KeyFormat::String);
constexpr char reservation[] = {
kReservedStrPrefix, static_cast<char>(ReservationId::kWildcardMultikeyMetadataId)};
return RecordId(reservation, sizeof(reservation));
}
}
bool isReserved(const RecordId& id) {
if (id.isNull()) {
return false;
}
if (id.isLong()) {
return id.getLong() >= kMinReservedLong && id.getLong() < RecordId::kMaxRepr;
}
// All RecordId strings that start with FF are considered reserved.
auto strData = id.getStr();
return strData.rawData()[0] == kReservedStrPrefix;
}
} // namespace record_id_helpers
} // namespace mongo
|
