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
|
//===--- Refcounting.cpp - Reference-counting for Swift -------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
#include "swift/Runtime/HeapObject.h"
#include "swift/Runtime/Metadata.h"
#include "gtest/gtest.h"
using namespace swift;
struct TestObject : HeapObject {
constexpr TestObject(HeapMetadata const *newMetadata)
: HeapObject(newMetadata, InlineRefCounts::Immortal)
, Addr(NULL), Value(0) {}
size_t *Addr;
size_t Value;
};
static SWIFT_CC(swift) void destroyTestObject(SWIFT_CONTEXT HeapObject *_object) {
auto object = static_cast<TestObject*>(_object);
assert(object->Addr && "object already deallocated");
*object->Addr = object->Value;
object->Addr = nullptr;
swift_deallocObject(object, sizeof(TestObject), alignof(TestObject) - 1);
}
static const FullMetadata<ClassMetadata> TestClassObjectMetadata = {
{ { nullptr }, { &destroyTestObject }, { &VALUE_WITNESS_SYM(Bo) } },
{ { nullptr }, ClassFlags::UsesSwiftRefcounting, 0, 0, 0, 0, 0, 0 }
};
static TestObject ImmortalTestObject{&TestClassObjectMetadata};
/// Create an object that, when deallocated, stores the given value to
/// the given pointer.
static TestObject *allocTestObject(size_t *addr, size_t value) {
auto result =
static_cast<TestObject *>(swift_allocObject(&TestClassObjectMetadata,
sizeof(TestObject),
alignof(TestObject) - 1));
result->Addr = addr;
result->Value = value;
return result;
}
TEST(RefcountingTest, release) {
size_t value = 0;
auto object = allocTestObject(&value, 1);
EXPECT_EQ(0u, value);
swift_release(object);
EXPECT_EQ(1u, value);
}
TEST(RefcountingTest, retain_release) {
size_t value = 0;
auto object = allocTestObject(&value, 1);
EXPECT_EQ(0u, value);
swift_retain(object);
EXPECT_EQ(0u, value);
swift_release(object);
EXPECT_EQ(0u, value);
swift_release(object);
EXPECT_EQ(1u, value);
}
TEST(RefcountingTest, retain_release_n) {
size_t value = 0;
auto object = allocTestObject(&value, 1);
EXPECT_EQ(0u, value);
swift_retain_n(object, 32);
swift_retain(object);
EXPECT_EQ(0u, value);
EXPECT_EQ(34u, swift_retainCount(object));
swift_release_n(object, 31);
EXPECT_EQ(0u, value);
EXPECT_EQ(3u, swift_retainCount(object));
swift_release(object);
EXPECT_EQ(0u, value);
EXPECT_EQ(2u, swift_retainCount(object));
swift_release_n(object, 1);
EXPECT_EQ(0u, value);
EXPECT_EQ(1u, swift_retainCount(object));
}
TEST(RefcountingTest, unknown_retain_release_n) {
size_t value = 0;
auto object = allocTestObject(&value, 1);
EXPECT_EQ(0u, value);
swift_unknownObjectRetain_n(object, 32);
swift_unknownObjectRetain(object);
EXPECT_EQ(0u, value);
EXPECT_EQ(34u, swift_retainCount(object));
swift_unknownObjectRelease_n(object, 31);
EXPECT_EQ(0u, value);
EXPECT_EQ(3u, swift_retainCount(object));
swift_unknownObjectRelease(object);
EXPECT_EQ(0u, value);
EXPECT_EQ(2u, swift_retainCount(object));
swift_unknownObjectRelease_n(object, 1);
EXPECT_EQ(0u, value);
EXPECT_EQ(1u, swift_retainCount(object));
}
TEST(RefcountingTest, unowned_retain_release_n) {
size_t value = 0;
auto object = allocTestObject(&value, 1);
EXPECT_EQ(0u, value);
swift_unownedRetain_n(object, 32);
swift_unownedRetain(object);
EXPECT_EQ(34u, swift_unownedRetainCount(object));
swift_unownedRelease_n(object, 31);
EXPECT_EQ(3u, swift_unownedRetainCount(object));
swift_unownedRelease(object);
EXPECT_EQ(2u, swift_unownedRetainCount(object));
swift_unownedRelease_n(object, 1);
EXPECT_EQ(1u, swift_unownedRetainCount(object));
swift_release(object);
EXPECT_EQ(1u, value);
}
TEST(RefcountingTest, unowned_retain_release_n_overflow) {
// This test would test overflow on 32bit platforms.
// These platforms have 7 unowned reference count bits.
size_t value = 0;
auto object = allocTestObject(&value, 1);
EXPECT_EQ(0u, value);
swift_unownedRetain_n(object, 128);
EXPECT_EQ(129u, swift_unownedRetainCount(object));
swift_unownedRetain(object);
EXPECT_EQ(130u, swift_unownedRetainCount(object));
swift_unownedRelease_n(object, 128);
EXPECT_EQ(2u, swift_unownedRetainCount(object));
swift_unownedRelease(object);
EXPECT_EQ(1u, swift_unownedRetainCount(object));
swift_release(object);
EXPECT_EQ(1u, value);
}
TEST(RefcountingTest, isUniquelyReferenced) {
size_t value = 0;
auto object = allocTestObject(&value, 1);
EXPECT_EQ(0u, value);
EXPECT_TRUE(swift_isUniquelyReferenced_nonNull_native(object));
swift_retain(object);
EXPECT_FALSE(swift_isUniquelyReferenced_nonNull_native(object));
swift_release(object);
EXPECT_TRUE(swift_isUniquelyReferenced_nonNull_native(object));
swift_release(object);
EXPECT_EQ(1u, value);
}
/////////////////////////////////////////
// Non-atomic reference counting tests //
/////////////////////////////////////////
TEST(RefcountingTest, nonatomic_release) {
size_t value = 0;
auto object = allocTestObject(&value, 1);
EXPECT_EQ(0u, value);
swift_nonatomic_release(object);
EXPECT_EQ(1u, value);
}
TEST(RefcountingTest, nonatomic_retain_release) {
size_t value = 0;
auto object = allocTestObject(&value, 1);
EXPECT_EQ(0u, value);
swift_nonatomic_retain(object);
EXPECT_EQ(0u, value);
swift_nonatomic_release(object);
EXPECT_EQ(0u, value);
swift_nonatomic_release(object);
EXPECT_EQ(1u, value);
}
TEST(RefcountingTest, nonatomic_retain_release_n) {
size_t value = 0;
auto object = allocTestObject(&value, 1);
EXPECT_EQ(0u, value);
auto res = swift_nonatomic_retain_n(object, 32);
EXPECT_EQ(object, res);
res = swift_nonatomic_retain(object);
EXPECT_EQ(object, res);
EXPECT_EQ(0u, value);
EXPECT_EQ(34u, swift_retainCount(object));
swift_nonatomic_release_n(object, 31);
EXPECT_EQ(0u, value);
EXPECT_EQ(3u, swift_retainCount(object));
swift_nonatomic_release(object);
EXPECT_EQ(0u, value);
EXPECT_EQ(2u, swift_retainCount(object));
swift_nonatomic_release_n(object, 1);
EXPECT_EQ(0u, value);
EXPECT_EQ(1u, swift_retainCount(object));
}
TEST(RefcountingTest, nonatomic_unknown_retain_release_n) {
size_t value = 0;
auto object = allocTestObject(&value, 1);
EXPECT_EQ(0u, value);
auto res = swift_nonatomic_unknownObjectRetain_n(object, 32);
EXPECT_EQ(object, res);
res = swift_nonatomic_unknownObjectRetain(object);
EXPECT_EQ(object, res);
EXPECT_EQ(0u, value);
EXPECT_EQ(34u, swift_retainCount(object));
swift_nonatomic_unknownObjectRelease_n(object, 31);
EXPECT_EQ(0u, value);
EXPECT_EQ(3u, swift_retainCount(object));
swift_nonatomic_unknownObjectRelease(object);
EXPECT_EQ(0u, value);
EXPECT_EQ(2u, swift_retainCount(object));
swift_nonatomic_unknownObjectRelease_n(object, 1);
EXPECT_EQ(0u, value);
EXPECT_EQ(1u, swift_retainCount(object));
}
// Verify that refcounting operations on immortal objects never changes the
// refcount field.
TEST(RefcountingTest, immortal_retain_release) {
auto initialBitsValue = ImmortalTestObject.refCounts.getBitsValue();
swift_retain(&ImmortalTestObject);
EXPECT_EQ(initialBitsValue, ImmortalTestObject.refCounts.getBitsValue());
swift_release(&ImmortalTestObject);
EXPECT_EQ(initialBitsValue, ImmortalTestObject.refCounts.getBitsValue());
swift_nonatomic_retain(&ImmortalTestObject);
EXPECT_EQ(initialBitsValue, ImmortalTestObject.refCounts.getBitsValue());
swift_nonatomic_release(&ImmortalTestObject);
EXPECT_EQ(initialBitsValue, ImmortalTestObject.refCounts.getBitsValue());
swift_unownedRetain(&ImmortalTestObject);
EXPECT_EQ(initialBitsValue, ImmortalTestObject.refCounts.getBitsValue());
swift_unownedRelease(&ImmortalTestObject);
EXPECT_EQ(initialBitsValue, ImmortalTestObject.refCounts.getBitsValue());
swift_nonatomic_unownedRetain(&ImmortalTestObject);
EXPECT_EQ(initialBitsValue, ImmortalTestObject.refCounts.getBitsValue());
swift_nonatomic_unownedRelease(&ImmortalTestObject);
EXPECT_EQ(initialBitsValue, ImmortalTestObject.refCounts.getBitsValue());
for (unsigned i = 0; i < 32; i++) {
uint32_t amount = 1U << i;
swift_retain_n(&ImmortalTestObject, amount);
EXPECT_EQ(initialBitsValue, ImmortalTestObject.refCounts.getBitsValue());
swift_release_n(&ImmortalTestObject, amount);
EXPECT_EQ(initialBitsValue, ImmortalTestObject.refCounts.getBitsValue());
swift_nonatomic_retain_n(&ImmortalTestObject, amount);
EXPECT_EQ(initialBitsValue, ImmortalTestObject.refCounts.getBitsValue());
swift_nonatomic_release_n(&ImmortalTestObject, amount);
EXPECT_EQ(initialBitsValue, ImmortalTestObject.refCounts.getBitsValue());
swift_unownedRetain_n(&ImmortalTestObject, amount);
EXPECT_EQ(initialBitsValue, ImmortalTestObject.refCounts.getBitsValue());
swift_unownedRelease_n(&ImmortalTestObject, amount);
EXPECT_EQ(initialBitsValue, ImmortalTestObject.refCounts.getBitsValue());
swift_nonatomic_unownedRetain_n(&ImmortalTestObject, amount);
EXPECT_EQ(initialBitsValue, ImmortalTestObject.refCounts.getBitsValue());
swift_nonatomic_unownedRelease_n(&ImmortalTestObject, amount);
EXPECT_EQ(initialBitsValue, ImmortalTestObject.refCounts.getBitsValue());
}
}
|
