1 //===-- llvm/LLVMContext.h - Class for managing "global" state --*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares LLVMContext, a container of "global" state in LLVM, such
11 // as the global type and constant uniquing tables.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_LLVMCONTEXT_H
16 #define LLVM_LLVMCONTEXT_H
18 #include "llvm/Support/DataTypes.h"
24 class LLVMContextImpl;
27 class ConstantPointerNull;
29 class ConstantAggregateZero;
46 /// This is an important class for using LLVM in a threaded context. It
47 /// (opaquely) owns and manages the core "global" data of LLVM's core
48 /// infrastructure, including the type and constant uniquing tables.
49 /// LLVMContext itself provides no locking guarantees, so you should be careful
50 /// to have one context per thread.
52 LLVMContextImpl* pImpl;
58 Constant* getNullValue(const Type* Ty);
59 Constant* getAllOnesValue(const Type* Ty);
61 // UndefValue accessors
62 UndefValue* getUndef(const Type* Ty);
64 // ConstantInt accessors
65 ConstantInt* getConstantIntTrue();
66 ConstantInt* getConstantIntFalse();
67 ConstantInt* getConstantInt(const IntegerType* Ty, uint64_t V,
68 bool isSigned = false);
69 ConstantInt* getConstantIntSigned(const IntegerType* Ty, int64_t V);
70 ConstantInt* getConstantInt(const APInt& V);
71 Constant* getConstantInt(const Type* Ty, const APInt& V);
72 ConstantInt* getAllOnesConstantInt(const Type* Ty);
74 // ConstantPointerNull accessors
75 ConstantPointerNull* getConstantPointerNull(const PointerType* T);
77 // ConstantStruct accessors
78 Constant* getConstantStruct(const StructType* T,
79 const std::vector<Constant*>& V);
80 Constant* getConstantStruct(const std::vector<Constant*>& V,
82 Constant* getConstantStruct(Constant* const *Vals, unsigned NumVals,
85 // ConstantAggregateZero accessors
86 ConstantAggregateZero* getConstantAggregateZero(const Type* Ty);
88 // ConstantArray accessors
89 Constant* getConstantArray(const ArrayType* T,
90 const std::vector<Constant*>& V);
91 Constant* getConstantArray(const ArrayType* T, Constant* const* Vals,
93 Constant* getConstantArray(const std::string& Initializer,
94 bool AddNull = false);
96 // ConstantExpr accessors
97 Constant* getConstantExpr(unsigned Opcode, Constant* C1, Constant* C2);
98 Constant* getConstantExprTrunc(Constant* C, const Type* Ty);
99 Constant* getConstantExprSExt(Constant* C, const Type* Ty);
100 Constant* getConstantExprZExt(Constant* C, const Type* Ty);
101 Constant* getConstantExprFPTrunc(Constant* C, const Type* Ty);
102 Constant* getConstantExprFPExtend(Constant* C, const Type* Ty);
103 Constant* getConstantExprUIToFP(Constant* C, const Type* Ty);
104 Constant* getConstantExprSIToFP(Constant* C, const Type* Ty);
105 Constant* getConstantExprFPToUI(Constant* C, const Type* Ty);
106 Constant* getConstantExprFPToSI(Constant* C, const Type* Ty);
107 Constant* getConstantExprPtrToInt(Constant* C, const Type* Ty);
108 Constant* getConstantExprIntToPtr(Constant* C, const Type* Ty);
109 Constant* getConstantExprBitCast(Constant* C, const Type* Ty);
110 Constant* getConstantExprCast(unsigned ops, Constant* C, const Type* Ty);
111 Constant* getConstantExprZExtOrBitCast(Constant* C, const Type* Ty);
112 Constant* getConstantExprSExtOrBitCast(Constant* C, const Type* Ty);
113 Constant* getConstantExprTruncOrBitCast(Constant* C, const Type* Ty);
114 Constant* getConstantExprPointerCast(Constant* C, const Type* Ty);
115 Constant* getConstantExprIntegerCast(Constant* C, const Type* Ty,
117 Constant* getConstantExprFPCast(Constant* C, const Type* Ty);
118 Constant* getConstantExprSelect(Constant* C, Constant* V1, Constant* V2);
119 Constant* getConstantExprAlignOf(const Type* Ty);
120 Constant* getConstantExprCompare(unsigned short pred,
121 Constant* C1, Constant* C2);
122 Constant* getConstantExprNeg(Constant* C);
123 Constant* getConstantExprFNeg(Constant* C);
124 Constant* getConstantExprNot(Constant* C);
125 Constant* getConstantExprAdd(Constant* C1, Constant* C2);
126 Constant* getConstantExprFAdd(Constant* C1, Constant* C2);
127 Constant* getConstantExprSub(Constant* C1, Constant* C2);
128 Constant* getConstantExprFSub(Constant* C1, Constant* C2);
129 Constant* getConstantExprMul(Constant* C1, Constant* C2);
130 Constant* getConstantExprFMul(Constant* C1, Constant* C2);
131 Constant* getConstantExprUDiv(Constant* C1, Constant* C2);
132 Constant* getConstantExprSDiv(Constant* C1, Constant* C2);
133 Constant* getConstantExprFDiv(Constant* C1, Constant* C2);
134 Constant* getConstantExprURem(Constant* C1, Constant* C2);
135 Constant* getConstantExprSRem(Constant* C1, Constant* C2);
136 Constant* getConstantExprFRem(Constant* C1, Constant* C2);
137 Constant* getConstantExprAnd(Constant* C1, Constant* C2);
138 Constant* getConstantExprOr(Constant* C1, Constant* C2);
139 Constant* getConstantExprXor(Constant* C1, Constant* C2);
140 Constant* getConstantExprICmp(unsigned short pred, Constant* LHS,
142 Constant* getConstantExprFCmp(unsigned short pred, Constant* LHS,
144 Constant* getConstantExprVICmp(unsigned short pred, Constant* LHS,
146 Constant* getConstantExprVFCmp(unsigned short pred, Constant* LHS,
148 Constant* getConstantExprShl(Constant* C1, Constant* C2);
149 Constant* getConstantExprLShr(Constant* C1, Constant* C2);
150 Constant* getConstantExprAShr(Constant* C1, Constant* C2);
151 Constant* getConstantExprGetElementPtr(Constant* C, Constant* const* IdxList,
153 Constant* getConstantExprGetElementPtr(Constant* C, Value* const* IdxList,
155 Constant* getConstantExprExtractElement(Constant* Vec, Constant* Idx);
156 Constant* getConstantExprInsertElement(Constant* Vec, Constant* Elt,
158 Constant* getConstantExprShuffleVector(Constant* V1, Constant* V2,
160 Constant* getConstantExprExtractValue(Constant* Agg, const unsigned* IdxList,
162 Constant* getConstantExprInsertValue(Constant* Agg, Constant* Val,
163 const unsigned* IdxList,
165 Constant* getZeroValueForNegation(const Type* Ty);
167 // ConstantFP accessors
168 ConstantFP* getConstantFP(const APFloat& V);
169 Constant* getConstantFP(const Type* Ty, double V);
170 ConstantFP* getConstantFPNegativeZero(const Type* Ty);
172 // ConstantVector accessors
173 Constant* getConstantVector(const VectorType* T,
174 const std::vector<Constant*>& V);
175 Constant* getConstantVector(const std::vector<Constant*>& V);
176 Constant* getConstantVector(Constant* const* Vals, unsigned NumVals);
177 ConstantVector* getConstantVectorAllOnes(const VectorType* Ty);
179 // FunctionType accessors
180 FunctionType* getFunctionType(const Type* Result,
181 const std::vector<const Type*>& Params,
184 // IntegerType accessors
185 const IntegerType* getIntegerType(unsigned NumBits);
187 // OpaqueType accessors
188 OpaqueType* getOpaqueType();
190 // StructType accessors
191 StructType* getStructType(bool isPacked=false);
192 StructType* getStructType(const std::vector<const Type*>& Params,
193 bool isPacked = false);
195 // ArrayType accessors
196 ArrayType* getArrayType(const Type* ElementType, uint64_t NumElements);
198 // PointerType accessors
199 PointerType* getPointerType(const Type* ElementType, unsigned AddressSpace);
200 PointerType* getPointerTypeUnqual(const Type* ElementType);
202 // VectorType accessors
203 VectorType* getVectorType(const Type* ElementType, unsigned NumElements);
204 VectorType* getVectorTypeInteger(const VectorType* VTy);
205 VectorType* getVectorTypeExtendedElement(const VectorType* VTy);
206 VectorType* getVectorTypeTruncatedElement(const VectorType* VTy);
209 /// FOR BACKWARDS COMPATIBILITY - Returns a global context.
210 extern LLVMContext& getGlobalContext();