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
| //=== - llvm/unittest/Support/TrailingObjectsTest.cpp ---------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "llvm/Support/TrailingObjects.h"
#include "gtest/gtest.h"
using namespace llvm;
namespace {
// This class, beyond being used by the test case, a nice
// demonstration of the intended usage of TrailingObjects, with a
// single trailing array.
class Class1 final : protected TrailingObjects<Class1, short> {
friend TrailingObjects;
unsigned NumShorts;
protected:
size_t numTrailingObjects(OverloadToken<short>) const { return NumShorts; }
Class1(int *ShortArray, unsigned NumShorts) : NumShorts(NumShorts) {
std::uninitialized_copy(ShortArray, ShortArray + NumShorts,
getTrailingObjects<short>());
}
public:
static Class1 *create(int *ShortArray, unsigned NumShorts) {
void *Mem = ::operator new(totalSizeToAlloc<short>(NumShorts));
return new (Mem) Class1(ShortArray, NumShorts);
}
void operator delete(void *p) { ::operator delete(p); }
short get(unsigned Num) const { return getTrailingObjects<short>()[Num]; }
unsigned numShorts() const { return NumShorts; }
// Pull some protected members in as public, for testability.
template <typename... Ty>
using FixedSizeStorage = TrailingObjects::FixedSizeStorage<Ty...>;
using TrailingObjects::totalSizeToAlloc;
using TrailingObjects::additionalSizeToAlloc;
using TrailingObjects::getTrailingObjects;
};
// Here, there are two singular optional object types appended. Note
// that the alignment of Class2 is automatically increased to account
// for the alignment requirements of the trailing objects.
class Class2 final : protected TrailingObjects<Class2, double, short> {
friend TrailingObjects;
bool HasShort, HasDouble;
protected:
size_t numTrailingObjects(OverloadToken<short>) const {
return HasShort ? 1 : 0;
}
size_t numTrailingObjects(OverloadToken<double>) const {
return HasDouble ? 1 : 0;
}
Class2(bool HasShort, bool HasDouble)
: HasShort(HasShort), HasDouble(HasDouble) {}
public:
static Class2 *create(short S = 0, double D = 0.0) {
bool HasShort = S != 0;
bool HasDouble = D != 0.0;
void *Mem =
::operator new(totalSizeToAlloc<double, short>(HasDouble, HasShort));
Class2 *C = new (Mem) Class2(HasShort, HasDouble);
if (HasShort)
*C->getTrailingObjects<short>() = S;
if (HasDouble)
*C->getTrailingObjects<double>() = D;
return C;
}
void operator delete(void *p) { ::operator delete(p); }
short getShort() const {
if (!HasShort)
return 0;
return *getTrailingObjects<short>();
}
double getDouble() const {
if (!HasDouble)
return 0.0;
return *getTrailingObjects<double>();
}
// Pull some protected members in as public, for testability.
template <typename... Ty>
using FixedSizeStorage = TrailingObjects::FixedSizeStorage<Ty...>;
using TrailingObjects::totalSizeToAlloc;
using TrailingObjects::additionalSizeToAlloc;
using TrailingObjects::getTrailingObjects;
};
TEST(TrailingObjects, OneArg) {
int arr[] = {1, 2, 3};
Class1 *C = Class1::create(arr, 3);
EXPECT_EQ(sizeof(Class1), sizeof(unsigned));
EXPECT_EQ(Class1::additionalSizeToAlloc<short>(1), sizeof(short));
EXPECT_EQ(Class1::additionalSizeToAlloc<short>(3), sizeof(short) * 3);
EXPECT_EQ(alignof(Class1),
alignof(Class1::FixedSizeStorage<short>::with_counts<1>::type));
EXPECT_EQ(sizeof(Class1::FixedSizeStorage<short>::with_counts<1>::type),
llvm::alignTo(Class1::totalSizeToAlloc<short>(1), alignof(Class1)));
EXPECT_EQ(Class1::totalSizeToAlloc<short>(1), sizeof(Class1) + sizeof(short));
EXPECT_EQ(alignof(Class1),
alignof(Class1::FixedSizeStorage<short>::with_counts<3>::type));
EXPECT_EQ(sizeof(Class1::FixedSizeStorage<short>::with_counts<3>::type),
llvm::alignTo(Class1::totalSizeToAlloc<short>(3), alignof(Class1)));
EXPECT_EQ(Class1::totalSizeToAlloc<short>(3),
sizeof(Class1) + sizeof(short) * 3);
EXPECT_EQ(C->getTrailingObjects<short>(), reinterpret_cast<short *>(C + 1));
EXPECT_EQ(C->get(0), 1);
EXPECT_EQ(C->get(2), 3);
delete C;
}
TEST(TrailingObjects, TwoArg) {
Class2 *C1 = Class2::create(4);
Class2 *C2 = Class2::create(0, 4.2);
EXPECT_EQ(sizeof(Class2), llvm::alignTo(sizeof(bool) * 2, alignof(double)));
EXPECT_EQ(alignof(Class2), alignof(double));
EXPECT_EQ((Class2::additionalSizeToAlloc<double, short>(1, 0)),
sizeof(double));
EXPECT_EQ((Class2::additionalSizeToAlloc<double, short>(0, 1)),
sizeof(short));
EXPECT_EQ((Class2::additionalSizeToAlloc<double, short>(3, 1)),
sizeof(double) * 3 + sizeof(short));
EXPECT_EQ(
alignof(Class2),
(alignof(
Class2::FixedSizeStorage<double, short>::with_counts<1, 1>::type)));
EXPECT_EQ(
sizeof(Class2::FixedSizeStorage<double, short>::with_counts<1, 1>::type),
llvm::alignTo(Class2::totalSizeToAlloc<double, short>(1, 1),
alignof(Class2)));
EXPECT_EQ((Class2::totalSizeToAlloc<double, short>(1, 1)),
sizeof(Class2) + sizeof(double) + sizeof(short));
EXPECT_EQ(C1->getDouble(), 0);
EXPECT_EQ(C1->getShort(), 4);
EXPECT_EQ(C1->getTrailingObjects<double>(),
reinterpret_cast<double *>(C1 + 1));
EXPECT_EQ(C1->getTrailingObjects<short>(), reinterpret_cast<short *>(C1 + 1));
EXPECT_EQ(C2->getDouble(), 4.2);
EXPECT_EQ(C2->getShort(), 0);
EXPECT_EQ(C2->getTrailingObjects<double>(),
reinterpret_cast<double *>(C2 + 1));
EXPECT_EQ(C2->getTrailingObjects<short>(),
reinterpret_cast<short *>(reinterpret_cast<double *>(C2 + 1) + 1));
delete C1;
delete C2;
}
// This test class is not trying to be a usage demo, just asserting
// that three args does actually work too (it's the same code as
// handles the second arg, so it's basically covered by the above, but
// just in case..)
class Class3 final : public TrailingObjects<Class3, double, short, bool> {
friend TrailingObjects;
size_t numTrailingObjects(OverloadToken<double>) const { return 1; }
size_t numTrailingObjects(OverloadToken<short>) const { return 1; }
};
TEST(TrailingObjects, ThreeArg) {
EXPECT_EQ((Class3::additionalSizeToAlloc<double, short, bool>(1, 1, 3)),
sizeof(double) + sizeof(short) + 3 * sizeof(bool));
EXPECT_EQ(sizeof(Class3), llvm::alignTo(1, alignof(double)));
EXPECT_EQ(
alignof(Class3),
(alignof(Class3::FixedSizeStorage<double, short,
bool>::with_counts<1, 1, 3>::type)));
EXPECT_EQ(
sizeof(Class3::FixedSizeStorage<double, short,
bool>::with_counts<1, 1, 3>::type),
llvm::alignTo(Class3::totalSizeToAlloc<double, short, bool>(1, 1, 3),
alignof(Class3)));
std::unique_ptr<char[]> P(new char[1000]);
Class3 *C = reinterpret_cast<Class3 *>(P.get());
EXPECT_EQ(C->getTrailingObjects<double>(), reinterpret_cast<double *>(C + 1));
EXPECT_EQ(C->getTrailingObjects<short>(),
reinterpret_cast<short *>(reinterpret_cast<double *>(C + 1) + 1));
EXPECT_EQ(
C->getTrailingObjects<bool>(),
reinterpret_cast<bool *>(
reinterpret_cast<short *>(reinterpret_cast<double *>(C + 1) + 1) +
1));
}
class Class4 final : public TrailingObjects<Class4, char, long> {
friend TrailingObjects;
size_t numTrailingObjects(OverloadToken<char>) const { return 1; }
};
TEST(TrailingObjects, Realignment) {
EXPECT_EQ((Class4::additionalSizeToAlloc<char, long>(1, 1)),
llvm::alignTo(sizeof(long) + 1, alignof(long)));
EXPECT_EQ(sizeof(Class4), llvm::alignTo(1, alignof(long)));
EXPECT_EQ(
alignof(Class4),
(alignof(Class4::FixedSizeStorage<char, long>::with_counts<1, 1>::type)));
EXPECT_EQ(
sizeof(Class4::FixedSizeStorage<char, long>::with_counts<1, 1>::type),
llvm::alignTo(Class4::totalSizeToAlloc<char, long>(1, 1),
alignof(Class4)));
std::unique_ptr<char[]> P(new char[1000]);
Class4 *C = reinterpret_cast<Class4 *>(P.get());
EXPECT_EQ(C->getTrailingObjects<char>(), reinterpret_cast<char *>(C + 1));
EXPECT_EQ(C->getTrailingObjects<long>(),
reinterpret_cast<long *>(llvm::alignAddr(
reinterpret_cast<char *>(C + 1) + 1, Align::Of<long>())));
}
}
// Test the use of TrailingObjects with a template class. This
// previously failed to compile due to a bug in MSVC's member access
// control/lookup handling for OverloadToken.
template <typename Derived>
class Class5Tmpl : private llvm::TrailingObjects<Derived, float, int> {
using TrailingObjects = typename llvm::TrailingObjects<Derived, float>;
friend TrailingObjects;
size_t numTrailingObjects(
typename TrailingObjects::template OverloadToken<float>) const {
return 1;
}
size_t numTrailingObjects(
typename TrailingObjects::template OverloadToken<int>) const {
return 2;
}
};
class Class5 : public Class5Tmpl<Class5> {};
|