03564b5d74ece7c8b0577baf0cfae9fbe5aa990a
[WebKit-https.git] / Source / JavaScriptCore / assembler / MacroAssemblerCodeRef.h
1 /*
2  * Copyright (C) 2009-2018 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 #pragma once
27
28 #include "ExecutableAllocator.h"
29 #include "JSCPoison.h"
30 #include <wtf/DataLog.h>
31 #include <wtf/PrintStream.h>
32 #include <wtf/RefPtr.h>
33 #include <wtf/text/CString.h>
34
35 // ASSERT_VALID_CODE_POINTER checks that ptr is a non-null pointer, and that it is a valid
36 // instruction address on the platform (for example, check any alignment requirements).
37 #if CPU(ARM_THUMB2) && ENABLE(JIT)
38 // ARM instructions must be 16-bit aligned. Thumb2 code pointers to be loaded into
39 // into the processor are decorated with the bottom bit set, while traditional ARM has
40 // the lower bit clear. Since we don't know what kind of pointer, we check for both
41 // decorated and undecorated null.
42 #define ASSERT_VALID_CODE_POINTER(ptr) \
43     ASSERT(reinterpret_cast<intptr_t>(ptr) & ~1)
44 #define ASSERT_VALID_CODE_OFFSET(offset) \
45     ASSERT(!(offset & 1)) // Must be multiple of 2.
46 #else
47 #define ASSERT_VALID_CODE_POINTER(ptr) \
48     ASSERT(ptr)
49 #define ASSERT_VALID_CODE_OFFSET(offset) // Anything goes!
50 #endif
51
52 namespace JSC {
53
54 class MacroAssemblerCodePtr;
55
56 enum OpcodeID : unsigned;
57
58 // FunctionPtr:
59 //
60 // FunctionPtr should be used to wrap pointers to C/C++ functions in JSC
61 // (particularly, the stub functions).
62 class FunctionPtr {
63 public:
64     FunctionPtr() { }
65
66     template<typename returnType, typename... Arguments>
67     FunctionPtr(returnType(*value)(Arguments...))
68         : m_value(reinterpret_cast<void*>(value))
69     {
70         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
71         ASSERT_VALID_CODE_POINTER(m_value);
72     }
73
74 // MSVC doesn't seem to treat functions with different calling conventions as
75 // different types; these methods already defined for fastcall, below.
76 #if CALLING_CONVENTION_IS_STDCALL && !OS(WINDOWS)
77
78     template<typename returnType, typename... Arguments>
79     FunctionPtr(returnType(CDECL *value)(Arguments...))
80         : m_value(reinterpret_cast<void*>(value))
81     {
82         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
83         ASSERT_VALID_CODE_POINTER(m_value);
84     }
85
86 #endif // CALLING_CONVENTION_IS_STDCALL && !OS(WINDOWS)
87
88 #if COMPILER_SUPPORTS(FASTCALL_CALLING_CONVENTION)
89
90     template<typename returnType, typename... Arguments>
91     FunctionPtr(returnType(FASTCALL *value)(Arguments...))
92         : m_value(reinterpret_cast<void*>(value))
93     {
94         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
95         ASSERT_VALID_CODE_POINTER(m_value);
96     }
97
98 #endif // COMPILER_SUPPORTS(FASTCALL_CALLING_CONVENTION)
99
100     template<typename FunctionType>
101     explicit FunctionPtr(FunctionType* value)
102         // Using a C-ctyle cast here to avoid compiler error on RVTC:
103         // Error:  #694: reinterpret_cast cannot cast away const or other type qualifiers
104         // (I guess on RVTC function pointers have a different constness to GCC/MSVC?)
105         : m_value((void*)value)
106     {
107         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
108         ASSERT_VALID_CODE_POINTER(m_value);
109     }
110
111     explicit FunctionPtr(MacroAssemblerCodePtr);
112
113     void* value() const
114     {
115         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
116         return m_value;
117     }
118     void* executableAddress() const
119     {
120         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
121         return m_value;
122     }
123
124 private:
125     void* m_value { nullptr };
126 };
127
128 // ReturnAddressPtr:
129 //
130 // ReturnAddressPtr should be used to wrap return addresses generated by processor
131 // 'call' instructions exectued in JIT code.  We use return addresses to look up
132 // exception and optimization information, and to repatch the call instruction
133 // that is the source of the return address.
134 class ReturnAddressPtr {
135 public:
136     ReturnAddressPtr() { }
137
138     explicit ReturnAddressPtr(void* value)
139         : m_value(value)
140     {
141         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
142         ASSERT_VALID_CODE_POINTER(m_value);
143     }
144
145     explicit ReturnAddressPtr(FunctionPtr function)
146         : m_value(function.value())
147     {
148         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
149         ASSERT_VALID_CODE_POINTER(m_value);
150     }
151
152     void* value() const
153     {
154         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
155         return m_value;
156     }
157     
158     void dump(PrintStream& out) const
159     {
160         out.print(RawPointer(m_value));
161     }
162
163 private:
164     void* m_value { nullptr };
165 };
166
167 // MacroAssemblerCodePtr:
168 //
169 // MacroAssemblerCodePtr should be used to wrap pointers to JIT generated code.
170 class MacroAssemblerCodePtr {
171 public:
172     MacroAssemblerCodePtr() { }
173
174     explicit MacroAssemblerCodePtr(void* value)
175 #if CPU(ARM_THUMB2)
176         // Decorate the pointer as a thumb code pointer.
177         : m_value(reinterpret_cast<char*>(value) + 1)
178 #else
179         : m_value(value)
180 #endif
181     {
182         m_value.assertIsPoisoned();
183         ASSERT(value);
184         ASSERT_VALID_CODE_POINTER(m_value.unpoisoned());
185     }
186     
187     static MacroAssemblerCodePtr createFromExecutableAddress(void* value)
188     {
189         ASSERT(value);
190         ASSERT_VALID_CODE_POINTER(value);
191         MacroAssemblerCodePtr result;
192         result.m_value = PoisonedMasmPtr(value);
193         result.m_value.assertIsPoisoned();
194         return result;
195     }
196
197     static MacroAssemblerCodePtr createLLIntCodePtr(OpcodeID codeId);
198
199     explicit MacroAssemblerCodePtr(ReturnAddressPtr ra)
200         : m_value(ra.value())
201     {
202         ASSERT(ra.value());
203         m_value.assertIsPoisoned();
204         ASSERT_VALID_CODE_POINTER(m_value.unpoisoned());
205     }
206
207     PoisonedMasmPtr poisonedPtr() const { return m_value; }
208
209     template<typename T = void*>
210     T executableAddress() const
211     {
212         m_value.assertIsPoisoned();
213         return m_value.unpoisoned<T>();
214     }
215 #if CPU(ARM_THUMB2)
216     // To use this pointer as a data address remove the decoration.
217     template<typename T = void*>
218     T dataLocation() const
219     {
220         m_value.assertIsPoisoned();
221         ASSERT_VALID_CODE_POINTER(m_value.unpoisoned());
222         return bitwise_cast<T>(m_value ? m_value.unpoisoned<char*>() - 1 : nullptr);
223     }
224 #else
225     template<typename T = void*>
226     T dataLocation() const
227     {
228         m_value.assertIsPoisoned();
229         ASSERT_VALID_CODE_POINTER(m_value);
230         return m_value.unpoisoned<T>();
231     }
232 #endif
233
234     bool operator!() const
235     {
236 #if ENABLE(POISON_ASSERTS)
237         if (!isEmptyValue() && !isDeletedValue())
238             m_value.assertIsPoisoned();
239 #endif
240         return !m_value;
241     }
242     explicit operator bool() const { return !(!*this); }
243     
244     bool operator==(const MacroAssemblerCodePtr& other) const
245     {
246 #if ENABLE(POISON_ASSERTS)
247         if (!isEmptyValue() && !isDeletedValue())
248             m_value.assertIsPoisoned();
249         if (!other.isEmptyValue() && !other.isDeletedValue())
250             other.m_value.assertIsPoisoned();
251 #endif
252         return m_value == other.m_value;
253     }
254
255     // Disallow any casting operations (except for booleans). Instead, the client
256     // should be asking for poisonedPtr() or executableAddress() explicitly.
257     template<typename T, typename = std::enable_if_t<!std::is_same<T, bool>::value>>
258     operator T() = delete;
259
260     void dumpWithName(const char* name, PrintStream& out) const;
261     
262     void dump(PrintStream& out) const;
263     
264     enum EmptyValueTag { EmptyValue };
265     enum DeletedValueTag { DeletedValue };
266     
267     MacroAssemblerCodePtr(EmptyValueTag)
268         : m_value(emptyValue())
269     { }
270     
271     MacroAssemblerCodePtr(DeletedValueTag)
272         : m_value(deletedValue())
273     { }
274     
275     bool isEmptyValue() const { return m_value == emptyValue(); }
276     bool isDeletedValue() const { return m_value == deletedValue(); }
277
278     unsigned hash() const { return IntHash<uintptr_t>::hash(m_value.bits()); }
279
280     static void initialize();
281
282 private:
283     static PoisonedMasmPtr emptyValue() { return PoisonedMasmPtr(AlreadyPoisoned, 1); }
284     static PoisonedMasmPtr deletedValue() { return PoisonedMasmPtr(AlreadyPoisoned, 2); }
285
286     PoisonedMasmPtr m_value;
287 };
288
289 struct MacroAssemblerCodePtrHash {
290     static unsigned hash(const MacroAssemblerCodePtr& ptr) { return ptr.hash(); }
291     static bool equal(const MacroAssemblerCodePtr& a, const MacroAssemblerCodePtr& b)
292     {
293         return a == b;
294     }
295     static const bool safeToCompareToEmptyOrDeleted = true;
296 };
297
298 // MacroAssemblerCodeRef:
299 //
300 // A reference to a section of JIT generated code.  A CodeRef consists of a
301 // pointer to the code, and a ref pointer to the pool from within which it
302 // was allocated.
303 class MacroAssemblerCodeRef {
304 private:
305     // This is private because it's dangerous enough that we want uses of it
306     // to be easy to find - hence the static create method below.
307     explicit MacroAssemblerCodeRef(MacroAssemblerCodePtr codePtr)
308         : m_codePtr(codePtr)
309     {
310         ASSERT(m_codePtr);
311     }
312
313 public:
314     MacroAssemblerCodeRef()
315     {
316     }
317
318     MacroAssemblerCodeRef(Ref<ExecutableMemoryHandle>&& executableMemory)
319         : m_codePtr(executableMemory->start())
320         , m_executableMemory(WTFMove(executableMemory))
321     {
322         ASSERT(m_executableMemory->isManaged());
323         ASSERT(m_executableMemory->start());
324         ASSERT(m_codePtr);
325     }
326     
327     // Use this only when you know that the codePtr refers to code that is
328     // already being kept alive through some other means. Typically this means
329     // that codePtr is immortal.
330     static MacroAssemblerCodeRef createSelfManagedCodeRef(MacroAssemblerCodePtr codePtr)
331     {
332         return MacroAssemblerCodeRef(codePtr);
333     }
334     
335     // Helper for creating self-managed code refs from LLInt.
336     static MacroAssemblerCodeRef createLLIntCodeRef(OpcodeID codeId);
337
338     ExecutableMemoryHandle* executableMemory() const
339     {
340         return m_executableMemory.get();
341     }
342     
343     MacroAssemblerCodePtr code() const
344     {
345         return m_codePtr;
346     }
347     
348     size_t size() const
349     {
350         if (!m_executableMemory)
351             return 0;
352         return m_executableMemory->sizeInBytes();
353     }
354
355     bool tryToDisassemble(PrintStream& out, const char* prefix = "") const;
356     
357     bool tryToDisassemble(const char* prefix = "") const;
358     
359     JS_EXPORT_PRIVATE CString disassembly() const;
360     
361     explicit operator bool() const { return !!m_codePtr; }
362     
363     void dump(PrintStream& out) const;
364
365 private:
366     MacroAssemblerCodePtr m_codePtr;
367     RefPtr<ExecutableMemoryHandle> m_executableMemory;
368 };
369
370 inline FunctionPtr::FunctionPtr(MacroAssemblerCodePtr ptr)
371     : m_value(ptr.executableAddress())
372 {
373     PoisonedMasmPtr::assertIsNotPoisoned(m_value);
374     ASSERT_VALID_CODE_POINTER(m_value);
375 }
376
377 } // namespace JSC
378
379 namespace WTF {
380
381 template<typename T> struct DefaultHash;
382 template<> struct DefaultHash<JSC::MacroAssemblerCodePtr> {
383     typedef JSC::MacroAssemblerCodePtrHash Hash;
384 };
385
386 template<typename T> struct HashTraits;
387 template<> struct HashTraits<JSC::MacroAssemblerCodePtr> : public CustomHashTraits<JSC::MacroAssemblerCodePtr> { };
388
389 } // namespace WTF