Templatize CodePtr/Refs/FunctionPtrs with PtrTags.
[WebKit-https.git] / Source / JavaScriptCore / ftl / FTLJITCode.cpp
1 /*
2  * Copyright (C) 2013-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 #include "config.h"
27 #include "FTLJITCode.h"
28
29 #if ENABLE(FTL_JIT)
30
31 #include "FTLState.h"
32 #include "PtrTag.h"
33
34 namespace JSC { namespace FTL {
35
36 using namespace B3;
37
38 JITCode::JITCode()
39     : JSC::JITCode(FTLJIT)
40 {
41 }
42
43 JITCode::~JITCode()
44 {
45     if (FTL::shouldDumpDisassembly()) {
46         dataLog("Destroying FTL JIT code at ");
47         CommaPrinter comma;
48         dataLog(comma, m_b3Code);
49         dataLog(comma, m_arityCheckEntrypoint);
50         dataLog("\n");
51     }
52 }
53
54 void JITCode::initializeB3Code(CodeRef<JSEntryPtrTag> b3Code)
55 {
56     m_b3Code = b3Code;
57 }
58
59 void JITCode::initializeB3Byproducts(std::unique_ptr<OpaqueByproducts> byproducts)
60 {
61     m_b3Byproducts = WTFMove(byproducts);
62 }
63
64 void JITCode::initializeAddressForCall(CodePtr<JSEntryPtrTag> address)
65 {
66     m_addressForCall = address;
67 }
68
69 void JITCode::initializeArityCheckEntrypoint(CodeRef<JSEntryPtrTag> entrypoint)
70 {
71     m_arityCheckEntrypoint = entrypoint;
72 }
73
74 JITCode::CodePtr<JSEntryPtrTag> JITCode::addressForCall(ArityCheckMode arityCheck)
75 {
76     switch (arityCheck) {
77     case ArityCheckNotRequired:
78         return m_addressForCall;
79     case MustCheckArity:
80         return m_arityCheckEntrypoint.code();
81     }
82     RELEASE_ASSERT_NOT_REACHED();
83     return CodePtr<JSEntryPtrTag>();
84 }
85
86 void* JITCode::executableAddressAtOffset(size_t offset)
87 {
88     if (!offset)
89         return m_addressForCall.executableAddress();
90
91     char* executableAddress = m_addressForCall.untaggedExecutableAddress<char*>();
92     return tagCodePtr<JSEntryPtrTag>(executableAddress + offset);
93 }
94
95 void* JITCode::dataAddressAtOffset(size_t)
96 {
97     // We can't patch FTL code, yet. Even if we did, it's not clear that we would do so
98     // through this API.
99     RELEASE_ASSERT_NOT_REACHED();
100     return 0;
101 }
102
103 unsigned JITCode::offsetOf(void*)
104 {
105     // We currently don't have visibility into the FTL code.
106     RELEASE_ASSERT_NOT_REACHED();
107     return 0;
108 }
109
110 size_t JITCode::size()
111 {
112     // We don't know the size of FTL code, yet. Make a wild guess. This is mostly used for
113     // GC load estimates.
114     return 1000;
115 }
116
117 bool JITCode::contains(void*)
118 {
119     // We have no idea what addresses the FTL code contains, yet.
120     RELEASE_ASSERT_NOT_REACHED();
121     return false;
122 }
123
124 JITCode* JITCode::ftl()
125 {
126     return this;
127 }
128
129 DFG::CommonData* JITCode::dfgCommon()
130 {
131     return &common;
132 }
133
134 void JITCode::validateReferences(const TrackedReferences& trackedReferences)
135 {
136     common.validateReferences(trackedReferences);
137     
138     for (OSRExit& exit : osrExit)
139         exit.m_descriptor->validateReferences(trackedReferences);
140 }
141
142 RegisterSet JITCode::liveRegistersToPreserveAtExceptionHandlingCallSite(CodeBlock*, CallSiteIndex callSiteIndex)
143 {
144     for (OSRExit& exit : osrExit) {
145         if (exit.m_exceptionHandlerCallSiteIndex.bits() == callSiteIndex.bits()) {
146             RELEASE_ASSERT(exit.isExceptionHandler());
147             RELEASE_ASSERT(exit.isGenericUnwindHandler());
148             return ValueRep::usedRegisters(exit.m_valueReps);
149         }
150     }
151     return { };
152 }
153
154 std::optional<CodeOrigin> JITCode::findPC(CodeBlock* codeBlock, void* pc)
155 {
156     for (OSRExit& exit : osrExit) {
157         if (ExecutableMemoryHandle* handle = exit.m_code.executableMemory()) {
158             if (handle->start() <= pc && pc < handle->end())
159                 return std::optional<CodeOrigin>(exit.m_codeOriginForExitProfile);
160         }
161     }
162
163     for (std::unique_ptr<LazySlowPath>& lazySlowPath : lazySlowPaths) {
164         if (ExecutableMemoryHandle* handle = lazySlowPath->stub().executableMemory()) {
165             if (handle->start() <= pc && pc < handle->end())
166                 return std::optional<CodeOrigin>(codeBlock->codeOrigin(lazySlowPath->callSiteIndex()));
167         }
168     }
169
170     return std::nullopt;
171 }
172
173 } } // namespace JSC::FTL
174
175 #endif // ENABLE(FTL_JIT)
176