fourthTier: FTL shouldn't use the LLVM global context, and should instead create...
[WebKit-https.git] / Source / JavaScriptCore / ftl / FTLAbbreviations.h
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 #ifndef FTLAbbreviations_h
27 #define FTLAbbreviations_h
28
29 #include <wtf/Platform.h>
30
31 #if ENABLE(FTL_JIT)
32
33 #include "FTLAbbreviatedTypes.h"
34 #include "FTLValueFromBlock.h"
35
36 namespace JSC { namespace FTL {
37
38 // This file contains short-form calls into the LLVM C API. It is meant to
39 // save typing and make the lowering code clearer. If we ever call an LLVM C API
40 // function more than once in the FTL lowering code, we should add a shortcut for
41 // it here.
42
43 #if USE(JSVALUE32_64)
44 #error "The FTL backend assumes that pointers are 64-bit."
45 #endif
46
47 static inline LType voidType(LContext context) { return LLVMVoidTypeInContext(context); }
48 static inline LType int1Type(LContext context) { return LLVMInt1TypeInContext(context); }
49 static inline LType int8Type(LContext context) { return LLVMInt8TypeInContext(context); }
50 static inline LType int32Type(LContext context) { return LLVMInt32TypeInContext(context); }
51 static inline LType int64Type(LContext context) { return LLVMInt64TypeInContext(context); }
52 static inline LType intPtrType(LContext context) { return LLVMInt64TypeInContext(context); }
53 static inline LType doubleType(LContext context) { return LLVMDoubleTypeInContext(context); }
54
55 static inline LType pointerType(LType type) { return LLVMPointerType(type, 0); }
56
57 enum PackingMode { NotPacked, Packed };
58 static inline LType structType(LContext context, LType* elementTypes, unsigned elementCount, PackingMode packing = NotPacked)
59 {
60     return LLVMStructTypeInContext(context, elementTypes, elementCount, packing == Packed);
61 }
62 static inline LType structType(LContext context, PackingMode packing = NotPacked)
63 {
64     return structType(context, 0, 0, packing);
65 }
66 static inline LType structType(LContext context, LType element1, PackingMode packing = NotPacked)
67 {
68     return structType(context, &element1, 1, packing);
69 }
70 static inline LType structType(LContext context, LType element1, LType element2, PackingMode packing = NotPacked)
71 {
72     LType elements[] = { element1, element2 };
73     return structType(context, elements, 2, packing);
74 }
75
76 enum Variadicity { NotVariadic, Variadic };
77 static inline LType functionType(LType returnType, const LType* paramTypes, unsigned paramCount, Variadicity variadicity)
78 {
79     return LLVMFunctionType(returnType, const_cast<LType*>(paramTypes), paramCount, variadicity == Variadic);
80 }
81 template<typename VectorType>
82 inline LType functionType(LType returnType, const VectorType& vector, Variadicity variadicity = NotVariadic)
83 {
84     return functionType(returnType, vector.begin(), vector.size(), variadicity);
85 }
86 static inline LType functionType(LType returnType, Variadicity variadicity = NotVariadic)
87 {
88     return functionType(returnType, 0, 0, variadicity);
89 }
90 static inline LType functionType(LType returnType, LType param1, Variadicity variadicity = NotVariadic)
91 {
92     return functionType(returnType, &param1, 1, variadicity);
93 }
94 static inline LType functionType(LType returnType, LType param1, LType param2, Variadicity variadicity = NotVariadic)
95 {
96     LType paramTypes[] = { param1, param2 };
97     return functionType(returnType, paramTypes, 2, variadicity);
98 }
99
100 static inline LType typeOf(LValue value) { return LLVMTypeOf(value); }
101
102 static inline unsigned mdKindID(LContext context, const char* string) { return LLVMGetMDKindIDInContext(context, string, strlen(string)); }
103 static inline LValue mdString(LContext context, const char* string, unsigned length) { return LLVMMDStringInContext(context, string, length); }
104 static inline LValue mdString(LContext context, const char* string) { return mdString(context, string, strlen(string)); }
105 static inline LValue mdNode(LContext context, LValue* args, unsigned numArgs) { return LLVMMDNodeInContext(context, args, numArgs); }
106 static inline LValue mdNode(LContext context) { return mdNode(context, 0, 0); }
107 static inline LValue mdNode(LContext context, LValue arg1) { return mdNode(context, &arg1, 1); }
108 static inline LValue mdNode(LContext context, LValue arg1, LValue arg2)
109 {
110     LValue args[] = { arg1, arg2 };
111     return mdNode(context, args, 2);
112 }
113
114 static inline void setMetadata(LValue instruction, unsigned kind, LValue metadata) { LLVMSetMetadata(instruction, kind, metadata); }
115
116 static inline LValue addFunction(LModule module, const char* name, LType type) { return LLVMAddFunction(module, name, type); }
117 static inline void setLinkage(LValue global, LLinkage linkage) { LLVMSetLinkage(global, linkage); }
118 static inline void setFunctionCallingConv(LValue function, LCallConv convention) { LLVMSetFunctionCallConv(function, convention); }
119
120 static inline LValue addExternFunction(LModule module, const char* name, LType type)
121 {
122     LValue result = addFunction(module, name, type);
123     setLinkage(result, LLVMExternalLinkage);
124     return result;
125 }
126
127 static inline LValue getParam(LValue function, unsigned index) { return LLVMGetParam(function, index); }
128
129 enum BitExtension { ZeroExtend, SignExtend };
130 static inline LValue constInt(LType type, unsigned long long value, BitExtension extension) { return LLVMConstInt(type, value, extension == SignExtend); }
131 static inline LValue constReal(LType type, double value) { return LLVMConstReal(type, value); }
132 static inline LValue constIntToPtr(LValue value, LType type) { return LLVMConstIntToPtr(value, type); }
133 static inline LValue constBitCast(LValue value, LType type) { return LLVMConstBitCast(value, type); }
134
135 static inline LBasicBlock appendBasicBlock(LContext context, LValue function, const char* name = "") { return LLVMAppendBasicBlockInContext(context, function, name); }
136 static inline LBasicBlock insertBasicBlock(LContext context, LBasicBlock beforeBasicBlock, const char* name = "") { return LLVMInsertBasicBlockInContext(context, beforeBasicBlock, name); }
137
138 static inline LValue buildPhi(LBuilder builder, LType type) { return LLVMBuildPhi(builder, type, ""); }
139 static inline void addIncoming(LValue phi, const LValue* values, const LBasicBlock* blocks, unsigned numPredecessors)
140 {
141     LLVMAddIncoming(phi, const_cast<LValue*>(values), const_cast<LBasicBlock*>(blocks), numPredecessors);
142 }
143 static inline void addIncoming(LValue phi, ValueFromBlock value1)
144 {
145     LValue value = value1.value();
146     LBasicBlock block = value1.block();
147     addIncoming(phi, &value, &block, 1);
148 }
149 static inline void addIncoming(LValue phi, ValueFromBlock value1, ValueFromBlock value2)
150 {
151     LValue values[] = { value1.value(), value2.value() };
152     LBasicBlock blocks[] = { value1.block(), value2.block() };
153     addIncoming(phi, values, blocks, 2);
154 }
155 static inline LValue buildPhi(LBuilder builder, LType type, ValueFromBlock value1)
156 {
157     LValue result = buildPhi(builder, type);
158     addIncoming(result, value1);
159     return result;
160 }
161 static inline LValue buildPhi(
162     LBuilder builder, LType type, ValueFromBlock value1, ValueFromBlock value2)
163 {
164     LValue result = buildPhi(builder, type);
165     addIncoming(result, value1, value2);
166     return result;
167 }
168
169 static inline LValue buildAlloca(LBuilder builder, LType type) { return LLVMBuildAlloca(builder, type, ""); }
170 static inline LValue buildAdd(LBuilder builder, LValue left, LValue right) { return LLVMBuildAdd(builder, left, right, ""); }
171 static inline LValue buildSub(LBuilder builder, LValue left, LValue right) { return LLVMBuildSub(builder, left, right, ""); }
172 static inline LValue buildMul(LBuilder builder, LValue left, LValue right) { return LLVMBuildMul(builder, left, right, ""); }
173 static inline LValue buildNeg(LBuilder builder, LValue value) { return LLVMBuildNeg(builder, value, ""); }
174 static inline LValue buildFAdd(LBuilder builder, LValue left, LValue right) { return LLVMBuildFAdd(builder, left, right, ""); }
175 static inline LValue buildFSub(LBuilder builder, LValue left, LValue right) { return LLVMBuildFSub(builder, left, right, ""); }
176 static inline LValue buildFMul(LBuilder builder, LValue left, LValue right) { return LLVMBuildFMul(builder, left, right, ""); }
177 static inline LValue buildFNeg(LBuilder builder, LValue value) { return LLVMBuildFNeg(builder, value, ""); }
178 static inline LValue buildAnd(LBuilder builder, LValue left, LValue right) { return LLVMBuildAnd(builder, left, right, ""); }
179 static inline LValue buildOr(LBuilder builder, LValue left, LValue right) { return LLVMBuildOr(builder, left, right, ""); }
180 static inline LValue buildXor(LBuilder builder, LValue left, LValue right) { return LLVMBuildXor(builder, left, right, ""); }
181 static inline LValue buildShl(LBuilder builder, LValue left, LValue right) { return LLVMBuildShl(builder, left, right, ""); }
182 static inline LValue buildAShr(LBuilder builder, LValue left, LValue right) { return LLVMBuildAShr(builder, left, right, ""); }
183 static inline LValue buildLShr(LBuilder builder, LValue left, LValue right) { return LLVMBuildLShr(builder, left, right, ""); }
184 static inline LValue buildNot(LBuilder builder, LValue value) { return LLVMBuildNot(builder, value, ""); }
185 static inline LValue buildLoad(LBuilder builder, LValue pointer) { return LLVMBuildLoad(builder, pointer, ""); }
186 static inline LValue buildStore(LBuilder builder, LValue value, LValue pointer) { return LLVMBuildStore(builder, value, pointer); }
187 static inline LValue buildZExt(LBuilder builder, LValue value, LType type) { return LLVMBuildZExt(builder, value, type, ""); }
188 static inline LValue buildSIToFP(LBuilder builder, LValue value, LType type) { return LLVMBuildSIToFP(builder, value, type, ""); }
189 static inline LValue buildUIToFP(LBuilder builder, LValue value, LType type) { return LLVMBuildUIToFP(builder, value, type, ""); }
190 static inline LValue buildIntCast(LBuilder builder, LValue value, LType type) { return LLVMBuildIntCast(builder, value, type, ""); }
191 static inline LValue buildIntToPtr(LBuilder builder, LValue value, LType type) { return LLVMBuildIntToPtr(builder, value, type, ""); }
192 static inline LValue buildPtrToInt(LBuilder builder, LValue value, LType type) { return LLVMBuildPtrToInt(builder, value, type, ""); }
193 static inline LValue buildBitCast(LBuilder builder, LValue value, LType type) { return LLVMBuildBitCast(builder, value, type, ""); }
194 static inline LValue buildICmp(LBuilder builder, LIntPredicate cond, LValue left, LValue right) { return LLVMBuildICmp(builder, cond, left, right, ""); }
195 static inline LValue buildFCmp(LBuilder builder, LRealPredicate cond, LValue left, LValue right) { return LLVMBuildFCmp(builder, cond, left, right, ""); }
196 static inline LValue buildCall(LBuilder builder, LValue function, const LValue* args, unsigned numArgs)
197 {
198     return LLVMBuildCall(builder, function, const_cast<LValue*>(args), numArgs, "");
199 }
200 template<typename VectorType>
201 inline LValue buildCall(LBuilder builder, LValue function, const VectorType& vector)
202 {
203     return buildCall(builder, function, vector.begin(), vector.size());
204 }
205 static inline LValue buildCall(LBuilder builder, LValue function)
206 {
207     return buildCall(builder, function, 0, 0);
208 }
209 static inline LValue buildCall(LBuilder builder, LValue function, LValue arg1)
210 {
211     return buildCall(builder, function, &arg1, 1);
212 }
213 static inline LValue buildCall(LBuilder builder, LValue function, LValue arg1, LValue arg2)
214 {
215     LValue args[] = { arg1, arg2 };
216     return buildCall(builder, function, args, 2);
217 }
218 enum TailCallMode { IsNotTailCall, IsTailCall };
219 static inline void setTailCall(LValue call, TailCallMode mode) { LLVMSetTailCall(call, mode == IsTailCall); }
220 static inline LValue buildExtractValue(LBuilder builder, LValue aggVal, unsigned index) { return LLVMBuildExtractValue(builder, aggVal, index, ""); }
221 static inline LValue buildSelect(LBuilder builder, LValue condition, LValue taken, LValue notTaken) { return LLVMBuildSelect(builder, condition, taken, notTaken, ""); }
222 static inline LValue buildBr(LBuilder builder, LBasicBlock destination) { return LLVMBuildBr(builder, destination); }
223 static inline LValue buildCondBr(LBuilder builder, LValue condition, LBasicBlock taken, LBasicBlock notTaken) { return LLVMBuildCondBr(builder, condition, taken, notTaken); }
224 static inline LValue buildRet(LBuilder builder, LValue value) { return LLVMBuildRet(builder, value); }
225 static inline LValue buildUnreachable(LBuilder builder) { return LLVMBuildUnreachable(builder); }
226
227 static inline void dumpModule(LModule module) { LLVMDumpModule(module); }
228 static inline void verifyModule(LModule module)
229 {
230     char* error = 0;
231     LLVMVerifyModule(module, LLVMAbortProcessAction, &error);
232     LLVMDisposeMessage(error);
233 }
234
235 } } // namespace JSC::FTL
236
237 #endif // ENABLE(FTL_JIT)
238
239 #endif // FTLAbbreviations_h
240