3d75ef5367fe7033fe2803ed940b2f4dcb983202
[WebKit-https.git] / Source / JavaScriptCore / jit / JITStubRoutine.h
1 /*
2  * Copyright (C) 2012, 2014 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 JITStubRoutine_h
27 #define JITStubRoutine_h
28
29 #if ENABLE(JIT)
30
31 #include "ExecutableAllocator.h"
32 #include "MacroAssemblerCodeRef.h"
33 #include <wtf/RefCounted.h>
34 #include <wtf/Vector.h>
35
36 namespace JSC {
37
38 class JITStubRoutineSet;
39
40 // This is a base-class for JIT stub routines, and also the class you want
41 // to instantiate directly if you have a routine that does not need any
42 // help from the GC. If in doubt, use one of the other stub routines. But
43 // if you know for sure that the stub routine cannot be on the stack while
44 // someone triggers a stub routine reset, then using this will speed up
45 // memory reclamation. One case where a stub routine satisfies this
46 // condition is if it doesn't make any calls, to either C++ or JS code. In
47 // such a routine you know that it cannot be on the stack when anything
48 // interesting happens.
49 // See GCAwareJITStubRoutine.h for the other stub routines.
50 class JITStubRoutine {
51     WTF_MAKE_NONCOPYABLE(JITStubRoutine);
52     WTF_MAKE_FAST_ALLOCATED;
53 public:
54     JITStubRoutine(const MacroAssemblerCodeRef& code)
55         : m_code(code)
56         , m_refCount(1)
57     {
58     }
59     
60     // Use this if you want to pass a CodePtr to someone who insists on taking
61     // a RefPtr<JITStubRoutine>.
62     static Ref<JITStubRoutine> createSelfManagedRoutine(
63         MacroAssemblerCodePtr rawCodePointer)
64     {
65         return adoptRef(*new JITStubRoutine(MacroAssemblerCodeRef::createSelfManagedCodeRef(rawCodePointer)));
66     }
67     
68     virtual ~JITStubRoutine();
69     
70     // MacroAssemblerCodeRef is copyable, but at the cost of reference
71     // counting churn. Returning a reference is a good way of reducing
72     // the churn.
73     const MacroAssemblerCodeRef& code() const { return m_code; }
74     
75     static MacroAssemblerCodePtr asCodePtr(PassRefPtr<JITStubRoutine> stubRoutine)
76     {
77         if (!stubRoutine)
78             return MacroAssemblerCodePtr();
79         
80         MacroAssemblerCodePtr result = stubRoutine->code().code();
81         ASSERT(!!result);
82         return result;
83     }
84     
85     void ref()
86     {
87         m_refCount++;
88     }
89     
90     void deref()
91     {
92         if (--m_refCount)
93             return;
94         observeZeroRefCount();
95     }
96     
97     // Helpers for the GC to determine how to deal with marking JIT stub
98     // routines.
99     uintptr_t startAddress() const { return m_code.executableMemory()->startAsInteger(); }
100     uintptr_t endAddress() const { return m_code.executableMemory()->endAsInteger(); }
101     static uintptr_t addressStep() { return jitAllocationGranule; }
102     
103     static bool canPerformRangeFilter()
104     {
105 #if ENABLE(EXECUTABLE_ALLOCATOR_FIXED)
106         return true;
107 #else
108         return false;
109 #endif
110     }
111     static uintptr_t filteringStartAddress()
112     {
113 #if ENABLE(EXECUTABLE_ALLOCATOR_FIXED)
114         return startOfFixedExecutableMemoryPool;
115 #else
116         UNREACHABLE_FOR_PLATFORM();
117         return 0;
118 #endif
119     }
120     static size_t filteringExtentSize()
121     {
122 #if ENABLE(EXECUTABLE_ALLOCATOR_FIXED)
123         return fixedExecutableMemoryPoolSize;
124 #else
125         UNREACHABLE_FOR_PLATFORM();
126         return 0;
127 #endif
128     }
129     static bool passesFilter(uintptr_t address)
130     {
131         if (!canPerformRangeFilter()) {
132             // Just check that the address doesn't use any special values that would make
133             // our hashtables upset.
134             return address >= jitAllocationGranule && address != std::numeric_limits<uintptr_t>::max();
135         }
136         
137         if (address - filteringStartAddress() >= filteringExtentSize())
138             return false;
139         
140         return true;
141     }
142     
143     // Return true if you are still valid after. Return false if you are now invalid. If you return
144     // false, you will usually not do any clearing because the idea is that you will simply be
145     // destroyed.
146     virtual bool visitWeak(VM&);
147
148 protected:
149     virtual void observeZeroRefCount();
150
151     MacroAssemblerCodeRef m_code;
152     unsigned m_refCount;
153 };
154
155 // Helper for the creation of simple stub routines that need no help from the GC.
156 #define FINALIZE_CODE_FOR_STUB(codeBlock, patchBuffer, dataLogFArguments) \
157     (adoptRef(new JITStubRoutine(FINALIZE_CODE_FOR((codeBlock), (patchBuffer), dataLogFArguments))))
158
159 } // namespace JSC
160
161 #endif // ENABLE(JIT)
162
163 #endif // JITStubRoutine_h
164