Refactoring: Rename ScrambledPtr to Poisoned.
[WebKit-https.git] / Source / JavaScriptCore / assembler / MacroAssemblerCodeRef.h
1 /*
2  * Copyright (C) 2009-2017 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 "JSCPoisonedPtr.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>
67     FunctionPtr(returnType(*value)())
68         : m_value((void*)value)
69     {
70         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
71         ASSERT_VALID_CODE_POINTER(m_value);
72     }
73
74     template<typename returnType, typename argType1>
75     FunctionPtr(returnType(*value)(argType1))
76         : m_value((void*)value)
77     {
78         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
79         ASSERT_VALID_CODE_POINTER(m_value);
80     }
81
82     template<typename returnType, typename argType1, typename argType2>
83     FunctionPtr(returnType(*value)(argType1, argType2))
84         : m_value((void*)value)
85     {
86         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
87         ASSERT_VALID_CODE_POINTER(m_value);
88     }
89
90     template<typename returnType, typename argType1, typename argType2, typename argType3>
91     FunctionPtr(returnType(*value)(argType1, argType2, argType3))
92         : m_value((void*)value)
93     {
94         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
95         ASSERT_VALID_CODE_POINTER(m_value);
96     }
97
98     template<typename returnType, typename argType1, typename argType2, typename argType3, typename argType4>
99     FunctionPtr(returnType(*value)(argType1, argType2, argType3, argType4))
100         : m_value((void*)value)
101     {
102         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
103         ASSERT_VALID_CODE_POINTER(m_value);
104     }
105
106     template<typename returnType, typename argType1, typename argType2, typename argType3, typename argType4, typename argType5>
107     FunctionPtr(returnType(*value)(argType1, argType2, argType3, argType4, argType5))
108         : m_value((void*)value)
109     {
110         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
111         ASSERT_VALID_CODE_POINTER(m_value);
112     }
113
114     template<typename returnType, typename argType1, typename argType2, typename argType3, typename argType4, typename argType5, typename argType6>
115     FunctionPtr(returnType(*value)(argType1, argType2, argType3, argType4, argType5, argType6))
116         : m_value((void*)value)
117     {
118         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
119         ASSERT_VALID_CODE_POINTER(m_value);
120     }
121 // MSVC doesn't seem to treat functions with different calling conventions as
122 // different types; these methods already defined for fastcall, below.
123 #if CALLING_CONVENTION_IS_STDCALL && !OS(WINDOWS)
124
125     template<typename returnType>
126     FunctionPtr(returnType (CDECL *value)())
127         : m_value((void*)value)
128     {
129         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
130         ASSERT_VALID_CODE_POINTER(m_value);
131     }
132
133     template<typename returnType, typename argType1>
134     FunctionPtr(returnType (CDECL *value)(argType1))
135         : m_value((void*)value)
136     {
137         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
138         ASSERT_VALID_CODE_POINTER(m_value);
139     }
140
141     template<typename returnType, typename argType1, typename argType2>
142     FunctionPtr(returnType (CDECL *value)(argType1, argType2))
143         : m_value((void*)value)
144     {
145         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
146         ASSERT_VALID_CODE_POINTER(m_value);
147     }
148
149     template<typename returnType, typename argType1, typename argType2, typename argType3>
150     FunctionPtr(returnType (CDECL *value)(argType1, argType2, argType3))
151         : m_value((void*)value)
152     {
153         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
154         ASSERT_VALID_CODE_POINTER(m_value);
155     }
156
157     template<typename returnType, typename argType1, typename argType2, typename argType3, typename argType4>
158     FunctionPtr(returnType (CDECL *value)(argType1, argType2, argType3, argType4))
159         : m_value((void*)value)
160     {
161         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
162         ASSERT_VALID_CODE_POINTER(m_value);
163     }
164 #endif
165
166 #if COMPILER_SUPPORTS(FASTCALL_CALLING_CONVENTION)
167
168     template<typename returnType>
169     FunctionPtr(returnType (FASTCALL *value)())
170         : m_value((void*)value)
171     {
172         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
173         ASSERT_VALID_CODE_POINTER(m_value);
174     }
175
176     template<typename returnType, typename argType1>
177     FunctionPtr(returnType (FASTCALL *value)(argType1))
178         : m_value((void*)value)
179     {
180         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
181         ASSERT_VALID_CODE_POINTER(m_value);
182     }
183
184     template<typename returnType, typename argType1, typename argType2>
185     FunctionPtr(returnType (FASTCALL *value)(argType1, argType2))
186         : m_value((void*)value)
187     {
188         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
189         ASSERT_VALID_CODE_POINTER(m_value);
190     }
191
192     template<typename returnType, typename argType1, typename argType2, typename argType3>
193     FunctionPtr(returnType (FASTCALL *value)(argType1, argType2, argType3))
194         : m_value((void*)value)
195     {
196         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
197         ASSERT_VALID_CODE_POINTER(m_value);
198     }
199
200     template<typename returnType, typename argType1, typename argType2, typename argType3, typename argType4>
201     FunctionPtr(returnType (FASTCALL *value)(argType1, argType2, argType3, argType4))
202         : m_value((void*)value)
203     {
204         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
205         ASSERT_VALID_CODE_POINTER(m_value);
206     }
207 #endif
208
209     template<typename FunctionType>
210     explicit FunctionPtr(FunctionType* value)
211         // Using a C-ctyle cast here to avoid compiler error on RVTC:
212         // Error:  #694: reinterpret_cast cannot cast away const or other type qualifiers
213         // (I guess on RVTC function pointers have a different constness to GCC/MSVC?)
214         : m_value((void*)value)
215     {
216         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
217         ASSERT_VALID_CODE_POINTER(m_value);
218     }
219
220     explicit FunctionPtr(MacroAssemblerCodePtr);
221
222     void* value() const
223     {
224         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
225         return m_value;
226     }
227     void* executableAddress() const
228     {
229         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
230         return m_value;
231     }
232
233 private:
234     void* m_value { nullptr };
235 };
236
237 // ReturnAddressPtr:
238 //
239 // ReturnAddressPtr should be used to wrap return addresses generated by processor
240 // 'call' instructions exectued in JIT code.  We use return addresses to look up
241 // exception and optimization information, and to repatch the call instruction
242 // that is the source of the return address.
243 class ReturnAddressPtr {
244 public:
245     ReturnAddressPtr() { }
246
247     explicit ReturnAddressPtr(void* value)
248         : m_value(value)
249     {
250         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
251         ASSERT_VALID_CODE_POINTER(m_value);
252     }
253
254     explicit ReturnAddressPtr(FunctionPtr function)
255         : m_value(function.value())
256     {
257         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
258         ASSERT_VALID_CODE_POINTER(m_value);
259     }
260
261     void* value() const
262     {
263         PoisonedMasmPtr::assertIsNotPoisoned(m_value);
264         return m_value;
265     }
266     
267     void dump(PrintStream& out) const
268     {
269         out.print(RawPointer(m_value));
270     }
271
272 private:
273     void* m_value { nullptr };
274 };
275
276 // MacroAssemblerCodePtr:
277 //
278 // MacroAssemblerCodePtr should be used to wrap pointers to JIT generated code.
279 class MacroAssemblerCodePtr {
280 public:
281     MacroAssemblerCodePtr() { }
282
283     explicit MacroAssemblerCodePtr(void* value)
284 #if CPU(ARM_THUMB2)
285         // Decorate the pointer as a thumb code pointer.
286         : m_value(reinterpret_cast<char*>(value) + 1)
287 #else
288         : m_value(value)
289 #endif
290     {
291         m_value.assertIsPoisoned();
292         ASSERT(value);
293         ASSERT_VALID_CODE_POINTER(m_value);
294     }
295     
296     static MacroAssemblerCodePtr createFromExecutableAddress(void* value)
297     {
298         ASSERT(value);
299         ASSERT_VALID_CODE_POINTER(value);
300         MacroAssemblerCodePtr result;
301         result.m_value = PoisonedMasmPtr(value);
302         result.m_value.assertIsPoisoned();
303         return result;
304     }
305
306     static MacroAssemblerCodePtr createLLIntCodePtr(OpcodeID codeId);
307
308     explicit MacroAssemblerCodePtr(ReturnAddressPtr ra)
309         : m_value(ra.value())
310     {
311         ASSERT(ra.value());
312         m_value.assertIsPoisoned();
313         ASSERT_VALID_CODE_POINTER(m_value);
314     }
315
316     PoisonedMasmPtr poisonedPtr() const { return m_value; }
317
318     template<typename T = void*>
319     T executableAddress() const
320     {
321         m_value.assertIsPoisoned();
322         return m_value.unpoisoned<T>();
323     }
324 #if CPU(ARM_THUMB2)
325     // To use this pointer as a data address remove the decoration.
326     template<typename T = void*>
327     T dataLocation() const
328     {
329         m_value.assertIsPoisoned();
330         ASSERT_VALID_CODE_POINTER(m_value);
331         return bitwise_cast<T>(m_value ? m_value.unpoisoned<char*>() - 1 : nullptr);
332     }
333 #else
334     template<typename T = void*>
335     T dataLocation() const
336     {
337         m_value.assertIsPoisoned();
338         ASSERT_VALID_CODE_POINTER(m_value);
339         return m_value.unpoisoned<T>();
340     }
341 #endif
342
343     bool operator!() const
344     {
345 #if ENABLE(POISON_ASSERTS)
346         if (!isEmptyValue() && !isDeletedValue())
347             m_value.assertIsPoisoned();
348 #endif
349         return !m_value;
350     }
351     explicit operator bool() const { return !(!*this); }
352     
353     bool operator==(const MacroAssemblerCodePtr& other) const
354     {
355 #if ENABLE(POISON_ASSERTS)
356         if (!isEmptyValue() && !isDeletedValue())
357             m_value.assertIsPoisoned();
358         if (!other.isEmptyValue() && !other.isDeletedValue())
359             other.m_value.assertIsPoisoned();
360 #endif
361         return m_value == other.m_value;
362     }
363
364     // Disallow any casting operations (except for booleans). Instead, the client
365     // should be asking for poisonedPtr() or executableAddress() explicitly.
366     template<typename T, typename = std::enable_if_t<!std::is_same<T, bool>::value>>
367     operator T() = delete;
368
369     void dumpWithName(const char* name, PrintStream& out) const;
370     
371     void dump(PrintStream& out) const;
372     
373     enum EmptyValueTag { EmptyValue };
374     enum DeletedValueTag { DeletedValue };
375     
376     MacroAssemblerCodePtr(EmptyValueTag)
377         : m_value(emptyValue())
378     { }
379     
380     MacroAssemblerCodePtr(DeletedValueTag)
381         : m_value(deletedValue())
382     { }
383     
384     bool isEmptyValue() const { return m_value == emptyValue(); }
385     bool isDeletedValue() const { return m_value == deletedValue(); }
386
387     unsigned hash() const { return IntHash<uintptr_t>::hash(m_value.bits()); }
388
389     static void initialize();
390
391 private:
392     static PoisonedMasmPtr emptyValue() { return PoisonedMasmPtr(1); }
393     static PoisonedMasmPtr deletedValue() { return PoisonedMasmPtr(2); }
394
395     PoisonedMasmPtr m_value;
396 };
397
398 struct MacroAssemblerCodePtrHash {
399     static unsigned hash(const MacroAssemblerCodePtr& ptr) { return ptr.hash(); }
400     static bool equal(const MacroAssemblerCodePtr& a, const MacroAssemblerCodePtr& b)
401     {
402         return a == b;
403     }
404     static const bool safeToCompareToEmptyOrDeleted = true;
405 };
406
407 // MacroAssemblerCodeRef:
408 //
409 // A reference to a section of JIT generated code.  A CodeRef consists of a
410 // pointer to the code, and a ref pointer to the pool from within which it
411 // was allocated.
412 class MacroAssemblerCodeRef {
413 private:
414     // This is private because it's dangerous enough that we want uses of it
415     // to be easy to find - hence the static create method below.
416     explicit MacroAssemblerCodeRef(MacroAssemblerCodePtr codePtr)
417         : m_codePtr(codePtr)
418     {
419         ASSERT(m_codePtr);
420     }
421
422 public:
423     MacroAssemblerCodeRef()
424     {
425     }
426
427     MacroAssemblerCodeRef(Ref<ExecutableMemoryHandle>&& executableMemory)
428         : m_codePtr(executableMemory->start())
429         , m_executableMemory(WTFMove(executableMemory))
430     {
431         ASSERT(m_executableMemory->isManaged());
432         ASSERT(m_executableMemory->start());
433         ASSERT(m_codePtr);
434     }
435     
436     // Use this only when you know that the codePtr refers to code that is
437     // already being kept alive through some other means. Typically this means
438     // that codePtr is immortal.
439     static MacroAssemblerCodeRef createSelfManagedCodeRef(MacroAssemblerCodePtr codePtr)
440     {
441         return MacroAssemblerCodeRef(codePtr);
442     }
443     
444     // Helper for creating self-managed code refs from LLInt.
445     static MacroAssemblerCodeRef createLLIntCodeRef(OpcodeID codeId);
446
447     ExecutableMemoryHandle* executableMemory() const
448     {
449         return m_executableMemory.get();
450     }
451     
452     MacroAssemblerCodePtr code() const
453     {
454         return m_codePtr;
455     }
456     
457     size_t size() const
458     {
459         if (!m_executableMemory)
460             return 0;
461         return m_executableMemory->sizeInBytes();
462     }
463
464     bool tryToDisassemble(PrintStream& out, const char* prefix = "") const;
465     
466     bool tryToDisassemble(const char* prefix = "") const;
467     
468     JS_EXPORT_PRIVATE CString disassembly() const;
469     
470     explicit operator bool() const { return !!m_codePtr; }
471     
472     void dump(PrintStream& out) const;
473
474 private:
475     MacroAssemblerCodePtr m_codePtr;
476     RefPtr<ExecutableMemoryHandle> m_executableMemory;
477 };
478
479 inline FunctionPtr::FunctionPtr(MacroAssemblerCodePtr ptr)
480     : m_value(ptr.executableAddress())
481 {
482     PoisonedMasmPtr::assertIsNotPoisoned(m_value);
483     ASSERT_VALID_CODE_POINTER(m_value);
484 }
485
486 } // namespace JSC
487
488 namespace WTF {
489
490 template<typename T> struct DefaultHash;
491 template<> struct DefaultHash<JSC::MacroAssemblerCodePtr> {
492     typedef JSC::MacroAssemblerCodePtrHash Hash;
493 };
494
495 template<typename T> struct HashTraits;
496 template<> struct HashTraits<JSC::MacroAssemblerCodePtr> : public CustomHashTraits<JSC::MacroAssemblerCodePtr> { };
497
498 } // namespace WTF