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
|
/**
* 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/update/log_builder.h"
#include "mongo/util/str.h"
namespace mongo {
using mutablebson::Element;
namespace {
const char kSet[] = "$set";
const char kUnset[] = "$unset";
} // namespace
constexpr StringData LogBuilder::kUpdateSemanticsFieldName;
inline Status LogBuilder::addToSection(Element newElt, Element* section, const char* sectionName) {
// If we don't already have this section, try to create it now.
if (!section->ok()) {
// If we already have object replacement data, we can't also have section entries.
if (hasObjectReplacement())
return Status(ErrorCodes::IllegalOperation,
"LogBuilder: Invalid attempt to add a $set/$unset entry"
"to a log with an existing object replacement");
mutablebson::Document& doc = _logRoot.getDocument();
// We should not already have an element with the section name under the root.
dassert(_logRoot[sectionName] == doc.end());
// Construct a new object element to represent this section in the log.
const Element newElement = doc.makeElementObject(sectionName);
if (!newElement.ok())
return Status(ErrorCodes::InternalError,
"LogBuilder: failed to construct Object Element for $set/$unset");
// Enqueue the new section under the root, and record it as our out parameter.
Status result = _logRoot.pushBack(newElement);
if (!result.isOK())
return result;
*section = newElement;
// Invalidate attempts to add an object replacement, now that we have a named
// section under the root.
_objectReplacementAccumulator = doc.end();
}
// Whatever transpired, we should now have an ok accumulator for the section, and not
// have a replacement accumulator.
dassert(section->ok());
dassert(!_objectReplacementAccumulator.ok());
// Enqueue the provided element to the section and propagate the result.
return section->pushBack(newElt);
}
Status LogBuilder::addToSets(Element elt) {
return addToSection(elt, &_setAccumulator, kSet);
}
Status LogBuilder::addToSetsWithNewFieldName(StringData name, const mutablebson::Element val) {
mutablebson::Element elemToSet = _logRoot.getDocument().makeElementWithNewFieldName(name, val);
if (!elemToSet.ok())
return Status(ErrorCodes::InternalError,
str::stream() << "Could not create new '" << name
<< "' element from existing element '"
<< val.getFieldName()
<< "' of type "
<< typeName(val.getType()));
return addToSets(elemToSet);
}
Status LogBuilder::addToSetsWithNewFieldName(StringData name, const BSONElement& val) {
mutablebson::Element elemToSet = _logRoot.getDocument().makeElementWithNewFieldName(name, val);
if (!elemToSet.ok())
return Status(ErrorCodes::InternalError,
str::stream() << "Could not create new '" << name
<< "' element from existing element '"
<< val.fieldName()
<< "' of type "
<< typeName(val.type()));
return addToSets(elemToSet);
}
Status LogBuilder::addToSets(StringData name, const SafeNum& val) {
mutablebson::Element elemToSet = _logRoot.getDocument().makeElementSafeNum(name, val);
if (!elemToSet.ok())
return Status(ErrorCodes::InternalError,
str::stream() << "Could not create new '" << name << "' SafeNum from "
<< val.debugString());
return addToSets(elemToSet);
}
Status LogBuilder::addToUnsets(StringData path) {
mutablebson::Element logElement = _logRoot.getDocument().makeElementBool(path, true);
if (!logElement.ok())
return Status(ErrorCodes::InternalError,
str::stream() << "Cannot create $unset oplog entry for path" << path);
return addToSection(logElement, &_unsetAccumulator, kUnset);
}
Status LogBuilder::setUpdateSemantics(UpdateSemantics updateSemantics) {
if (hasObjectReplacement()) {
return Status(ErrorCodes::IllegalOperation,
"LogBuilder: Invalid attempt to add a $v entry to a log with an existing "
"object replacement");
}
if (_updateSemantics.ok()) {
return Status(ErrorCodes::IllegalOperation, "LogBuilder: Invalid attempt to set $v twice.");
}
mutablebson::Document& doc = _logRoot.getDocument();
_updateSemantics =
doc.makeElementInt(kUpdateSemanticsFieldName, static_cast<int>(updateSemantics));
dassert(_logRoot[kUpdateSemanticsFieldName] == doc.end());
return _logRoot.pushFront(_updateSemantics);
}
Status LogBuilder::getReplacementObject(Element* outElt) {
// If the replacement accumulator is not ok, we must have started a $set or $unset
// already, so an object replacement is not permitted.
if (!_objectReplacementAccumulator.ok()) {
dassert(_setAccumulator.ok() || _unsetAccumulator.ok());
return Status(ErrorCodes::IllegalOperation,
"LogBuilder: Invalid attempt to obtain the object replacement slot "
"for a log containing $set or $unset entries");
}
if (hasObjectReplacement())
return Status(ErrorCodes::IllegalOperation,
"LogBuilder: Invalid attempt to acquire the replacement object "
"in a log with existing object replacement data");
if (_updateSemantics.ok()) {
return Status(ErrorCodes::IllegalOperation,
"LogBuilder: Invalid attempt to acquire the replacement object in a log with "
"an update semantics value");
}
// OK to enqueue object replacement items.
*outElt = _objectReplacementAccumulator;
return Status::OK();
}
inline bool LogBuilder::hasObjectReplacement() const {
if (!_objectReplacementAccumulator.ok())
return false;
dassert(!_setAccumulator.ok());
dassert(!_unsetAccumulator.ok());
return _objectReplacementAccumulator.hasChildren();
}
} // namespace mongo
|
