cda81b57925d57a2c20bbc7a6686fe34e20e6140
[WebKit-https.git] / Source / JavaScriptCore / ftl / FTLThunks.cpp
1 /*
2  * Copyright (C) 2013 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 "FTLThunks.h"
28
29 #if ENABLE(FTL_JIT)
30
31 #include "AssemblyHelpers.h"
32 #include "FPRInfo.h"
33 #include "FTLOSRExitCompiler.h"
34 #include "FTLOperations.h"
35 #include "FTLSaveRestore.h"
36 #include "GPRInfo.h"
37 #include "LinkBuffer.h"
38
39 namespace JSC { namespace FTL {
40
41 using namespace DFG;
42
43 static MacroAssemblerCodeRef genericGenerationThunkGenerator(
44     VM* vm, FunctionPtr generationFunction, const char* name, unsigned extraPopsToRestore)
45 {
46     AssemblyHelpers jit(vm, 0);
47     
48     // Note that the "return address" will be the ID that we pass to the generation function.
49     
50     ptrdiff_t stackMisalignment = MacroAssembler::pushToSaveByteOffset();
51     
52     // Pretend that we're a C call frame.
53     jit.pushToSave(MacroAssembler::framePointerRegister);
54     jit.move(MacroAssembler::stackPointerRegister, MacroAssembler::framePointerRegister);
55     stackMisalignment += MacroAssembler::pushToSaveByteOffset();
56     
57     // Now create ourselves enough stack space to give saveAllRegisters() a scratch slot.
58     unsigned numberOfRequiredPops = 0;
59     do {
60         jit.pushToSave(GPRInfo::regT0);
61         stackMisalignment += MacroAssembler::pushToSaveByteOffset();
62         numberOfRequiredPops++;
63     } while (stackMisalignment % stackAlignmentBytes());
64     
65     ScratchBuffer* scratchBuffer = vm->scratchBufferForSize(requiredScratchMemorySizeInBytes());
66     char* buffer = static_cast<char*>(scratchBuffer->dataBuffer());
67     
68     saveAllRegisters(jit, buffer);
69     
70     // Tell GC mark phase how much of the scratch buffer is active during call.
71     jit.move(MacroAssembler::TrustedImmPtr(scratchBuffer->activeLengthPtr()), GPRInfo::nonArgGPR0);
72     jit.storePtr(MacroAssembler::TrustedImmPtr(requiredScratchMemorySizeInBytes()), GPRInfo::nonArgGPR0);
73
74     jit.loadPtr(GPRInfo::callFrameRegister, GPRInfo::argumentGPR0);
75     jit.peek(
76         GPRInfo::argumentGPR1,
77         (stackMisalignment - MacroAssembler::pushToSaveByteOffset()) / sizeof(void*));
78     MacroAssembler::Call functionCall = jit.call();
79     
80     // At this point we want to make a tail call to what was returned to us in the
81     // returnValueGPR. But at the same time as we do this, we must restore all registers.
82     // The way we will accomplish this is by arranging to have the tail call target in the
83     // return address "slot" (be it a register or the stack).
84     
85     jit.move(GPRInfo::returnValueGPR, GPRInfo::regT0);
86     
87     // Make sure we tell the GC that we're not using the scratch buffer anymore.
88     jit.move(MacroAssembler::TrustedImmPtr(scratchBuffer->activeLengthPtr()), GPRInfo::regT1);
89     jit.storePtr(MacroAssembler::TrustedImmPtr(0), GPRInfo::regT1);
90     
91     // Prepare for tail call.
92     while (numberOfRequiredPops--)
93         jit.popToRestore(GPRInfo::regT1);
94     jit.popToRestore(MacroAssembler::framePointerRegister);
95
96     // When we came in here, there was an additional thing pushed to the stack. Some clients want it
97     // popped before proceeding.
98     while (extraPopsToRestore--)
99         jit.popToRestore(GPRInfo::regT1);
100
101     // Put the return address wherever the return instruction wants it. On all platforms, this
102     // ensures that the return address is out of the way of register restoration.
103     jit.restoreReturnAddressBeforeReturn(GPRInfo::regT0);
104
105     restoreAllRegisters(jit, buffer);
106
107     jit.ret();
108     
109     LinkBuffer patchBuffer(*vm, jit, GLOBAL_THUNK_ID);
110     patchBuffer.link(functionCall, generationFunction);
111     return FINALIZE_CODE(patchBuffer, ("%s", name));
112 }
113
114 MacroAssemblerCodeRef osrExitGenerationThunkGenerator(VM* vm)
115 {
116     unsigned extraPopsToRestore = 0;
117     return genericGenerationThunkGenerator(
118         vm, compileFTLOSRExit, "FTL OSR exit generation thunk", extraPopsToRestore);
119 }
120
121 MacroAssemblerCodeRef lazySlowPathGenerationThunkGenerator(VM* vm)
122 {
123     unsigned extraPopsToRestore = 1;
124     return genericGenerationThunkGenerator(
125         vm, compileFTLLazySlowPath, "FTL lazy slow path generation thunk", extraPopsToRestore);
126 }
127
128 static void registerClobberCheck(AssemblyHelpers& jit, RegisterSet dontClobber)
129 {
130     if (!Options::clobberAllRegsInFTLICSlowPath())
131         return;
132     
133     RegisterSet clobber = RegisterSet::allRegisters();
134     clobber.exclude(RegisterSet::reservedHardwareRegisters());
135     clobber.exclude(RegisterSet::stackRegisters());
136     clobber.exclude(RegisterSet::calleeSaveRegisters());
137     clobber.exclude(dontClobber);
138     
139     GPRReg someGPR;
140     for (Reg reg = Reg::first(); reg <= Reg::last(); reg = reg.next()) {
141         if (!clobber.get(reg) || !reg.isGPR())
142             continue;
143         
144         jit.move(AssemblyHelpers::TrustedImm32(0x1337beef), reg.gpr());
145         someGPR = reg.gpr();
146     }
147     
148     for (Reg reg = Reg::first(); reg <= Reg::last(); reg = reg.next()) {
149         if (!clobber.get(reg) || !reg.isFPR())
150             continue;
151         
152         jit.move64ToDouble(someGPR, reg.fpr());
153     }
154 }
155
156 MacroAssemblerCodeRef slowPathCallThunkGenerator(VM& vm, const SlowPathCallKey& key)
157 {
158     AssemblyHelpers jit(&vm, 0);
159     
160     // We want to save the given registers at the given offset, then we want to save the
161     // old return address somewhere past that offset, and then finally we want to make the
162     // call.
163     
164     size_t currentOffset = key.offset() + sizeof(void*);
165     
166 #if CPU(X86) || CPU(X86_64)
167     currentOffset += sizeof(void*);
168 #endif
169     
170     for (MacroAssembler::RegisterID reg = MacroAssembler::firstRegister(); reg <= MacroAssembler::lastRegister(); reg = static_cast<MacroAssembler::RegisterID>(reg + 1)) {
171         if (!key.usedRegisters().get(reg))
172             continue;
173         jit.storePtr(reg, AssemblyHelpers::Address(MacroAssembler::stackPointerRegister, currentOffset));
174         currentOffset += sizeof(void*);
175     }
176     
177     for (MacroAssembler::FPRegisterID reg = MacroAssembler::firstFPRegister(); reg <= MacroAssembler::lastFPRegister(); reg = static_cast<MacroAssembler::FPRegisterID>(reg + 1)) {
178         if (!key.usedRegisters().get(reg))
179             continue;
180         jit.storeDouble(reg, AssemblyHelpers::Address(MacroAssembler::stackPointerRegister, currentOffset));
181         currentOffset += sizeof(double);
182     }
183     
184     jit.preserveReturnAddressAfterCall(GPRInfo::nonArgGPR0);
185     jit.storePtr(GPRInfo::nonArgGPR0, AssemblyHelpers::Address(MacroAssembler::stackPointerRegister, key.offset()));
186     
187     registerClobberCheck(jit, key.argumentRegisters());
188     
189     AssemblyHelpers::Call call = jit.call();
190
191     jit.loadPtr(AssemblyHelpers::Address(MacroAssembler::stackPointerRegister, key.offset()), GPRInfo::nonPreservedNonReturnGPR);
192     jit.restoreReturnAddressBeforeReturn(GPRInfo::nonPreservedNonReturnGPR);
193     
194     for (MacroAssembler::FPRegisterID reg = MacroAssembler::lastFPRegister(); ; reg = static_cast<MacroAssembler::FPRegisterID>(reg - 1)) {
195         if (key.usedRegisters().get(reg)) {
196             currentOffset -= sizeof(double);
197             jit.loadDouble(AssemblyHelpers::Address(MacroAssembler::stackPointerRegister, currentOffset), reg);
198         }
199         if (reg == MacroAssembler::firstFPRegister())
200             break;
201     }
202     
203     for (MacroAssembler::RegisterID reg = MacroAssembler::lastRegister(); ; reg = static_cast<MacroAssembler::RegisterID>(reg - 1)) {
204         if (key.usedRegisters().get(reg)) {
205             currentOffset -= sizeof(void*);
206             jit.loadPtr(AssemblyHelpers::Address(MacroAssembler::stackPointerRegister, currentOffset), reg);
207         }
208         if (reg == MacroAssembler::firstRegister())
209             break;
210     }
211     
212     jit.ret();
213
214     LinkBuffer patchBuffer(vm, jit, GLOBAL_THUNK_ID);
215     patchBuffer.link(call, FunctionPtr(key.callTarget()));
216     return FINALIZE_CODE(patchBuffer, ("FTL slow path call thunk for %s", toCString(key).data()));
217 }
218
219 } } // namespace JSC::FTL
220
221 #endif // ENABLE(FTL_JIT)
222