#ifndef LLVM_LLVMCONTEXT_H
#define LLVM_LLVMCONTEXT_H
-#include "llvm/Support/DataTypes.h"
-#include <vector>
-#include <string>
+#include "llvm/Support/Compiler.h"
namespace llvm {
class LLVMContextImpl;
-class Constant;
-class ConstantInt;
-class ConstantPointerNull;
-class ConstantStruct;
-class ConstantAggregateZero;
-class ConstantArray;
-class ConstantFP;
-class ConstantVector;
-class IntegerType;
-class PointerType;
-class StructType;
-class ArrayType;
-class VectorType;
-class OpaqueType;
-class FunctionType;
-class Type;
-class APInt;
-class APFloat;
-class Value;
+class StringRef;
+class Twine;
+class Instruction;
+class Module;
+class SMDiagnostic;
+template <typename T> class SmallVectorImpl;
/// This is an important class for using LLVM in a threaded context. It
/// (opaquely) owns and manages the core "global" data of LLVM's core
/// LLVMContext itself provides no locking guarantees, so you should be careful
/// to have one context per thread.
class LLVMContext {
- LLVMContextImpl* pImpl;
public:
+ LLVMContextImpl *const pImpl;
LLVMContext();
~LLVMContext();
- // ConstantInt accessors
- ConstantInt* getConstantIntTrue();
- ConstantInt* getConstantIntFalse();
- ConstantInt* getConstantInt(const IntegerType* Ty, uint64_t V,
- bool isSigned = false);
- ConstantInt* getConstantIntSigned(const IntegerType* Ty, int64_t V);
- ConstantInt* getConstantInt(const APInt& V);
- Constant* getConstantInt(const Type* Ty, const APInt& V);
- ConstantInt* getAllOnesConstantInt(const Type* Ty);
+ // Pinned metadata names, which always have the same value. This is a
+ // compile-time performance optimization, not a correctness optimization.
+ enum {
+ MD_dbg = 0, // "dbg"
+ MD_tbaa = 1, // "tbaa"
+ MD_prof = 2, // "prof"
+ MD_fpmath = 3, // "fpmath"
+ MD_range = 4, // "range"
+ MD_tbaa_struct = 5 // "tbaa.struct"
+ };
- // ConstantPointerNull accessors
- ConstantPointerNull* getConstantPointerNull(const PointerType* T);
+ /// getMDKindID - Return a unique non-zero ID for the specified metadata kind.
+ /// This ID is uniqued across modules in the current LLVMContext.
+ unsigned getMDKindID(StringRef Name) const;
- // ConstantStruct accessors
- Constant* getConstantStruct(const StructType* T,
- const std::vector<Constant*>& V);
- Constant* getConstantStruct(const std::vector<Constant*>& V,
- bool Packed = false);
- Constant* getConstantStruct(Constant* const *Vals, unsigned NumVals,
- bool Packed = false);
-
- // ConstantAggregateZero accessors
- ConstantAggregateZero* getConstantAggregateZero(const Type* Ty);
+ /// getMDKindNames - Populate client supplied SmallVector with the name for
+ /// custom metadata IDs registered in this LLVMContext.
+ void getMDKindNames(SmallVectorImpl<StringRef> &Result) const;
- // ConstantArray accessors
- Constant* getConstantArray(const ArrayType* T,
- const std::vector<Constant*>& V);
- Constant* getConstantArray(const ArrayType* T, Constant* const* Vals,
- unsigned NumVals);
- Constant* getConstantArray(const std::string& Initializer,
- bool AddNull = false);
-
- // ConstantExpr accessors
- Constant* getConstantExpr(unsigned Opcode, Constant* C1, Constant* C2);
- Constant* getConstantExprTrunc(Constant* C, const Type* Ty);
- Constant* getConstantExprSExt(Constant* C, const Type* Ty);
- Constant* getConstantExprZExt(Constant* C, const Type* Ty);
- Constant* getConstantExprFPTrunc(Constant* C, const Type* Ty);
- Constant* getConstantExprFPExtend(Constant* C, const Type* Ty);
- Constant* getConstantExprUIToFP(Constant* C, const Type* Ty);
- Constant* getConstantExprSIToFP(Constant* C, const Type* Ty);
- Constant* getConstantExprFPToUI(Constant* C, const Type* Ty);
- Constant* getConstantExprFPToSI(Constant* C, const Type* Ty);
- Constant* getConstantExprPtrToInt(Constant* C, const Type* Ty);
- Constant* getConstantExprIntToPtr(Constant* C, const Type* Ty);
- Constant* getConstantExprBitCast(Constant* C, const Type* Ty);
- Constant* getConstantExprCast(unsigned ops, Constant* C, const Type* Ty);
- Constant* getConstantExprZExtOrBitCast(Constant* C, const Type* Ty);
- Constant* getConstantExprSExtOrBitCast(Constant* C, const Type* Ty);
- Constant* getConstantExprTruncOrBitCast(Constant* C, const Type* Ty);
- Constant* getConstantExprPointerCast(Constant* C, const Type* Ty);
- Constant* getConstantExprIntegerCast(Constant* C, const Type* Ty,
- bool isSigned);
- Constant* getConstantExprFPCast(Constant* C, const Type* Ty);
- Constant* getConstantExprSelect(Constant* C, Constant* V1, Constant* V2);
- Constant* getConstantExprAlignOf(const Type* Ty);
- Constant* getConstantExprCompare(unsigned short pred,
- Constant* C1, Constant* C2);
- Constant* getConstantExprNeg(Constant* C);
- Constant* getConstantExprFNeg(Constant* C);
- Constant* getConstantExprNot(Constant* C);
- Constant* getConstantExprAdd(Constant* C1, Constant* C2);
- Constant* getConstantExprFAdd(Constant* C1, Constant* C2);
- Constant* getConstantExprSub(Constant* C1, Constant* C2);
- Constant* getConstantExprFSub(Constant* C1, Constant* C2);
- Constant* getConstantExprMul(Constant* C1, Constant* C2);
- Constant* getConstantExprFMul(Constant* C1, Constant* C2);
- Constant* getConstantExprUDiv(Constant* C1, Constant* C2);
- Constant* getConstantExprSDiv(Constant* C1, Constant* C2);
- Constant* getConstantExprFDiv(Constant* C1, Constant* C2);
- Constant* getConstantExprURem(Constant* C1, Constant* C2);
- Constant* getConstantExprSRem(Constant* C1, Constant* C2);
- Constant* getConstantExprFRem(Constant* C1, Constant* C2);
- Constant* getConstantExprAnd(Constant* C1, Constant* C2);
- Constant* getConstantExprOr(Constant* C1, Constant* C2);
- Constant* getConstantExprXor(Constant* C1, Constant* C2);
- Constant* getConstantExprICmp(unsigned short pred, Constant* LHS,
- Constant* RHS);
- Constant* getConstantExprFCmp(unsigned short pred, Constant* LHS,
- Constant* RHS);
- Constant* getConstantExprVICmp(unsigned short pred, Constant* LHS,
- Constant* RHS);
- Constant* getConstantExprVFCmp(unsigned short pred, Constant* LHS,
- Constant* RHS);
- Constant* getConstantExprShl(Constant* C1, Constant* C2);
- Constant* getConstantExprLShr(Constant* C1, Constant* C2);
- Constant* getConstantExprAShr(Constant* C1, Constant* C2);
- Constant* getConstantExprGetElementPtr(Constant* C, Constant* const* IdxList,
- unsigned NumIdx);
- Constant* getConstantExprGetElementPtr(Constant* C, Value* const* IdxList,
- unsigned NumIdx);
- Constant* getConstantExprExtractElement(Constant* Vec, Constant* Idx);
- Constant* getConstantExprInsertElement(Constant* Vec, Constant* Elt,
- Constant* Idx);
- Constant* getConstantExprShuffleVector(Constant* V1, Constant* V2,
- Constant* Mask);
- Constant* getConstantExprExtractValue(Constant* Agg, const unsigned* IdxList,
- unsigned NumIdx);
- Constant* getConstantExprInsertValue(Constant* Agg, Constant* Val,
- const unsigned* IdxList,
- unsigned NumIdx);
- Constant* getZeroValueForNegation(const Type* Ty);
- // ConstantFP accessors
- ConstantFP* getConstantFP(const APFloat& V);
- Constant* getConstantFP(const Type* Ty, double V);
- ConstantFP* getConstantFPNegativeZero(const Type* Ty);
+ typedef void (*DiagHandlerTy)(const SMDiagnostic&, void *Context,
+ unsigned LocCookie);
- // ConstantVector accessors
- Constant* getConstantVector(const VectorType* T,
- const std::vector<Constant*>& V);
- Constant* getConstantVector(const std::vector<Constant*>& V);
- Constant* getConstantVector(Constant* const* Vals, unsigned NumVals);
- ConstantVector* getConstantVectorAllOnes(const VectorType* Ty);
-
- // FunctionType accessors
- FunctionType* getFunctionType(const Type* Result,
- const std::vector<const Type*>& Params,
- bool isVarArg);
-
- // IntegerType accessors
- const IntegerType* getIntegerType(unsigned NumBits);
-
- // OpaqueType accessors
- OpaqueType* getOpaqueType();
+ /// setDiagnosticHandler - This method sets a handler that is invoked
+ /// when problems are detected by the backend. The first argument is a
+ /// function pointer and the second is a context pointer that gets passed
+ /// into the DiagHandler.
+ ///
+ /// LLVMContext doesn't take ownership or interpret either of these
+ /// pointers.
+ void setDiagnosticHandler(DiagHandlerTy DiagHandler, void *DiagContext = 0);
+
+ /// getDiagnosticHandler - Return the diagnostic handler set by
+ /// setDiagnosticHandler.
+ DiagHandlerTy getDiagnosticHandler() const;
+
+ /// getDiagnosticContext - Return the diagnostic context set by
+ /// setDiagnosticHandler.
+ void *getDiagnosticContext() const;
- // StructType accessors
- StructType* getStructType(const std::vector<const Type*>& Params,
- bool isPacked = false);
+ /// FIXME: Temporary copies of the old names; to be removed as soon as
+ /// clang switches to the new ones.
+ typedef DiagHandlerTy InlineAsmDiagHandlerTy;
+ void setInlineAsmDiagnosticHandler(InlineAsmDiagHandlerTy DiagHandler,
+ void *DiagContext = 0) {
+ setDiagnosticHandler(DiagHandler, DiagContext);
+ }
+ InlineAsmDiagHandlerTy getInlineAsmDiagnosticHandler() const {
+ return getDiagnosticHandler();
+ }
+ void *getInlineAsmDiagnosticContext() const {
+ return getDiagnosticContext();
+ }
- // ArrayType accessors
- ArrayType* getArrayType(const Type* ElementType, uint64_t NumElements);
+ /// emitError - Emit an error message to the currently installed error handler
+ /// with optional location information. This function returns, so code should
+ /// be prepared to drop the erroneous construct on the floor and "not crash".
+ /// The generated code need not be correct. The error message will be
+ /// implicitly prefixed with "error: " and should not end with a ".".
+ void emitError(unsigned LocCookie, const Twine &ErrorStr);
+ void emitError(const Instruction *I, const Twine &ErrorStr);
+ void emitError(const Twine &ErrorStr);
+
+ /// emitWarning - This is similar to emitError but it emits a warning instead
+ /// of an error.
+ void emitWarning(unsigned LocCookie, const Twine &ErrorStr);
+ void emitWarning(const Instruction *I, const Twine &ErrorStr);
+ void emitWarning(const Twine &ErrorStr);
+
+private:
+ LLVMContext(LLVMContext&) LLVM_DELETED_FUNCTION;
+ void operator=(LLVMContext&) LLVM_DELETED_FUNCTION;
+
+ /// addModule - Register a module as being instantiated in this context. If
+ /// the context is deleted, the module will be deleted as well.
+ void addModule(Module*);
- // PointerType accessors
- PointerType* getPointerType(const Type* ElementType, unsigned AddressSpace);
- PointerType* getPointerTypeUnqualified(const Type* ElementType);
+ /// removeModule - Unregister a module from this context.
+ void removeModule(Module*);
- // VectorType accessors
- VectorType* getVectorType(const Type* ElementType, unsigned NumElements);
- VectorType* getVectorTypeInteger(const VectorType* VTy);
- VectorType* getVectorTypeExtendedElement(const VectorType* VTy);
- VectorType* getVectorTypeTruncatedElement(const VectorType* VTy);
+ // Module needs access to the add/removeModule methods.
+ friend class Module;
};
+/// getGlobalContext - Returns a global context. This is for LLVM clients that
+/// only care about operating on a single thread.
+extern LLVMContext &getGlobalContext();
+
}
#endif