1 //===- llvm/unittest/Support/AllocatorTest.cpp - BumpPtrAllocator tests ---===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/Support/Memory.h"
11 #include "llvm/Support/Process.h"
12 #include "gtest/gtest.h"
20 class MappedMemoryTest : public ::testing::TestWithParam<unsigned> {
24 PageSize = sys::process::get_self()->page_size();
28 // Adds RW flags to permit testing of the resulting memory
29 unsigned getTestableEquivalent(unsigned RequestedFlags) {
30 switch (RequestedFlags) {
32 case Memory::MF_WRITE:
33 case Memory::MF_READ|Memory::MF_WRITE:
34 return Memory::MF_READ|Memory::MF_WRITE;
35 case Memory::MF_READ|Memory::MF_EXEC:
36 case Memory::MF_READ|Memory::MF_WRITE|Memory::MF_EXEC:
38 return Memory::MF_READ|Memory::MF_WRITE|Memory::MF_EXEC;
40 // Default in case values are added to the enum, as required by some compilers
41 return Memory::MF_READ|Memory::MF_WRITE;
44 // Returns true if the memory blocks overlap
45 bool doesOverlap(MemoryBlock M1, MemoryBlock M2) {
46 if (M1.base() == M2.base())
49 if (M1.base() > M2.base())
50 return (unsigned char *)M2.base() + M2.size() > M1.base();
52 return (unsigned char *)M1.base() + M1.size() > M2.base();
59 TEST_P(MappedMemoryTest, AllocAndRelease) {
61 MemoryBlock M1 = Memory::allocateMappedMemory(sizeof(int), 0, Flags, EC);
62 EXPECT_EQ(error_code::success(), EC);
64 EXPECT_NE((void*)0, M1.base());
65 EXPECT_LE(sizeof(int), M1.size());
67 EXPECT_FALSE(Memory::releaseMappedMemory(M1));
70 TEST_P(MappedMemoryTest, MultipleAllocAndRelease) {
72 MemoryBlock M1 = Memory::allocateMappedMemory(16, 0, Flags, EC);
73 EXPECT_EQ(error_code::success(), EC);
74 MemoryBlock M2 = Memory::allocateMappedMemory(64, 0, Flags, EC);
75 EXPECT_EQ(error_code::success(), EC);
76 MemoryBlock M3 = Memory::allocateMappedMemory(32, 0, Flags, EC);
77 EXPECT_EQ(error_code::success(), EC);
79 EXPECT_NE((void*)0, M1.base());
80 EXPECT_LE(16U, M1.size());
81 EXPECT_NE((void*)0, M2.base());
82 EXPECT_LE(64U, M2.size());
83 EXPECT_NE((void*)0, M3.base());
84 EXPECT_LE(32U, M3.size());
86 EXPECT_FALSE(doesOverlap(M1, M2));
87 EXPECT_FALSE(doesOverlap(M2, M3));
88 EXPECT_FALSE(doesOverlap(M1, M3));
90 EXPECT_FALSE(Memory::releaseMappedMemory(M1));
91 EXPECT_FALSE(Memory::releaseMappedMemory(M3));
92 MemoryBlock M4 = Memory::allocateMappedMemory(16, 0, Flags, EC);
93 EXPECT_EQ(error_code::success(), EC);
94 EXPECT_NE((void*)0, M4.base());
95 EXPECT_LE(16U, M4.size());
96 EXPECT_FALSE(Memory::releaseMappedMemory(M4));
97 EXPECT_FALSE(Memory::releaseMappedMemory(M2));
100 TEST_P(MappedMemoryTest, BasicWrite) {
101 // This test applies only to readable and writeable combinations
103 !((Flags & Memory::MF_READ) && (Flags & Memory::MF_WRITE)))
107 MemoryBlock M1 = Memory::allocateMappedMemory(sizeof(int), 0, Flags, EC);
108 EXPECT_EQ(error_code::success(), EC);
110 EXPECT_NE((void*)0, M1.base());
111 EXPECT_LE(sizeof(int), M1.size());
113 int *a = (int*)M1.base();
117 EXPECT_FALSE(Memory::releaseMappedMemory(M1));
120 TEST_P(MappedMemoryTest, MultipleWrite) {
121 // This test applies only to readable and writeable combinations
123 !((Flags & Memory::MF_READ) && (Flags & Memory::MF_WRITE)))
126 MemoryBlock M1 = Memory::allocateMappedMemory(sizeof(int), 0, Flags, EC);
127 EXPECT_EQ(error_code::success(), EC);
128 MemoryBlock M2 = Memory::allocateMappedMemory(8 * sizeof(int), 0, Flags, EC);
129 EXPECT_EQ(error_code::success(), EC);
130 MemoryBlock M3 = Memory::allocateMappedMemory(4 * sizeof(int), 0, Flags, EC);
131 EXPECT_EQ(error_code::success(), EC);
133 EXPECT_FALSE(doesOverlap(M1, M2));
134 EXPECT_FALSE(doesOverlap(M2, M3));
135 EXPECT_FALSE(doesOverlap(M1, M3));
137 EXPECT_NE((void*)0, M1.base());
138 EXPECT_LE(1U * sizeof(int), M1.size());
139 EXPECT_NE((void*)0, M2.base());
140 EXPECT_LE(8U * sizeof(int), M2.size());
141 EXPECT_NE((void*)0, M3.base());
142 EXPECT_LE(4U * sizeof(int), M3.size());
144 int *x = (int*)M1.base();
147 int *y = (int*)M2.base();
148 for (int i = 0; i < 8; i++) {
152 int *z = (int*)M3.base();
159 EXPECT_FALSE(Memory::releaseMappedMemory(M1));
160 EXPECT_FALSE(Memory::releaseMappedMemory(M3));
162 MemoryBlock M4 = Memory::allocateMappedMemory(64 * sizeof(int), 0, Flags, EC);
163 EXPECT_EQ(error_code::success(), EC);
164 EXPECT_NE((void*)0, M4.base());
165 EXPECT_LE(64U * sizeof(int), M4.size());
169 EXPECT_FALSE(Memory::releaseMappedMemory(M4));
171 // Verify that M2 remains unaffected by other activity
172 for (int i = 0; i < 8; i++) {
175 EXPECT_FALSE(Memory::releaseMappedMemory(M2));
178 TEST_P(MappedMemoryTest, EnabledWrite) {
180 MemoryBlock M1 = Memory::allocateMappedMemory(2 * sizeof(int), 0, Flags, EC);
181 EXPECT_EQ(error_code::success(), EC);
182 MemoryBlock M2 = Memory::allocateMappedMemory(8 * sizeof(int), 0, Flags, EC);
183 EXPECT_EQ(error_code::success(), EC);
184 MemoryBlock M3 = Memory::allocateMappedMemory(4 * sizeof(int), 0, Flags, EC);
185 EXPECT_EQ(error_code::success(), EC);
187 EXPECT_NE((void*)0, M1.base());
188 EXPECT_LE(2U * sizeof(int), M1.size());
189 EXPECT_NE((void*)0, M2.base());
190 EXPECT_LE(8U * sizeof(int), M2.size());
191 EXPECT_NE((void*)0, M3.base());
192 EXPECT_LE(4U * sizeof(int), M3.size());
194 EXPECT_FALSE(Memory::protectMappedMemory(M1, getTestableEquivalent(Flags)));
195 EXPECT_FALSE(Memory::protectMappedMemory(M2, getTestableEquivalent(Flags)));
196 EXPECT_FALSE(Memory::protectMappedMemory(M3, getTestableEquivalent(Flags)));
198 EXPECT_FALSE(doesOverlap(M1, M2));
199 EXPECT_FALSE(doesOverlap(M2, M3));
200 EXPECT_FALSE(doesOverlap(M1, M3));
202 int *x = (int*)M1.base();
204 int *y = (int*)M2.base();
205 for (unsigned int i = 0; i < 8; i++) {
208 int *z = (int*)M3.base();
215 EXPECT_FALSE(Memory::releaseMappedMemory(M1));
216 EXPECT_FALSE(Memory::releaseMappedMemory(M3));
219 MemoryBlock M4 = Memory::allocateMappedMemory(16, 0, Flags, EC);
220 EXPECT_EQ(error_code::success(), EC);
221 EXPECT_NE((void*)0, M4.base());
222 EXPECT_LE(16U, M4.size());
223 EXPECT_EQ(error_code::success(), Memory::protectMappedMemory(M4, getTestableEquivalent(Flags)));
227 EXPECT_FALSE(Memory::releaseMappedMemory(M4));
228 EXPECT_FALSE(Memory::releaseMappedMemory(M2));
231 TEST_P(MappedMemoryTest, SuccessiveNear) {
233 MemoryBlock M1 = Memory::allocateMappedMemory(16, 0, Flags, EC);
234 EXPECT_EQ(error_code::success(), EC);
235 MemoryBlock M2 = Memory::allocateMappedMemory(64, &M1, Flags, EC);
236 EXPECT_EQ(error_code::success(), EC);
237 MemoryBlock M3 = Memory::allocateMappedMemory(32, &M2, Flags, EC);
238 EXPECT_EQ(error_code::success(), EC);
240 EXPECT_NE((void*)0, M1.base());
241 EXPECT_LE(16U, M1.size());
242 EXPECT_NE((void*)0, M2.base());
243 EXPECT_LE(64U, M2.size());
244 EXPECT_NE((void*)0, M3.base());
245 EXPECT_LE(32U, M3.size());
247 EXPECT_FALSE(doesOverlap(M1, M2));
248 EXPECT_FALSE(doesOverlap(M2, M3));
249 EXPECT_FALSE(doesOverlap(M1, M3));
251 EXPECT_FALSE(Memory::releaseMappedMemory(M1));
252 EXPECT_FALSE(Memory::releaseMappedMemory(M3));
253 EXPECT_FALSE(Memory::releaseMappedMemory(M2));
256 TEST_P(MappedMemoryTest, DuplicateNear) {
258 MemoryBlock Near((void*)(3*PageSize), 16);
259 MemoryBlock M1 = Memory::allocateMappedMemory(16, &Near, Flags, EC);
260 EXPECT_EQ(error_code::success(), EC);
261 MemoryBlock M2 = Memory::allocateMappedMemory(64, &Near, Flags, EC);
262 EXPECT_EQ(error_code::success(), EC);
263 MemoryBlock M3 = Memory::allocateMappedMemory(32, &Near, Flags, EC);
264 EXPECT_EQ(error_code::success(), EC);
266 EXPECT_NE((void*)0, M1.base());
267 EXPECT_LE(16U, M1.size());
268 EXPECT_NE((void*)0, M2.base());
269 EXPECT_LE(64U, M2.size());
270 EXPECT_NE((void*)0, M3.base());
271 EXPECT_LE(32U, M3.size());
273 EXPECT_FALSE(Memory::releaseMappedMemory(M1));
274 EXPECT_FALSE(Memory::releaseMappedMemory(M3));
275 EXPECT_FALSE(Memory::releaseMappedMemory(M2));
278 TEST_P(MappedMemoryTest, ZeroNear) {
280 MemoryBlock Near(0, 0);
281 MemoryBlock M1 = Memory::allocateMappedMemory(16, &Near, Flags, EC);
282 EXPECT_EQ(error_code::success(), EC);
283 MemoryBlock M2 = Memory::allocateMappedMemory(64, &Near, Flags, EC);
284 EXPECT_EQ(error_code::success(), EC);
285 MemoryBlock M3 = Memory::allocateMappedMemory(32, &Near, Flags, EC);
286 EXPECT_EQ(error_code::success(), EC);
288 EXPECT_NE((void*)0, M1.base());
289 EXPECT_LE(16U, M1.size());
290 EXPECT_NE((void*)0, M2.base());
291 EXPECT_LE(64U, M2.size());
292 EXPECT_NE((void*)0, M3.base());
293 EXPECT_LE(32U, M3.size());
295 EXPECT_FALSE(doesOverlap(M1, M2));
296 EXPECT_FALSE(doesOverlap(M2, M3));
297 EXPECT_FALSE(doesOverlap(M1, M3));
299 EXPECT_FALSE(Memory::releaseMappedMemory(M1));
300 EXPECT_FALSE(Memory::releaseMappedMemory(M3));
301 EXPECT_FALSE(Memory::releaseMappedMemory(M2));
304 TEST_P(MappedMemoryTest, ZeroSizeNear) {
306 MemoryBlock Near((void*)(4*PageSize), 0);
307 MemoryBlock M1 = Memory::allocateMappedMemory(16, &Near, Flags, EC);
308 EXPECT_EQ(error_code::success(), EC);
309 MemoryBlock M2 = Memory::allocateMappedMemory(64, &Near, Flags, EC);
310 EXPECT_EQ(error_code::success(), EC);
311 MemoryBlock M3 = Memory::allocateMappedMemory(32, &Near, Flags, EC);
312 EXPECT_EQ(error_code::success(), EC);
314 EXPECT_NE((void*)0, M1.base());
315 EXPECT_LE(16U, M1.size());
316 EXPECT_NE((void*)0, M2.base());
317 EXPECT_LE(64U, M2.size());
318 EXPECT_NE((void*)0, M3.base());
319 EXPECT_LE(32U, M3.size());
321 EXPECT_FALSE(doesOverlap(M1, M2));
322 EXPECT_FALSE(doesOverlap(M2, M3));
323 EXPECT_FALSE(doesOverlap(M1, M3));
325 EXPECT_FALSE(Memory::releaseMappedMemory(M1));
326 EXPECT_FALSE(Memory::releaseMappedMemory(M3));
327 EXPECT_FALSE(Memory::releaseMappedMemory(M2));
330 TEST_P(MappedMemoryTest, UnalignedNear) {
332 MemoryBlock Near((void*)(2*PageSize+5), 0);
333 MemoryBlock M1 = Memory::allocateMappedMemory(15, &Near, Flags, EC);
334 EXPECT_EQ(error_code::success(), EC);
336 EXPECT_NE((void*)0, M1.base());
337 EXPECT_LE(sizeof(int), M1.size());
339 EXPECT_FALSE(Memory::releaseMappedMemory(M1));
342 // Note that Memory::MF_WRITE is not supported exclusively across
343 // operating systems and architectures and can imply MF_READ|MF_WRITE
344 unsigned MemoryFlags[] = {
347 Memory::MF_READ|Memory::MF_WRITE,
349 Memory::MF_READ|Memory::MF_EXEC,
350 Memory::MF_READ|Memory::MF_WRITE|Memory::MF_EXEC
353 INSTANTIATE_TEST_CASE_P(AllocationTests,
355 ::testing::ValuesIn(MemoryFlags));
357 } // anonymous namespace