Merge r169628 from ftlopt.
[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 #if ENABLE(FTL_JIT)
30
31 #include "FTLAbbreviatedTypes.h"
32 #include "FTLValueFromBlock.h"
33 #include "LLVMAPI.h"
34 #include <cstring>
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 llvm->VoidTypeInContext(context); }
48 static inline LType int1Type(LContext context) { return llvm->Int1TypeInContext(context); }
49 static inline LType int8Type(LContext context) { return llvm->Int8TypeInContext(context); }
50 static inline LType int16Type(LContext context) { return llvm->Int16TypeInContext(context); }
51 static inline LType int32Type(LContext context) { return llvm->Int32TypeInContext(context); }
52 static inline LType int64Type(LContext context) { return llvm->Int64TypeInContext(context); }
53 static inline LType intPtrType(LContext context) { return llvm->Int64TypeInContext(context); }
54 static inline LType floatType(LContext context) { return llvm->FloatTypeInContext(context); }
55 static inline LType doubleType(LContext context) { return llvm->DoubleTypeInContext(context); }
56
57 static inline LType pointerType(LType type) { return llvm->PointerType(type, 0); }
58 static inline LType arrayType(LType type, unsigned count) { return llvm->ArrayType(type, count); }
59 static inline LType vectorType(LType type, unsigned count) { return llvm->VectorType(type, count); }
60
61 enum PackingMode { NotPacked, Packed };
62 static inline LType structType(LContext context, LType* elementTypes, unsigned elementCount, PackingMode packing = NotPacked)
63 {
64     return llvm->StructTypeInContext(context, elementTypes, elementCount, packing == Packed);
65 }
66 static inline LType structType(LContext context, PackingMode packing = NotPacked)
67 {
68     return structType(context, 0, 0, packing);
69 }
70 static inline LType structType(LContext context, LType element1, PackingMode packing = NotPacked)
71 {
72     return structType(context, &element1, 1, packing);
73 }
74 static inline LType structType(LContext context, LType element1, LType element2, PackingMode packing = NotPacked)
75 {
76     LType elements[] = { element1, element2 };
77     return structType(context, elements, 2, packing);
78 }
79
80 enum Variadicity { NotVariadic, Variadic };
81 static inline LType functionType(LType returnType, const LType* paramTypes, unsigned paramCount, Variadicity variadicity)
82 {
83     return llvm->FunctionType(returnType, const_cast<LType*>(paramTypes), paramCount, variadicity == Variadic);
84 }
85 template<typename VectorType>
86 inline LType functionType(LType returnType, const VectorType& vector, Variadicity variadicity = NotVariadic)
87 {
88     return functionType(returnType, vector.begin(), vector.size(), variadicity);
89 }
90 static inline LType functionType(LType returnType, Variadicity variadicity = NotVariadic)
91 {
92     return functionType(returnType, 0, 0, variadicity);
93 }
94 static inline LType functionType(LType returnType, LType param1, Variadicity variadicity = NotVariadic)
95 {
96     return functionType(returnType, &param1, 1, variadicity);
97 }
98 static inline LType functionType(LType returnType, LType param1, LType param2, Variadicity variadicity = NotVariadic)
99 {
100     LType paramTypes[] = { param1, param2 };
101     return functionType(returnType, paramTypes, 2, variadicity);
102 }
103 static inline LType functionType(LType returnType, LType param1, LType param2, LType param3, Variadicity variadicity = NotVariadic)
104 {
105     LType paramTypes[] = { param1, param2, param3 };
106     return functionType(returnType, paramTypes, 3, variadicity);
107 }
108 static inline LType functionType(LType returnType, LType param1, LType param2, LType param3, LType param4, Variadicity variadicity = NotVariadic)
109 {
110     LType paramTypes[] = { param1, param2, param3, param4 };
111     return functionType(returnType, paramTypes, 4, variadicity);
112 }
113
114 static inline LType typeOf(LValue value) { return llvm->TypeOf(value); }
115
116 static inline LType getElementType(LType value) { return llvm->GetElementType(value); }
117
118 static inline unsigned mdKindID(LContext context, const char* string) { return llvm->GetMDKindIDInContext(context, string, std::strlen(string)); }
119 static inline LValue mdString(LContext context, const char* string, unsigned length) { return llvm->MDStringInContext(context, string, length); }
120 static inline LValue mdString(LContext context, const char* string) { return mdString(context, string, std::strlen(string)); }
121 static inline LValue mdNode(LContext context, LValue* args, unsigned numArgs) { return llvm->MDNodeInContext(context, args, numArgs); }
122 template<typename VectorType>
123 static inline LValue mdNode(LContext context, const VectorType& vector) { return mdNode(context, const_cast<LValue*>(vector.begin()), vector.size()); }
124 static inline LValue mdNode(LContext context) { return mdNode(context, 0, 0); }
125 static inline LValue mdNode(LContext context, LValue arg1) { return mdNode(context, &arg1, 1); }
126 static inline LValue mdNode(LContext context, LValue arg1, LValue arg2)
127 {
128     LValue args[] = { arg1, arg2 };
129     return mdNode(context, args, 2);
130 }
131 static inline LValue mdNode(LContext context, LValue arg1, LValue arg2, LValue arg3)
132 {
133     LValue args[] = { arg1, arg2, arg3 };
134     return mdNode(context, args, 3);
135 }
136
137 static inline void setMetadata(LValue instruction, unsigned kind, LValue metadata) { llvm->SetMetadata(instruction, kind, metadata); }
138
139 static inline LValue getFirstInstruction(LBasicBlock block) { return llvm->GetFirstInstruction(block); }
140 static inline LValue getNextInstruction(LValue instruction) { return llvm->GetNextInstruction(instruction); }
141
142
143 static inline LValue addFunction(LModule module, const char* name, LType type) { return llvm->AddFunction(module, name, type); }
144 static inline LValue getNamedFunction(LModule module, const char* name) { return llvm->GetNamedFunction(module, name); }
145 static inline LValue getFirstFunction(LModule module) { return llvm->GetFirstFunction(module); }
146 static inline LValue getNextFunction(LValue function) { return llvm->GetNextFunction(function); }
147
148 static inline void setFunctionCallingConv(LValue function, LCallConv convention) { llvm->SetFunctionCallConv(function, convention); }
149 static inline void addTargetDependentFunctionAttr(LValue function, const char* key, const char* value) { llvm->AddTargetDependentFunctionAttr(function, key, value); }
150 static inline void removeFunctionAttr(LValue function, LLVMAttribute pa) { llvm->RemoveFunctionAttr(function, pa); }
151
152
153
154 static inline void setLinkage(LValue global, LLVMLinkage linkage) { llvm->SetLinkage(global, linkage); }
155 static inline void setVisibility(LValue global, LLVMVisibility viz) { llvm->SetVisibility(global, viz); }
156 static inline LLVMBool isDeclaration(LValue global) { return llvm->IsDeclaration(global); }
157
158 static inline LLVMBool linkModules(LModule dest, LModule str, LLVMLinkerMode mode, char** outMessage) { return llvm->LinkModules(dest, str, mode, outMessage); }
159
160 static inline const char * getValueName(LValue global) { return llvm->GetValueName(global); }
161
162 static inline LValue getNamedGlobal(LModule module, const char* name) { return llvm->GetNamedGlobal(module, name); }
163 static inline LValue getFirstGlobal(LModule module) { return llvm->GetFirstGlobal(module); }
164 static inline LValue getNextGlobal(LValue global) { return llvm->GetNextGlobal(global); }
165
166
167
168
169
170 static inline LValue addExternFunction(LModule module, const char* name, LType type)
171 {
172     LValue result = addFunction(module, name, type);
173     setLinkage(result, LLVMExternalLinkage);
174     return result;
175 }
176
177 static inline LLVMBool createMemoryBufferWithContentsOfFile(const char* path, LLVMMemoryBufferRef* outMemBuf, char** outMessage) 
178
179     return llvm->CreateMemoryBufferWithContentsOfFile(path, outMemBuf, outMessage); 
180 }
181
182
183 static inline LLVMBool parseBitcodeInContext(LLVMContextRef contextRef, LLVMMemoryBufferRef memBuf, LModule *outModule, char **outMessage)
184
185     return llvm->ParseBitcodeInContext(contextRef, memBuf, outModule, outMessage); 
186 }
187
188
189 static inline void disposeMemoryBuffer(LLVMMemoryBufferRef memBuf){ llvm->DisposeMemoryBuffer(memBuf); }
190
191
192 static inline LModule moduleCreateWithNameInContext(const char* moduleID, LContext context){ return llvm->ModuleCreateWithNameInContext(moduleID, context); }
193 static inline void disposeModule(LModule m){ llvm->DisposeModule(m); }
194
195 static inline LValue getParam(LValue function, unsigned index) { return llvm->GetParam(function, index); }
196
197 static inline void getParamTypes(LType function, LType* dest) { return llvm->GetParamTypes(function, dest); }
198 static inline LValue getUndef(LType type) { return llvm->GetUndef(type); }
199
200 enum BitExtension { ZeroExtend, SignExtend };
201 static inline LValue constInt(LType type, unsigned long long value, BitExtension extension = ZeroExtend) { return llvm->ConstInt(type, value, extension == SignExtend); }
202 static inline LValue constReal(LType type, double value) { return llvm->ConstReal(type, value); }
203 static inline LValue constIntToPtr(LValue value, LType type) { return llvm->ConstIntToPtr(value, type); }
204 static inline LValue constNull(LType type) { return llvm->ConstNull(type); }
205 static inline LValue constBitCast(LValue value, LType type) { return llvm->ConstBitCast(value, type); }
206
207 static inline LBasicBlock getFirstBasicBlock(LValue function) { return llvm->GetFirstBasicBlock(function); }
208 static inline LBasicBlock getNextBasicBlock(LBasicBlock block) { return llvm->GetNextBasicBlock(block); }
209
210 static inline LBasicBlock appendBasicBlock(LContext context, LValue function, const char* name = "") { return llvm->AppendBasicBlockInContext(context, function, name); }
211 static inline LBasicBlock insertBasicBlock(LContext context, LBasicBlock beforeBasicBlock, const char* name = "") { return llvm->InsertBasicBlockInContext(context, beforeBasicBlock, name); }
212
213 static inline LValue buildPhi(LBuilder builder, LType type) { return llvm->BuildPhi(builder, type, ""); }
214 static inline void addIncoming(LValue phi, const LValue* values, const LBasicBlock* blocks, unsigned numPredecessors)
215 {
216     llvm->AddIncoming(phi, const_cast<LValue*>(values), const_cast<LBasicBlock*>(blocks), numPredecessors);
217 }
218 static inline void addIncoming(LValue phi, ValueFromBlock value1)
219 {
220     LValue value = value1.value();
221     LBasicBlock block = value1.block();
222     addIncoming(phi, &value, &block, 1);
223 }
224 static inline void addIncoming(LValue phi, ValueFromBlock value1, ValueFromBlock value2)
225 {
226     LValue values[] = { value1.value(), value2.value() };
227     LBasicBlock blocks[] = { value1.block(), value2.block() };
228     addIncoming(phi, values, blocks, 2);
229 }
230 static inline LValue buildPhi(LBuilder builder, LType type, ValueFromBlock value1)
231 {
232     LValue result = buildPhi(builder, type);
233     addIncoming(result, value1);
234     return result;
235 }
236 static inline LValue buildPhi(
237     LBuilder builder, LType type, ValueFromBlock value1, ValueFromBlock value2)
238 {
239     LValue result = buildPhi(builder, type);
240     addIncoming(result, value1, value2);
241     return result;
242 }
243
244 static inline LValue buildAlloca(LBuilder builder, LType type) { return llvm->BuildAlloca(builder, type, ""); }
245 static inline LValue buildAdd(LBuilder builder, LValue left, LValue right) { return llvm->BuildAdd(builder, left, right, ""); }
246 static inline LValue buildSub(LBuilder builder, LValue left, LValue right) { return llvm->BuildSub(builder, left, right, ""); }
247 static inline LValue buildMul(LBuilder builder, LValue left, LValue right) { return llvm->BuildMul(builder, left, right, ""); }
248 static inline LValue buildDiv(LBuilder builder, LValue left, LValue right) { return llvm->BuildSDiv(builder, left, right, ""); }
249 static inline LValue buildRem(LBuilder builder, LValue left, LValue right) { return llvm->BuildSRem(builder, left, right, ""); }
250 static inline LValue buildNeg(LBuilder builder, LValue value) { return llvm->BuildNeg(builder, value, ""); }
251 static inline LValue buildFAdd(LBuilder builder, LValue left, LValue right) { return llvm->BuildFAdd(builder, left, right, ""); }
252 static inline LValue buildFSub(LBuilder builder, LValue left, LValue right) { return llvm->BuildFSub(builder, left, right, ""); }
253 static inline LValue buildFMul(LBuilder builder, LValue left, LValue right) { return llvm->BuildFMul(builder, left, right, ""); }
254 static inline LValue buildFDiv(LBuilder builder, LValue left, LValue right) { return llvm->BuildFDiv(builder, left, right, ""); }
255 static inline LValue buildFRem(LBuilder builder, LValue left, LValue right) { return llvm->BuildFRem(builder, left, right, ""); }
256 static inline LValue buildFNeg(LBuilder builder, LValue value) { return llvm->BuildFNeg(builder, value, ""); }
257 static inline LValue buildAnd(LBuilder builder, LValue left, LValue right) { return llvm->BuildAnd(builder, left, right, ""); }
258 static inline LValue buildOr(LBuilder builder, LValue left, LValue right) { return llvm->BuildOr(builder, left, right, ""); }
259 static inline LValue buildXor(LBuilder builder, LValue left, LValue right) { return llvm->BuildXor(builder, left, right, ""); }
260 static inline LValue buildShl(LBuilder builder, LValue left, LValue right) { return llvm->BuildShl(builder, left, right, ""); }
261 static inline LValue buildAShr(LBuilder builder, LValue left, LValue right) { return llvm->BuildAShr(builder, left, right, ""); }
262 static inline LValue buildLShr(LBuilder builder, LValue left, LValue right) { return llvm->BuildLShr(builder, left, right, ""); }
263 static inline LValue buildNot(LBuilder builder, LValue value) { return llvm->BuildNot(builder, value, ""); }
264 static inline LValue buildLoad(LBuilder builder, LValue pointer) { return llvm->BuildLoad(builder, pointer, ""); }
265 static inline LValue buildStore(LBuilder builder, LValue value, LValue pointer) { return llvm->BuildStore(builder, value, pointer); }
266 static inline LValue buildSExt(LBuilder builder, LValue value, LType type) { return llvm->BuildSExt(builder, value, type, ""); }
267 static inline LValue buildZExt(LBuilder builder, LValue value, LType type) { return llvm->BuildZExt(builder, value, type, ""); }
268 static inline LValue buildFPToSI(LBuilder builder, LValue value, LType type) { return llvm->BuildFPToSI(builder, value, type, ""); }
269 static inline LValue buildFPToUI(LBuilder builder, LValue value, LType type) { return llvm->BuildFPToUI(builder, value, type, ""); }
270 static inline LValue buildSIToFP(LBuilder builder, LValue value, LType type) { return llvm->BuildSIToFP(builder, value, type, ""); }
271 static inline LValue buildUIToFP(LBuilder builder, LValue value, LType type) { return llvm->BuildUIToFP(builder, value, type, ""); }
272 static inline LValue buildIntCast(LBuilder builder, LValue value, LType type) { return llvm->BuildIntCast(builder, value, type, ""); }
273 static inline LValue buildFPCast(LBuilder builder, LValue value, LType type) { return llvm->BuildFPCast(builder, value, type, ""); }
274 static inline LValue buildIntToPtr(LBuilder builder, LValue value, LType type) { return llvm->BuildIntToPtr(builder, value, type, ""); }
275 static inline LValue buildPtrToInt(LBuilder builder, LValue value, LType type) { return llvm->BuildPtrToInt(builder, value, type, ""); }
276 static inline LValue buildBitCast(LBuilder builder, LValue value, LType type) { return llvm->BuildBitCast(builder, value, type, ""); }
277 static inline LValue buildICmp(LBuilder builder, LIntPredicate cond, LValue left, LValue right) { return llvm->BuildICmp(builder, cond, left, right, ""); }
278 static inline LValue buildFCmp(LBuilder builder, LRealPredicate cond, LValue left, LValue right) { return llvm->BuildFCmp(builder, cond, left, right, ""); }
279 static inline LValue buildInsertElement(LBuilder builder, LValue vector, LValue element, LValue index) { return llvm->BuildInsertElement(builder, vector, element, index, ""); }
280
281 enum SynchronizationScope { SingleThread, CrossThread };
282 static inline LValue buildFence(LBuilder builder, LAtomicOrdering ordering, SynchronizationScope scope = CrossThread)
283 {
284     return llvm->BuildFence(builder, ordering, scope == SingleThread, "");
285 }
286
287 static inline LValue buildCall(LBuilder builder, LValue function, const LValue* args, unsigned numArgs)
288 {
289     return llvm->BuildCall(builder, function, const_cast<LValue*>(args), numArgs, "");
290 }
291 template<typename VectorType>
292 inline LValue buildCall(LBuilder builder, LValue function, const VectorType& vector)
293 {
294     return buildCall(builder, function, vector.begin(), vector.size());
295 }
296 static inline LValue buildCall(LBuilder builder, LValue function)
297 {
298     return buildCall(builder, function, 0, 0);
299 }
300 static inline LValue buildCall(LBuilder builder, LValue function, LValue arg1)
301 {
302     return buildCall(builder, function, &arg1, 1);
303 }
304 static inline LValue buildCall(LBuilder builder, LValue function, LValue arg1, LValue arg2)
305 {
306     LValue args[] = { arg1, arg2 };
307     return buildCall(builder, function, args, 2);
308 }
309 static inline LValue buildCall(LBuilder builder, LValue function, LValue arg1, LValue arg2, LValue arg3)
310 {
311     LValue args[] = { arg1, arg2, arg3 };
312     return buildCall(builder, function, args, 3);
313 }
314 static inline LValue buildCall(LBuilder builder, LValue function, LValue arg1, LValue arg2, LValue arg3, LValue arg4)
315 {
316     LValue args[] = { arg1, arg2, arg3, arg4 };
317     return buildCall(builder, function, args, 4);
318 }
319 static inline LValue buildCall(LBuilder builder, LValue function, LValue arg1, LValue arg2, LValue arg3, LValue arg4, LValue arg5)
320 {
321     LValue args[] = { arg1, arg2, arg3, arg4, arg5 };
322     return buildCall(builder, function, args, 5);
323 }
324 static inline LValue buildCall(LBuilder builder, LValue function, LValue arg1, LValue arg2, LValue arg3, LValue arg4, LValue arg5, LValue arg6)
325 {
326     LValue args[] = { arg1, arg2, arg3, arg4, arg5, arg6 };
327     return buildCall(builder, function, args, 6);
328 }
329 static inline LValue buildCall(LBuilder builder, LValue function, LValue arg1, LValue arg2, LValue arg3, LValue arg4, LValue arg5, LValue arg6, LValue arg7)
330 {
331     LValue args[] = { arg1, arg2, arg3, arg4, arg5, arg6, arg7 };
332     return buildCall(builder, function, args, 7);
333 }
334 static inline LValue buildCall(LBuilder builder, LValue function, LValue arg1, LValue arg2, LValue arg3, LValue arg4, LValue arg5, LValue arg6, LValue arg7, LValue arg8)
335 {
336     LValue args[] = { arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8 };
337     return buildCall(builder, function, args, 8);
338 }
339 static inline void setInstructionCallingConvention(LValue instruction, LCallConv callingConvention) { llvm->SetInstructionCallConv(instruction, callingConvention); }
340 static inline LValue buildExtractValue(LBuilder builder, LValue aggVal, unsigned index) { return llvm->BuildExtractValue(builder, aggVal, index, ""); }
341 static inline LValue buildSelect(LBuilder builder, LValue condition, LValue taken, LValue notTaken) { return llvm->BuildSelect(builder, condition, taken, notTaken, ""); }
342 static inline LValue buildBr(LBuilder builder, LBasicBlock destination) { return llvm->BuildBr(builder, destination); }
343 static inline LValue buildCondBr(LBuilder builder, LValue condition, LBasicBlock taken, LBasicBlock notTaken) { return llvm->BuildCondBr(builder, condition, taken, notTaken); }
344 static inline LValue buildSwitch(LBuilder builder, LValue value, LBasicBlock fallThrough, unsigned numCases) { return llvm->BuildSwitch(builder, value, fallThrough, numCases); }
345 static inline void addCase(LValue switchInst, LValue value, LBasicBlock target) { llvm->AddCase(switchInst, value, target); }
346 template<typename VectorType>
347 static inline LValue buildSwitch(LBuilder builder, LValue value, const VectorType& cases, LBasicBlock fallThrough)
348 {
349     LValue result = buildSwitch(builder, value, fallThrough, cases.size());
350     for (unsigned i = 0; i < cases.size(); ++i)
351         addCase(result, cases[i].value(), cases[i].target());
352     return result;
353 }
354 static inline LValue buildRet(LBuilder builder, LValue value) { return llvm->BuildRet(builder, value); }
355 static inline LValue buildUnreachable(LBuilder builder) { return llvm->BuildUnreachable(builder); }
356
357 static inline void dumpModule(LModule module) { llvm->DumpModule(module); }
358 static inline void verifyModule(LModule module)
359 {
360     char* error = 0;
361     llvm->VerifyModule(module, LLVMAbortProcessAction, &error);
362     llvm->DisposeMessage(error);
363 }
364
365 } } // namespace JSC::FTL
366
367 #endif // ENABLE(FTL_JIT)
368
369 #endif // FTLAbbreviations_h
370