[BlackBerry] Implement OSAllocator::commit/decommit in the correct way
[WebKit-https.git] / Source / JavaScriptCore / wtf / OSAllocatorPosix.cpp
1 /*
2  * Copyright (C) 2010 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "OSAllocator.h"
28
29 #include "PageAllocation.h"
30 #include <errno.h>
31 #include <sys/mman.h>
32 #include <wtf/Assertions.h>
33 #include <wtf/UnusedParam.h>
34
35 namespace WTF {
36
37 void* OSAllocator::reserveUncommitted(size_t bytes, Usage usage, bool writable, bool executable, bool includesGuardPages)
38 {
39 #if OS(QNX)
40     // Reserve memory with PROT_NONE and MAP_LAZY so it isn't committed now.
41     void* result = mmap(0, bytes, PROT_NONE, MAP_LAZY | MAP_PRIVATE | MAP_ANON, -1, 0);
42     if (result == MAP_FAILED)
43         CRASH();
44 #else // OS(QNX)
45
46     void* result = reserveAndCommit(bytes, usage, writable, executable, includesGuardPages);
47 #if OS(LINUX)
48     madvise(result, bytes, MADV_DONTNEED);
49 #elif HAVE(MADV_FREE_REUSE)
50     // To support the "reserve then commit" model, we have to initially decommit.
51     while (madvise(result, bytes, MADV_FREE_REUSABLE) == -1 && errno == EAGAIN) { }
52 #endif
53
54 #endif // OS(QNX)
55
56     return result;
57 }
58
59 void* OSAllocator::reserveAndCommit(size_t bytes, Usage usage, bool writable, bool executable, bool includesGuardPages)
60 {
61     // All POSIX reservations start out logically committed.
62     int protection = PROT_READ;
63     if (writable)
64         protection |= PROT_WRITE;
65     if (executable)
66         protection |= PROT_EXEC;
67
68     int flags = MAP_PRIVATE | MAP_ANON;
69 #if PLATFORM(IOS)
70     if (executable)
71         flags |= MAP_JIT;
72 #endif
73
74 #if OS(LINUX)
75     // Linux distros usually do not allow overcommit by default, so
76     // JSC's strategy of mmaping a large amount of memory upfront
77     // won't work very well on some systems. Fortunately there's a
78     // flag we can pass to mmap to disable the overcommit check for
79     // this particular call, so we can get away with it as long as the
80     // overcommit flag value in /proc/sys/vm/overcommit_memory is 0
81     // ('heuristic') and not 2 (always check). 0 is the usual default
82     // value, so this should work well in general.
83     flags |= MAP_NORESERVE;
84 #endif
85
86 #if OS(DARWIN)
87     int fd = usage;
88 #else
89     int fd = -1;
90 #endif
91
92     void* result = 0;
93 #if (OS(DARWIN) && CPU(X86_64))
94     if (executable) {
95         ASSERT(includesGuardPages);
96         // Cook up an address to allocate at, using the following recipe:
97         //   17 bits of zero, stay in userspace kids.
98         //   26 bits of randomness for ASLR.
99         //   21 bits of zero, at least stay aligned within one level of the pagetables.
100         //
101         // But! - as a temporary workaround for some plugin problems (rdar://problem/6812854),
102         // for now instead of 2^26 bits of ASLR lets stick with 25 bits of randomization plus
103         // 2^24, which should put up somewhere in the middle of userspace (in the address range
104         // 0x200000000000 .. 0x5fffffffffff).
105         intptr_t randomLocation = 0;
106         randomLocation = arc4random() & ((1 << 25) - 1);
107         randomLocation += (1 << 24);
108         randomLocation <<= 21;
109         result = reinterpret_cast<void*>(randomLocation);
110     }
111 #endif
112
113     result = mmap(result, bytes, protection, flags, fd, 0);
114     if (result == MAP_FAILED) {
115     #if ENABLE(CLASSIC_INTERPRETER)
116         if (executable)
117             result = 0;
118         else
119     #endif
120             CRASH();
121     }
122     if (result && includesGuardPages) {
123         // We use mmap to remap the guardpages rather than using mprotect as
124         // mprotect results in multiple references to the code region.  This
125         // breaks the madvise based mechanism we use to return physical memory
126         // to the OS.
127         mmap(result, pageSize(), PROT_NONE, MAP_FIXED | MAP_PRIVATE | MAP_ANON, fd, 0);
128         mmap(static_cast<char*>(result) + bytes - pageSize(), pageSize(), PROT_NONE, MAP_FIXED | MAP_PRIVATE | MAP_ANON, fd, 0);
129     }
130     return result;
131 }
132
133 void OSAllocator::commit(void* address, size_t bytes, bool writable, bool executable)
134 {
135 #if OS(QNX)
136     int protection = PROT_READ;
137     if (writable)
138         protection |= PROT_WRITE;
139     if (executable)
140         protection |= PROT_EXEC;
141     if (MAP_FAILED == mmap(address, bytes, protection, MAP_FIXED | MAP_PRIVATE | MAP_ANON, -1, 0))
142         CRASH();
143 #elif OS(LINUX)
144     UNUSED_PARAM(writable);
145     UNUSED_PARAM(executable);
146     madvise(address, bytes, MADV_WILLNEED);
147 #elif HAVE(MADV_FREE_REUSE)
148     UNUSED_PARAM(writable);
149     UNUSED_PARAM(executable);
150     while (madvise(address, bytes, MADV_FREE_REUSE) == -1 && errno == EAGAIN) { }
151 #else
152     // Non-MADV_FREE_REUSE reservations automatically commit on demand.
153     UNUSED_PARAM(address);
154     UNUSED_PARAM(bytes);
155     UNUSED_PARAM(writable);
156     UNUSED_PARAM(executable);
157 #endif
158 }
159
160 void OSAllocator::decommit(void* address, size_t bytes)
161 {
162 #if OS(QNX)
163     // Use PROT_NONE and MAP_LAZY to decommit the pages.
164     mmap(address, bytes, PROT_NONE, MAP_FIXED | MAP_LAZY | MAP_PRIVATE | MAP_ANON, -1, 0);
165 #elif OS(LINUX)
166     madvise(address, bytes, MADV_DONTNEED);
167 #elif HAVE(MADV_FREE_REUSE)
168     while (madvise(address, bytes, MADV_FREE_REUSABLE) == -1 && errno == EAGAIN) { }
169 #elif HAVE(MADV_FREE)
170     while (madvise(address, bytes, MADV_FREE) == -1 && errno == EAGAIN) { }
171 #elif HAVE(MADV_DONTNEED)
172     while (madvise(address, bytes, MADV_DONTNEED) == -1 && errno == EAGAIN) { }
173 #else
174     UNUSED_PARAM(address);
175     UNUSED_PARAM(bytes);
176 #endif
177 }
178
179 void OSAllocator::releaseDecommitted(void* address, size_t bytes)
180 {
181     int result = munmap(address, bytes);
182     if (result == -1)
183         CRASH();
184 }
185
186 } // namespace WTF