6435c69b9385eefc437f6d295aef1da76aea9125
[WebKit-https.git] / Source / JavaScriptCore / jit / ExecutableAllocator.h
1 /*
2  * Copyright (C) 2008 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 #ifndef ExecutableAllocator_h
27 #define ExecutableAllocator_h
28 #include "JITCompilationEffort.h"
29 #include <stddef.h> // for ptrdiff_t
30 #include <limits>
31 #include <wtf/Assertions.h>
32 #include <wtf/MetaAllocatorHandle.h>
33 #include <wtf/MetaAllocator.h>
34 #include <wtf/PageAllocation.h>
35 #include <wtf/PassRefPtr.h>
36 #include <wtf/RefCounted.h>
37 #include <wtf/Vector.h>
38
39 #if OS(IOS)
40 #include <libkern/OSCacheControl.h>
41 #endif
42
43 #if OS(IOS)
44 #include <sys/mman.h>
45 #endif
46
47 #if CPU(MIPS) && OS(LINUX)
48 #include <sys/cachectl.h>
49 #endif
50
51 #if CPU(SH4) && OS(LINUX)
52 #include <asm/cachectl.h>
53 #include <asm/unistd.h>
54 #include <sys/syscall.h>
55 #include <unistd.h>
56 #endif
57
58 #define JIT_ALLOCATOR_LARGE_ALLOC_SIZE (pageSize() * 4)
59
60 #if ENABLE(ASSEMBLER_WX_EXCLUSIVE)
61 #define PROTECTION_FLAGS_RW (PROT_READ | PROT_WRITE)
62 #define PROTECTION_FLAGS_RX (PROT_READ | PROT_EXEC)
63 #define EXECUTABLE_POOL_WRITABLE false
64 #else
65 #define EXECUTABLE_POOL_WRITABLE true
66 #endif
67
68 namespace JSC {
69
70 class VM;
71 void releaseExecutableMemory(VM&);
72
73 static const unsigned jitAllocationGranule = 32;
74
75 typedef WTF::MetaAllocatorHandle ExecutableMemoryHandle;
76
77 #if ENABLE(ASSEMBLER)
78
79 #if ENABLE(EXECUTABLE_ALLOCATOR_DEMAND)
80 class DemandExecutableAllocator;
81 #endif
82
83 #if ENABLE(EXECUTABLE_ALLOCATOR_FIXED)
84 #if CPU(ARM) || CPU(ARM64)
85 static const size_t fixedExecutableMemoryPoolSize = 16 * 1024 * 1024;
86 #elif CPU(X86_64)
87 static const size_t fixedExecutableMemoryPoolSize = 1024 * 1024 * 1024;
88 #else
89 static const size_t fixedExecutableMemoryPoolSize = 32 * 1024 * 1024;
90 #endif
91
92 extern uintptr_t startOfFixedExecutableMemoryPool;
93 #endif
94
95 class ExecutableAllocator {
96     enum ProtectionSetting { Writable, Executable };
97
98 public:
99     ExecutableAllocator(VM&);
100     ~ExecutableAllocator();
101     
102     static void initializeAllocator();
103
104     bool isValid() const;
105
106     static bool underMemoryPressure();
107     
108     static double memoryPressureMultiplier(size_t addedMemoryUsage);
109     
110 #if ENABLE(META_ALLOCATOR_PROFILE)
111     static void dumpProfile();
112 #else
113     static void dumpProfile() { }
114 #endif
115
116     PassRefPtr<ExecutableMemoryHandle> allocate(VM&, size_t sizeInBytes, void* ownerUID, JITCompilationEffort);
117
118 #if ENABLE(ASSEMBLER_WX_EXCLUSIVE)
119     static void makeWritable(void* start, size_t size)
120     {
121         reprotectRegion(start, size, Writable);
122     }
123
124     static void makeExecutable(void* start, size_t size)
125     {
126         reprotectRegion(start, size, Executable);
127     }
128 #else
129     static void makeWritable(void*, size_t) {}
130     static void makeExecutable(void*, size_t) {}
131 #endif
132
133     static size_t committedByteCount();
134
135 private:
136
137 #if ENABLE(ASSEMBLER_WX_EXCLUSIVE)
138     static void reprotectRegion(void*, size_t, ProtectionSetting);
139 #if ENABLE(EXECUTABLE_ALLOCATOR_DEMAND)
140     // We create a MetaAllocator for each JS global object.
141     std::unique_ptr<DemandExecutableAllocator> m_allocator;
142     DemandExecutableAllocator* allocator() { return m_allocator.get(); }
143 #endif
144 #endif
145
146 };
147
148 #endif // ENABLE(JIT) && ENABLE(ASSEMBLER)
149
150 } // namespace JSC
151
152 #endif // !defined(ExecutableAllocator)