Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 1 | /*===-- llvm-c/Core.h - Core Library C Interface ------------------*- C -*-===*\ |
| 2 | |* *| |
| 3 | |* The LLVM Compiler Infrastructure *| |
| 4 | |* *| |
Chris Lattner | e9cc742 | 2007-12-29 19:59:42 +0000 | [diff] [blame] | 5 | |* This file is distributed under the University of Illinois Open Source *| |
| 6 | |* License. See LICENSE.TXT for details. *| |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 7 | |* *| |
| 8 | |*===----------------------------------------------------------------------===*| |
| 9 | |* *| |
| 10 | |* This header declares the C interface to libLLVMCore.a, which implements *| |
| 11 | |* the LLVM intermediate representation. *| |
| 12 | |* *| |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 13 | \*===----------------------------------------------------------------------===*/ |
| 14 | |
| 15 | #ifndef LLVM_C_CORE_H |
| 16 | #define LLVM_C_CORE_H |
| 17 | |
Michael J. Spencer | ab425d8 | 2010-11-29 18:47:54 +0000 | [diff] [blame] | 18 | #include "llvm/Support/DataTypes.h" |
Erick Tryzelaar | dd99135 | 2009-08-16 23:36:46 +0000 | [diff] [blame] | 19 | |
Evan Cheng | 2e254d0 | 2013-04-04 17:40:53 +0000 | [diff] [blame] | 20 | #ifdef __cplusplus |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 21 | extern "C" { |
| 22 | #endif |
| 23 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 24 | /** |
| 25 | * @defgroup LLVMC LLVM-C: C interface to LLVM |
| 26 | * |
| 27 | * This module exposes parts of the LLVM library as a C API. |
| 28 | * |
| 29 | * @{ |
| 30 | */ |
| 31 | |
| 32 | /** |
| 33 | * @defgroup LLVMCTransforms Transforms |
| 34 | */ |
| 35 | |
| 36 | /** |
| 37 | * @defgroup LLVMCCore Core |
| 38 | * |
| 39 | * This modules provide an interface to libLLVMCore, which implements |
| 40 | * the LLVM intermediate representation as well as other related types |
| 41 | * and utilities. |
| 42 | * |
| 43 | * LLVM uses a polymorphic type hierarchy which C cannot represent, therefore |
| 44 | * parameters must be passed as base types. Despite the declared types, most |
| 45 | * of the functions provided operate only on branches of the type hierarchy. |
| 46 | * The declared parameter names are descriptive and specify which type is |
| 47 | * required. Additionally, each type hierarchy is documented along with the |
| 48 | * functions that operate upon it. For more detail, refer to LLVM's C++ code. |
Eli Bendersky | 870d057 | 2012-08-10 18:26:20 +0000 | [diff] [blame] | 49 | * If in doubt, refer to Core.cpp, which performs parameter downcasts in the |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 50 | * form unwrap<RequiredType>(Param). |
| 51 | * |
| 52 | * Many exotic languages can interoperate with C code but have a harder time |
| 53 | * with C++ due to name mangling. So in addition to C, this interface enables |
| 54 | * tools written in such languages. |
| 55 | * |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 56 | * @{ |
| 57 | */ |
| 58 | |
| 59 | /** |
| 60 | * @defgroup LLVMCCoreTypes Types and Enumerations |
| 61 | * |
| 62 | * @{ |
| 63 | */ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 64 | |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 65 | typedef int LLVMBool; |
| 66 | |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 67 | /* Opaque types. */ |
Gordon Henriksen | 4a4d735 | 2007-12-30 17:46:33 +0000 | [diff] [blame] | 68 | |
| 69 | /** |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 70 | * The top-level container for all LLVM global data. See the LLVMContext class. |
Owen Anderson | 6773d38 | 2009-07-01 16:58:40 +0000 | [diff] [blame] | 71 | */ |
Erick Tryzelaar | 262332f | 2009-08-14 00:01:31 +0000 | [diff] [blame] | 72 | typedef struct LLVMOpaqueContext *LLVMContextRef; |
Owen Anderson | 6773d38 | 2009-07-01 16:58:40 +0000 | [diff] [blame] | 73 | |
| 74 | /** |
Gordon Henriksen | 4a4d735 | 2007-12-30 17:46:33 +0000 | [diff] [blame] | 75 | * The top-level container for all other LLVM Intermediate Representation (IR) |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 76 | * objects. |
| 77 | * |
| 78 | * @see llvm::Module |
Gordon Henriksen | 4a4d735 | 2007-12-30 17:46:33 +0000 | [diff] [blame] | 79 | */ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 80 | typedef struct LLVMOpaqueModule *LLVMModuleRef; |
Gordon Henriksen | 4a4d735 | 2007-12-30 17:46:33 +0000 | [diff] [blame] | 81 | |
| 82 | /** |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 83 | * Each value in the LLVM IR has a type, an LLVMTypeRef. |
| 84 | * |
| 85 | * @see llvm::Type |
Gordon Henriksen | 4a4d735 | 2007-12-30 17:46:33 +0000 | [diff] [blame] | 86 | */ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 87 | typedef struct LLVMOpaqueType *LLVMTypeRef; |
Gordon Henriksen | 4a4d735 | 2007-12-30 17:46:33 +0000 | [diff] [blame] | 88 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 89 | /** |
| 90 | * Represents an individual value in LLVM IR. |
| 91 | * |
| 92 | * This models llvm::Value. |
| 93 | */ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 94 | typedef struct LLVMOpaqueValue *LLVMValueRef; |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 95 | |
| 96 | /** |
Eli Bendersky | 870d057 | 2012-08-10 18:26:20 +0000 | [diff] [blame] | 97 | * Represents a basic block of instructions in LLVM IR. |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 98 | * |
| 99 | * This models llvm::BasicBlock. |
| 100 | */ |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 101 | typedef struct LLVMOpaqueBasicBlock *LLVMBasicBlockRef; |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 102 | |
| 103 | /** |
| 104 | * Represents an LLVM basic block builder. |
| 105 | * |
| 106 | * This models llvm::IRBuilder. |
| 107 | */ |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 108 | typedef struct LLVMOpaqueBuilder *LLVMBuilderRef; |
Gordon Henriksen | 34eb6d8 | 2007-12-19 22:30:40 +0000 | [diff] [blame] | 109 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 110 | /** |
| 111 | * Interface used to provide a module to JIT or interpreter. |
| 112 | * This is now just a synonym for llvm::Module, but we have to keep using the |
| 113 | * different type to keep binary compatibility. |
Gordon Henriksen | 34eb6d8 | 2007-12-19 22:30:40 +0000 | [diff] [blame] | 114 | */ |
Gordon Henriksen | 0a68fe2 | 2007-12-12 01:04:30 +0000 | [diff] [blame] | 115 | typedef struct LLVMOpaqueModuleProvider *LLVMModuleProviderRef; |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 116 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 117 | /** |
| 118 | * Used to provide a module to JIT or interpreter. |
| 119 | * |
| 120 | * @see llvm::MemoryBuffer |
Gordon Henriksen | 34eb6d8 | 2007-12-19 22:30:40 +0000 | [diff] [blame] | 121 | */ |
| 122 | typedef struct LLVMOpaqueMemoryBuffer *LLVMMemoryBufferRef; |
| 123 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 124 | /** @see llvm::PassManagerBase */ |
Gordon Henriksen | 878114b | 2008-03-16 04:20:44 +0000 | [diff] [blame] | 125 | typedef struct LLVMOpaquePassManager *LLVMPassManagerRef; |
| 126 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 127 | /** @see llvm::PassRegistry */ |
Owen Anderson | 4698c5d | 2010-10-07 17:55:47 +0000 | [diff] [blame] | 128 | typedef struct LLVMOpaquePassRegistry *LLVMPassRegistryRef; |
| 129 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 130 | /** |
| 131 | * Used to get the users and usees of a Value. |
| 132 | * |
| 133 | * @see llvm::Use */ |
Erick Tryzelaar | 9f9857e | 2010-03-02 20:32:28 +0000 | [diff] [blame] | 134 | typedef struct LLVMOpaqueUse *LLVMUseRef; |
Chris Lattner | 40cf28d | 2009-10-12 04:01:02 +0000 | [diff] [blame] | 135 | |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 136 | typedef enum { |
Devang Patel | 4c758ea | 2008-09-25 21:00:45 +0000 | [diff] [blame] | 137 | LLVMZExtAttribute = 1<<0, |
| 138 | LLVMSExtAttribute = 1<<1, |
| 139 | LLVMNoReturnAttribute = 1<<2, |
| 140 | LLVMInRegAttribute = 1<<3, |
| 141 | LLVMStructRetAttribute = 1<<4, |
| 142 | LLVMNoUnwindAttribute = 1<<5, |
| 143 | LLVMNoAliasAttribute = 1<<6, |
| 144 | LLVMByValAttribute = 1<<7, |
| 145 | LLVMNestAttribute = 1<<8, |
| 146 | LLVMReadNoneAttribute = 1<<9, |
Anton Korobeynikov | c8ce7b08 | 2009-07-17 18:07:26 +0000 | [diff] [blame] | 147 | LLVMReadOnlyAttribute = 1<<10, |
Anton Korobeynikov | 9750be9 | 2009-07-17 18:57:16 +0000 | [diff] [blame] | 148 | LLVMNoInlineAttribute = 1<<11, |
| 149 | LLVMAlwaysInlineAttribute = 1<<12, |
| 150 | LLVMOptimizeForSizeAttribute = 1<<13, |
| 151 | LLVMStackProtectAttribute = 1<<14, |
| 152 | LLVMStackProtectReqAttribute = 1<<15, |
Erick Tryzelaar | 8f69fea | 2010-03-03 23:51:25 +0000 | [diff] [blame] | 153 | LLVMAlignment = 31<<16, |
Anton Korobeynikov | 9750be9 | 2009-07-17 18:57:16 +0000 | [diff] [blame] | 154 | LLVMNoCaptureAttribute = 1<<21, |
| 155 | LLVMNoRedZoneAttribute = 1<<22, |
| 156 | LLVMNoImplicitFloatAttribute = 1<<23, |
Jakob Stoklund Olesen | 74bb06c | 2010-02-06 01:16:28 +0000 | [diff] [blame] | 157 | LLVMNakedAttribute = 1<<24, |
Erick Tryzelaar | 8f69fea | 2010-03-03 23:51:25 +0000 | [diff] [blame] | 158 | LLVMInlineHintAttribute = 1<<25, |
Torok Edwin | 1db48c0 | 2011-10-06 12:13:32 +0000 | [diff] [blame] | 159 | LLVMStackAlignment = 7<<26, |
| 160 | LLVMReturnsTwice = 1 << 29, |
| 161 | LLVMUWTable = 1 << 30, |
Chandler Carruth | 44d69d9 | 2012-01-25 07:40:15 +0000 | [diff] [blame] | 162 | LLVMNonLazyBind = 1 << 31 |
| 163 | |
Bill Wendling | d154e283 | 2013-01-23 06:41:41 +0000 | [diff] [blame] | 164 | /* FIXME: These attributes are currently not included in the C API as |
Nuno Lopes | def422997 | 2012-09-02 14:19:21 +0000 | [diff] [blame] | 165 | a temporary measure until the API/ABI impact to the C API is understood |
| 166 | and the path forward agreed upon. |
Bill Wendling | d154e283 | 2013-01-23 06:41:41 +0000 | [diff] [blame] | 167 | LLVMAddressSafety = 1ULL << 32, |
Andrea Di Biagio | 377496b | 2013-08-23 11:53:55 +0000 | [diff] [blame] | 168 | LLVMStackProtectStrongAttribute = 1ULL<<33, |
| 169 | LLVMCold = 1ULL << 34, |
| 170 | LLVMOptimizeNone = 1ULL << 35 |
Nuno Lopes | def422997 | 2012-09-02 14:19:21 +0000 | [diff] [blame] | 171 | */ |
Devang Patel | 4c758ea | 2008-09-25 21:00:45 +0000 | [diff] [blame] | 172 | } LLVMAttribute; |
Gordon Henriksen | 2d9cc21 | 2008-04-28 17:37:06 +0000 | [diff] [blame] | 173 | |
| 174 | typedef enum { |
Bill Wendling | da52cec | 2010-02-15 20:53:17 +0000 | [diff] [blame] | 175 | /* Terminator Instructions */ |
Chris Lattner | 40cf28d | 2009-10-12 04:01:02 +0000 | [diff] [blame] | 176 | LLVMRet = 1, |
| 177 | LLVMBr = 2, |
| 178 | LLVMSwitch = 3, |
Bill Wendling | 07d6d76 | 2010-02-15 20:50:51 +0000 | [diff] [blame] | 179 | LLVMIndirectBr = 4, |
| 180 | LLVMInvoke = 5, |
Bill Wendling | 46ffaa9 | 2011-08-02 06:20:17 +0000 | [diff] [blame] | 181 | /* removed 6 due to API changes */ |
Bill Wendling | 2641d13 | 2011-07-27 21:00:28 +0000 | [diff] [blame] | 182 | LLVMUnreachable = 7, |
Bill Wendling | 07d6d76 | 2010-02-15 20:50:51 +0000 | [diff] [blame] | 183 | |
Bill Wendling | da52cec | 2010-02-15 20:53:17 +0000 | [diff] [blame] | 184 | /* Standard Binary Operators */ |
Bill Wendling | 2641d13 | 2011-07-27 21:00:28 +0000 | [diff] [blame] | 185 | LLVMAdd = 8, |
| 186 | LLVMFAdd = 9, |
| 187 | LLVMSub = 10, |
| 188 | LLVMFSub = 11, |
| 189 | LLVMMul = 12, |
| 190 | LLVMFMul = 13, |
| 191 | LLVMUDiv = 14, |
| 192 | LLVMSDiv = 15, |
| 193 | LLVMFDiv = 16, |
| 194 | LLVMURem = 17, |
| 195 | LLVMSRem = 18, |
| 196 | LLVMFRem = 19, |
Bill Wendling | 07d6d76 | 2010-02-15 20:50:51 +0000 | [diff] [blame] | 197 | |
Bill Wendling | da52cec | 2010-02-15 20:53:17 +0000 | [diff] [blame] | 198 | /* Logical Operators */ |
Bill Wendling | 2641d13 | 2011-07-27 21:00:28 +0000 | [diff] [blame] | 199 | LLVMShl = 20, |
| 200 | LLVMLShr = 21, |
| 201 | LLVMAShr = 22, |
| 202 | LLVMAnd = 23, |
| 203 | LLVMOr = 24, |
| 204 | LLVMXor = 25, |
Bill Wendling | 07d6d76 | 2010-02-15 20:50:51 +0000 | [diff] [blame] | 205 | |
Bill Wendling | da52cec | 2010-02-15 20:53:17 +0000 | [diff] [blame] | 206 | /* Memory Operators */ |
Bill Wendling | 2641d13 | 2011-07-27 21:00:28 +0000 | [diff] [blame] | 207 | LLVMAlloca = 26, |
| 208 | LLVMLoad = 27, |
| 209 | LLVMStore = 28, |
| 210 | LLVMGetElementPtr = 29, |
Bill Wendling | 07d6d76 | 2010-02-15 20:50:51 +0000 | [diff] [blame] | 211 | |
Bill Wendling | da52cec | 2010-02-15 20:53:17 +0000 | [diff] [blame] | 212 | /* Cast Operators */ |
Bill Wendling | 2641d13 | 2011-07-27 21:00:28 +0000 | [diff] [blame] | 213 | LLVMTrunc = 30, |
| 214 | LLVMZExt = 31, |
| 215 | LLVMSExt = 32, |
| 216 | LLVMFPToUI = 33, |
| 217 | LLVMFPToSI = 34, |
| 218 | LLVMUIToFP = 35, |
| 219 | LLVMSIToFP = 36, |
| 220 | LLVMFPTrunc = 37, |
| 221 | LLVMFPExt = 38, |
| 222 | LLVMPtrToInt = 39, |
| 223 | LLVMIntToPtr = 40, |
| 224 | LLVMBitCast = 41, |
Bill Wendling | 07d6d76 | 2010-02-15 20:50:51 +0000 | [diff] [blame] | 225 | |
Bill Wendling | da52cec | 2010-02-15 20:53:17 +0000 | [diff] [blame] | 226 | /* Other Operators */ |
Bill Wendling | 2641d13 | 2011-07-27 21:00:28 +0000 | [diff] [blame] | 227 | LLVMICmp = 42, |
| 228 | LLVMFCmp = 43, |
| 229 | LLVMPHI = 44, |
| 230 | LLVMCall = 45, |
| 231 | LLVMSelect = 46, |
Torok Edwin | 05dc9d6 | 2011-10-06 12:39:34 +0000 | [diff] [blame] | 232 | LLVMUserOp1 = 47, |
| 233 | LLVMUserOp2 = 48, |
Bill Wendling | 2641d13 | 2011-07-27 21:00:28 +0000 | [diff] [blame] | 234 | LLVMVAArg = 49, |
| 235 | LLVMExtractElement = 50, |
| 236 | LLVMInsertElement = 51, |
| 237 | LLVMShuffleVector = 52, |
| 238 | LLVMExtractValue = 53, |
| 239 | LLVMInsertValue = 54, |
Eli Friedman | 4fc946c | 2011-07-27 18:59:19 +0000 | [diff] [blame] | 240 | |
| 241 | /* Atomic operators */ |
Bill Wendling | 2641d13 | 2011-07-27 21:00:28 +0000 | [diff] [blame] | 242 | LLVMFence = 55, |
Eli Friedman | c9a551e | 2011-07-28 21:48:00 +0000 | [diff] [blame] | 243 | LLVMAtomicCmpXchg = 56, |
Bill Wendling | f891bf8 | 2011-07-31 06:30:59 +0000 | [diff] [blame] | 244 | LLVMAtomicRMW = 57, |
| 245 | |
| 246 | /* Exception Handling Operators */ |
Bill Wendling | fae1475 | 2011-08-12 20:24:12 +0000 | [diff] [blame] | 247 | LLVMResume = 58, |
Bill Wendling | 0aef16a | 2012-02-06 21:44:22 +0000 | [diff] [blame] | 248 | LLVMLandingPad = 59 |
Bill Wendling | 2641d13 | 2011-07-27 21:00:28 +0000 | [diff] [blame] | 249 | |
Chris Lattner | 40cf28d | 2009-10-12 04:01:02 +0000 | [diff] [blame] | 250 | } LLVMOpcode; |
| 251 | |
| 252 | typedef enum { |
Gordon Henriksen | 4a4d735 | 2007-12-30 17:46:33 +0000 | [diff] [blame] | 253 | LLVMVoidTypeKind, /**< type with no size */ |
Dan Gohman | 518cda4 | 2011-12-17 00:04:22 +0000 | [diff] [blame] | 254 | LLVMHalfTypeKind, /**< 16 bit floating point type */ |
Gordon Henriksen | 4a4d735 | 2007-12-30 17:46:33 +0000 | [diff] [blame] | 255 | LLVMFloatTypeKind, /**< 32 bit floating point type */ |
| 256 | LLVMDoubleTypeKind, /**< 64 bit floating point type */ |
| 257 | LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */ |
| 258 | LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/ |
| 259 | LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */ |
| 260 | LLVMLabelTypeKind, /**< Labels */ |
| 261 | LLVMIntegerTypeKind, /**< Arbitrary bit width integers */ |
| 262 | LLVMFunctionTypeKind, /**< Functions */ |
| 263 | LLVMStructTypeKind, /**< Structures */ |
| 264 | LLVMArrayTypeKind, /**< Arrays */ |
| 265 | LLVMPointerTypeKind, /**< Pointers */ |
Chris Lattner | dac44ec | 2009-07-15 22:00:31 +0000 | [diff] [blame] | 266 | LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */ |
Dale Johannesen | baa5d04 | 2010-09-10 20:55:01 +0000 | [diff] [blame] | 267 | LLVMMetadataTypeKind, /**< Metadata */ |
| 268 | LLVMX86_MMXTypeKind /**< X86 MMX */ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 269 | } LLVMTypeKind; |
| 270 | |
| 271 | typedef enum { |
Gordon Henriksen | 4a4d735 | 2007-12-30 17:46:33 +0000 | [diff] [blame] | 272 | LLVMExternalLinkage, /**< Externally visible function */ |
Chris Lattner | 2dba0f0 | 2009-04-13 06:25:37 +0000 | [diff] [blame] | 273 | LLVMAvailableExternallyLinkage, |
Duncan Sands | 12da8ce | 2009-03-07 15:45:40 +0000 | [diff] [blame] | 274 | LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/ |
| 275 | LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something |
| 276 | equivalent. */ |
Rafael Espindola | 716e740 | 2013-11-01 17:09:14 +0000 | [diff] [blame^] | 277 | LLVMLinkOnceODRAutoHideLinkage, /**< Obsolete */ |
Duncan Sands | 12da8ce | 2009-03-07 15:45:40 +0000 | [diff] [blame] | 278 | LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */ |
| 279 | LLVMWeakODRLinkage, /**< Same, but only replaced by something |
| 280 | equivalent. */ |
Gordon Henriksen | 4a4d735 | 2007-12-30 17:46:33 +0000 | [diff] [blame] | 281 | LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */ |
| 282 | LLVMInternalLinkage, /**< Rename collisions when linking (static |
| 283 | functions) */ |
Duncan Sands | 12da8ce | 2009-03-07 15:45:40 +0000 | [diff] [blame] | 284 | LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */ |
Gordon Henriksen | 4a4d735 | 2007-12-30 17:46:33 +0000 | [diff] [blame] | 285 | LLVMDLLImportLinkage, /**< Function to be imported from DLL */ |
| 286 | LLVMDLLExportLinkage, /**< Function to be accessible from DLL */ |
Duncan Sands | e288105 | 2009-03-11 08:08:06 +0000 | [diff] [blame] | 287 | LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */ |
Jeffrey Yasskin | 091217b | 2010-01-27 20:34:15 +0000 | [diff] [blame] | 288 | LLVMGhostLinkage, /**< Obsolete */ |
Bill Wendling | 002b167 | 2009-07-20 18:22:52 +0000 | [diff] [blame] | 289 | LLVMCommonLinkage, /**< Tentative definitions */ |
Bill Wendling | 03bcd6e | 2010-07-01 21:55:59 +0000 | [diff] [blame] | 290 | LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */ |
Bill Wendling | 34bc34e | 2012-08-17 18:33:14 +0000 | [diff] [blame] | 291 | LLVMLinkerPrivateWeakLinkage /**< Like LinkerPrivate, but is weak. */ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 292 | } LLVMLinkage; |
| 293 | |
| 294 | typedef enum { |
Gordon Henriksen | 4a4d735 | 2007-12-30 17:46:33 +0000 | [diff] [blame] | 295 | LLVMDefaultVisibility, /**< The GV is visible */ |
| 296 | LLVMHiddenVisibility, /**< The GV is hidden */ |
| 297 | LLVMProtectedVisibility /**< The GV is protected */ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 298 | } LLVMVisibility; |
| 299 | |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 300 | typedef enum { |
| 301 | LLVMCCallConv = 0, |
| 302 | LLVMFastCallConv = 8, |
| 303 | LLVMColdCallConv = 9, |
| 304 | LLVMX86StdcallCallConv = 64, |
| 305 | LLVMX86FastcallCallConv = 65 |
| 306 | } LLVMCallConv; |
| 307 | |
| 308 | typedef enum { |
Gordon Henriksen | 4a4d735 | 2007-12-30 17:46:33 +0000 | [diff] [blame] | 309 | LLVMIntEQ = 32, /**< equal */ |
| 310 | LLVMIntNE, /**< not equal */ |
| 311 | LLVMIntUGT, /**< unsigned greater than */ |
| 312 | LLVMIntUGE, /**< unsigned greater or equal */ |
| 313 | LLVMIntULT, /**< unsigned less than */ |
| 314 | LLVMIntULE, /**< unsigned less or equal */ |
| 315 | LLVMIntSGT, /**< signed greater than */ |
| 316 | LLVMIntSGE, /**< signed greater or equal */ |
| 317 | LLVMIntSLT, /**< signed less than */ |
| 318 | LLVMIntSLE /**< signed less or equal */ |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 319 | } LLVMIntPredicate; |
| 320 | |
| 321 | typedef enum { |
Gordon Henriksen | 4a4d735 | 2007-12-30 17:46:33 +0000 | [diff] [blame] | 322 | LLVMRealPredicateFalse, /**< Always false (always folded) */ |
| 323 | LLVMRealOEQ, /**< True if ordered and equal */ |
| 324 | LLVMRealOGT, /**< True if ordered and greater than */ |
| 325 | LLVMRealOGE, /**< True if ordered and greater than or equal */ |
| 326 | LLVMRealOLT, /**< True if ordered and less than */ |
| 327 | LLVMRealOLE, /**< True if ordered and less than or equal */ |
| 328 | LLVMRealONE, /**< True if ordered and operands are unequal */ |
| 329 | LLVMRealORD, /**< True if ordered (no nans) */ |
| 330 | LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */ |
| 331 | LLVMRealUEQ, /**< True if unordered or equal */ |
| 332 | LLVMRealUGT, /**< True if unordered or greater than */ |
| 333 | LLVMRealUGE, /**< True if unordered, greater than, or equal */ |
| 334 | LLVMRealULT, /**< True if unordered or less than */ |
| 335 | LLVMRealULE, /**< True if unordered, less than, or equal */ |
| 336 | LLVMRealUNE, /**< True if unordered or not equal */ |
| 337 | LLVMRealPredicateTrue /**< Always true (always folded) */ |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 338 | } LLVMRealPredicate; |
| 339 | |
Bill Wendling | fae1475 | 2011-08-12 20:24:12 +0000 | [diff] [blame] | 340 | typedef enum { |
| 341 | LLVMLandingPadCatch, /**< A catch clause */ |
| 342 | LLVMLandingPadFilter /**< A filter clause */ |
| 343 | } LLVMLandingPadClauseTy; |
| 344 | |
Hans Wennborg | 5ff7120 | 2013-04-16 08:58:59 +0000 | [diff] [blame] | 345 | typedef enum { |
| 346 | LLVMNotThreadLocal = 0, |
| 347 | LLVMGeneralDynamicTLSModel, |
| 348 | LLVMLocalDynamicTLSModel, |
| 349 | LLVMInitialExecTLSModel, |
| 350 | LLVMLocalExecTLSModel |
| 351 | } LLVMThreadLocalMode; |
| 352 | |
Carlo Kok | da0ac72 | 2013-04-23 13:45:37 +0000 | [diff] [blame] | 353 | typedef enum { |
Carlo Kok | 8c6719b | 2013-04-23 13:21:19 +0000 | [diff] [blame] | 354 | LLVMAtomicOrderingNotAtomic = 0, /**< A load or store which is not atomic */ |
| 355 | LLVMAtomicOrderingUnordered = 1, /**< Lowest level of atomicity, guarantees |
| 356 | somewhat sane results, lock free. */ |
NAKAMURA Takumi | a3a8135 | 2013-10-23 17:56:29 +0000 | [diff] [blame] | 357 | LLVMAtomicOrderingMonotonic = 2, /**< guarantees that if you take all the |
| 358 | operations affecting a specific address, |
Carlo Kok | 8c6719b | 2013-04-23 13:21:19 +0000 | [diff] [blame] | 359 | a consistent ordering exists */ |
NAKAMURA Takumi | a3a8135 | 2013-10-23 17:56:29 +0000 | [diff] [blame] | 360 | LLVMAtomicOrderingAcquire = 4, /**< Acquire provides a barrier of the sort |
| 361 | necessary to acquire a lock to access other |
Carlo Kok | 8c6719b | 2013-04-23 13:21:19 +0000 | [diff] [blame] | 362 | memory with normal loads and stores. */ |
NAKAMURA Takumi | a3a8135 | 2013-10-23 17:56:29 +0000 | [diff] [blame] | 363 | LLVMAtomicOrderingRelease = 5, /**< Release is similar to Acquire, but with |
| 364 | a barrier of the sort necessary to release |
Carlo Kok | 8c6719b | 2013-04-23 13:21:19 +0000 | [diff] [blame] | 365 | a lock. */ |
NAKAMURA Takumi | a3a8135 | 2013-10-23 17:56:29 +0000 | [diff] [blame] | 366 | LLVMAtomicOrderingAcquireRelease = 6, /**< provides both an Acquire and a |
| 367 | Release barrier (for fences and |
Carlo Kok | 8c6719b | 2013-04-23 13:21:19 +0000 | [diff] [blame] | 368 | operations which both read and write |
| 369 | memory). */ |
NAKAMURA Takumi | a3a8135 | 2013-10-23 17:56:29 +0000 | [diff] [blame] | 370 | LLVMAtomicOrderingSequentiallyConsistent = 7 /**< provides Acquire semantics |
| 371 | for loads and Release |
| 372 | semantics for stores. |
| 373 | Additionally, it guarantees |
| 374 | that a total ordering exists |
| 375 | between all |
| 376 | SequentiallyConsistent |
Carlo Kok | 8c6719b | 2013-04-23 13:21:19 +0000 | [diff] [blame] | 377 | operations. */ |
Carlo Kok | da0ac72 | 2013-04-23 13:45:37 +0000 | [diff] [blame] | 378 | } LLVMAtomicOrdering; |
Carlo Kok | 8c6719b | 2013-04-23 13:21:19 +0000 | [diff] [blame] | 379 | |
Carlo Kok | da0ac72 | 2013-04-23 13:45:37 +0000 | [diff] [blame] | 380 | typedef enum { |
Carlo Kok | 8c6719b | 2013-04-23 13:21:19 +0000 | [diff] [blame] | 381 | LLVMAtomicRMWBinOpXchg, /**< Set the new value and return the one old */ |
| 382 | LLVMAtomicRMWBinOpAdd, /**< Add a value and return the old one */ |
| 383 | LLVMAtomicRMWBinOpSub, /**< Subtract a value and return the old one */ |
| 384 | LLVMAtomicRMWBinOpAnd, /**< And a value and return the old one */ |
| 385 | LLVMAtomicRMWBinOpNand, /**< Not-And a value and return the old one */ |
| 386 | LLVMAtomicRMWBinOpOr, /**< OR a value and return the old one */ |
| 387 | LLVMAtomicRMWBinOpXor, /**< Xor a value and return the old one */ |
| 388 | LLVMAtomicRMWBinOpMax, /**< Sets the value if it's greater than the |
NAKAMURA Takumi | a3a8135 | 2013-10-23 17:56:29 +0000 | [diff] [blame] | 389 | original using a signed comparison and return |
Carlo Kok | 8c6719b | 2013-04-23 13:21:19 +0000 | [diff] [blame] | 390 | the old one */ |
| 391 | LLVMAtomicRMWBinOpMin, /**< Sets the value if it's Smaller than the |
NAKAMURA Takumi | a3a8135 | 2013-10-23 17:56:29 +0000 | [diff] [blame] | 392 | original using a signed comparison and return |
Carlo Kok | 8c6719b | 2013-04-23 13:21:19 +0000 | [diff] [blame] | 393 | the old one */ |
| 394 | LLVMAtomicRMWBinOpUMax, /**< Sets the value if it's greater than the |
NAKAMURA Takumi | a3a8135 | 2013-10-23 17:56:29 +0000 | [diff] [blame] | 395 | original using an unsigned comparison and return |
Carlo Kok | 8c6719b | 2013-04-23 13:21:19 +0000 | [diff] [blame] | 396 | the old one */ |
| 397 | LLVMAtomicRMWBinOpUMin /**< Sets the value if it's greater than the |
NAKAMURA Takumi | a3a8135 | 2013-10-23 17:56:29 +0000 | [diff] [blame] | 398 | original using an unsigned comparison and return |
Carlo Kok | 8c6719b | 2013-04-23 13:21:19 +0000 | [diff] [blame] | 399 | the old one */ |
Carlo Kok | da0ac72 | 2013-04-23 13:45:37 +0000 | [diff] [blame] | 400 | } LLVMAtomicRMWBinOp; |
Carlo Kok | 8c6719b | 2013-04-23 13:21:19 +0000 | [diff] [blame] | 401 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 402 | /** |
| 403 | * @} |
| 404 | */ |
| 405 | |
Nick Lewycky | 0db2654 | 2011-05-15 07:20:34 +0000 | [diff] [blame] | 406 | void LLVMInitializeCore(LLVMPassRegistryRef R); |
| 407 | |
Duncan Sands | 1cba0a8 | 2013-02-17 16:35:51 +0000 | [diff] [blame] | 408 | /** Deallocate and destroy all ManagedStatic variables. |
| 409 | @see llvm::llvm_shutdown |
| 410 | @see ManagedStatic */ |
Benjamin Kramer | 325ec89 | 2013-10-23 16:57:34 +0000 | [diff] [blame] | 411 | void LLVMShutdown(void); |
Duncan Sands | 1cba0a8 | 2013-02-17 16:35:51 +0000 | [diff] [blame] | 412 | |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 413 | |
Gordon Henriksen | 34eb6d8 | 2007-12-19 22:30:40 +0000 | [diff] [blame] | 414 | /*===-- Error handling ----------------------------------------------------===*/ |
| 415 | |
Filip Pizlo | 3fdbaff | 2013-05-22 02:46:43 +0000 | [diff] [blame] | 416 | char *LLVMCreateMessage(const char *Message); |
Gordon Henriksen | 34eb6d8 | 2007-12-19 22:30:40 +0000 | [diff] [blame] | 417 | void LLVMDisposeMessage(char *Message); |
| 418 | |
Filip Pizlo | a535b14 | 2013-10-17 01:38:28 +0000 | [diff] [blame] | 419 | typedef void (*LLVMFatalErrorHandler)(const char *Reason); |
| 420 | |
| 421 | /** |
| 422 | * Install a fatal error handler. By default, if LLVM detects a fatal error, it |
| 423 | * will call exit(1). This may not be appropriate in many contexts. For example, |
| 424 | * doing exit(1) will bypass many crash reporting/tracing system tools. This |
| 425 | * function allows you to install a callback that will be invoked prior to the |
| 426 | * call to exit(1). |
| 427 | */ |
| 428 | void LLVMInstallFatalErrorHandler(LLVMFatalErrorHandler Handler); |
| 429 | |
| 430 | /** |
| 431 | * Reset the fatal error handler. This resets LLVM's fatal error handling |
| 432 | * behavior to the default. |
| 433 | */ |
| 434 | void LLVMResetFatalErrorHandler(void); |
Gordon Henriksen | 34eb6d8 | 2007-12-19 22:30:40 +0000 | [diff] [blame] | 435 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 436 | /** |
| 437 | * @defgroup LLVMCCoreContext Contexts |
| 438 | * |
| 439 | * Contexts are execution states for the core LLVM IR system. |
| 440 | * |
| 441 | * Most types are tied to a context instance. Multiple contexts can |
| 442 | * exist simultaneously. A single context is not thread safe. However, |
| 443 | * different contexts can execute on different threads simultaneously. |
| 444 | * |
| 445 | * @{ |
| 446 | */ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 447 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 448 | /** |
| 449 | * Create a new context. |
| 450 | * |
| 451 | * Every call to this function should be paired with a call to |
| 452 | * LLVMContextDispose() or the context will leak memory. |
| 453 | */ |
Erick Tryzelaar | f34cb0c | 2009-08-30 23:38:06 +0000 | [diff] [blame] | 454 | LLVMContextRef LLVMContextCreate(void); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 455 | |
| 456 | /** |
| 457 | * Obtain the global context instance. |
| 458 | */ |
Erick Tryzelaar | f34cb0c | 2009-08-30 23:38:06 +0000 | [diff] [blame] | 459 | LLVMContextRef LLVMGetGlobalContext(void); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 460 | |
| 461 | /** |
| 462 | * Destroy a context instance. |
| 463 | * |
| 464 | * This should be called for every call to LLVMContextCreate() or memory |
| 465 | * will be leaked. |
| 466 | */ |
Owen Anderson | 6773d38 | 2009-07-01 16:58:40 +0000 | [diff] [blame] | 467 | void LLVMContextDispose(LLVMContextRef C); |
| 468 | |
Erick Tryzelaar | d8531fa | 2010-02-28 09:45:59 +0000 | [diff] [blame] | 469 | unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name, |
| 470 | unsigned SLen); |
| 471 | unsigned LLVMGetMDKindID(const char* Name, unsigned SLen); |
| 472 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 473 | /** |
| 474 | * @} |
| 475 | */ |
| 476 | |
Gregory Szorc | 52d2660 | 2012-03-21 07:28:27 +0000 | [diff] [blame] | 477 | /** |
| 478 | * @defgroup LLVMCCoreModule Modules |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 479 | * |
Daniel Dunbar | 06b9f9e | 2013-08-16 23:30:19 +0000 | [diff] [blame] | 480 | * Modules represent the top-level structure in an LLVM program. An LLVM |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 481 | * module is effectively a translation unit or a collection of |
| 482 | * translation units merged together. |
| 483 | * |
| 484 | * @{ |
| 485 | */ |
| 486 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 487 | /** |
| 488 | * Create a new, empty module in the global context. |
| 489 | * |
| 490 | * This is equivalent to calling LLVMModuleCreateWithNameInContext with |
| 491 | * LLVMGetGlobalContext() as the context parameter. |
| 492 | * |
| 493 | * Every invocation should be paired with LLVMDisposeModule() or memory |
| 494 | * will be leaked. |
| 495 | */ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 496 | LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 497 | |
| 498 | /** |
| 499 | * Create a new, empty module in a specific context. |
| 500 | * |
| 501 | * Every invocation should be paired with LLVMDisposeModule() or memory |
| 502 | * will be leaked. |
| 503 | */ |
Owen Anderson | 31d44e4 | 2009-07-02 07:17:57 +0000 | [diff] [blame] | 504 | LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID, |
| 505 | LLVMContextRef C); |
Gordon Henriksen | a49d435 | 2008-03-07 19:13:06 +0000 | [diff] [blame] | 506 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 507 | /** |
| 508 | * Destroy a module instance. |
| 509 | * |
| 510 | * This must be called for every created module or memory will be |
| 511 | * leaked. |
| 512 | */ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 513 | void LLVMDisposeModule(LLVMModuleRef M); |
| 514 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 515 | /** |
| 516 | * Obtain the data layout for a module. |
| 517 | * |
| 518 | * @see Module::getDataLayout() |
| 519 | */ |
Gordon Henriksen | 05568bb | 2007-12-27 20:13:47 +0000 | [diff] [blame] | 520 | const char *LLVMGetDataLayout(LLVMModuleRef M); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 521 | |
| 522 | /** |
| 523 | * Set the data layout for a module. |
| 524 | * |
| 525 | * @see Module::setDataLayout() |
| 526 | */ |
Gordon Henriksen | 05568bb | 2007-12-27 20:13:47 +0000 | [diff] [blame] | 527 | void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple); |
| 528 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 529 | /** |
| 530 | * Obtain the target triple for a module. |
| 531 | * |
| 532 | * @see Module::getTargetTriple() |
| 533 | */ |
Gordon Henriksen | 05568bb | 2007-12-27 20:13:47 +0000 | [diff] [blame] | 534 | const char *LLVMGetTarget(LLVMModuleRef M); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 535 | |
| 536 | /** |
| 537 | * Set the target triple for a module. |
| 538 | * |
| 539 | * @see Module::setTargetTriple() |
| 540 | */ |
Gordon Henriksen | 05568bb | 2007-12-27 20:13:47 +0000 | [diff] [blame] | 541 | void LLVMSetTarget(LLVMModuleRef M, const char *Triple); |
| 542 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 543 | /** |
| 544 | * Dump a representation of a module to stderr. |
| 545 | * |
| 546 | * @see Module::dump() |
| 547 | */ |
Gordon Henriksen | 6c6075e | 2008-03-14 23:58:56 +0000 | [diff] [blame] | 548 | void LLVMDumpModule(LLVMModuleRef M); |
| 549 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 550 | /** |
Hans Wennborg | b7ef2fe | 2012-05-09 16:54:17 +0000 | [diff] [blame] | 551 | * Print a representation of a module to a file. The ErrorMessage needs to be |
| 552 | * disposed with LLVMDisposeMessage. Returns 0 on success, 1 otherwise. |
| 553 | * |
| 554 | * @see Module::print() |
| 555 | */ |
| 556 | LLVMBool LLVMPrintModuleToFile(LLVMModuleRef M, const char *Filename, |
| 557 | char **ErrorMessage); |
| 558 | |
| 559 | /** |
Anders Waldenborg | 84355db | 2013-10-16 18:00:54 +0000 | [diff] [blame] | 560 | * Return a string representation of the module. Use |
| 561 | * LLVMDisposeMessage to free the string. |
| 562 | * |
| 563 | * @see Module::print() |
| 564 | */ |
| 565 | char *LLVMPrintModuleToString(LLVMModuleRef M); |
| 566 | |
| 567 | /** |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 568 | * Set inline assembly for a module. |
| 569 | * |
| 570 | * @see Module::setModuleInlineAsm() |
| 571 | */ |
Chris Lattner | 2694145 | 2010-04-10 17:52:58 +0000 | [diff] [blame] | 572 | void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm); |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 573 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 574 | /** |
| 575 | * Obtain the context to which this module is associated. |
| 576 | * |
| 577 | * @see Module::getContext() |
| 578 | */ |
Chris Lattner | a7e04b0 | 2010-11-28 20:03:44 +0000 | [diff] [blame] | 579 | LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M); |
| 580 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 581 | /** |
| 582 | * Obtain a Type from a module by its registered name. |
| 583 | */ |
| 584 | LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name); |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 585 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 586 | /** |
| 587 | * Obtain the number of operands for named metadata in a module. |
| 588 | * |
| 589 | * @see llvm::Module::getNamedMetadata() |
| 590 | */ |
| 591 | unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name); |
| 592 | |
| 593 | /** |
| 594 | * Obtain the named metadata operands for a module. |
| 595 | * |
| 596 | * The passed LLVMValueRef pointer should refer to an array of |
| 597 | * LLVMValueRef at least LLVMGetNamedMetadataNumOperands long. This |
| 598 | * array will be populated with the LLVMValueRef instances. Each |
| 599 | * instance corresponds to a llvm::MDNode. |
| 600 | * |
| 601 | * @see llvm::Module::getNamedMetadata() |
| 602 | * @see llvm::MDNode::getOperand() |
| 603 | */ |
| 604 | void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest); |
| 605 | |
| 606 | /** |
| 607 | * Add an operand to named metadata. |
| 608 | * |
| 609 | * @see llvm::Module::getNamedMetadata() |
| 610 | * @see llvm::MDNode::addOperand() |
| 611 | */ |
| 612 | void LLVMAddNamedMetadataOperand(LLVMModuleRef M, const char* name, |
| 613 | LLVMValueRef Val); |
| 614 | |
Gregory Szorc | 52d2660 | 2012-03-21 07:28:27 +0000 | [diff] [blame] | 615 | /** |
| 616 | * Add a function to a module under a specified name. |
| 617 | * |
| 618 | * @see llvm::Function::Create() |
| 619 | */ |
| 620 | LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name, |
| 621 | LLVMTypeRef FunctionTy); |
| 622 | |
| 623 | /** |
| 624 | * Obtain a Function value from a Module by its name. |
| 625 | * |
| 626 | * The returned value corresponds to a llvm::Function value. |
| 627 | * |
| 628 | * @see llvm::Module::getFunction() |
| 629 | */ |
| 630 | LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name); |
| 631 | |
| 632 | /** |
| 633 | * Obtain an iterator to the first Function in a Module. |
| 634 | * |
| 635 | * @see llvm::Module::begin() |
| 636 | */ |
| 637 | LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M); |
| 638 | |
| 639 | /** |
| 640 | * Obtain an iterator to the last Function in a Module. |
| 641 | * |
| 642 | * @see llvm::Module::end() |
| 643 | */ |
| 644 | LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M); |
| 645 | |
| 646 | /** |
| 647 | * Advance a Function iterator to the next Function. |
| 648 | * |
| 649 | * Returns NULL if the iterator was already at the end and there are no more |
| 650 | * functions. |
| 651 | */ |
| 652 | LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn); |
| 653 | |
| 654 | /** |
| 655 | * Decrement a Function iterator to the previous Function. |
| 656 | * |
| 657 | * Returns NULL if the iterator was already at the beginning and there are |
| 658 | * no previous functions. |
| 659 | */ |
| 660 | LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 661 | |
| 662 | /** |
| 663 | * @} |
| 664 | */ |
| 665 | |
| 666 | /** |
| 667 | * @defgroup LLVMCCoreType Types |
| 668 | * |
| 669 | * Types represent the type of a value. |
| 670 | * |
| 671 | * Types are associated with a context instance. The context internally |
| 672 | * deduplicates types so there is only 1 instance of a specific type |
| 673 | * alive at a time. In other words, a unique type is shared among all |
| 674 | * consumers within a context. |
| 675 | * |
| 676 | * A Type in the C API corresponds to llvm::Type. |
| 677 | * |
| 678 | * Types have the following hierarchy: |
| 679 | * |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 680 | * types: |
| 681 | * integer type |
| 682 | * real type |
| 683 | * function type |
| 684 | * sequence types: |
| 685 | * array type |
| 686 | * pointer type |
| 687 | * vector type |
| 688 | * void type |
| 689 | * label type |
| 690 | * opaque type |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 691 | * |
| 692 | * @{ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 693 | */ |
| 694 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 695 | /** |
| 696 | * Obtain the enumerated type of a Type instance. |
| 697 | * |
| 698 | * @see llvm::Type:getTypeID() |
| 699 | */ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 700 | LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 701 | |
| 702 | /** |
| 703 | * Whether the type has a known size. |
| 704 | * |
| 705 | * Things that don't have a size are abstract types, labels, and void.a |
| 706 | * |
| 707 | * @see llvm::Type::isSized() |
| 708 | */ |
Torok Edwin | 1cd9ade | 2011-10-06 12:13:28 +0000 | [diff] [blame] | 709 | LLVMBool LLVMTypeIsSized(LLVMTypeRef Ty); |
Gordon Henriksen | a49d435 | 2008-03-07 19:13:06 +0000 | [diff] [blame] | 710 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 711 | /** |
| 712 | * Obtain the context to which this type instance is associated. |
| 713 | * |
| 714 | * @see llvm::Type::getContext() |
| 715 | */ |
Erick Tryzelaar | 262332f | 2009-08-14 00:01:31 +0000 | [diff] [blame] | 716 | LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty); |
| 717 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 718 | /** |
Anders Waldenborg | b822cff | 2013-10-16 21:30:25 +0000 | [diff] [blame] | 719 | * Dump a representation of a type to stderr. |
| 720 | * |
| 721 | * @see llvm::Type::dump() |
| 722 | */ |
| 723 | void LLVMDumpType(LLVMTypeRef Val); |
| 724 | |
| 725 | /** |
Anders Waldenborg | 47b3bd3 | 2013-10-22 06:58:34 +0000 | [diff] [blame] | 726 | * Return a string representation of the type. Use |
| 727 | * LLVMDisposeMessage to free the string. |
| 728 | * |
| 729 | * @see llvm::Type::print() |
| 730 | */ |
| 731 | char *LLVMPrintTypeToString(LLVMTypeRef Val); |
| 732 | |
| 733 | /** |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 734 | * @defgroup LLVMCCoreTypeInt Integer Types |
| 735 | * |
| 736 | * Functions in this section operate on integer types. |
| 737 | * |
| 738 | * @{ |
| 739 | */ |
| 740 | |
| 741 | /** |
| 742 | * Obtain an integer type from a context with specified bit width. |
| 743 | */ |
Erick Tryzelaar | 262332f | 2009-08-14 00:01:31 +0000 | [diff] [blame] | 744 | LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C); |
| 745 | LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C); |
| 746 | LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C); |
| 747 | LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C); |
| 748 | LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C); |
| 749 | LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits); |
| 750 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 751 | /** |
| 752 | * Obtain an integer type from the global context with a specified bit |
| 753 | * width. |
| 754 | */ |
Gordon Henriksen | a735a9c | 2008-05-04 12:55:34 +0000 | [diff] [blame] | 755 | LLVMTypeRef LLVMInt1Type(void); |
| 756 | LLVMTypeRef LLVMInt8Type(void); |
| 757 | LLVMTypeRef LLVMInt16Type(void); |
| 758 | LLVMTypeRef LLVMInt32Type(void); |
| 759 | LLVMTypeRef LLVMInt64Type(void); |
Gordon Henriksen | ed7beaa | 2007-10-06 16:05:20 +0000 | [diff] [blame] | 760 | LLVMTypeRef LLVMIntType(unsigned NumBits); |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 761 | unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy); |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 762 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 763 | /** |
| 764 | * @} |
| 765 | */ |
| 766 | |
| 767 | /** |
| 768 | * @defgroup LLVMCCoreTypeFloat Floating Point Types |
| 769 | * |
| 770 | * @{ |
| 771 | */ |
| 772 | |
| 773 | /** |
| 774 | * Obtain a 16-bit floating point type from a context. |
| 775 | */ |
Dan Gohman | 518cda4 | 2011-12-17 00:04:22 +0000 | [diff] [blame] | 776 | LLVMTypeRef LLVMHalfTypeInContext(LLVMContextRef C); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 777 | |
| 778 | /** |
| 779 | * Obtain a 32-bit floating point type from a context. |
| 780 | */ |
Erick Tryzelaar | 262332f | 2009-08-14 00:01:31 +0000 | [diff] [blame] | 781 | LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 782 | |
| 783 | /** |
| 784 | * Obtain a 64-bit floating point type from a context. |
| 785 | */ |
Erick Tryzelaar | 262332f | 2009-08-14 00:01:31 +0000 | [diff] [blame] | 786 | LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 787 | |
| 788 | /** |
| 789 | * Obtain a 80-bit floating point type (X87) from a context. |
| 790 | */ |
Erick Tryzelaar | 262332f | 2009-08-14 00:01:31 +0000 | [diff] [blame] | 791 | LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 792 | |
| 793 | /** |
| 794 | * Obtain a 128-bit floating point type (112-bit mantissa) from a |
| 795 | * context. |
| 796 | */ |
Erick Tryzelaar | 262332f | 2009-08-14 00:01:31 +0000 | [diff] [blame] | 797 | LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 798 | |
| 799 | /** |
| 800 | * Obtain a 128-bit floating point type (two 64-bits) from a context. |
| 801 | */ |
Erick Tryzelaar | 262332f | 2009-08-14 00:01:31 +0000 | [diff] [blame] | 802 | LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C); |
| 803 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 804 | /** |
| 805 | * Obtain a floating point type from the global context. |
| 806 | * |
| 807 | * These map to the functions in this group of the same name. |
| 808 | */ |
Dan Gohman | 518cda4 | 2011-12-17 00:04:22 +0000 | [diff] [blame] | 809 | LLVMTypeRef LLVMHalfType(void); |
Gordon Henriksen | a735a9c | 2008-05-04 12:55:34 +0000 | [diff] [blame] | 810 | LLVMTypeRef LLVMFloatType(void); |
| 811 | LLVMTypeRef LLVMDoubleType(void); |
| 812 | LLVMTypeRef LLVMX86FP80Type(void); |
| 813 | LLVMTypeRef LLVMFP128Type(void); |
| 814 | LLVMTypeRef LLVMPPCFP128Type(void); |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 815 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 816 | /** |
| 817 | * @} |
| 818 | */ |
| 819 | |
| 820 | /** |
| 821 | * @defgroup LLVMCCoreTypeFunction Function Types |
| 822 | * |
| 823 | * @{ |
| 824 | */ |
| 825 | |
| 826 | /** |
| 827 | * Obtain a function type consisting of a specified signature. |
| 828 | * |
| 829 | * The function is defined as a tuple of a return Type, a list of |
| 830 | * parameter types, and whether the function is variadic. |
| 831 | */ |
Gordon Henriksen | ed7beaa | 2007-10-06 16:05:20 +0000 | [diff] [blame] | 832 | LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType, |
| 833 | LLVMTypeRef *ParamTypes, unsigned ParamCount, |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 834 | LLVMBool IsVarArg); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 835 | |
| 836 | /** |
| 837 | * Returns whether a function type is variadic. |
| 838 | */ |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 839 | LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 840 | |
| 841 | /** |
| 842 | * Obtain the Type this function Type returns. |
| 843 | */ |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 844 | LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 845 | |
| 846 | /** |
| 847 | * Obtain the number of parameters this function accepts. |
| 848 | */ |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 849 | unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 850 | |
| 851 | /** |
| 852 | * Obtain the types of a function's parameters. |
| 853 | * |
| 854 | * The Dest parameter should point to a pre-allocated array of |
| 855 | * LLVMTypeRef at least LLVMCountParamTypes() large. On return, the |
| 856 | * first LLVMCountParamTypes() entries in the array will be populated |
| 857 | * with LLVMTypeRef instances. |
| 858 | * |
| 859 | * @param FunctionTy The function type to operate on. |
| 860 | * @param Dest Memory address of an array to be filled with result. |
| 861 | */ |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 862 | void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest); |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 863 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 864 | /** |
| 865 | * @} |
| 866 | */ |
| 867 | |
| 868 | /** |
| 869 | * @defgroup LLVMCCoreTypeStruct Structure Types |
| 870 | * |
| 871 | * These functions relate to LLVMTypeRef instances. |
| 872 | * |
| 873 | * @see llvm::StructType |
| 874 | * |
| 875 | * @{ |
| 876 | */ |
| 877 | |
| 878 | /** |
| 879 | * Create a new structure type in a context. |
| 880 | * |
| 881 | * A structure is specified by a list of inner elements/types and |
| 882 | * whether these can be packed together. |
| 883 | * |
| 884 | * @see llvm::StructType::create() |
| 885 | */ |
Erick Tryzelaar | 262332f | 2009-08-14 00:01:31 +0000 | [diff] [blame] | 886 | LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes, |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 887 | unsigned ElementCount, LLVMBool Packed); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 888 | |
| 889 | /** |
| 890 | * Create a new structure type in the global context. |
| 891 | * |
| 892 | * @see llvm::StructType::create() |
| 893 | */ |
Gordon Henriksen | ed7beaa | 2007-10-06 16:05:20 +0000 | [diff] [blame] | 894 | LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount, |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 895 | LLVMBool Packed); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 896 | |
| 897 | /** |
| 898 | * Create an empty structure in a context having a specified name. |
| 899 | * |
| 900 | * @see llvm::StructType::create() |
| 901 | */ |
Chris Lattner | e71ccde | 2011-07-14 05:53:17 +0000 | [diff] [blame] | 902 | LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 903 | |
| 904 | /** |
| 905 | * Obtain the name of a structure. |
| 906 | * |
| 907 | * @see llvm::StructType::getName() |
| 908 | */ |
Torok Edwin | 0d5f6ae | 2011-10-06 12:12:50 +0000 | [diff] [blame] | 909 | const char *LLVMGetStructName(LLVMTypeRef Ty); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 910 | |
| 911 | /** |
| 912 | * Set the contents of a structure type. |
| 913 | * |
| 914 | * @see llvm::StructType::setBody() |
| 915 | */ |
Chris Lattner | e71ccde | 2011-07-14 05:53:17 +0000 | [diff] [blame] | 916 | void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes, |
| 917 | unsigned ElementCount, LLVMBool Packed); |
| 918 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 919 | /** |
| 920 | * Get the number of elements defined inside the structure. |
| 921 | * |
| 922 | * @see llvm::StructType::getNumElements() |
| 923 | */ |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 924 | unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 925 | |
| 926 | /** |
| 927 | * Get the elements within a structure. |
| 928 | * |
| 929 | * The function is passed the address of a pre-allocated array of |
| 930 | * LLVMTypeRef at least LLVMCountStructElementTypes() long. After |
| 931 | * invocation, this array will be populated with the structure's |
| 932 | * elements. The objects in the destination array will have a lifetime |
| 933 | * of the structure type itself, which is the lifetime of the context it |
| 934 | * is contained in. |
| 935 | */ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 936 | void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 937 | |
| 938 | /** |
| 939 | * Determine whether a structure is packed. |
| 940 | * |
| 941 | * @see llvm::StructType::isPacked() |
| 942 | */ |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 943 | LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 944 | |
| 945 | /** |
| 946 | * Determine whether a structure is opaque. |
| 947 | * |
| 948 | * @see llvm::StructType::isOpaque() |
| 949 | */ |
Chris Lattner | 17cf05b | 2011-07-14 16:20:28 +0000 | [diff] [blame] | 950 | LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy); |
| 951 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 952 | /** |
| 953 | * @} |
| 954 | */ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 955 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 956 | |
| 957 | /** |
| 958 | * @defgroup LLVMCCoreTypeSequential Sequential Types |
| 959 | * |
| 960 | * Sequential types represents "arrays" of types. This is a super class |
| 961 | * for array, vector, and pointer types. |
| 962 | * |
| 963 | * @{ |
| 964 | */ |
| 965 | |
| 966 | /** |
| 967 | * Obtain the type of elements within a sequential type. |
| 968 | * |
| 969 | * This works on array, vector, and pointer types. |
| 970 | * |
| 971 | * @see llvm::SequentialType::getElementType() |
| 972 | */ |
| 973 | LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty); |
| 974 | |
| 975 | /** |
| 976 | * Create a fixed size array type that refers to a specific type. |
| 977 | * |
| 978 | * The created type will exist in the context that its element type |
| 979 | * exists in. |
| 980 | * |
| 981 | * @see llvm::ArrayType::get() |
| 982 | */ |
Gordon Henriksen | ed7beaa | 2007-10-06 16:05:20 +0000 | [diff] [blame] | 983 | LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 984 | |
| 985 | /** |
| 986 | * Obtain the length of an array type. |
| 987 | * |
| 988 | * This only works on types that represent arrays. |
| 989 | * |
| 990 | * @see llvm::ArrayType::getNumElements() |
| 991 | */ |
| 992 | unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy); |
| 993 | |
| 994 | /** |
| 995 | * Create a pointer type that points to a defined type. |
| 996 | * |
| 997 | * The created type will exist in the context that its pointee type |
| 998 | * exists in. |
| 999 | * |
| 1000 | * @see llvm::PointerType::get() |
| 1001 | */ |
Gordon Henriksen | 5a3fe03 | 2007-12-17 16:08:32 +0000 | [diff] [blame] | 1002 | LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1003 | |
| 1004 | /** |
| 1005 | * Obtain the address space of a pointer type. |
| 1006 | * |
| 1007 | * This only works on types that represent pointers. |
| 1008 | * |
| 1009 | * @see llvm::PointerType::getAddressSpace() |
| 1010 | */ |
| 1011 | unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy); |
| 1012 | |
| 1013 | /** |
| 1014 | * Create a vector type that contains a defined type and has a specific |
| 1015 | * number of elements. |
| 1016 | * |
| 1017 | * The created type will exist in the context thats its element type |
| 1018 | * exists in. |
| 1019 | * |
| 1020 | * @see llvm::VectorType::get() |
| 1021 | */ |
Gordon Henriksen | ed7beaa | 2007-10-06 16:05:20 +0000 | [diff] [blame] | 1022 | LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount); |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 1023 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1024 | /** |
| 1025 | * Obtain the number of elements in a vector type. |
| 1026 | * |
| 1027 | * This only works on types that represent vectors. |
| 1028 | * |
| 1029 | * @see llvm::VectorType::getNumElements() |
| 1030 | */ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 1031 | unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy); |
| 1032 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1033 | /** |
| 1034 | * @} |
| 1035 | */ |
| 1036 | |
| 1037 | /** |
| 1038 | * @defgroup LLVMCCoreTypeOther Other Types |
| 1039 | * |
| 1040 | * @{ |
| 1041 | */ |
| 1042 | |
| 1043 | /** |
| 1044 | * Create a void type in a context. |
| 1045 | */ |
Erick Tryzelaar | 262332f | 2009-08-14 00:01:31 +0000 | [diff] [blame] | 1046 | LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1047 | |
| 1048 | /** |
| 1049 | * Create a label type in a context. |
| 1050 | */ |
Erick Tryzelaar | 262332f | 2009-08-14 00:01:31 +0000 | [diff] [blame] | 1051 | LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1052 | |
| 1053 | /** |
| 1054 | * Create a X86 MMX type in a context. |
| 1055 | */ |
Dale Johannesen | 95b67af | 2010-09-10 21:58:02 +0000 | [diff] [blame] | 1056 | LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C); |
Erick Tryzelaar | 262332f | 2009-08-14 00:01:31 +0000 | [diff] [blame] | 1057 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1058 | /** |
| 1059 | * These are similar to the above functions except they operate on the |
| 1060 | * global context. |
| 1061 | */ |
Gordon Henriksen | a735a9c | 2008-05-04 12:55:34 +0000 | [diff] [blame] | 1062 | LLVMTypeRef LLVMVoidType(void); |
| 1063 | LLVMTypeRef LLVMLabelType(void); |
Dale Johannesen | 95b67af | 2010-09-10 21:58:02 +0000 | [diff] [blame] | 1064 | LLVMTypeRef LLVMX86MMXType(void); |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 1065 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1066 | /** |
| 1067 | * @} |
| 1068 | */ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 1069 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1070 | /** |
| 1071 | * @} |
| 1072 | */ |
| 1073 | |
| 1074 | /** |
| 1075 | * @defgroup LLVMCCoreValues Values |
| 1076 | * |
| 1077 | * The bulk of LLVM's object model consists of values, which comprise a very |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 1078 | * rich type hierarchy. |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1079 | * |
| 1080 | * LLVMValueRef essentially represents llvm::Value. There is a rich |
| 1081 | * hierarchy of classes within this type. Depending on the instance |
Eli Bendersky | c52863c | 2012-08-10 18:30:44 +0000 | [diff] [blame] | 1082 | * obtained, not all APIs are available. |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1083 | * |
Daniel Dunbar | 06b9f9e | 2013-08-16 23:30:19 +0000 | [diff] [blame] | 1084 | * Callers can determine the type of an LLVMValueRef by calling the |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1085 | * LLVMIsA* family of functions (e.g. LLVMIsAArgument()). These |
| 1086 | * functions are defined by a macro, so it isn't obvious which are |
| 1087 | * available by looking at the Doxygen source code. Instead, look at the |
| 1088 | * source definition of LLVM_FOR_EACH_VALUE_SUBCLASS and note the list |
| 1089 | * of value names given. These value names also correspond to classes in |
| 1090 | * the llvm::Value hierarchy. |
| 1091 | * |
| 1092 | * @{ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 1093 | */ |
| 1094 | |
Gordon Henriksen | 29e3894 | 2008-12-19 18:39:45 +0000 | [diff] [blame] | 1095 | #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \ |
| 1096 | macro(Argument) \ |
| 1097 | macro(BasicBlock) \ |
| 1098 | macro(InlineAsm) \ |
Torok Edwin | d09b757 | 2011-10-14 20:37:56 +0000 | [diff] [blame] | 1099 | macro(MDNode) \ |
| 1100 | macro(MDString) \ |
Gordon Henriksen | 29e3894 | 2008-12-19 18:39:45 +0000 | [diff] [blame] | 1101 | macro(User) \ |
| 1102 | macro(Constant) \ |
Torok Edwin | d09b757 | 2011-10-14 20:37:56 +0000 | [diff] [blame] | 1103 | macro(BlockAddress) \ |
Gordon Henriksen | 29e3894 | 2008-12-19 18:39:45 +0000 | [diff] [blame] | 1104 | macro(ConstantAggregateZero) \ |
| 1105 | macro(ConstantArray) \ |
| 1106 | macro(ConstantExpr) \ |
| 1107 | macro(ConstantFP) \ |
| 1108 | macro(ConstantInt) \ |
| 1109 | macro(ConstantPointerNull) \ |
| 1110 | macro(ConstantStruct) \ |
| 1111 | macro(ConstantVector) \ |
| 1112 | macro(GlobalValue) \ |
| 1113 | macro(Function) \ |
| 1114 | macro(GlobalAlias) \ |
| 1115 | macro(GlobalVariable) \ |
| 1116 | macro(UndefValue) \ |
| 1117 | macro(Instruction) \ |
| 1118 | macro(BinaryOperator) \ |
| 1119 | macro(CallInst) \ |
| 1120 | macro(IntrinsicInst) \ |
| 1121 | macro(DbgInfoIntrinsic) \ |
| 1122 | macro(DbgDeclareInst) \ |
Gordon Henriksen | 29e3894 | 2008-12-19 18:39:45 +0000 | [diff] [blame] | 1123 | macro(MemIntrinsic) \ |
| 1124 | macro(MemCpyInst) \ |
| 1125 | macro(MemMoveInst) \ |
| 1126 | macro(MemSetInst) \ |
| 1127 | macro(CmpInst) \ |
Torok Edwin | d09b757 | 2011-10-14 20:37:56 +0000 | [diff] [blame] | 1128 | macro(FCmpInst) \ |
| 1129 | macro(ICmpInst) \ |
Gordon Henriksen | 29e3894 | 2008-12-19 18:39:45 +0000 | [diff] [blame] | 1130 | macro(ExtractElementInst) \ |
| 1131 | macro(GetElementPtrInst) \ |
| 1132 | macro(InsertElementInst) \ |
| 1133 | macro(InsertValueInst) \ |
Bill Wendling | fae1475 | 2011-08-12 20:24:12 +0000 | [diff] [blame] | 1134 | macro(LandingPadInst) \ |
Gordon Henriksen | 29e3894 | 2008-12-19 18:39:45 +0000 | [diff] [blame] | 1135 | macro(PHINode) \ |
| 1136 | macro(SelectInst) \ |
| 1137 | macro(ShuffleVectorInst) \ |
| 1138 | macro(StoreInst) \ |
| 1139 | macro(TerminatorInst) \ |
| 1140 | macro(BranchInst) \ |
Torok Edwin | d09b757 | 2011-10-14 20:37:56 +0000 | [diff] [blame] | 1141 | macro(IndirectBrInst) \ |
Gordon Henriksen | 29e3894 | 2008-12-19 18:39:45 +0000 | [diff] [blame] | 1142 | macro(InvokeInst) \ |
| 1143 | macro(ReturnInst) \ |
| 1144 | macro(SwitchInst) \ |
| 1145 | macro(UnreachableInst) \ |
Bill Wendling | f891bf8 | 2011-07-31 06:30:59 +0000 | [diff] [blame] | 1146 | macro(ResumeInst) \ |
Duncan Sands | 5e37e99 | 2013-05-06 08:55:45 +0000 | [diff] [blame] | 1147 | macro(UnaryInstruction) \ |
| 1148 | macro(AllocaInst) \ |
| 1149 | macro(CastInst) \ |
| 1150 | macro(BitCastInst) \ |
| 1151 | macro(FPExtInst) \ |
| 1152 | macro(FPToSIInst) \ |
| 1153 | macro(FPToUIInst) \ |
| 1154 | macro(FPTruncInst) \ |
| 1155 | macro(IntToPtrInst) \ |
| 1156 | macro(PtrToIntInst) \ |
| 1157 | macro(SExtInst) \ |
| 1158 | macro(SIToFPInst) \ |
| 1159 | macro(TruncInst) \ |
| 1160 | macro(UIToFPInst) \ |
| 1161 | macro(ZExtInst) \ |
| 1162 | macro(ExtractValueInst) \ |
| 1163 | macro(LoadInst) \ |
| 1164 | macro(VAArgInst) |
Gordon Henriksen | 29e3894 | 2008-12-19 18:39:45 +0000 | [diff] [blame] | 1165 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1166 | /** |
| 1167 | * @defgroup LLVMCCoreValueGeneral General APIs |
| 1168 | * |
| 1169 | * Functions in this section work on all LLVMValueRef instances, |
| 1170 | * regardless of their sub-type. They correspond to functions available |
| 1171 | * on llvm::Value. |
| 1172 | * |
| 1173 | * @{ |
| 1174 | */ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 1175 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1176 | /** |
| 1177 | * Obtain the type of a value. |
| 1178 | * |
| 1179 | * @see llvm::Value::getType() |
| 1180 | */ |
| 1181 | LLVMTypeRef LLVMTypeOf(LLVMValueRef Val); |
| 1182 | |
| 1183 | /** |
| 1184 | * Obtain the string name of a value. |
| 1185 | * |
| 1186 | * @see llvm::Value::getName() |
| 1187 | */ |
| 1188 | const char *LLVMGetValueName(LLVMValueRef Val); |
| 1189 | |
| 1190 | /** |
| 1191 | * Set the string name of a value. |
| 1192 | * |
| 1193 | * @see llvm::Value::setName() |
| 1194 | */ |
| 1195 | void LLVMSetValueName(LLVMValueRef Val, const char *Name); |
| 1196 | |
| 1197 | /** |
| 1198 | * Dump a representation of a value to stderr. |
| 1199 | * |
| 1200 | * @see llvm::Value::dump() |
| 1201 | */ |
| 1202 | void LLVMDumpValue(LLVMValueRef Val); |
| 1203 | |
| 1204 | /** |
| 1205 | * Replace all uses of a value with another one. |
| 1206 | * |
| 1207 | * @see llvm::Value::replaceAllUsesWith() |
| 1208 | */ |
| 1209 | void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal); |
| 1210 | |
| 1211 | /** |
| 1212 | * Determine whether the specified constant instance is constant. |
| 1213 | */ |
| 1214 | LLVMBool LLVMIsConstant(LLVMValueRef Val); |
| 1215 | |
| 1216 | /** |
| 1217 | * Determine whether a value instance is undefined. |
| 1218 | */ |
| 1219 | LLVMBool LLVMIsUndef(LLVMValueRef Val); |
| 1220 | |
| 1221 | /** |
| 1222 | * Convert value instances between types. |
| 1223 | * |
Daniel Dunbar | 06b9f9e | 2013-08-16 23:30:19 +0000 | [diff] [blame] | 1224 | * Internally, an LLVMValueRef is "pinned" to a specific type. This |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1225 | * series of functions allows you to cast an instance to a specific |
| 1226 | * type. |
| 1227 | * |
| 1228 | * If the cast is not valid for the specified type, NULL is returned. |
| 1229 | * |
| 1230 | * @see llvm::dyn_cast_or_null<> |
| 1231 | */ |
Gordon Henriksen | 29e3894 | 2008-12-19 18:39:45 +0000 | [diff] [blame] | 1232 | #define LLVM_DECLARE_VALUE_CAST(name) \ |
| 1233 | LLVMValueRef LLVMIsA##name(LLVMValueRef Val); |
| 1234 | LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST) |
| 1235 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1236 | /** |
| 1237 | * @} |
| 1238 | */ |
| 1239 | |
| 1240 | /** |
| 1241 | * @defgroup LLVMCCoreValueUses Usage |
| 1242 | * |
| 1243 | * This module defines functions that allow you to inspect the uses of a |
| 1244 | * LLVMValueRef. |
| 1245 | * |
Daniel Dunbar | 06b9f9e | 2013-08-16 23:30:19 +0000 | [diff] [blame] | 1246 | * It is possible to obtain an LLVMUseRef for any LLVMValueRef instance. |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1247 | * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a |
| 1248 | * llvm::User and llvm::Value. |
| 1249 | * |
| 1250 | * @{ |
| 1251 | */ |
| 1252 | |
| 1253 | /** |
| 1254 | * Obtain the first use of a value. |
| 1255 | * |
| 1256 | * Uses are obtained in an iterator fashion. First, call this function |
| 1257 | * to obtain a reference to the first use. Then, call LLVMGetNextUse() |
Eli Bendersky | c52863c | 2012-08-10 18:30:44 +0000 | [diff] [blame] | 1258 | * on that instance and all subsequently obtained instances until |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1259 | * LLVMGetNextUse() returns NULL. |
| 1260 | * |
| 1261 | * @see llvm::Value::use_begin() |
| 1262 | */ |
Erick Tryzelaar | 9f9857e | 2010-03-02 20:32:28 +0000 | [diff] [blame] | 1263 | LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1264 | |
| 1265 | /** |
| 1266 | * Obtain the next use of a value. |
| 1267 | * |
| 1268 | * This effectively advances the iterator. It returns NULL if you are on |
| 1269 | * the final use and no more are available. |
| 1270 | */ |
Erick Tryzelaar | 9f9857e | 2010-03-02 20:32:28 +0000 | [diff] [blame] | 1271 | LLVMUseRef LLVMGetNextUse(LLVMUseRef U); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1272 | |
| 1273 | /** |
| 1274 | * Obtain the user value for a user. |
| 1275 | * |
| 1276 | * The returned value corresponds to a llvm::User type. |
| 1277 | * |
| 1278 | * @see llvm::Use::getUser() |
| 1279 | */ |
Erick Tryzelaar | 9f9857e | 2010-03-02 20:32:28 +0000 | [diff] [blame] | 1280 | LLVMValueRef LLVMGetUser(LLVMUseRef U); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1281 | |
| 1282 | /** |
| 1283 | * Obtain the value this use corresponds to. |
| 1284 | * |
| 1285 | * @see llvm::Use::get(). |
| 1286 | */ |
Erick Tryzelaar | 9f9857e | 2010-03-02 20:32:28 +0000 | [diff] [blame] | 1287 | LLVMValueRef LLVMGetUsedValue(LLVMUseRef U); |
Chris Lattner | 40cf28d | 2009-10-12 04:01:02 +0000 | [diff] [blame] | 1288 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1289 | /** |
| 1290 | * @} |
| 1291 | */ |
| 1292 | |
| 1293 | /** |
Gregory Szorc | 52d2660 | 2012-03-21 07:28:27 +0000 | [diff] [blame] | 1294 | * @defgroup LLVMCCoreValueUser User value |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1295 | * |
| 1296 | * Function in this group pertain to LLVMValueRef instances that descent |
| 1297 | * from llvm::User. This includes constants, instructions, and |
| 1298 | * operators. |
| 1299 | * |
| 1300 | * @{ |
| 1301 | */ |
| 1302 | |
| 1303 | /** |
| 1304 | * Obtain an operand at a specific index in a llvm::User value. |
| 1305 | * |
| 1306 | * @see llvm::User::getOperand() |
| 1307 | */ |
Chris Lattner | 40cf28d | 2009-10-12 04:01:02 +0000 | [diff] [blame] | 1308 | LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1309 | |
| 1310 | /** |
| 1311 | * Set an operand at a specific index in a llvm::User value. |
| 1312 | * |
| 1313 | * @see llvm::User::setOperand() |
| 1314 | */ |
Erick Tryzelaar | b4d4870 | 2010-08-20 14:51:22 +0000 | [diff] [blame] | 1315 | void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1316 | |
| 1317 | /** |
| 1318 | * Obtain the number of operands in a llvm::User value. |
| 1319 | * |
| 1320 | * @see llvm::User::getNumOperands() |
| 1321 | */ |
Erick Tryzelaar | b4d4870 | 2010-08-20 14:51:22 +0000 | [diff] [blame] | 1322 | int LLVMGetNumOperands(LLVMValueRef Val); |
Chris Lattner | 40cf28d | 2009-10-12 04:01:02 +0000 | [diff] [blame] | 1323 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1324 | /** |
| 1325 | * @} |
| 1326 | */ |
| 1327 | |
| 1328 | /** |
Gregory Szorc | 52d2660 | 2012-03-21 07:28:27 +0000 | [diff] [blame] | 1329 | * @defgroup LLVMCCoreValueConstant Constants |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1330 | * |
| 1331 | * This section contains APIs for interacting with LLVMValueRef that |
| 1332 | * correspond to llvm::Constant instances. |
| 1333 | * |
| 1334 | * These functions will work for any LLVMValueRef in the llvm::Constant |
| 1335 | * class hierarchy. |
| 1336 | * |
| 1337 | * @{ |
| 1338 | */ |
| 1339 | |
| 1340 | /** |
| 1341 | * Obtain a constant value referring to the null instance of a type. |
| 1342 | * |
| 1343 | * @see llvm::Constant::getNullValue() |
| 1344 | */ |
Gordon Henriksen | 1046c73 | 2007-10-06 15:11:06 +0000 | [diff] [blame] | 1345 | LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */ |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1346 | |
| 1347 | /** |
| 1348 | * Obtain a constant value referring to the instance of a type |
| 1349 | * consisting of all ones. |
| 1350 | * |
| 1351 | * This is only valid for integer types. |
| 1352 | * |
| 1353 | * @see llvm::Constant::getAllOnesValue() |
| 1354 | */ |
| 1355 | LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); |
| 1356 | |
| 1357 | /** |
| 1358 | * Obtain a constant value referring to an undefined value of a type. |
| 1359 | * |
| 1360 | * @see llvm::UndefValue::get() |
| 1361 | */ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 1362 | LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1363 | |
| 1364 | /** |
| 1365 | * Determine whether a value instance is null. |
| 1366 | * |
| 1367 | * @see llvm::Constant::isNullValue() |
| 1368 | */ |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 1369 | LLVMBool LLVMIsNull(LLVMValueRef Val); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1370 | |
| 1371 | /** |
| 1372 | * Obtain a constant that is a constant pointer pointing to NULL for a |
| 1373 | * specified type. |
| 1374 | */ |
Chris Lattner | 7f31824 | 2009-07-06 17:29:59 +0000 | [diff] [blame] | 1375 | LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty); |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 1376 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1377 | /** |
| 1378 | * @defgroup LLVMCCoreValueConstantScalar Scalar constants |
| 1379 | * |
| 1380 | * Functions in this group model LLVMValueRef instances that correspond |
| 1381 | * to constants referring to scalar types. |
| 1382 | * |
| 1383 | * For integer types, the LLVMTypeRef parameter should correspond to a |
| 1384 | * llvm::IntegerType instance and the returned LLVMValueRef will |
| 1385 | * correspond to a llvm::ConstantInt. |
| 1386 | * |
| 1387 | * For floating point types, the LLVMTypeRef returned corresponds to a |
| 1388 | * llvm::ConstantFP. |
| 1389 | * |
| 1390 | * @{ |
| 1391 | */ |
Erick Tryzelaar | d8531fa | 2010-02-28 09:45:59 +0000 | [diff] [blame] | 1392 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1393 | /** |
| 1394 | * Obtain a constant value for an integer type. |
| 1395 | * |
| 1396 | * The returned value corresponds to a llvm::ConstantInt. |
| 1397 | * |
| 1398 | * @see llvm::ConstantInt::get() |
| 1399 | * |
| 1400 | * @param IntTy Integer type to obtain value of. |
| 1401 | * @param N The value the returned instance should refer to. |
| 1402 | * @param SignExtend Whether to sign extend the produced value. |
| 1403 | */ |
Gordon Henriksen | 1046c73 | 2007-10-06 15:11:06 +0000 | [diff] [blame] | 1404 | LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N, |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 1405 | LLVMBool SignExtend); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1406 | |
| 1407 | /** |
| 1408 | * Obtain a constant value for an integer of arbitrary precision. |
| 1409 | * |
| 1410 | * @see llvm::ConstantInt::get() |
| 1411 | */ |
Chris Lattner | 4329e07 | 2010-11-23 02:47:22 +0000 | [diff] [blame] | 1412 | LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy, |
| 1413 | unsigned NumWords, |
| 1414 | const uint64_t Words[]); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1415 | |
| 1416 | /** |
| 1417 | * Obtain a constant value for an integer parsed from a string. |
| 1418 | * |
| 1419 | * A similar API, LLVMConstIntOfStringAndSize is also available. If the |
| 1420 | * string's length is available, it is preferred to call that function |
| 1421 | * instead. |
| 1422 | * |
| 1423 | * @see llvm::ConstantInt::get() |
| 1424 | */ |
Erick Tryzelaar | dd99135 | 2009-08-16 23:36:46 +0000 | [diff] [blame] | 1425 | LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text, |
| 1426 | uint8_t Radix); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1427 | |
| 1428 | /** |
| 1429 | * Obtain a constant value for an integer parsed from a string with |
| 1430 | * specified length. |
| 1431 | * |
| 1432 | * @see llvm::ConstantInt::get() |
| 1433 | */ |
Erick Tryzelaar | dd99135 | 2009-08-16 23:36:46 +0000 | [diff] [blame] | 1434 | LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text, |
| 1435 | unsigned SLen, uint8_t Radix); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1436 | |
| 1437 | /** |
| 1438 | * Obtain a constant value referring to a double floating point value. |
| 1439 | */ |
Gordon Henriksen | 1046c73 | 2007-10-06 15:11:06 +0000 | [diff] [blame] | 1440 | LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1441 | |
| 1442 | /** |
| 1443 | * Obtain a constant for a floating point value parsed from a string. |
| 1444 | * |
| 1445 | * A similar API, LLVMConstRealOfStringAndSize is also available. It |
| 1446 | * should be used if the input string's length is known. |
| 1447 | */ |
Gordon Henriksen | 931e121 | 2008-02-02 01:07:50 +0000 | [diff] [blame] | 1448 | LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1449 | |
| 1450 | /** |
| 1451 | * Obtain a constant for a floating point value parsed from a string. |
| 1452 | */ |
Erick Tryzelaar | dd99135 | 2009-08-16 23:36:46 +0000 | [diff] [blame] | 1453 | LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text, |
| 1454 | unsigned SLen); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1455 | |
| 1456 | /** |
| 1457 | * Obtain the zero extended value for an integer constant value. |
| 1458 | * |
| 1459 | * @see llvm::ConstantInt::getZExtValue() |
| 1460 | */ |
Chris Lattner | 40cf28d | 2009-10-12 04:01:02 +0000 | [diff] [blame] | 1461 | unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1462 | |
| 1463 | /** |
| 1464 | * Obtain the sign extended value for an integer constant value. |
| 1465 | * |
| 1466 | * @see llvm::ConstantInt::getSExtValue() |
| 1467 | */ |
Chris Lattner | 40cf28d | 2009-10-12 04:01:02 +0000 | [diff] [blame] | 1468 | long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal); |
Erick Tryzelaar | dd99135 | 2009-08-16 23:36:46 +0000 | [diff] [blame] | 1469 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1470 | /** |
| 1471 | * @} |
| 1472 | */ |
| 1473 | |
| 1474 | /** |
Gregory Szorc | 52d2660 | 2012-03-21 07:28:27 +0000 | [diff] [blame] | 1475 | * @defgroup LLVMCCoreValueConstantComposite Composite Constants |
| 1476 | * |
| 1477 | * Functions in this group operate on composite constants. |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1478 | * |
| 1479 | * @{ |
| 1480 | */ |
| 1481 | |
| 1482 | /** |
Gregory Szorc | 52d2660 | 2012-03-21 07:28:27 +0000 | [diff] [blame] | 1483 | * Create a ConstantDataSequential and initialize it with a string. |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1484 | * |
Gregory Szorc | 52d2660 | 2012-03-21 07:28:27 +0000 | [diff] [blame] | 1485 | * @see llvm::ConstantDataArray::getString() |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1486 | */ |
Erick Tryzelaar | 262332f | 2009-08-14 00:01:31 +0000 | [diff] [blame] | 1487 | LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str, |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 1488 | unsigned Length, LLVMBool DontNullTerminate); |
Gregory Szorc | 52d2660 | 2012-03-21 07:28:27 +0000 | [diff] [blame] | 1489 | |
| 1490 | /** |
| 1491 | * Create a ConstantDataSequential with string content in the global context. |
| 1492 | * |
| 1493 | * This is the same as LLVMConstStringInContext except it operates on the |
| 1494 | * global context. |
| 1495 | * |
| 1496 | * @see LLVMConstStringInContext() |
| 1497 | * @see llvm::ConstantDataArray::getString() |
| 1498 | */ |
| 1499 | LLVMValueRef LLVMConstString(const char *Str, unsigned Length, |
| 1500 | LLVMBool DontNullTerminate); |
| 1501 | |
| 1502 | /** |
| 1503 | * Create an anonymous ConstantStruct with the specified values. |
| 1504 | * |
| 1505 | * @see llvm::ConstantStruct::getAnon() |
| 1506 | */ |
| 1507 | LLVMValueRef LLVMConstStructInContext(LLVMContextRef C, |
Erick Tryzelaar | 262332f | 2009-08-14 00:01:31 +0000 | [diff] [blame] | 1508 | LLVMValueRef *ConstantVals, |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 1509 | unsigned Count, LLVMBool Packed); |
Erick Tryzelaar | 262332f | 2009-08-14 00:01:31 +0000 | [diff] [blame] | 1510 | |
Gregory Szorc | 52d2660 | 2012-03-21 07:28:27 +0000 | [diff] [blame] | 1511 | /** |
| 1512 | * Create a ConstantStruct in the global Context. |
| 1513 | * |
| 1514 | * This is the same as LLVMConstStructInContext except it operates on the |
| 1515 | * global Context. |
| 1516 | * |
| 1517 | * @see LLVMConstStructInContext() |
| 1518 | */ |
Gordon Henriksen | 1046c73 | 2007-10-06 15:11:06 +0000 | [diff] [blame] | 1519 | LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count, |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 1520 | LLVMBool Packed); |
Gregory Szorc | 52d2660 | 2012-03-21 07:28:27 +0000 | [diff] [blame] | 1521 | |
| 1522 | /** |
| 1523 | * Create a ConstantArray from values. |
| 1524 | * |
| 1525 | * @see llvm::ConstantArray::get() |
| 1526 | */ |
| 1527 | LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy, |
| 1528 | LLVMValueRef *ConstantVals, unsigned Length); |
| 1529 | |
| 1530 | /** |
| 1531 | * Create a non-anonymous ConstantStruct from values. |
| 1532 | * |
| 1533 | * @see llvm::ConstantStruct::get() |
| 1534 | */ |
Rafael Espindola | 784ad24 | 2011-07-14 19:09:08 +0000 | [diff] [blame] | 1535 | LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy, |
| 1536 | LLVMValueRef *ConstantVals, |
| 1537 | unsigned Count); |
Gregory Szorc | 52d2660 | 2012-03-21 07:28:27 +0000 | [diff] [blame] | 1538 | |
| 1539 | /** |
| 1540 | * Create a ConstantVector from values. |
| 1541 | * |
| 1542 | * @see llvm::ConstantVector::get() |
| 1543 | */ |
Gordon Henriksen | 1046c73 | 2007-10-06 15:11:06 +0000 | [diff] [blame] | 1544 | LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size); |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 1545 | |
Gregory Szorc | 52d2660 | 2012-03-21 07:28:27 +0000 | [diff] [blame] | 1546 | /** |
| 1547 | * @} |
| 1548 | */ |
| 1549 | |
| 1550 | /** |
| 1551 | * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions |
| 1552 | * |
| 1553 | * Functions in this group correspond to APIs on llvm::ConstantExpr. |
| 1554 | * |
| 1555 | * @see llvm::ConstantExpr. |
| 1556 | * |
| 1557 | * @{ |
| 1558 | */ |
Chris Lattner | 40cf28d | 2009-10-12 04:01:02 +0000 | [diff] [blame] | 1559 | LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal); |
Erick Tryzelaar | fd529d7 | 2009-08-19 08:36:49 +0000 | [diff] [blame] | 1560 | LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty); |
Gordon Henriksen | 7ce3176 | 2007-10-06 14:29:36 +0000 | [diff] [blame] | 1561 | LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty); |
| 1562 | LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal); |
Erick Tryzelaar | 4c340c7 | 2010-02-28 05:51:43 +0000 | [diff] [blame] | 1563 | LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal); |
| 1564 | LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal); |
Erick Tryzelaar | 4cc690c | 2009-08-16 02:20:12 +0000 | [diff] [blame] | 1565 | LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal); |
Gordon Henriksen | 7ce3176 | 2007-10-06 14:29:36 +0000 | [diff] [blame] | 1566 | LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal); |
| 1567 | LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
Dan Gohman | e4ca02d | 2009-09-03 23:34:49 +0000 | [diff] [blame] | 1568 | LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
Erick Tryzelaar | 4c340c7 | 2010-02-28 05:51:43 +0000 | [diff] [blame] | 1569 | LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
Erick Tryzelaar | 4cc690c | 2009-08-16 02:20:12 +0000 | [diff] [blame] | 1570 | LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
Gordon Henriksen | 7ce3176 | 2007-10-06 14:29:36 +0000 | [diff] [blame] | 1571 | LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
Erick Tryzelaar | 4c340c7 | 2010-02-28 05:51:43 +0000 | [diff] [blame] | 1572 | LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
| 1573 | LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
Erick Tryzelaar | 4cc690c | 2009-08-16 02:20:12 +0000 | [diff] [blame] | 1574 | LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
Gordon Henriksen | 7ce3176 | 2007-10-06 14:29:36 +0000 | [diff] [blame] | 1575 | LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
Erick Tryzelaar | 4c340c7 | 2010-02-28 05:51:43 +0000 | [diff] [blame] | 1576 | LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
| 1577 | LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
Erick Tryzelaar | 4cc690c | 2009-08-16 02:20:12 +0000 | [diff] [blame] | 1578 | LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
Gordon Henriksen | 7ce3176 | 2007-10-06 14:29:36 +0000 | [diff] [blame] | 1579 | LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
| 1580 | LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
Dan Gohman | e4ca02d | 2009-09-03 23:34:49 +0000 | [diff] [blame] | 1581 | LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
Gordon Henriksen | 7ce3176 | 2007-10-06 14:29:36 +0000 | [diff] [blame] | 1582 | LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
| 1583 | LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
| 1584 | LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
| 1585 | LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
| 1586 | LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
| 1587 | LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
| 1588 | LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
| 1589 | LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate, |
| 1590 | LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
| 1591 | LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate, |
| 1592 | LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
| 1593 | LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
| 1594 | LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
| 1595 | LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); |
| 1596 | LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal, |
| 1597 | LLVMValueRef *ConstantIndices, unsigned NumIndices); |
Dan Gohman | e4ca02d | 2009-09-03 23:34:49 +0000 | [diff] [blame] | 1598 | LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal, |
| 1599 | LLVMValueRef *ConstantIndices, |
| 1600 | unsigned NumIndices); |
Gordon Henriksen | 7ce3176 | 2007-10-06 14:29:36 +0000 | [diff] [blame] | 1601 | LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType); |
| 1602 | LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType); |
| 1603 | LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType); |
| 1604 | LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType); |
| 1605 | LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType); |
| 1606 | LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType); |
| 1607 | LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType); |
| 1608 | LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType); |
| 1609 | LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType); |
| 1610 | LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType); |
| 1611 | LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType); |
| 1612 | LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType); |
Erick Tryzelaar | 4cc690c | 2009-08-16 02:20:12 +0000 | [diff] [blame] | 1613 | LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal, |
| 1614 | LLVMTypeRef ToType); |
| 1615 | LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal, |
| 1616 | LLVMTypeRef ToType); |
| 1617 | LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal, |
| 1618 | LLVMTypeRef ToType); |
| 1619 | LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal, |
| 1620 | LLVMTypeRef ToType); |
| 1621 | LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType, |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 1622 | LLVMBool isSigned); |
Erick Tryzelaar | 4cc690c | 2009-08-16 02:20:12 +0000 | [diff] [blame] | 1623 | LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType); |
Gordon Henriksen | 7ce3176 | 2007-10-06 14:29:36 +0000 | [diff] [blame] | 1624 | LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition, |
| 1625 | LLVMValueRef ConstantIfTrue, |
| 1626 | LLVMValueRef ConstantIfFalse); |
| 1627 | LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant, |
| 1628 | LLVMValueRef IndexConstant); |
| 1629 | LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant, |
| 1630 | LLVMValueRef ElementValueConstant, |
| 1631 | LLVMValueRef IndexConstant); |
| 1632 | LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant, |
| 1633 | LLVMValueRef VectorBConstant, |
| 1634 | LLVMValueRef MaskConstant); |
Dan Gohman | d5104a5 | 2008-11-03 22:55:43 +0000 | [diff] [blame] | 1635 | LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList, |
| 1636 | unsigned NumIdx); |
| 1637 | LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant, |
| 1638 | LLVMValueRef ElementValueConstant, |
| 1639 | unsigned *IdxList, unsigned NumIdx); |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 1640 | LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty, |
Chris Lattner | 3d1f552 | 2008-12-17 21:39:50 +0000 | [diff] [blame] | 1641 | const char *AsmString, const char *Constraints, |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 1642 | LLVMBool HasSideEffects, LLVMBool IsAlignStack); |
Erick Tryzelaar | 0fb26ef | 2010-02-28 09:46:06 +0000 | [diff] [blame] | 1643 | LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB); |
Gordon Henriksen | 7ce3176 | 2007-10-06 14:29:36 +0000 | [diff] [blame] | 1644 | |
Gregory Szorc | 52d2660 | 2012-03-21 07:28:27 +0000 | [diff] [blame] | 1645 | /** |
| 1646 | * @} |
| 1647 | */ |
| 1648 | |
| 1649 | /** |
| 1650 | * @defgroup LLVMCCoreValueConstantGlobals Global Values |
| 1651 | * |
| 1652 | * This group contains functions that operate on global values. Functions in |
| 1653 | * this group relate to functions in the llvm::GlobalValue class tree. |
| 1654 | * |
| 1655 | * @see llvm::GlobalValue |
| 1656 | * |
| 1657 | * @{ |
| 1658 | */ |
| 1659 | |
Gordon Henriksen | 265f780 | 2008-03-19 01:11:35 +0000 | [diff] [blame] | 1660 | LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global); |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 1661 | LLVMBool LLVMIsDeclaration(LLVMValueRef Global); |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 1662 | LLVMLinkage LLVMGetLinkage(LLVMValueRef Global); |
| 1663 | void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage); |
| 1664 | const char *LLVMGetSection(LLVMValueRef Global); |
| 1665 | void LLVMSetSection(LLVMValueRef Global, const char *Section); |
| 1666 | LLVMVisibility LLVMGetVisibility(LLVMValueRef Global); |
| 1667 | void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz); |
Anders Waldenborg | 213a63f | 2013-10-29 09:02:02 +0000 | [diff] [blame] | 1668 | |
| 1669 | /** |
| 1670 | * @defgroup LLVMCCoreValueWithAlignment Values with alignment |
| 1671 | * |
| 1672 | * Functions in this group only apply to values with alignment, i.e. |
| 1673 | * global variables, load and store instructions. |
| 1674 | */ |
| 1675 | |
| 1676 | /** |
| 1677 | * Obtain the preferred alignment of the value. |
| 1678 | * @see llvm::LoadInst::getAlignment() |
| 1679 | * @see llvm::StoreInst::getAlignment() |
| 1680 | * @see llvm::GlobalValue::getAlignment() |
| 1681 | */ |
| 1682 | unsigned LLVMGetAlignment(LLVMValueRef V); |
| 1683 | |
| 1684 | /** |
| 1685 | * Set the preferred alignment of the value. |
| 1686 | * @see llvm::LoadInst::setAlignment() |
| 1687 | * @see llvm::StoreInst::setAlignment() |
| 1688 | * @see llvm::GlobalValue::setAlignment() |
| 1689 | */ |
| 1690 | void LLVMSetAlignment(LLVMValueRef V, unsigned Bytes); |
| 1691 | |
| 1692 | /** |
| 1693 | * @} |
| 1694 | */ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 1695 | |
Gregory Szorc | 52d2660 | 2012-03-21 07:28:27 +0000 | [diff] [blame] | 1696 | /** |
| 1697 | * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables |
| 1698 | * |
| 1699 | * This group contains functions that operate on global variable values. |
| 1700 | * |
| 1701 | * @see llvm::GlobalVariable |
| 1702 | * |
| 1703 | * @{ |
| 1704 | */ |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 1705 | LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name); |
Erick Tryzelaar | 06894b3 | 2010-02-28 09:46:13 +0000 | [diff] [blame] | 1706 | LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty, |
| 1707 | const char *Name, |
| 1708 | unsigned AddressSpace); |
Gordon Henriksen | 783f7bb | 2007-10-08 03:45:09 +0000 | [diff] [blame] | 1709 | LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name); |
Gordon Henriksen | 07a45f4 | 2008-03-23 22:21:29 +0000 | [diff] [blame] | 1710 | LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M); |
| 1711 | LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M); |
| 1712 | LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar); |
| 1713 | LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar); |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 1714 | void LLVMDeleteGlobal(LLVMValueRef GlobalVar); |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 1715 | LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar); |
| 1716 | void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal); |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 1717 | LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar); |
| 1718 | void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal); |
| 1719 | LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar); |
| 1720 | void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant); |
Hans Wennborg | 5ff7120 | 2013-04-16 08:58:59 +0000 | [diff] [blame] | 1721 | LLVMThreadLocalMode LLVMGetThreadLocalMode(LLVMValueRef GlobalVar); |
| 1722 | void LLVMSetThreadLocalMode(LLVMValueRef GlobalVar, LLVMThreadLocalMode Mode); |
| 1723 | LLVMBool LLVMIsExternallyInitialized(LLVMValueRef GlobalVar); |
| 1724 | void LLVMSetExternallyInitialized(LLVMValueRef GlobalVar, LLVMBool IsExtInit); |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 1725 | |
Gregory Szorc | 52d2660 | 2012-03-21 07:28:27 +0000 | [diff] [blame] | 1726 | /** |
| 1727 | * @} |
| 1728 | */ |
| 1729 | |
| 1730 | /** |
| 1731 | * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases |
| 1732 | * |
| 1733 | * This group contains function that operate on global alias values. |
| 1734 | * |
| 1735 | * @see llvm::GlobalAlias |
| 1736 | * |
| 1737 | * @{ |
| 1738 | */ |
Chris Lattner | 3d1f552 | 2008-12-17 21:39:50 +0000 | [diff] [blame] | 1739 | LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee, |
| 1740 | const char *Name); |
| 1741 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1742 | /** |
| 1743 | * @} |
| 1744 | */ |
| 1745 | |
| 1746 | /** |
| 1747 | * @defgroup LLVMCCoreValueFunction Function values |
| 1748 | * |
| 1749 | * Functions in this group operate on LLVMValueRef instances that |
| 1750 | * correspond to llvm::Function instances. |
| 1751 | * |
| 1752 | * @see llvm::Function |
| 1753 | * |
| 1754 | * @{ |
| 1755 | */ |
| 1756 | |
| 1757 | /** |
| 1758 | * Remove a function from its containing module and deletes it. |
| 1759 | * |
| 1760 | * @see llvm::Function::eraseFromParent() |
| 1761 | */ |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 1762 | void LLVMDeleteFunction(LLVMValueRef Fn); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1763 | |
| 1764 | /** |
| 1765 | * Obtain the ID number from a function instance. |
| 1766 | * |
| 1767 | * @see llvm::Function::getIntrinsicID() |
| 1768 | */ |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 1769 | unsigned LLVMGetIntrinsicID(LLVMValueRef Fn); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1770 | |
| 1771 | /** |
| 1772 | * Obtain the calling function of a function. |
| 1773 | * |
| 1774 | * The returned value corresponds to the LLVMCallConv enumeration. |
| 1775 | * |
| 1776 | * @see llvm::Function::getCallingConv() |
| 1777 | */ |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 1778 | unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1779 | |
| 1780 | /** |
| 1781 | * Set the calling convention of a function. |
| 1782 | * |
| 1783 | * @see llvm::Function::setCallingConv() |
| 1784 | * |
| 1785 | * @param Fn Function to operate on |
| 1786 | * @param CC LLVMCallConv to set calling convention to |
| 1787 | */ |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 1788 | void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1789 | |
| 1790 | /** |
| 1791 | * Obtain the name of the garbage collector to use during code |
| 1792 | * generation. |
| 1793 | * |
| 1794 | * @see llvm::Function::getGC() |
| 1795 | */ |
Gordon Henriksen | d930f91 | 2008-08-17 18:44:35 +0000 | [diff] [blame] | 1796 | const char *LLVMGetGC(LLVMValueRef Fn); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1797 | |
| 1798 | /** |
| 1799 | * Define the garbage collector to use during code generation. |
| 1800 | * |
| 1801 | * @see llvm::Function::setGC() |
| 1802 | */ |
Gordon Henriksen | d930f91 | 2008-08-17 18:44:35 +0000 | [diff] [blame] | 1803 | void LLVMSetGC(LLVMValueRef Fn, const char *Name); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1804 | |
| 1805 | /** |
| 1806 | * Add an attribute to a function. |
| 1807 | * |
| 1808 | * @see llvm::Function::addAttribute() |
| 1809 | */ |
Duncan Sands | 7374a01 | 2009-05-06 12:21:17 +0000 | [diff] [blame] | 1810 | void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1811 | |
| 1812 | /** |
Tom Stellard | e8f35e1 | 2013-04-16 23:12:43 +0000 | [diff] [blame] | 1813 | * Add a target-dependent attribute to a fuction |
| 1814 | * @see llvm::AttrBuilder::addAttribute() |
| 1815 | */ |
| 1816 | void LLVMAddTargetDependentFunctionAttr(LLVMValueRef Fn, const char *A, |
| 1817 | const char *V); |
| 1818 | |
| 1819 | /** |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1820 | * Obtain an attribute from a function. |
| 1821 | * |
| 1822 | * @see llvm::Function::getAttributes() |
| 1823 | */ |
Chris Lattner | 40cf28d | 2009-10-12 04:01:02 +0000 | [diff] [blame] | 1824 | LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1825 | |
| 1826 | /** |
| 1827 | * Remove an attribute from a function. |
| 1828 | */ |
Duncan Sands | 7374a01 | 2009-05-06 12:21:17 +0000 | [diff] [blame] | 1829 | void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA); |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 1830 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1831 | /** |
| 1832 | * @defgroup LLVMCCoreValueFunctionParameters Function Parameters |
| 1833 | * |
| 1834 | * Functions in this group relate to arguments/parameters on functions. |
| 1835 | * |
| 1836 | * Functions in this group expect LLVMValueRef instances that correspond |
| 1837 | * to llvm::Function instances. |
| 1838 | * |
| 1839 | * @{ |
| 1840 | */ |
| 1841 | |
| 1842 | /** |
| 1843 | * Obtain the number of parameters in a function. |
| 1844 | * |
| 1845 | * @see llvm::Function::arg_size() |
| 1846 | */ |
Gordon Henriksen | 265f780 | 2008-03-19 01:11:35 +0000 | [diff] [blame] | 1847 | unsigned LLVMCountParams(LLVMValueRef Fn); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1848 | |
| 1849 | /** |
| 1850 | * Obtain the parameters in a function. |
| 1851 | * |
| 1852 | * The takes a pointer to a pre-allocated array of LLVMValueRef that is |
| 1853 | * at least LLVMCountParams() long. This array will be filled with |
| 1854 | * LLVMValueRef instances which correspond to the parameters the |
| 1855 | * function receives. Each LLVMValueRef corresponds to a llvm::Argument |
| 1856 | * instance. |
| 1857 | * |
| 1858 | * @see llvm::Function::arg_begin() |
| 1859 | */ |
Gordon Henriksen | 265f780 | 2008-03-19 01:11:35 +0000 | [diff] [blame] | 1860 | void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1861 | |
| 1862 | /** |
| 1863 | * Obtain the parameter at the specified index. |
| 1864 | * |
| 1865 | * Parameters are indexed from 0. |
| 1866 | * |
| 1867 | * @see llvm::Function::arg_begin() |
| 1868 | */ |
Gordon Henriksen | 265f780 | 2008-03-19 01:11:35 +0000 | [diff] [blame] | 1869 | LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1870 | |
| 1871 | /** |
| 1872 | * Obtain the function to which this argument belongs. |
| 1873 | * |
Daniel Dunbar | 06b9f9e | 2013-08-16 23:30:19 +0000 | [diff] [blame] | 1874 | * Unlike other functions in this group, this one takes an LLVMValueRef |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1875 | * that corresponds to a llvm::Attribute. |
| 1876 | * |
| 1877 | * The returned LLVMValueRef is the llvm::Function to which this |
| 1878 | * argument belongs. |
| 1879 | */ |
Gordon Henriksen | 265f780 | 2008-03-19 01:11:35 +0000 | [diff] [blame] | 1880 | LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1881 | |
| 1882 | /** |
| 1883 | * Obtain the first parameter to a function. |
| 1884 | * |
| 1885 | * @see llvm::Function::arg_begin() |
| 1886 | */ |
Gordon Henriksen | 07a45f4 | 2008-03-23 22:21:29 +0000 | [diff] [blame] | 1887 | LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1888 | |
| 1889 | /** |
| 1890 | * Obtain the last parameter to a function. |
| 1891 | * |
| 1892 | * @see llvm::Function::arg_end() |
| 1893 | */ |
Gordon Henriksen | 07a45f4 | 2008-03-23 22:21:29 +0000 | [diff] [blame] | 1894 | LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1895 | |
| 1896 | /** |
| 1897 | * Obtain the next parameter to a function. |
| 1898 | * |
Daniel Dunbar | 06b9f9e | 2013-08-16 23:30:19 +0000 | [diff] [blame] | 1899 | * This takes an LLVMValueRef obtained from LLVMGetFirstParam() (which is |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1900 | * actually a wrapped iterator) and obtains the next parameter from the |
| 1901 | * underlying iterator. |
| 1902 | */ |
Gordon Henriksen | 07a45f4 | 2008-03-23 22:21:29 +0000 | [diff] [blame] | 1903 | LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1904 | |
| 1905 | /** |
| 1906 | * Obtain the previous parameter to a function. |
| 1907 | * |
| 1908 | * This is the opposite of LLVMGetNextParam(). |
| 1909 | */ |
Gordon Henriksen | 07a45f4 | 2008-03-23 22:21:29 +0000 | [diff] [blame] | 1910 | LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1911 | |
| 1912 | /** |
| 1913 | * Add an attribute to a function argument. |
| 1914 | * |
| 1915 | * @see llvm::Argument::addAttr() |
| 1916 | */ |
Devang Patel | 4c758ea | 2008-09-25 21:00:45 +0000 | [diff] [blame] | 1917 | void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1918 | |
| 1919 | /** |
| 1920 | * Remove an attribute from a function argument. |
| 1921 | * |
| 1922 | * @see llvm::Argument::removeAttr() |
| 1923 | */ |
Devang Patel | 4c758ea | 2008-09-25 21:00:45 +0000 | [diff] [blame] | 1924 | void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1925 | |
| 1926 | /** |
| 1927 | * Get an attribute from a function argument. |
| 1928 | */ |
Chris Lattner | 40cf28d | 2009-10-12 04:01:02 +0000 | [diff] [blame] | 1929 | LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1930 | |
| 1931 | /** |
| 1932 | * Set the alignment for a function parameter. |
| 1933 | * |
| 1934 | * @see llvm::Argument::addAttr() |
Bill Wendling | 50d2784 | 2012-10-15 20:35:56 +0000 | [diff] [blame] | 1935 | * @see llvm::AttrBuilder::addAlignmentAttr() |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1936 | */ |
Gordon Henriksen | 2d9cc21 | 2008-04-28 17:37:06 +0000 | [diff] [blame] | 1937 | void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align); |
Gordon Henriksen | 265f780 | 2008-03-19 01:11:35 +0000 | [diff] [blame] | 1938 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 1939 | /** |
| 1940 | * @} |
| 1941 | */ |
| 1942 | |
| 1943 | /** |
| 1944 | * @} |
| 1945 | */ |
| 1946 | |
| 1947 | /** |
Gregory Szorc | 52d2660 | 2012-03-21 07:28:27 +0000 | [diff] [blame] | 1948 | * @} |
| 1949 | */ |
| 1950 | |
| 1951 | /** |
| 1952 | * @} |
| 1953 | */ |
| 1954 | |
| 1955 | /** |
| 1956 | * @defgroup LLVMCCoreValueMetadata Metadata |
| 1957 | * |
| 1958 | * @{ |
| 1959 | */ |
| 1960 | |
| 1961 | /** |
| 1962 | * Obtain a MDString value from a context. |
| 1963 | * |
| 1964 | * The returned instance corresponds to the llvm::MDString class. |
| 1965 | * |
| 1966 | * The instance is specified by string data of a specified length. The |
| 1967 | * string content is copied, so the backing memory can be freed after |
| 1968 | * this function returns. |
| 1969 | */ |
| 1970 | LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str, |
| 1971 | unsigned SLen); |
| 1972 | |
| 1973 | /** |
| 1974 | * Obtain a MDString value from the global context. |
| 1975 | */ |
| 1976 | LLVMValueRef LLVMMDString(const char *Str, unsigned SLen); |
| 1977 | |
| 1978 | /** |
| 1979 | * Obtain a MDNode value from a context. |
| 1980 | * |
| 1981 | * The returned value corresponds to the llvm::MDNode class. |
| 1982 | */ |
| 1983 | LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals, |
| 1984 | unsigned Count); |
| 1985 | |
| 1986 | /** |
| 1987 | * Obtain a MDNode value from the global context. |
| 1988 | */ |
| 1989 | LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count); |
| 1990 | |
| 1991 | /** |
| 1992 | * Obtain the underlying string from a MDString value. |
| 1993 | * |
| 1994 | * @param V Instance to obtain string from. |
| 1995 | * @param Len Memory address which will hold length of returned string. |
| 1996 | * @return String data in MDString. |
| 1997 | */ |
| 1998 | const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len); |
| 1999 | |
| 2000 | /** |
Duncan Sands | 12ccbe7 | 2012-09-19 20:29:39 +0000 | [diff] [blame] | 2001 | * Obtain the number of operands from an MDNode value. |
| 2002 | * |
| 2003 | * @param V MDNode to get number of operands from. |
| 2004 | * @return Number of operands of the MDNode. |
| 2005 | */ |
| 2006 | unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V); |
| 2007 | |
| 2008 | /** |
| 2009 | * Obtain the given MDNode's operands. |
| 2010 | * |
| 2011 | * The passed LLVMValueRef pointer should point to enough memory to hold all of |
| 2012 | * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as |
| 2013 | * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the |
| 2014 | * MDNode's operands. |
| 2015 | * |
| 2016 | * @param V MDNode to get the operands from. |
| 2017 | * @param Dest Destination array for operands. |
| 2018 | */ |
| 2019 | void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest); |
| 2020 | |
| 2021 | /** |
Gregory Szorc | 52d2660 | 2012-03-21 07:28:27 +0000 | [diff] [blame] | 2022 | * @} |
| 2023 | */ |
| 2024 | |
| 2025 | /** |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2026 | * @defgroup LLVMCCoreValueBasicBlock Basic Block |
| 2027 | * |
| 2028 | * A basic block represents a single entry single exit section of code. |
| 2029 | * Basic blocks contain a list of instructions which form the body of |
| 2030 | * the block. |
| 2031 | * |
| 2032 | * Basic blocks belong to functions. They have the type of label. |
| 2033 | * |
| 2034 | * Basic blocks are themselves values. However, the C API models them as |
| 2035 | * LLVMBasicBlockRef. |
| 2036 | * |
| 2037 | * @see llvm::BasicBlock |
| 2038 | * |
| 2039 | * @{ |
| 2040 | */ |
| 2041 | |
| 2042 | /** |
| 2043 | * Convert a basic block instance to a value type. |
| 2044 | */ |
Gordon Henriksen | 07a45f4 | 2008-03-23 22:21:29 +0000 | [diff] [blame] | 2045 | LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2046 | |
| 2047 | /** |
Daniel Dunbar | 06b9f9e | 2013-08-16 23:30:19 +0000 | [diff] [blame] | 2048 | * Determine whether an LLVMValueRef is itself a basic block. |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2049 | */ |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 2050 | LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2051 | |
| 2052 | /** |
Daniel Dunbar | 06b9f9e | 2013-08-16 23:30:19 +0000 | [diff] [blame] | 2053 | * Convert an LLVMValueRef to an LLVMBasicBlockRef instance. |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2054 | */ |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2055 | LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2056 | |
| 2057 | /** |
| 2058 | * Obtain the function to which a basic block belongs. |
| 2059 | * |
| 2060 | * @see llvm::BasicBlock::getParent() |
| 2061 | */ |
Gordon Henriksen | 07a45f4 | 2008-03-23 22:21:29 +0000 | [diff] [blame] | 2062 | LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2063 | |
| 2064 | /** |
| 2065 | * Obtain the terminator instruction for a basic block. |
| 2066 | * |
| 2067 | * If the basic block does not have a terminator (it is not well-formed |
| 2068 | * if it doesn't), then NULL is returned. |
| 2069 | * |
| 2070 | * The returned LLVMValueRef corresponds to a llvm::TerminatorInst. |
| 2071 | * |
| 2072 | * @see llvm::BasicBlock::getTerminator() |
| 2073 | */ |
Nate Begeman | 43c322b | 2011-08-23 20:27:46 +0000 | [diff] [blame] | 2074 | LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2075 | |
| 2076 | /** |
| 2077 | * Obtain the number of basic blocks in a function. |
| 2078 | * |
| 2079 | * @param Fn Function value to operate on. |
| 2080 | */ |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2081 | unsigned LLVMCountBasicBlocks(LLVMValueRef Fn); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2082 | |
| 2083 | /** |
| 2084 | * Obtain all of the basic blocks in a function. |
| 2085 | * |
| 2086 | * This operates on a function value. The BasicBlocks parameter is a |
| 2087 | * pointer to a pre-allocated array of LLVMBasicBlockRef of at least |
| 2088 | * LLVMCountBasicBlocks() in length. This array is populated with |
| 2089 | * LLVMBasicBlockRef instances. |
| 2090 | */ |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2091 | void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2092 | |
| 2093 | /** |
| 2094 | * Obtain the first basic block in a function. |
| 2095 | * |
| 2096 | * The returned basic block can be used as an iterator. You will likely |
| 2097 | * eventually call into LLVMGetNextBasicBlock() with it. |
| 2098 | * |
| 2099 | * @see llvm::Function::begin() |
| 2100 | */ |
Gordon Henriksen | 054817c | 2008-03-19 03:47:18 +0000 | [diff] [blame] | 2101 | LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2102 | |
| 2103 | /** |
| 2104 | * Obtain the last basic block in a function. |
| 2105 | * |
| 2106 | * @see llvm::Function::end() |
| 2107 | */ |
Gordon Henriksen | 054817c | 2008-03-19 03:47:18 +0000 | [diff] [blame] | 2108 | LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2109 | |
| 2110 | /** |
| 2111 | * Advance a basic block iterator. |
| 2112 | */ |
Gordon Henriksen | 054817c | 2008-03-19 03:47:18 +0000 | [diff] [blame] | 2113 | LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2114 | |
| 2115 | /** |
| 2116 | * Go backwards in a basic block iterator. |
| 2117 | */ |
Gordon Henriksen | 054817c | 2008-03-19 03:47:18 +0000 | [diff] [blame] | 2118 | LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2119 | |
| 2120 | /** |
| 2121 | * Obtain the basic block that corresponds to the entry point of a |
| 2122 | * function. |
| 2123 | * |
| 2124 | * @see llvm::Function::getEntryBlock() |
| 2125 | */ |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2126 | LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn); |
Erick Tryzelaar | 262332f | 2009-08-14 00:01:31 +0000 | [diff] [blame] | 2127 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2128 | /** |
| 2129 | * Append a basic block to the end of a function. |
| 2130 | * |
| 2131 | * @see llvm::BasicBlock::Create() |
| 2132 | */ |
Erick Tryzelaar | 262332f | 2009-08-14 00:01:31 +0000 | [diff] [blame] | 2133 | LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C, |
| 2134 | LLVMValueRef Fn, |
| 2135 | const char *Name); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2136 | |
| 2137 | /** |
| 2138 | * Append a basic block to the end of a function using the global |
| 2139 | * context. |
| 2140 | * |
| 2141 | * @see llvm::BasicBlock::Create() |
| 2142 | */ |
| 2143 | LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name); |
| 2144 | |
| 2145 | /** |
| 2146 | * Insert a basic block in a function before another basic block. |
| 2147 | * |
| 2148 | * The function to add to is determined by the function of the |
| 2149 | * passed basic block. |
| 2150 | * |
| 2151 | * @see llvm::BasicBlock::Create() |
| 2152 | */ |
Erick Tryzelaar | 262332f | 2009-08-14 00:01:31 +0000 | [diff] [blame] | 2153 | LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C, |
| 2154 | LLVMBasicBlockRef BB, |
| 2155 | const char *Name); |
| 2156 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2157 | /** |
| 2158 | * Insert a basic block in a function using the global context. |
| 2159 | * |
| 2160 | * @see llvm::BasicBlock::Create() |
| 2161 | */ |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2162 | LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB, |
| 2163 | const char *Name); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2164 | |
| 2165 | /** |
| 2166 | * Remove a basic block from a function and delete it. |
| 2167 | * |
| 2168 | * This deletes the basic block from its containing function and deletes |
| 2169 | * the basic block itself. |
| 2170 | * |
| 2171 | * @see llvm::BasicBlock::eraseFromParent() |
| 2172 | */ |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2173 | void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2174 | |
| 2175 | /** |
| 2176 | * Remove a basic block from a function. |
| 2177 | * |
| 2178 | * This deletes the basic block from its containing function but keep |
| 2179 | * the basic block alive. |
| 2180 | * |
| 2181 | * @see llvm::BasicBlock::removeFromParent() |
| 2182 | */ |
Nate Begeman | 43c322b | 2011-08-23 20:27:46 +0000 | [diff] [blame] | 2183 | void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB); |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2184 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2185 | /** |
| 2186 | * Move a basic block to before another one. |
| 2187 | * |
| 2188 | * @see llvm::BasicBlock::moveBefore() |
| 2189 | */ |
Duncan Sands | b1d61aa | 2010-07-19 15:31:07 +0000 | [diff] [blame] | 2190 | void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2191 | |
| 2192 | /** |
| 2193 | * Move a basic block to after another one. |
| 2194 | * |
| 2195 | * @see llvm::BasicBlock::moveAfter() |
| 2196 | */ |
Duncan Sands | b1d61aa | 2010-07-19 15:31:07 +0000 | [diff] [blame] | 2197 | void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos); |
| 2198 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2199 | /** |
| 2200 | * Obtain the first instruction in a basic block. |
| 2201 | * |
| 2202 | * The returned LLVMValueRef corresponds to a llvm::Instruction |
| 2203 | * instance. |
| 2204 | */ |
Gordon Henriksen | 054817c | 2008-03-19 03:47:18 +0000 | [diff] [blame] | 2205 | LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2206 | |
| 2207 | /** |
| 2208 | * Obtain the last instruction in a basic block. |
| 2209 | * |
Daniel Dunbar | 06b9f9e | 2013-08-16 23:30:19 +0000 | [diff] [blame] | 2210 | * The returned LLVMValueRef corresponds to an LLVM:Instruction. |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2211 | */ |
Gordon Henriksen | 054817c | 2008-03-19 03:47:18 +0000 | [diff] [blame] | 2212 | LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB); |
Nate Begeman | 43c322b | 2011-08-23 20:27:46 +0000 | [diff] [blame] | 2213 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2214 | /** |
| 2215 | * @} |
| 2216 | */ |
| 2217 | |
| 2218 | /** |
| 2219 | * @defgroup LLVMCCoreValueInstruction Instructions |
| 2220 | * |
| 2221 | * Functions in this group relate to the inspection and manipulation of |
| 2222 | * individual instructions. |
| 2223 | * |
| 2224 | * In the C++ API, an instruction is modeled by llvm::Instruction. This |
| 2225 | * class has a large number of descendents. llvm::Instruction is a |
| 2226 | * llvm::Value and in the C API, instructions are modeled by |
| 2227 | * LLVMValueRef. |
| 2228 | * |
| 2229 | * This group also contains sub-groups which operate on specific |
| 2230 | * llvm::Instruction types, e.g. llvm::CallInst. |
| 2231 | * |
| 2232 | * @{ |
| 2233 | */ |
| 2234 | |
| 2235 | /** |
| 2236 | * Determine whether an instruction has any metadata attached. |
| 2237 | */ |
| 2238 | int LLVMHasMetadata(LLVMValueRef Val); |
| 2239 | |
| 2240 | /** |
| 2241 | * Return metadata associated with an instruction value. |
| 2242 | */ |
| 2243 | LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID); |
| 2244 | |
| 2245 | /** |
| 2246 | * Set metadata associated with an instruction value. |
| 2247 | */ |
| 2248 | void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node); |
| 2249 | |
| 2250 | /** |
| 2251 | * Obtain the basic block to which an instruction belongs. |
| 2252 | * |
| 2253 | * @see llvm::Instruction::getParent() |
| 2254 | */ |
Nate Begeman | 43c322b | 2011-08-23 20:27:46 +0000 | [diff] [blame] | 2255 | LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2256 | |
| 2257 | /** |
| 2258 | * Obtain the instruction that occurs after the one specified. |
| 2259 | * |
| 2260 | * The next instruction will be from the same basic block. |
| 2261 | * |
| 2262 | * If this is the last instruction in a basic block, NULL will be |
| 2263 | * returned. |
| 2264 | */ |
Gordon Henriksen | 054817c | 2008-03-19 03:47:18 +0000 | [diff] [blame] | 2265 | LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2266 | |
| 2267 | /** |
Benjamin Kramer | bde9176 | 2012-06-02 10:20:22 +0000 | [diff] [blame] | 2268 | * Obtain the instruction that occurred before this one. |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2269 | * |
| 2270 | * If the instruction is the first instruction in a basic block, NULL |
| 2271 | * will be returned. |
| 2272 | */ |
Gordon Henriksen | 054817c | 2008-03-19 03:47:18 +0000 | [diff] [blame] | 2273 | LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2274 | |
| 2275 | /** |
| 2276 | * Remove and delete an instruction. |
| 2277 | * |
| 2278 | * The instruction specified is removed from its containing building |
| 2279 | * block and then deleted. |
| 2280 | * |
| 2281 | * @see llvm::Instruction::eraseFromParent() |
| 2282 | */ |
Devang Patel | dbebc6f | 2011-10-03 20:59:18 +0000 | [diff] [blame] | 2283 | void LLVMInstructionEraseFromParent(LLVMValueRef Inst); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2284 | |
| 2285 | /** |
| 2286 | * Obtain the code opcode for an individual instruction. |
| 2287 | * |
| 2288 | * @see llvm::Instruction::getOpCode() |
| 2289 | */ |
Torok Edwin | ab6158e | 2011-10-14 20:37:49 +0000 | [diff] [blame] | 2290 | LLVMOpcode LLVMGetInstructionOpcode(LLVMValueRef Inst); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2291 | |
| 2292 | /** |
| 2293 | * Obtain the predicate of an instruction. |
| 2294 | * |
| 2295 | * This is only valid for instructions that correspond to llvm::ICmpInst |
| 2296 | * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp. |
| 2297 | * |
| 2298 | * @see llvm::ICmpInst::getPredicate() |
| 2299 | */ |
Torok Edwin | 60c40de | 2011-10-06 12:13:20 +0000 | [diff] [blame] | 2300 | LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst); |
Gordon Henriksen | 265f780 | 2008-03-19 01:11:35 +0000 | [diff] [blame] | 2301 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2302 | /** |
| 2303 | * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations |
| 2304 | * |
| 2305 | * Functions in this group apply to instructions that refer to call |
| 2306 | * sites and invocations. These correspond to C++ types in the |
| 2307 | * llvm::CallInst class tree. |
| 2308 | * |
| 2309 | * @{ |
| 2310 | */ |
| 2311 | |
| 2312 | /** |
| 2313 | * Set the calling convention for a call instruction. |
| 2314 | * |
| 2315 | * This expects an LLVMValueRef that corresponds to a llvm::CallInst or |
| 2316 | * llvm::InvokeInst. |
| 2317 | * |
| 2318 | * @see llvm::CallInst::setCallingConv() |
| 2319 | * @see llvm::InvokeInst::setCallingConv() |
| 2320 | */ |
Gordon Henriksen | 1158c53 | 2007-12-29 20:45:00 +0000 | [diff] [blame] | 2321 | void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2322 | |
| 2323 | /** |
| 2324 | * Obtain the calling convention for a call instruction. |
| 2325 | * |
| 2326 | * This is the opposite of LLVMSetInstructionCallConv(). Reads its |
| 2327 | * usage. |
| 2328 | * |
| 2329 | * @see LLVMSetInstructionCallConv() |
| 2330 | */ |
Gordon Henriksen | 1158c53 | 2007-12-29 20:45:00 +0000 | [diff] [blame] | 2331 | unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2332 | |
| 2333 | |
Devang Patel | 4c758ea | 2008-09-25 21:00:45 +0000 | [diff] [blame] | 2334 | void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2335 | void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index, |
Devang Patel | 4c758ea | 2008-09-25 21:00:45 +0000 | [diff] [blame] | 2336 | LLVMAttribute); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2337 | void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index, |
Gordon Henriksen | 2d9cc21 | 2008-04-28 17:37:06 +0000 | [diff] [blame] | 2338 | unsigned align); |
Gordon Henriksen | 1158c53 | 2007-12-29 20:45:00 +0000 | [diff] [blame] | 2339 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2340 | /** |
| 2341 | * Obtain whether a call instruction is a tail call. |
| 2342 | * |
| 2343 | * This only works on llvm::CallInst instructions. |
| 2344 | * |
| 2345 | * @see llvm::CallInst::isTailCall() |
| 2346 | */ |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 2347 | LLVMBool LLVMIsTailCall(LLVMValueRef CallInst); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2348 | |
| 2349 | /** |
| 2350 | * Set whether a call instruction is a tail call. |
| 2351 | * |
| 2352 | * This only works on llvm::CallInst instructions. |
| 2353 | * |
| 2354 | * @see llvm::CallInst::setTailCall() |
| 2355 | */ |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 2356 | void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall); |
Gordon Henriksen | eeb6537 | 2008-08-30 16:34:54 +0000 | [diff] [blame] | 2357 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2358 | /** |
| 2359 | * @} |
| 2360 | */ |
| 2361 | |
| 2362 | /** |
| 2363 | * Obtain the default destination basic block of a switch instruction. |
| 2364 | * |
| 2365 | * This only works on llvm::SwitchInst instructions. |
| 2366 | * |
| 2367 | * @see llvm::SwitchInst::getDefaultDest() |
| 2368 | */ |
Nate Begeman | 43c322b | 2011-08-23 20:27:46 +0000 | [diff] [blame] | 2369 | LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr); |
| 2370 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2371 | /** |
| 2372 | * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes |
| 2373 | * |
| 2374 | * Functions in this group only apply to instructions that map to |
| 2375 | * llvm::PHINode instances. |
| 2376 | * |
| 2377 | * @{ |
| 2378 | */ |
| 2379 | |
| 2380 | /** |
| 2381 | * Add an incoming value to the end of a PHI list. |
| 2382 | */ |
Gordon Henriksen | 44dd8fb | 2007-10-08 18:14:39 +0000 | [diff] [blame] | 2383 | void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues, |
| 2384 | LLVMBasicBlockRef *IncomingBlocks, unsigned Count); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2385 | |
| 2386 | /** |
| 2387 | * Obtain the number of incoming basic blocks to a PHI node. |
| 2388 | */ |
Gordon Henriksen | 44dd8fb | 2007-10-08 18:14:39 +0000 | [diff] [blame] | 2389 | unsigned LLVMCountIncoming(LLVMValueRef PhiNode); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2390 | |
| 2391 | /** |
Daniel Dunbar | 06b9f9e | 2013-08-16 23:30:19 +0000 | [diff] [blame] | 2392 | * Obtain an incoming value to a PHI node as an LLVMValueRef. |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2393 | */ |
Gordon Henriksen | 44dd8fb | 2007-10-08 18:14:39 +0000 | [diff] [blame] | 2394 | LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index); |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2395 | |
| 2396 | /** |
Daniel Dunbar | 06b9f9e | 2013-08-16 23:30:19 +0000 | [diff] [blame] | 2397 | * Obtain an incoming value to a PHI node as an LLVMBasicBlockRef. |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2398 | */ |
Gordon Henriksen | 44dd8fb | 2007-10-08 18:14:39 +0000 | [diff] [blame] | 2399 | LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index); |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2400 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2401 | /** |
| 2402 | * @} |
| 2403 | */ |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2404 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2405 | /** |
| 2406 | * @} |
| 2407 | */ |
| 2408 | |
| 2409 | /** |
| 2410 | * @} |
| 2411 | */ |
| 2412 | |
| 2413 | /** |
| 2414 | * @defgroup LLVMCCoreInstructionBuilder Instruction Builders |
| 2415 | * |
| 2416 | * An instruction builder represents a point within a basic block and is |
| 2417 | * the exclusive means of building instructions using the C interface. |
| 2418 | * |
| 2419 | * @{ |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2420 | */ |
| 2421 | |
Erick Tryzelaar | 262332f | 2009-08-14 00:01:31 +0000 | [diff] [blame] | 2422 | LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C); |
Gordon Henriksen | a735a9c | 2008-05-04 12:55:34 +0000 | [diff] [blame] | 2423 | LLVMBuilderRef LLVMCreateBuilder(void); |
Gordon Henriksen | 054817c | 2008-03-19 03:47:18 +0000 | [diff] [blame] | 2424 | void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block, |
| 2425 | LLVMValueRef Instr); |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2426 | void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr); |
| 2427 | void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block); |
Gordon Henriksen | 265f780 | 2008-03-19 01:11:35 +0000 | [diff] [blame] | 2428 | LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder); |
Chris Lattner | 3d1f552 | 2008-12-17 21:39:50 +0000 | [diff] [blame] | 2429 | void LLVMClearInsertionPosition(LLVMBuilderRef Builder); |
| 2430 | void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr); |
Erick Tryzelaar | 9813bea | 2009-08-16 02:20:57 +0000 | [diff] [blame] | 2431 | void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr, |
| 2432 | const char *Name); |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2433 | void LLVMDisposeBuilder(LLVMBuilderRef Builder); |
| 2434 | |
Erick Tryzelaar | d8531fa | 2010-02-28 09:45:59 +0000 | [diff] [blame] | 2435 | /* Metadata */ |
| 2436 | void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L); |
| 2437 | LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder); |
| 2438 | void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst); |
| 2439 | |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2440 | /* Terminators */ |
| 2441 | LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef); |
| 2442 | LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V); |
Erick Tryzelaar | fd529d7 | 2009-08-19 08:36:49 +0000 | [diff] [blame] | 2443 | LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals, |
Erick Tryzelaar | 3045b8b | 2009-08-16 02:19:59 +0000 | [diff] [blame] | 2444 | unsigned N); |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2445 | LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest); |
| 2446 | LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If, |
| 2447 | LLVMBasicBlockRef Then, LLVMBasicBlockRef Else); |
| 2448 | LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V, |
| 2449 | LLVMBasicBlockRef Else, unsigned NumCases); |
Erick Tryzelaar | 0fb26ef | 2010-02-28 09:46:06 +0000 | [diff] [blame] | 2450 | LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr, |
| 2451 | unsigned NumDests); |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2452 | LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn, |
| 2453 | LLVMValueRef *Args, unsigned NumArgs, |
| 2454 | LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch, |
| 2455 | const char *Name); |
Benjamin Kramer | 5a656883 | 2011-08-19 01:36:54 +0000 | [diff] [blame] | 2456 | LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty, |
| 2457 | LLVMValueRef PersFn, unsigned NumClauses, |
| 2458 | const char *Name); |
Bill Wendling | f891bf8 | 2011-07-31 06:30:59 +0000 | [diff] [blame] | 2459 | LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn); |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2460 | LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef); |
| 2461 | |
Gordon Henriksen | 097102c | 2008-01-01 05:50:53 +0000 | [diff] [blame] | 2462 | /* Add a case to the switch instruction */ |
| 2463 | void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal, |
| 2464 | LLVMBasicBlockRef Dest); |
| 2465 | |
Erick Tryzelaar | 0fb26ef | 2010-02-28 09:46:06 +0000 | [diff] [blame] | 2466 | /* Add a destination to the indirectbr instruction */ |
| 2467 | void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest); |
| 2468 | |
Bill Wendling | fae1475 | 2011-08-12 20:24:12 +0000 | [diff] [blame] | 2469 | /* Add a catch or filter clause to the landingpad instruction */ |
| 2470 | void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal); |
| 2471 | |
| 2472 | /* Set the 'cleanup' flag in the landingpad instruction */ |
| 2473 | void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val); |
| 2474 | |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2475 | /* Arithmetic */ |
| 2476 | LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2477 | const char *Name); |
Erick Tryzelaar | 3045b8b | 2009-08-16 02:19:59 +0000 | [diff] [blame] | 2478 | LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2479 | const char *Name); |
Erick Tryzelaar | 4c340c7 | 2010-02-28 05:51:43 +0000 | [diff] [blame] | 2480 | LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2481 | const char *Name); |
Erick Tryzelaar | 3045b8b | 2009-08-16 02:19:59 +0000 | [diff] [blame] | 2482 | LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2483 | const char *Name); |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2484 | LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2485 | const char *Name); |
Erick Tryzelaar | 4c340c7 | 2010-02-28 05:51:43 +0000 | [diff] [blame] | 2486 | LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2487 | const char *Name); |
| 2488 | LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2489 | const char *Name); |
Erick Tryzelaar | 3045b8b | 2009-08-16 02:19:59 +0000 | [diff] [blame] | 2490 | LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2491 | const char *Name); |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2492 | LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2493 | const char *Name); |
Erick Tryzelaar | 4c340c7 | 2010-02-28 05:51:43 +0000 | [diff] [blame] | 2494 | LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2495 | const char *Name); |
| 2496 | LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2497 | const char *Name); |
Erick Tryzelaar | 3045b8b | 2009-08-16 02:19:59 +0000 | [diff] [blame] | 2498 | LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2499 | const char *Name); |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2500 | LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2501 | const char *Name); |
| 2502 | LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2503 | const char *Name); |
Erick Tryzelaar | 3045b8b | 2009-08-16 02:19:59 +0000 | [diff] [blame] | 2504 | LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2505 | const char *Name); |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2506 | LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2507 | const char *Name); |
| 2508 | LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2509 | const char *Name); |
| 2510 | LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2511 | const char *Name); |
| 2512 | LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2513 | const char *Name); |
| 2514 | LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2515 | const char *Name); |
| 2516 | LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2517 | const char *Name); |
| 2518 | LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2519 | const char *Name); |
| 2520 | LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2521 | const char *Name); |
| 2522 | LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2523 | const char *Name); |
| 2524 | LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, |
| 2525 | const char *Name); |
Erick Tryzelaar | 3183179 | 2010-02-28 05:51:27 +0000 | [diff] [blame] | 2526 | LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op, |
| 2527 | LLVMValueRef LHS, LLVMValueRef RHS, |
| 2528 | const char *Name); |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2529 | LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name); |
Erick Tryzelaar | 4c340c7 | 2010-02-28 05:51:43 +0000 | [diff] [blame] | 2530 | LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V, |
| 2531 | const char *Name); |
| 2532 | LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V, |
| 2533 | const char *Name); |
Dan Gohman | f919bd6 | 2009-09-28 21:51:41 +0000 | [diff] [blame] | 2534 | LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name); |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2535 | LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name); |
| 2536 | |
| 2537 | /* Memory */ |
| 2538 | LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name); |
| 2539 | LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty, |
| 2540 | LLVMValueRef Val, const char *Name); |
| 2541 | LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name); |
| 2542 | LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty, |
| 2543 | LLVMValueRef Val, const char *Name); |
| 2544 | LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal); |
| 2545 | LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal, |
| 2546 | const char *Name); |
| 2547 | LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr); |
| 2548 | LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer, |
| 2549 | LLVMValueRef *Indices, unsigned NumIndices, |
| 2550 | const char *Name); |
Erick Tryzelaar | 3045b8b | 2009-08-16 02:19:59 +0000 | [diff] [blame] | 2551 | LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer, |
| 2552 | LLVMValueRef *Indices, unsigned NumIndices, |
| 2553 | const char *Name); |
| 2554 | LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer, |
| 2555 | unsigned Idx, const char *Name); |
| 2556 | LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str, |
| 2557 | const char *Name); |
| 2558 | LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str, |
| 2559 | const char *Name); |
Chris Lattner | 2cc6f9d | 2012-03-22 03:54:15 +0000 | [diff] [blame] | 2560 | LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst); |
| 2561 | void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile); |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2562 | |
| 2563 | /* Casts */ |
| 2564 | LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val, |
| 2565 | LLVMTypeRef DestTy, const char *Name); |
| 2566 | LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val, |
| 2567 | LLVMTypeRef DestTy, const char *Name); |
| 2568 | LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val, |
| 2569 | LLVMTypeRef DestTy, const char *Name); |
| 2570 | LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val, |
| 2571 | LLVMTypeRef DestTy, const char *Name); |
| 2572 | LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val, |
| 2573 | LLVMTypeRef DestTy, const char *Name); |
| 2574 | LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val, |
| 2575 | LLVMTypeRef DestTy, const char *Name); |
| 2576 | LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val, |
| 2577 | LLVMTypeRef DestTy, const char *Name); |
| 2578 | LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val, |
| 2579 | LLVMTypeRef DestTy, const char *Name); |
| 2580 | LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val, |
| 2581 | LLVMTypeRef DestTy, const char *Name); |
| 2582 | LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val, |
| 2583 | LLVMTypeRef DestTy, const char *Name); |
| 2584 | LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val, |
| 2585 | LLVMTypeRef DestTy, const char *Name); |
| 2586 | LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val, |
| 2587 | LLVMTypeRef DestTy, const char *Name); |
Erick Tryzelaar | 3045b8b | 2009-08-16 02:19:59 +0000 | [diff] [blame] | 2588 | LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val, |
| 2589 | LLVMTypeRef DestTy, const char *Name); |
| 2590 | LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val, |
| 2591 | LLVMTypeRef DestTy, const char *Name); |
| 2592 | LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val, |
| 2593 | LLVMTypeRef DestTy, const char *Name); |
Erick Tryzelaar | 3183179 | 2010-02-28 05:51:27 +0000 | [diff] [blame] | 2594 | LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val, |
| 2595 | LLVMTypeRef DestTy, const char *Name); |
Erick Tryzelaar | 3045b8b | 2009-08-16 02:19:59 +0000 | [diff] [blame] | 2596 | LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val, |
| 2597 | LLVMTypeRef DestTy, const char *Name); |
Duncan Sands | 9d786d7 | 2009-11-23 10:49:03 +0000 | [diff] [blame] | 2598 | LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/ |
Erick Tryzelaar | 3045b8b | 2009-08-16 02:19:59 +0000 | [diff] [blame] | 2599 | LLVMTypeRef DestTy, const char *Name); |
| 2600 | LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val, |
| 2601 | LLVMTypeRef DestTy, const char *Name); |
Gordon Henriksen | c23b66c | 2007-09-26 20:56:12 +0000 | [diff] [blame] | 2602 | |
| 2603 | /* Comparisons */ |
| 2604 | LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op, |
| 2605 | LLVMValueRef LHS, LLVMValueRef RHS, |
| 2606 | const char *Name); |
| 2607 | LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op, |
| 2608 | LLVMValueRef LHS, LLVMValueRef RHS, |
| 2609 | const char *Name); |
| 2610 | |
| 2611 | /* Miscellaneous instructions */ |
| 2612 | LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name); |
| 2613 | LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn, |
| 2614 | LLVMValueRef *Args, unsigned NumArgs, |
| 2615 | const char *Name); |
| 2616 | LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If, |
| 2617 | LLVMValueRef Then, LLVMValueRef Else, |
| 2618 | const char *Name); |
| 2619 | LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty, |
| 2620 | const char *Name); |
| 2621 | LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal, |
| 2622 | LLVMValueRef Index, const char *Name); |
| 2623 | LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal, |
| 2624 | LLVMValueRef EltVal, LLVMValueRef Index, |
| 2625 | const char *Name); |
| 2626 | LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1, |
| 2627 | LLVMValueRef V2, LLVMValueRef Mask, |
| 2628 | const char *Name); |
Dan Gohman | d5104a5 | 2008-11-03 22:55:43 +0000 | [diff] [blame] | 2629 | LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal, |
| 2630 | unsigned Index, const char *Name); |
| 2631 | LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal, |
| 2632 | LLVMValueRef EltVal, unsigned Index, |
| 2633 | const char *Name); |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 2634 | |
Erick Tryzelaar | 3045b8b | 2009-08-16 02:19:59 +0000 | [diff] [blame] | 2635 | LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val, |
| 2636 | const char *Name); |
| 2637 | LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val, |
| 2638 | const char *Name); |
| 2639 | LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS, |
| 2640 | LLVMValueRef RHS, const char *Name); |
NAKAMURA Takumi | a3a8135 | 2013-10-23 17:56:29 +0000 | [diff] [blame] | 2641 | LLVMValueRef LLVMBuildAtomicRMW(LLVMBuilderRef B,LLVMAtomicRMWBinOp op, |
| 2642 | LLVMValueRef PTR, LLVMValueRef Val, |
| 2643 | LLVMAtomicOrdering ordering, |
Carlo Kok | 8c6719b | 2013-04-23 13:21:19 +0000 | [diff] [blame] | 2644 | LLVMBool singleThread); |
Erick Tryzelaar | 3045b8b | 2009-08-16 02:19:59 +0000 | [diff] [blame] | 2645 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2646 | /** |
| 2647 | * @} |
| 2648 | */ |
Gordon Henriksen | 34eb6d8 | 2007-12-19 22:30:40 +0000 | [diff] [blame] | 2649 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2650 | /** |
| 2651 | * @defgroup LLVMCCoreModuleProvider Module Providers |
| 2652 | * |
| 2653 | * @{ |
| 2654 | */ |
Gordon Henriksen | 0a68fe2 | 2007-12-12 01:04:30 +0000 | [diff] [blame] | 2655 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2656 | /** |
| 2657 | * Changes the type of M so it can be passed to FunctionPassManagers and the |
Jeffrey Yasskin | 091217b | 2010-01-27 20:34:15 +0000 | [diff] [blame] | 2658 | * JIT. They take ModuleProviders for historical reasons. |
Gordon Henriksen | 0a68fe2 | 2007-12-12 01:04:30 +0000 | [diff] [blame] | 2659 | */ |
| 2660 | LLVMModuleProviderRef |
| 2661 | LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M); |
| 2662 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2663 | /** |
| 2664 | * Destroys the module M. |
Gordon Henriksen | 0a68fe2 | 2007-12-12 01:04:30 +0000 | [diff] [blame] | 2665 | */ |
Jeffrey Yasskin | 091217b | 2010-01-27 20:34:15 +0000 | [diff] [blame] | 2666 | void LLVMDisposeModuleProvider(LLVMModuleProviderRef M); |
Gordon Henriksen | 0a68fe2 | 2007-12-12 01:04:30 +0000 | [diff] [blame] | 2667 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2668 | /** |
| 2669 | * @} |
| 2670 | */ |
Gordon Henriksen | 34eb6d8 | 2007-12-19 22:30:40 +0000 | [diff] [blame] | 2671 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2672 | /** |
| 2673 | * @defgroup LLVMCCoreMemoryBuffers Memory Buffers |
| 2674 | * |
| 2675 | * @{ |
| 2676 | */ |
Gordon Henriksen | 34eb6d8 | 2007-12-19 22:30:40 +0000 | [diff] [blame] | 2677 | |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 2678 | LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path, |
| 2679 | LLVMMemoryBufferRef *OutMemBuf, |
| 2680 | char **OutMessage); |
| 2681 | LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf, |
| 2682 | char **OutMessage); |
Bill Wendling | 526276a | 2013-02-14 19:11:28 +0000 | [diff] [blame] | 2683 | LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRange(const char *InputData, |
| 2684 | size_t InputDataLength, |
| 2685 | const char *BufferName, |
Bill Wendling | c9baa96 | 2013-02-14 19:39:14 +0000 | [diff] [blame] | 2686 | LLVMBool RequiresNullTerminator); |
Bill Wendling | 526276a | 2013-02-14 19:11:28 +0000 | [diff] [blame] | 2687 | LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRangeCopy(const char *InputData, |
| 2688 | size_t InputDataLength, |
| 2689 | const char *BufferName); |
Tom Stellard | 62c0320 | 2013-04-18 19:50:53 +0000 | [diff] [blame] | 2690 | const char *LLVMGetBufferStart(LLVMMemoryBufferRef MemBuf); |
Tom Stellard | b7fb724 | 2013-04-16 23:12:51 +0000 | [diff] [blame] | 2691 | size_t LLVMGetBufferSize(LLVMMemoryBufferRef MemBuf); |
Gordon Henriksen | 34eb6d8 | 2007-12-19 22:30:40 +0000 | [diff] [blame] | 2692 | void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf); |
| 2693 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2694 | /** |
| 2695 | * @} |
| 2696 | */ |
| 2697 | |
| 2698 | /** |
| 2699 | * @defgroup LLVMCCorePassRegistry Pass Registry |
| 2700 | * |
| 2701 | * @{ |
| 2702 | */ |
Owen Anderson | 4698c5d | 2010-10-07 17:55:47 +0000 | [diff] [blame] | 2703 | |
| 2704 | /** Return the global pass registry, for use with initialization functions. |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2705 | @see llvm::PassRegistry::getPassRegistry */ |
Owen Anderson | 4698c5d | 2010-10-07 17:55:47 +0000 | [diff] [blame] | 2706 | LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void); |
Gordon Henriksen | 878114b | 2008-03-16 04:20:44 +0000 | [diff] [blame] | 2707 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2708 | /** |
| 2709 | * @} |
| 2710 | */ |
| 2711 | |
| 2712 | /** |
| 2713 | * @defgroup LLVMCCorePassManagers Pass Managers |
| 2714 | * |
| 2715 | * @{ |
| 2716 | */ |
Gordon Henriksen | 878114b | 2008-03-16 04:20:44 +0000 | [diff] [blame] | 2717 | |
| 2718 | /** Constructs a new whole-module pass pipeline. This type of pipeline is |
| 2719 | suitable for link-time optimization and whole-module transformations. |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2720 | @see llvm::PassManager::PassManager */ |
Gordon Henriksen | a735a9c | 2008-05-04 12:55:34 +0000 | [diff] [blame] | 2721 | LLVMPassManagerRef LLVMCreatePassManager(void); |
Gordon Henriksen | 878114b | 2008-03-16 04:20:44 +0000 | [diff] [blame] | 2722 | |
| 2723 | /** Constructs a new function-by-function pass pipeline over the module |
| 2724 | provider. It does not take ownership of the module provider. This type of |
| 2725 | pipeline is suitable for code generation and JIT compilation tasks. |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2726 | @see llvm::FunctionPassManager::FunctionPassManager */ |
Erick Tryzelaar | ad0e0cb | 2010-03-02 23:58:54 +0000 | [diff] [blame] | 2727 | LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M); |
| 2728 | |
| 2729 | /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */ |
Gordon Henriksen | 878114b | 2008-03-16 04:20:44 +0000 | [diff] [blame] | 2730 | LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP); |
| 2731 | |
| 2732 | /** Initializes, executes on the provided module, and finalizes all of the |
| 2733 | passes scheduled in the pass manager. Returns 1 if any of the passes |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2734 | modified the module, 0 otherwise. |
| 2735 | @see llvm::PassManager::run(Module&) */ |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 2736 | LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M); |
Gordon Henriksen | 878114b | 2008-03-16 04:20:44 +0000 | [diff] [blame] | 2737 | |
| 2738 | /** Initializes all of the function passes scheduled in the function pass |
| 2739 | manager. Returns 1 if any of the passes modified the module, 0 otherwise. |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2740 | @see llvm::FunctionPassManager::doInitialization */ |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 2741 | LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM); |
Gordon Henriksen | 878114b | 2008-03-16 04:20:44 +0000 | [diff] [blame] | 2742 | |
| 2743 | /** Executes all of the function passes scheduled in the function pass manager |
| 2744 | on the provided function. Returns 1 if any of the passes modified the |
| 2745 | function, false otherwise. |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2746 | @see llvm::FunctionPassManager::run(Function&) */ |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 2747 | LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F); |
Gordon Henriksen | 878114b | 2008-03-16 04:20:44 +0000 | [diff] [blame] | 2748 | |
| 2749 | /** Finalizes all of the function passes scheduled in in the function pass |
| 2750 | manager. Returns 1 if any of the passes modified the module, 0 otherwise. |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2751 | @see llvm::FunctionPassManager::doFinalization */ |
Chris Lattner | 25963c6 | 2010-01-09 22:27:07 +0000 | [diff] [blame] | 2752 | LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM); |
Gordon Henriksen | 878114b | 2008-03-16 04:20:44 +0000 | [diff] [blame] | 2753 | |
| 2754 | /** Frees the memory of a pass pipeline. For function pipelines, does not free |
| 2755 | the module provider. |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2756 | @see llvm::PassManagerBase::~PassManagerBase. */ |
Gordon Henriksen | 878114b | 2008-03-16 04:20:44 +0000 | [diff] [blame] | 2757 | void LLVMDisposePassManager(LLVMPassManagerRef PM); |
| 2758 | |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2759 | /** |
| 2760 | * @} |
| 2761 | */ |
| 2762 | |
| 2763 | /** |
Duncan Sands | 1cba0a8 | 2013-02-17 16:35:51 +0000 | [diff] [blame] | 2764 | * @defgroup LLVMCCoreThreading Threading |
| 2765 | * |
| 2766 | * Handle the structures needed to make LLVM safe for multithreading. |
| 2767 | * |
| 2768 | * @{ |
| 2769 | */ |
| 2770 | |
| 2771 | /** Allocate and initialize structures needed to make LLVM safe for |
| 2772 | multithreading. The return value indicates whether multithreaded |
| 2773 | initialization succeeded. Must be executed in isolation from all |
| 2774 | other LLVM api calls. |
| 2775 | @see llvm::llvm_start_multithreaded */ |
Benjamin Kramer | 325ec89 | 2013-10-23 16:57:34 +0000 | [diff] [blame] | 2776 | LLVMBool LLVMStartMultithreaded(void); |
Duncan Sands | 1cba0a8 | 2013-02-17 16:35:51 +0000 | [diff] [blame] | 2777 | |
| 2778 | /** Deallocate structures necessary to make LLVM safe for multithreading. |
| 2779 | Must be executed in isolation from all other LLVM api calls. |
| 2780 | @see llvm::llvm_stop_multithreaded */ |
Benjamin Kramer | 325ec89 | 2013-10-23 16:57:34 +0000 | [diff] [blame] | 2781 | void LLVMStopMultithreaded(void); |
Duncan Sands | 1cba0a8 | 2013-02-17 16:35:51 +0000 | [diff] [blame] | 2782 | |
| 2783 | /** Check whether LLVM is executing in thread-safe mode or not. |
| 2784 | @see llvm::llvm_is_multithreaded */ |
Benjamin Kramer | 325ec89 | 2013-10-23 16:57:34 +0000 | [diff] [blame] | 2785 | LLVMBool LLVMIsMultithreaded(void); |
Duncan Sands | 1cba0a8 | 2013-02-17 16:35:51 +0000 | [diff] [blame] | 2786 | |
| 2787 | /** |
| 2788 | * @} |
| 2789 | */ |
| 2790 | |
| 2791 | /** |
Gregory Szorc | 34c863a | 2012-03-21 03:54:29 +0000 | [diff] [blame] | 2792 | * @} |
| 2793 | */ |
| 2794 | |
| 2795 | /** |
| 2796 | * @} |
| 2797 | */ |
Gordon Henriksen | 878114b | 2008-03-16 04:20:44 +0000 | [diff] [blame] | 2798 | |
Gordon Henriksen | 76a0374 | 2007-09-18 03:18:57 +0000 | [diff] [blame] | 2799 | #ifdef __cplusplus |
| 2800 | } |
Evan Cheng | 2e254d0 | 2013-04-04 17:40:53 +0000 | [diff] [blame] | 2801 | #endif /* !defined(__cplusplus) */ |
Gordon Henriksen | 7330acd | 2007-10-05 23:59:36 +0000 | [diff] [blame] | 2802 | |
Evan Cheng | 2e254d0 | 2013-04-04 17:40:53 +0000 | [diff] [blame] | 2803 | #endif /* !defined(LLVM_C_CORE_H) */ |