Roll out r108309, r108323, and r108326
[WebKit-https.git] / Source / JavaScriptCore / assembler / MacroAssemblerCodeRef.h
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 #ifndef MacroAssemblerCodeRef_h
27 #define MacroAssemblerCodeRef_h
28
29 #include "ExecutableAllocator.h"
30 #include "PassRefPtr.h"
31 #include "RefPtr.h"
32 #include "UnusedParam.h"
33
34 #if ENABLE(ASSEMBLER)
35
36 // ASSERT_VALID_CODE_POINTER checks that ptr is a non-null pointer, and that it is a valid
37 // instruction address on the platform (for example, check any alignment requirements).
38 #if CPU(ARM_THUMB2)
39 // ARM/thumb instructions must be 16-bit aligned, but all code pointers to be loaded
40 // into the processor are decorated with the bottom bit set, indicating that this is
41 // thumb code (as oposed to 32-bit traditional ARM).  The first test checks for both
42 // decorated and undectorated null, and the second test ensures that the pointer is
43 // decorated.
44 #define ASSERT_VALID_CODE_POINTER(ptr) \
45     ASSERT(reinterpret_cast<intptr_t>(ptr) & ~1); \
46     ASSERT(reinterpret_cast<intptr_t>(ptr) & 1)
47 #define ASSERT_VALID_CODE_OFFSET(offset) \
48     ASSERT(!(offset & 1)) // Must be multiple of 2.
49 #else
50 #define ASSERT_VALID_CODE_POINTER(ptr) \
51     ASSERT(ptr)
52 #define ASSERT_VALID_CODE_OFFSET(offset) // Anything goes!
53 #endif
54
55 #if CPU(X86) && OS(WINDOWS)
56 #define CALLING_CONVENTION_IS_STDCALL 1
57 #ifndef CDECL
58 #if COMPILER(MSVC)
59 #define CDECL __cdecl
60 #else
61 #define CDECL __attribute__ ((__cdecl))
62 #endif // COMPILER(MSVC)
63 #endif // CDECL
64 #else
65 #define CALLING_CONVENTION_IS_STDCALL 0
66 #endif
67
68 #if CPU(X86)
69 #define HAS_FASTCALL_CALLING_CONVENTION 1
70 #ifndef FASTCALL
71 #if COMPILER(MSVC)
72 #define FASTCALL __fastcall
73 #else
74 #define FASTCALL  __attribute__ ((fastcall))
75 #endif // COMPILER(MSVC)
76 #endif // FASTCALL
77 #else
78 #define HAS_FASTCALL_CALLING_CONVENTION 0
79 #endif // CPU(X86)
80
81 namespace JSC {
82
83 // FunctionPtr:
84 //
85 // FunctionPtr should be used to wrap pointers to C/C++ functions in JSC
86 // (particularly, the stub functions).
87 class FunctionPtr {
88 public:
89     FunctionPtr()
90         : m_value(0)
91     {
92     }
93
94     template<typename returnType>
95     FunctionPtr(returnType(*value)())
96         : m_value((void*)value)
97     {
98         ASSERT_VALID_CODE_POINTER(m_value);
99     }
100
101     template<typename returnType, typename argType1>
102     FunctionPtr(returnType(*value)(argType1))
103         : m_value((void*)value)
104     {
105         ASSERT_VALID_CODE_POINTER(m_value);
106     }
107
108     template<typename returnType, typename argType1, typename argType2>
109     FunctionPtr(returnType(*value)(argType1, argType2))
110         : m_value((void*)value)
111     {
112         ASSERT_VALID_CODE_POINTER(m_value);
113     }
114
115     template<typename returnType, typename argType1, typename argType2, typename argType3>
116     FunctionPtr(returnType(*value)(argType1, argType2, argType3))
117         : m_value((void*)value)
118     {
119         ASSERT_VALID_CODE_POINTER(m_value);
120     }
121
122     template<typename returnType, typename argType1, typename argType2, typename argType3, typename argType4>
123     FunctionPtr(returnType(*value)(argType1, argType2, argType3, argType4))
124         : m_value((void*)value)
125     {
126         ASSERT_VALID_CODE_POINTER(m_value);
127     }
128
129 // MSVC doesn't seem to treat functions with different calling conventions as
130 // different types; these methods already defined for fastcall, below.
131 #if CALLING_CONVENTION_IS_STDCALL && !OS(WINDOWS)
132
133     template<typename returnType>
134     FunctionPtr(returnType (CDECL *value)())
135         : m_value((void*)value)
136     {
137         ASSERT_VALID_CODE_POINTER(m_value);
138     }
139
140     template<typename returnType, typename argType1>
141     FunctionPtr(returnType (CDECL *value)(argType1))
142         : m_value((void*)value)
143     {
144         ASSERT_VALID_CODE_POINTER(m_value);
145     }
146
147     template<typename returnType, typename argType1, typename argType2>
148     FunctionPtr(returnType (CDECL *value)(argType1, argType2))
149         : m_value((void*)value)
150     {
151         ASSERT_VALID_CODE_POINTER(m_value);
152     }
153
154     template<typename returnType, typename argType1, typename argType2, typename argType3>
155     FunctionPtr(returnType (CDECL *value)(argType1, argType2, argType3))
156         : m_value((void*)value)
157     {
158         ASSERT_VALID_CODE_POINTER(m_value);
159     }
160
161     template<typename returnType, typename argType1, typename argType2, typename argType3, typename argType4>
162     FunctionPtr(returnType (CDECL *value)(argType1, argType2, argType3, argType4))
163         : m_value((void*)value)
164     {
165         ASSERT_VALID_CODE_POINTER(m_value);
166     }
167 #endif
168
169 #if HAS_FASTCALL_CALLING_CONVENTION
170
171     template<typename returnType>
172     FunctionPtr(returnType (FASTCALL *value)())
173         : m_value((void*)value)
174     {
175         ASSERT_VALID_CODE_POINTER(m_value);
176     }
177
178     template<typename returnType, typename argType1>
179     FunctionPtr(returnType (FASTCALL *value)(argType1))
180         : m_value((void*)value)
181     {
182         ASSERT_VALID_CODE_POINTER(m_value);
183     }
184
185     template<typename returnType, typename argType1, typename argType2>
186     FunctionPtr(returnType (FASTCALL *value)(argType1, argType2))
187         : m_value((void*)value)
188     {
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         ASSERT_VALID_CODE_POINTER(m_value);
197     }
198
199     template<typename returnType, typename argType1, typename argType2, typename argType3, typename argType4>
200     FunctionPtr(returnType (FASTCALL *value)(argType1, argType2, argType3, argType4))
201         : m_value((void*)value)
202     {
203         ASSERT_VALID_CODE_POINTER(m_value);
204     }
205 #endif
206
207     template<typename FunctionType>
208     explicit FunctionPtr(FunctionType* value)
209         // Using a C-ctyle cast here to avoid compiler error on RVTC:
210         // Error:  #694: reinterpret_cast cannot cast away const or other type qualifiers
211         // (I guess on RVTC function pointers have a different constness to GCC/MSVC?)
212         : m_value((void*)value)
213     {
214         ASSERT_VALID_CODE_POINTER(m_value);
215     }
216
217     void* value() const { return m_value; }
218     void* executableAddress() const { return m_value; }
219
220
221 private:
222     void* m_value;
223 };
224
225 // ReturnAddressPtr:
226 //
227 // ReturnAddressPtr should be used to wrap return addresses generated by processor
228 // 'call' instructions exectued in JIT code.  We use return addresses to look up
229 // exception and optimization information, and to repatch the call instruction
230 // that is the source of the return address.
231 class ReturnAddressPtr {
232 public:
233     ReturnAddressPtr()
234         : m_value(0)
235     {
236     }
237
238     explicit ReturnAddressPtr(void* value)
239         : m_value(value)
240     {
241         ASSERT_VALID_CODE_POINTER(m_value);
242     }
243
244     explicit ReturnAddressPtr(FunctionPtr function)
245         : m_value(function.value())
246     {
247         ASSERT_VALID_CODE_POINTER(m_value);
248     }
249
250     void* value() const { return m_value; }
251
252 private:
253     void* m_value;
254 };
255
256 // MacroAssemblerCodePtr:
257 //
258 // MacroAssemblerCodePtr should be used to wrap pointers to JIT generated code.
259 class MacroAssemblerCodePtr {
260 public:
261     MacroAssemblerCodePtr()
262         : m_value(0)
263     {
264     }
265
266     explicit MacroAssemblerCodePtr(void* value)
267 #if CPU(ARM_THUMB2)
268         // Decorate the pointer as a thumb code pointer.
269         : m_value(reinterpret_cast<char*>(value) + 1)
270 #else
271         : m_value(value)
272 #endif
273     {
274         ASSERT_VALID_CODE_POINTER(m_value);
275     }
276
277     explicit MacroAssemblerCodePtr(ReturnAddressPtr ra)
278         : m_value(ra.value())
279     {
280         ASSERT_VALID_CODE_POINTER(m_value);
281     }
282
283     void* executableAddress() const { return m_value; }
284 #if CPU(ARM_THUMB2)
285     // To use this pointer as a data address remove the decoration.
286     void* dataLocation() const { ASSERT_VALID_CODE_POINTER(m_value); return reinterpret_cast<char*>(m_value) - 1; }
287 #else
288     void* dataLocation() const { ASSERT_VALID_CODE_POINTER(m_value); return m_value; }
289 #endif
290
291     bool operator!() const
292     {
293         return !m_value;
294     }
295
296 private:
297     void* m_value;
298 };
299
300 // MacroAssemblerCodeRef:
301 //
302 // A reference to a section of JIT generated code.  A CodeRef consists of a
303 // pointer to the code, and a ref pointer to the pool from within which it
304 // was allocated.
305 class MacroAssemblerCodeRef {
306 private:
307     // This is private because it's dangerous enough that we want uses of it
308     // to be easy to find - hence the static create method below.
309     explicit MacroAssemblerCodeRef(MacroAssemblerCodePtr codePtr)
310         : m_codePtr(codePtr)
311     {
312         ASSERT(m_codePtr);
313     }
314
315 public:
316     MacroAssemblerCodeRef()
317     {
318     }
319
320     MacroAssemblerCodeRef(PassRefPtr<ExecutableMemoryHandle> executableMemory)
321         : m_codePtr(executableMemory->start())
322         , m_executableMemory(executableMemory)
323     {
324         ASSERT(m_executableMemory->isManaged());
325         ASSERT(m_executableMemory->start());
326         ASSERT(m_codePtr);
327     }
328     
329     // Use this only when you know that the codePtr refers to code that is
330     // already being kept alive through some other means. Typically this means
331     // that codePtr is immortal.
332     static MacroAssemblerCodeRef createSelfManagedCodeRef(MacroAssemblerCodePtr codePtr)
333     {
334         return MacroAssemblerCodeRef(codePtr);
335     }
336     
337     ExecutableMemoryHandle* executableMemory() const
338     {
339         return m_executableMemory.get();
340     }
341     
342     MacroAssemblerCodePtr code() const
343     {
344         return m_codePtr;
345     }
346     
347     size_t size() const
348     {
349         if (!m_executableMemory)
350             return 0;
351         return m_executableMemory->sizeInBytes();
352     }
353     
354     bool operator!() const { return !m_codePtr; }
355
356 private:
357     MacroAssemblerCodePtr m_codePtr;
358     RefPtr<ExecutableMemoryHandle> m_executableMemory;
359 };
360
361 } // namespace JSC
362
363 #endif // ENABLE(ASSEMBLER)
364
365 #endif // MacroAssemblerCodeRef_h