4a401fff77d8be63d478f6cd96c1d6da35382b34
[WebKit-https.git] / JavaScriptCore / jit / ExecutableAllocatorFixedVMPool.cpp
1 /*
2  * Copyright (C) 2009 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "config.h"
27
28 #include "ExecutableAllocator.h"
29
30 #if ENABLE(EXECUTABLE_ALLOCATOR_FIXED)
31
32 #include <errno.h>
33
34 #include "TCSpinLock.h"
35 #include <sys/mman.h>
36 #include <unistd.h>
37 #include <wtf/AVLTree.h>
38 #include <wtf/VMTags.h>
39
40 #if CPU(X86_64)
41     // These limits suitable on 64-bit platforms (particularly x86-64, where we require all jumps to have a 2Gb max range).
42     #define VM_POOL_SIZE (2u * 1024u * 1024u * 1024u) // 2Gb
43     #define COALESCE_LIMIT (16u * 1024u * 1024u) // 16Mb
44 #else
45     // These limits are hopefully sensible on embedded platforms.
46     #define VM_POOL_SIZE (32u * 1024u * 1024u) // 32Mb
47     #define COALESCE_LIMIT (4u * 1024u * 1024u) // 4Mb
48 #endif
49
50 // ASLR currently only works on darwin (due to arc4random) & 64-bit (due to address space size).
51 #define VM_POOL_ASLR (OS(DARWIN) && CPU(X86_64))
52
53 using namespace WTF;
54
55 namespace JSC {
56
57 // FreeListEntry describes a free chunk of memory, stored in the freeList.
58 struct FreeListEntry {
59     FreeListEntry(void* pointer, size_t size)
60         : pointer(pointer)
61         , size(size)
62         , nextEntry(0)
63         , less(0)
64         , greater(0)
65         , balanceFactor(0)
66     {
67     }
68
69     // All entries of the same size share a single entry
70     // in the AVLTree, and are linked together in a linked
71     // list, using nextEntry.
72     void* pointer;
73     size_t size;
74     FreeListEntry* nextEntry;
75
76     // These fields are used by AVLTree.
77     FreeListEntry* less;
78     FreeListEntry* greater;
79     int balanceFactor;
80 };
81
82 // Abstractor class for use in AVLTree.
83 // Nodes in the AVLTree are of type FreeListEntry, keyed on
84 // (and thus sorted by) their size.
85 struct AVLTreeAbstractorForFreeList {
86     typedef FreeListEntry* handle;
87     typedef int32_t size;
88     typedef size_t key;
89
90     handle get_less(handle h) { return h->less; }
91     void set_less(handle h, handle lh) { h->less = lh; }
92     handle get_greater(handle h) { return h->greater; }
93     void set_greater(handle h, handle gh) { h->greater = gh; }
94     int get_balance_factor(handle h) { return h->balanceFactor; }
95     void set_balance_factor(handle h, int bf) { h->balanceFactor = bf; }
96
97     static handle null() { return 0; }
98
99     int compare_key_key(key va, key vb) { return va - vb; }
100     int compare_key_node(key k, handle h) { return compare_key_key(k, h->size); }
101     int compare_node_node(handle h1, handle h2) { return compare_key_key(h1->size, h2->size); }
102 };
103
104 // Used to reverse sort an array of FreeListEntry pointers.
105 static int reverseSortFreeListEntriesByPointer(const void* leftPtr, const void* rightPtr)
106 {
107     FreeListEntry* left = *(FreeListEntry**)leftPtr;
108     FreeListEntry* right = *(FreeListEntry**)rightPtr;
109
110     return (intptr_t)(right->pointer) - (intptr_t)(left->pointer);
111 }
112
113 // Used to reverse sort an array of pointers.
114 static int reverseSortCommonSizedAllocations(const void* leftPtr, const void* rightPtr)
115 {
116     void* left = *(void**)leftPtr;
117     void* right = *(void**)rightPtr;
118
119     return (intptr_t)right - (intptr_t)left;
120 }
121
122 class FixedVMPoolAllocator
123 {
124     // The free list is stored in a sorted tree.
125     typedef AVLTree<AVLTreeAbstractorForFreeList, 40> SizeSortedFreeTree;
126
127     void release(void* position, size_t size)
128     {
129         m_allocation.decommit(position, size);
130     }
131
132     void reuse(void* position, size_t size)
133     {
134         bool okay = m_allocation.commit(position, size, EXECUTABLE_POOL_WRITABLE, true);
135         ASSERT_UNUSED(okay, okay);
136     }
137
138     // All addition to the free list should go through this method, rather than
139     // calling insert directly, to avoid multiple entries beging added with the
140     // same key.  All nodes being added should be singletons, they should not
141     // already be a part of a chain.
142     void addToFreeList(FreeListEntry* entry)
143     {
144         ASSERT(!entry->nextEntry);
145
146         if (entry->size == m_commonSize) {
147             m_commonSizedAllocations.append(entry->pointer);
148             delete entry;
149         } else if (FreeListEntry* entryInFreeList = m_freeList.search(entry->size, m_freeList.EQUAL)) {
150             // m_freeList already contain an entry for this size - insert this node into the chain.
151             entry->nextEntry = entryInFreeList->nextEntry;
152             entryInFreeList->nextEntry = entry;
153         } else
154             m_freeList.insert(entry);
155     }
156
157     // We do not attempt to coalesce addition, which may lead to fragmentation;
158     // instead we periodically perform a sweep to try to coalesce neigboring
159     // entries in m_freeList.  Presently this is triggered at the point 16MB
160     // of memory has been released.
161     void coalesceFreeSpace()
162     {
163         Vector<FreeListEntry*> freeListEntries;
164         SizeSortedFreeTree::Iterator iter;
165         iter.start_iter_least(m_freeList);
166
167         // Empty m_freeList into a Vector.
168         for (FreeListEntry* entry; (entry = *iter); ++iter) {
169             // Each entry in m_freeList might correspond to multiple
170             // free chunks of memory (of the same size).  Walk the chain
171             // (this is likely of couse only be one entry long!) adding
172             // each entry to the Vector (at reseting the next in chain
173             // pointer to separate each node out).
174             FreeListEntry* next;
175             do {
176                 next = entry->nextEntry;
177                 entry->nextEntry = 0;
178                 freeListEntries.append(entry);
179             } while ((entry = next));
180         }
181         // All entries are now in the Vector; purge the tree.
182         m_freeList.purge();
183
184         // Reverse-sort the freeListEntries and m_commonSizedAllocations Vectors.
185         // We reverse-sort so that we can logically work forwards through memory,
186         // whilst popping items off the end of the Vectors using last() and removeLast().
187         qsort(freeListEntries.begin(), freeListEntries.size(), sizeof(FreeListEntry*), reverseSortFreeListEntriesByPointer);
188         qsort(m_commonSizedAllocations.begin(), m_commonSizedAllocations.size(), sizeof(void*), reverseSortCommonSizedAllocations);
189
190         // The entries from m_commonSizedAllocations that cannot be
191         // coalesced into larger chunks will be temporarily stored here.
192         Vector<void*> newCommonSizedAllocations;
193
194         // Keep processing so long as entries remain in either of the vectors.
195         while (freeListEntries.size() || m_commonSizedAllocations.size()) {
196             // We're going to try to find a FreeListEntry node that we can coalesce onto.
197             FreeListEntry* coalescionEntry = 0;
198
199             // Is the lowest addressed chunk of free memory of common-size, or is it in the free list?
200             if (m_commonSizedAllocations.size() && (!freeListEntries.size() || (m_commonSizedAllocations.last() < freeListEntries.last()->pointer))) {
201                 // Pop an item from the m_commonSizedAllocations vector - this is the lowest
202                 // addressed free chunk.  Find out the begin and end addresses of the memory chunk.
203                 void* begin = m_commonSizedAllocations.last();
204                 void* end = (void*)((intptr_t)begin + m_commonSize);
205                 m_commonSizedAllocations.removeLast();
206
207                 // Try to find another free chunk abutting onto the end of the one we have already found.
208                 if (freeListEntries.size() && (freeListEntries.last()->pointer == end)) {
209                     // There is an existing FreeListEntry for the next chunk of memory!
210                     // we can reuse this.  Pop it off the end of m_freeList.
211                     coalescionEntry = freeListEntries.last();
212                     freeListEntries.removeLast();
213                     // Update the existing node to include the common-sized chunk that we also found. 
214                     coalescionEntry->pointer = (void*)((intptr_t)coalescionEntry->pointer - m_commonSize);
215                     coalescionEntry->size += m_commonSize;
216                 } else if (m_commonSizedAllocations.size() && (m_commonSizedAllocations.last() == end)) {
217                     // There is a second common-sized chunk that can be coalesced.
218                     // Allocate a new node.
219                     m_commonSizedAllocations.removeLast();
220                     coalescionEntry = new FreeListEntry(begin, 2 * m_commonSize);
221                 } else {
222                     // Nope - this poor little guy is all on his own. :-(
223                     // Add him into the newCommonSizedAllocations vector for now, we're
224                     // going to end up adding him back into the m_commonSizedAllocations
225                     // list when we're done.
226                     newCommonSizedAllocations.append(begin);
227                     continue;
228                 }
229             } else {
230                 ASSERT(freeListEntries.size());
231                 ASSERT(!m_commonSizedAllocations.size() || (freeListEntries.last()->pointer < m_commonSizedAllocations.last()));
232                 // The lowest addressed item is from m_freeList; pop it from the Vector.
233                 coalescionEntry = freeListEntries.last();
234                 freeListEntries.removeLast();
235             }
236             
237             // Right, we have a FreeListEntry, we just need check if there is anything else
238             // to coalesce onto the end.
239             ASSERT(coalescionEntry);
240             while (true) {
241                 // Calculate the end address of the chunk we have found so far.
242                 void* end = (void*)((intptr_t)coalescionEntry->pointer - coalescionEntry->size);
243
244                 // Is there another chunk adjacent to the one we already have?
245                 if (freeListEntries.size() && (freeListEntries.last()->pointer == end)) {
246                     // Yes - another FreeListEntry -pop it from the list.
247                     FreeListEntry* coalescee = freeListEntries.last();
248                     freeListEntries.removeLast();
249                     // Add it's size onto our existing node.
250                     coalescionEntry->size += coalescee->size;
251                     delete coalescee;
252                 } else if (m_commonSizedAllocations.size() && (m_commonSizedAllocations.last() == end)) {
253                     // We can coalesce the next common-sized chunk.
254                     m_commonSizedAllocations.removeLast();
255                     coalescionEntry->size += m_commonSize;
256                 } else
257                     break; // Nope, nothing to be added - stop here.
258             }
259
260             // We've coalesced everything we can onto the current chunk.
261             // Add it back into m_freeList.
262             addToFreeList(coalescionEntry);
263         }
264
265         // All chunks of free memory larger than m_commonSize should be
266         // back in m_freeList by now.  All that remains to be done is to
267         // copy the contents on the newCommonSizedAllocations back into
268         // the m_commonSizedAllocations Vector.
269         ASSERT(m_commonSizedAllocations.size() == 0);
270         m_commonSizedAllocations.append(newCommonSizedAllocations);
271     }
272
273 public:
274
275     FixedVMPoolAllocator(size_t commonSize, size_t totalHeapSize)
276         : m_commonSize(commonSize)
277         , m_countFreedSinceLastCoalesce(0)
278     {
279         // Cook up an address to allocate at, using the following recipe:
280         //   17 bits of zero, stay in userspace kids.
281         //   26 bits of randomness for ASLR.
282         //   21 bits of zero, at least stay aligned within one level of the pagetables.
283         //
284         // But! - as a temporary workaround for some plugin problems (rdar://problem/6812854),
285         // for now instead of 2^26 bits of ASLR lets stick with 25 bits of randomization plus
286         // 2^24, which should put up somewhere in the middle of usespace (in the address range
287         // 0x200000000000 .. 0x5fffffffffff).
288 #if VM_POOL_ASLR
289         intptr_t randomLocation = 0;
290         randomLocation = arc4random() & ((1 << 25) - 1);
291         randomLocation += (1 << 24);
292         randomLocation <<= 21;
293         m_allocation = PageAllocation::reserveAt(reinterpret_cast<void*>(randomLocation), false, totalHeapSize, PageAllocation::JSJITCodePages, EXECUTABLE_POOL_WRITABLE, true);
294 #else
295         m_allocation = PageAllocation::reserve(totalHeapSize, PageAllocation::JSJITCodePages, EXECUTABLE_POOL_WRITABLE, true);
296 #endif
297
298         if (!!m_allocation)
299             m_freeList.insert(new FreeListEntry(m_allocation.base(), m_allocation.size()));
300 #if !ENABLE(INTERPRETER)
301         else
302             CRASH();
303 #endif
304     }
305
306     PageAllocation alloc(size_t size)
307     {
308         return PageAllocation(allocInternal(size), size, m_allocation);
309     }
310
311     void free(PageAllocation allocation)
312     {
313         void* pointer = allocation.base();
314         size_t size = allocation.size();
315
316         ASSERT(!!m_allocation);
317         // Call release to report to the operating system that this
318         // memory is no longer in use, and need not be paged out.
319         ASSERT(isWithinVMPool(pointer, size));
320         release(pointer, size);
321
322         // Common-sized allocations are stored in the m_commonSizedAllocations
323         // vector; all other freed chunks are added to m_freeList.
324         if (size == m_commonSize)
325             m_commonSizedAllocations.append(pointer);
326         else
327             addToFreeList(new FreeListEntry(pointer, size));
328
329         // Do some housekeeping.  Every time we reach a point that
330         // 16MB of allocations have been freed, sweep m_freeList
331         // coalescing any neighboring fragments.
332         m_countFreedSinceLastCoalesce += size;
333         if (m_countFreedSinceLastCoalesce >= COALESCE_LIMIT) {
334             m_countFreedSinceLastCoalesce = 0;
335             coalesceFreeSpace();
336         }
337     }
338
339     bool isValid() const { return !!m_allocation; }
340
341 private:
342     void* allocInternal(size_t size)
343     {
344 #if ENABLE(INTERPRETER)
345         if (!m_allocation)
346             return 0;
347 #else
348         ASSERT(!!m_allocation);
349 #endif
350         void* result;
351
352         // Freed allocations of the common size are not stored back into the main
353         // m_freeList, but are instead stored in a separate vector.  If the request
354         // is for a common sized allocation, check this list.
355         if ((size == m_commonSize) && m_commonSizedAllocations.size()) {
356             result = m_commonSizedAllocations.last();
357             m_commonSizedAllocations.removeLast();
358         } else {
359             // Serach m_freeList for a suitable sized chunk to allocate memory from.
360             FreeListEntry* entry = m_freeList.search(size, m_freeList.GREATER_EQUAL);
361
362             // This would be bad news.
363             if (!entry) {
364                 // Errk!  Lets take a last-ditch desparation attempt at defragmentation...
365                 coalesceFreeSpace();
366                 // Did that free up a large enough chunk?
367                 entry = m_freeList.search(size, m_freeList.GREATER_EQUAL);
368                 // No?...  *BOOM!*
369                 if (!entry)
370                     CRASH();
371             }
372             ASSERT(entry->size != m_commonSize);
373
374             // Remove the entry from m_freeList.  But! -
375             // Each entry in the tree may represent a chain of multiple chunks of the
376             // same size, and we only want to remove one on them.  So, if this entry
377             // does have a chain, just remove the first-but-one item from the chain.
378             if (FreeListEntry* next = entry->nextEntry) {
379                 // We're going to leave 'entry' in the tree; remove 'next' from its chain.
380                 entry->nextEntry = next->nextEntry;
381                 next->nextEntry = 0;
382                 entry = next;
383             } else
384                 m_freeList.remove(entry->size);
385
386             // Whoo!, we have a result!
387             ASSERT(entry->size >= size);
388             result = entry->pointer;
389
390             // If the allocation exactly fits the chunk we found in the,
391             // m_freeList then the FreeListEntry node is no longer needed.
392             if (entry->size == size)
393                 delete entry;
394             else {
395                 // There is memory left over, and it is not of the common size.
396                 // We can reuse the existing FreeListEntry node to add this back
397                 // into m_freeList.
398                 entry->pointer = (void*)((intptr_t)entry->pointer + size);
399                 entry->size -= size;
400                 addToFreeList(entry);
401             }
402         }
403
404         // Call reuse to report to the operating system that this memory is in use.
405         ASSERT(isWithinVMPool(result, size));
406         reuse(result, size);
407         return result;
408     }
409
410 #ifndef NDEBUG
411     bool isWithinVMPool(void* pointer, size_t size)
412     {
413         return pointer >= m_allocation.base() && (reinterpret_cast<char*>(pointer) + size <= reinterpret_cast<char*>(m_allocation.base()) + m_allocation.size());
414     }
415 #endif
416
417     // Freed space from the most common sized allocations will be held in this list, ...
418     const size_t m_commonSize;
419     Vector<void*> m_commonSizedAllocations;
420
421     // ... and all other freed allocations are held in m_freeList.
422     SizeSortedFreeTree m_freeList;
423
424     // This is used for housekeeping, to trigger defragmentation of the freed lists.
425     size_t m_countFreedSinceLastCoalesce;
426
427     PageAllocation m_allocation;
428 };
429
430 void ExecutableAllocator::intializePageSize()
431 {
432     ExecutableAllocator::pageSize = getpagesize();
433 }
434
435 static FixedVMPoolAllocator* allocator = 0;
436 static SpinLock spinlock = SPINLOCK_INITIALIZER;
437
438 bool ExecutableAllocator::isValid() const
439 {
440     SpinLockHolder lock_holder(&spinlock);
441     if (!allocator)
442         allocator = new FixedVMPoolAllocator(JIT_ALLOCATOR_LARGE_ALLOC_SIZE, VM_POOL_SIZE);
443     return allocator->isValid();
444 }
445
446 ExecutablePool::Allocation ExecutablePool::systemAlloc(size_t size)
447 {
448     SpinLockHolder lock_holder(&spinlock);
449     ASSERT(allocator);
450     return allocator->alloc(size);
451 }
452
453 void ExecutablePool::systemRelease(const ExecutablePool::Allocation& allocation) 
454 {
455     SpinLockHolder lock_holder(&spinlock);
456     ASSERT(allocator);
457     allocator->free(allocation);
458 }
459
460 }
461
462
463 #endif // HAVE(ASSEMBLER)