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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
base / scoped_generic_unittest.cc [blame]
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "base/scoped_generic.h"
#include <memory>
#include <unordered_map>
#include <unordered_set>
#include <utility>
#include <vector>
#include "base/containers/contains.h"
#include "base/memory/raw_ptr.h"
#include "build/build_config.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace base {
namespace {
struct IntTraits {
IntTraits(std::vector<int>* freed) : freed_ints(freed) {}
static int InvalidValue() {
return -1;
}
void Free(int value) {
freed_ints->push_back(value);
}
raw_ptr<std::vector<int>> freed_ints;
};
using ScopedInt = ScopedGeneric<int, IntTraits>;
} // namespace
TEST(ScopedGenericTest, ScopedGeneric) {
std::vector<int> values_freed;
IntTraits traits(&values_freed);
// Invalid case, delete should not be called.
{
ScopedInt a(IntTraits::InvalidValue(), traits);
}
EXPECT_TRUE(values_freed.empty());
// Simple deleting case.
static const int kFirst = 0;
{
ScopedInt a(kFirst, traits);
}
ASSERT_EQ(1u, values_freed.size());
ASSERT_EQ(kFirst, values_freed[0]);
values_freed.clear();
// Release should return the right value and leave the object empty.
{
ScopedInt a(kFirst, traits);
EXPECT_EQ(kFirst, a.release());
ScopedInt b(IntTraits::InvalidValue(), traits);
EXPECT_EQ(IntTraits::InvalidValue(), b.release());
}
ASSERT_TRUE(values_freed.empty());
// Reset should free the old value, then the new one should go away when
// it goes out of scope.
static const int kSecond = 1;
{
ScopedInt b(kFirst, traits);
b.reset(kSecond);
ASSERT_EQ(1u, values_freed.size());
ASSERT_EQ(kFirst, values_freed[0]);
}
ASSERT_EQ(2u, values_freed.size());
ASSERT_EQ(kSecond, values_freed[1]);
values_freed.clear();
// Move constructor.
{
ScopedInt a(kFirst, traits);
ScopedInt b(std::move(a));
EXPECT_TRUE(values_freed.empty()); // Nothing should be freed.
ASSERT_EQ(IntTraits::InvalidValue(), a.get());
ASSERT_EQ(kFirst, b.get());
}
ASSERT_EQ(1u, values_freed.size());
ASSERT_EQ(kFirst, values_freed[0]);
values_freed.clear();
// Move assign.
{
ScopedInt a(kFirst, traits);
ScopedInt b(kSecond, traits);
b = std::move(a);
ASSERT_EQ(1u, values_freed.size());
EXPECT_EQ(kSecond, values_freed[0]);
ASSERT_EQ(IntTraits::InvalidValue(), a.get());
ASSERT_EQ(kFirst, b.get());
}
ASSERT_EQ(2u, values_freed.size());
EXPECT_EQ(kFirst, values_freed[1]);
values_freed.clear();
}
TEST(ScopedGenericTest, Operators) {
std::vector<int> values_freed;
IntTraits traits(&values_freed);
static const int kFirst = 0;
static const int kSecond = 1;
{
ScopedInt a(kFirst, traits);
EXPECT_TRUE(a == kFirst);
EXPECT_FALSE(a != kFirst);
EXPECT_FALSE(a == kSecond);
EXPECT_TRUE(a != kSecond);
EXPECT_TRUE(kFirst == a);
EXPECT_FALSE(kFirst != a);
EXPECT_FALSE(kSecond == a);
EXPECT_TRUE(kSecond != a);
}
// is_valid().
{
ScopedInt a(kFirst, traits);
EXPECT_TRUE(a.is_valid());
a.reset();
EXPECT_FALSE(a.is_valid());
}
}
TEST(ScopedGenericTest, Receive) {
std::vector<int> values_freed;
IntTraits traits(&values_freed);
auto a = std::make_unique<ScopedInt>(123, traits);
EXPECT_EQ(123, a->get());
{
ScopedInt::Receiver r(*a);
EXPECT_EQ(123, a->get());
*r.get() = 456;
EXPECT_EQ(123, a->get());
}
EXPECT_EQ(456, a->get());
{
ScopedInt::Receiver r(*a);
EXPECT_DEATH_IF_SUPPORTED(a.reset(), "");
EXPECT_DEATH_IF_SUPPORTED(ScopedInt::Receiver(*a).get(), "");
}
}
namespace {
struct TrackedIntTraits : public ScopedGenericOwnershipTracking {
using OwnerMap = std::unordered_map<
int,
raw_ptr<const ScopedGeneric<int, TrackedIntTraits>, CtnExperimental>>;
TrackedIntTraits(std::unordered_set<int>* freed, OwnerMap* owners)
: freed(freed), owners(owners) {}
static int InvalidValue() { return -1; }
void Free(int value) {
auto it = owners->find(value);
ASSERT_EQ(owners->end(), it);
ASSERT_EQ(0U, freed->count(value));
freed->insert(value);
}
void Acquire(const ScopedGeneric<int, TrackedIntTraits>& owner, int value) {
auto it = owners->find(value);
ASSERT_EQ(owners->end(), it);
(*owners)[value] = &owner;
}
void Release(const ScopedGeneric<int, TrackedIntTraits>& owner, int value) {
auto it = owners->find(value);
ASSERT_NE(owners->end(), it);
owners->erase(it);
}
raw_ptr<std::unordered_set<int>> freed;
raw_ptr<OwnerMap> owners;
};
using ScopedTrackedInt = ScopedGeneric<int, TrackedIntTraits>;
} // namespace
TEST(ScopedGenericTest, OwnershipTracking) {
TrackedIntTraits::OwnerMap owners;
std::unordered_set<int> freed;
TrackedIntTraits traits(&freed, &owners);
#define ASSERT_OWNED(value, owner) \
ASSERT_TRUE(base::Contains(owners, value)); \
ASSERT_EQ(&owner, owners[value]); \
ASSERT_FALSE(base::Contains(freed, value))
#define ASSERT_UNOWNED(value) \
ASSERT_FALSE(base::Contains(owners, value)); \
ASSERT_FALSE(base::Contains(freed, value))
#define ASSERT_FREED(value) \
ASSERT_FALSE(base::Contains(owners, value)); \
ASSERT_TRUE(base::Contains(freed, value))
// Constructor.
{
{
ScopedTrackedInt a(0, traits);
ASSERT_OWNED(0, a);
}
ASSERT_FREED(0);
}
owners.clear();
freed.clear();
// Reset.
{
ScopedTrackedInt a(0, traits);
ASSERT_OWNED(0, a);
a.reset(1);
ASSERT_FREED(0);
ASSERT_OWNED(1, a);
a.reset();
ASSERT_FREED(0);
ASSERT_FREED(1);
}
owners.clear();
freed.clear();
// Release.
{
{
ScopedTrackedInt a(0, traits);
ASSERT_OWNED(0, a);
int released = a.release();
ASSERT_EQ(0, released);
ASSERT_UNOWNED(0);
}
ASSERT_UNOWNED(0);
}
owners.clear();
freed.clear();
// Move constructor.
{
ScopedTrackedInt a(0, traits);
ASSERT_OWNED(0, a);
{
ScopedTrackedInt b(std::move(a));
ASSERT_OWNED(0, b);
}
ASSERT_FREED(0);
}
owners.clear();
freed.clear();
// Move assignment.
{
{
ScopedTrackedInt a(0, traits);
ScopedTrackedInt b(1, traits);
ASSERT_OWNED(0, a);
ASSERT_OWNED(1, b);
a = std::move(b);
ASSERT_OWNED(1, a);
ASSERT_FREED(0);
}
ASSERT_FREED(1);
}
owners.clear();
freed.clear();
#undef ASSERT_OWNED
#undef ASSERT_UNOWNED
#undef ASSERT_FREED
}
// Cheesy manual "no compile" test for manually validating changes.
#if 0
TEST(ScopedGenericTest, NoCompile) {
// Assignment shouldn't work.
/*{
ScopedInt a(kFirst, traits);
ScopedInt b(a);
}*/
// Comparison shouldn't work.
/*{
ScopedInt a(kFirst, traits);
ScopedInt b(kFirst, traits);
if (a == b) {
}
}*/
// Implicit conversion to bool shouldn't work.
/*{
ScopedInt a(kFirst, traits);
bool result = a;
}*/
}
#endif
} // namespace base