Change WebAssembly calling conventions
[WebKit-https.git] / Source / JavaScriptCore / wasm / WasmBinding.cpp
1 /*
2  * Copyright (C) 2016-2019 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 "WasmBinding.h"
28
29 #if ENABLE(WEBASSEMBLY)
30
31 #include "CCallHelpers.h"
32 #include "JSCInlines.h"
33 #include "LinkBuffer.h"
34 #include "WasmCallingConvention.h"
35 #include "WasmInstance.h"
36
37 namespace JSC { namespace Wasm {
38
39 using JIT = CCallHelpers;
40
41 Expected<MacroAssemblerCodeRef<WasmEntryPtrTag>, BindingFailure> wasmToWasm(unsigned importIndex)
42 {
43     // FIXME: Consider uniquify the stubs based on signature + index to see if this saves memory.
44     // https://bugs.webkit.org/show_bug.cgi?id=184157
45
46     const PinnedRegisterInfo& pinnedRegs = PinnedRegisterInfo::get();
47     JIT jit;
48
49     GPRReg scratch = wasmCallingConventionAir().prologueScratch(0);
50     GPRReg callee = wasmCallingConventionAir().prologueScratch(1);
51     GPRReg baseMemory = pinnedRegs.baseMemoryPointer;
52     ASSERT(baseMemory != scratch);
53     ASSERT(pinnedRegs.sizeRegister != baseMemory);
54     ASSERT(pinnedRegs.sizeRegister != scratch);
55     GPRReg sizeRegAsScratch = pinnedRegs.sizeRegister;
56
57     // B3's call codegen ensures that the JSCell is a WebAssemblyFunction.
58     jit.loadWasmContextInstance(sizeRegAsScratch); // Old Instance*
59     // Get the callee's Wasm::Instance and set it as WasmContext's instance. The caller will take care of restoring its own Instance.
60     jit.loadPtr(JIT::Address(sizeRegAsScratch, Instance::offsetOfTargetInstance(importIndex)), baseMemory); // Instance*.
61     // While we're accessing that cacheline, also get the wasm entrypoint and callee so we can tail call to it below.
62     jit.loadPtr(JIT::Address(sizeRegAsScratch, Instance::offsetOfWasmEntrypointLoadLocation(importIndex)), scratch);
63     jit.loadPtr(JIT::Address(sizeRegAsScratch, Instance::offsetOfBoxedCalleeLoadLocation(importIndex)), callee);
64     jit.storeWasmContextInstance(baseMemory);
65
66     jit.loadPtr(JIT::Address(sizeRegAsScratch, Instance::offsetOfCachedStackLimit()), sizeRegAsScratch);
67     jit.storePtr(sizeRegAsScratch, JIT::Address(baseMemory, Instance::offsetOfCachedStackLimit()));
68
69     // Set the callee slot in the call frame
70     jit.loadPtr(callee, callee);
71     // At this point, we have been called, so ReturnPC is on the stack, but we have not yet pushed the frame pointer,
72     // so we have to subtract the space for CallerFrame from the callee slot
73     jit.storePtr(callee, JIT::Address(JIT::stackPointerRegister, CallFrameSlot::callee * sizeof(Register) - sizeof(CPURegister)));
74
75     // FIXME the following code assumes that all Wasm::Instance have the same pinned registers. https://bugs.webkit.org/show_bug.cgi?id=162952
76     // Set up the callee's baseMemory register as well as the memory size registers.
77     {
78         GPRReg scratchOrSize = !Gigacage::isEnabled(Gigacage::Primitive) ? pinnedRegs.sizeRegister : wasmCallingConventionAir().prologueScratch(1);
79
80         jit.loadPtr(JIT::Address(baseMemory, Wasm::Instance::offsetOfCachedMemorySize()), pinnedRegs.sizeRegister); // Memory size.
81         jit.loadPtr(JIT::Address(baseMemory, Wasm::Instance::offsetOfCachedMemory()), baseMemory); // Wasm::Memory::TaggedArrayStoragePtr<void> (void*).
82         jit.cageConditionally(Gigacage::Primitive, baseMemory, pinnedRegs.sizeRegister, scratchOrSize);
83     }
84
85     // Tail call into the callee WebAssembly function.
86     jit.loadPtr(scratch, scratch);
87     jit.farJump(scratch, WasmEntryPtrTag);
88
89     LinkBuffer patchBuffer(jit, GLOBAL_THUNK_ID, JITCompilationCanFail);
90     if (UNLIKELY(patchBuffer.didFailToAllocate()))
91         return makeUnexpected(BindingFailure::OutOfMemory);
92
93     return FINALIZE_CODE(patchBuffer, WasmEntryPtrTag, "WebAssembly->WebAssembly import[%i]", importIndex);
94 }
95
96 } } // namespace JSC::Wasm
97
98 #endif // ENABLE(WEBASSEMBLY)