TargetMachine.h revision 9313da5a90838c7242101dae250e86dcfc708e6a
1d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands/*===-- llvm-c/TargetMachine.h - Target Machine Library C Interface - C++ -*-=*\ 2d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands|* *| 3d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands|* The LLVM Compiler Infrastructure *| 4d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands|* *| 5d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands|* This file is distributed under the University of Illinois Open Source *| 6d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands|* License. See LICENSE.TXT for details. *| 7d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands|* *| 8d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands|*===----------------------------------------------------------------------===*| 9d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands|* *| 10d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands|* This header declares the C interface to the Target and TargetMachine *| 11d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands|* classes, which can be used to generate assembly or object files. *| 12d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands|* *| 13d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands|* Many exotic languages can interoperate with C code but have a harder time *| 14d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands|* with C++ due to name mangling. So in addition to C, this interface enables *| 15d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands|* tools written in such languages. *| 16d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands|* *| 17d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands\*===----------------------------------------------------------------------===*/ 18d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 19d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands#ifndef LLVM_C_TARGETMACHINE_H 20d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands#define LLVM_C_TARGETMACHINE_H 21d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 22d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands#include "llvm-c/Core.h" 23d04a8d4b33ff316ca4cf961e06c9e312eff8e64fChandler Carruth#include "llvm-c/Target.h" 24d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 25d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands#ifdef __cplusplus 26d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sandsextern "C" { 27d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands#endif 28d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sandstypedef struct LLVMTargetMachine *LLVMTargetMachineRef; 29d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sandstypedef struct LLVMTarget *LLVMTargetRef; 30d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 31d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sandstypedef enum { 32d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMCodeGenLevelNone, 33d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMCodeGenLevelLess, 34d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMCodeGenLevelDefault, 35d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMCodeGenLevelAggressive 36d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands} LLVMCodeGenOptLevel; 37d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 38d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sandstypedef enum { 39d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMRelocDefault, 40d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMRelocStatic, 41d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMRelocPIC, 42d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMRelocDynamicNoPic 43d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands} LLVMRelocMode; 44d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 45d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sandstypedef enum { 46d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMCodeModelDefault, 47d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMCodeModelJITDefault, 48d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMCodeModelSmall, 49d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMCodeModelKernel, 50d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMCodeModelMedium, 51d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMCodeModelLarge 52d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands} LLVMCodeModel; 53d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 54d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sandstypedef enum { 55d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMAssemblyFile, 56d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMObjectFile 57d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands} LLVMCodeGenFileType; 58d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 59d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands/** Returns the first llvm::Target in the registered targets list. */ 60d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan SandsLLVMTargetRef LLVMGetFirstTarget(); 61d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands/** Returns the next llvm::Target given a previous one (or null if there's none) */ 62d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan SandsLLVMTargetRef LLVMGetNextTarget(LLVMTargetRef T); 63d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 64d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands/*===-- Target ------------------------------------------------------------===*/ 65d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands/** Returns the name of a target. See llvm::Target::getName */ 66d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sandsconst char *LLVMGetTargetName(LLVMTargetRef T); 67d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 68d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands/** Returns the description of a target. See llvm::Target::getDescription */ 69d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sandsconst char *LLVMGetTargetDescription(LLVMTargetRef T); 70d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 71d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands/** Returns if the target has a JIT */ 72d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan SandsLLVMBool LLVMTargetHasJIT(LLVMTargetRef T); 73d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 74d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands/** Returns if the target has a TargetMachine associated */ 75d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan SandsLLVMBool LLVMTargetHasTargetMachine(LLVMTargetRef T); 76d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 77d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands/** Returns if the target as an ASM backend (required for emitting output) */ 78d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan SandsLLVMBool LLVMTargetHasAsmBackend(LLVMTargetRef T); 79d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 80d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands/*===-- Target Machine ----------------------------------------------------===*/ 81d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands/** Creates a new llvm::TargetMachine. See llvm::Target::createTargetMachine */ 82d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan SandsLLVMTargetMachineRef LLVMCreateTargetMachine(LLVMTargetRef T, char *Triple, 83d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands char *CPU, char *Features, LLVMCodeGenOptLevel Level, LLVMRelocMode Reloc, 84d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMCodeModel CodeModel); 85d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 86d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands/** Dispose the LLVMTargetMachineRef instance generated by 87d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMCreateTargetMachine. */ 88d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sandsvoid LLVMDisposeTargetMachine(LLVMTargetMachineRef T); 89d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 90d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands/** Returns the Target used in a TargetMachine */ 91d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan SandsLLVMTargetRef LLVMGetTargetMachineTarget(LLVMTargetMachineRef T); 92d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 93d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands/** Returns the triple used creating this target machine. See 94d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands llvm::TargetMachine::getTriple. The result needs to be disposed with 95d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMDisposeMessage. */ 96d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sandschar *LLVMGetTargetMachineTriple(LLVMTargetMachineRef T); 97d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 98d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands/** Returns the cpu used creating this target machine. See 99d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands llvm::TargetMachine::getCPU. The result needs to be disposed with 100d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMDisposeMessage. */ 101d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sandschar *LLVMGetTargetMachineCPU(LLVMTargetMachineRef T); 102d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 103d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands/** Returns the feature string used creating this target machine. See 104d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands llvm::TargetMachine::getFeatureString. The result needs to be disposed with 105d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands LLVMDisposeMessage. */ 106d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sandschar *LLVMGetTargetMachineFeatureString(LLVMTargetMachineRef T); 107d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 1083574eca1b02600bac4e625297f4ecf745f4c4f32Micah Villmow/** Returns the llvm::DataLayout used for this llvm:TargetMachine. */ 109d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan SandsLLVMTargetDataRef LLVMGetTargetMachineData(LLVMTargetMachineRef T); 110d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 111d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands/** Emits an asm or object file for the given module to the filename. This 112d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands wraps several c++ only classes (among them a file stream). Returns any 113d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands error in ErrorMessage. Use LLVMDisposeMessage to dispose the message. */ 114d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan SandsLLVMBool LLVMTargetMachineEmitToFile(LLVMTargetMachineRef T, LLVMModuleRef M, 115d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands char *Filename, LLVMCodeGenFileType codegen, char **ErrorMessage); 116d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 117d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 118d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 119d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 120d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands#ifdef __cplusplus 121d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands} 122d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 123d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sandsnamespace llvm { 124d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands class TargetMachine; 125d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands class Target; 126d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 127d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands inline TargetMachine *unwrap(LLVMTargetMachineRef P) { 128d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands return reinterpret_cast<TargetMachine*>(P); 129d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands } 130d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands inline Target *unwrap(LLVMTargetRef P) { 131d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands return reinterpret_cast<Target*>(P); 132d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands } 133d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands inline LLVMTargetMachineRef wrap(const TargetMachine *P) { 134d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands return reinterpret_cast<LLVMTargetMachineRef>( 135d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands const_cast<TargetMachine*>(P)); 136d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands } 137d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands inline LLVMTargetRef wrap(const Target * P) { 138d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands return reinterpret_cast<LLVMTargetRef>(const_cast<Target*>(P)); 139d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands } 140d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands} 1419313da5a90838c7242101dae250e86dcfc708e6aEvan Cheng#endif 142d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands 143d6b7b8f49b0554b82165ecef07de7e9c0c5eeb42Duncan Sands#endif 144