LLVM  6.0.0svn
TargetMachine.h
Go to the documentation of this file.
1 /*===-- llvm-c/TargetMachine.h - Target Machine Library C Interface - C++ -*-=*\
2 |* *|
3 |* The LLVM Compiler Infrastructure *|
4 |* *|
5 |* This file is distributed under the University of Illinois Open Source *|
6 |* License. See LICENSE.TXT for details. *|
7 |* *|
8 |*===----------------------------------------------------------------------===*|
9 |* *|
10 |* This header declares the C interface to the Target and TargetMachine *|
11 |* classes, which can be used to generate assembly or object files. *|
12 |* *|
13 |* Many exotic languages can interoperate with C code but have a harder time *|
14 |* with C++ due to name mangling. So in addition to C, this interface enables *|
15 |* tools written in such languages. *|
16 |* *|
17 \*===----------------------------------------------------------------------===*/
18 
19 #ifndef LLVM_C_TARGETMACHINE_H
20 #define LLVM_C_TARGETMACHINE_H
21 
22 #include "llvm-c/Target.h"
23 #include "llvm-c/Types.h"
24 
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28 typedef struct LLVMOpaqueTargetMachine *LLVMTargetMachineRef;
29 typedef struct LLVMTarget *LLVMTargetRef;
30 
31 typedef enum {
37 
38 typedef enum {
44 
45 typedef enum {
53 
54 typedef enum {
58 
59 /** Returns the first llvm::Target in the registered targets list. */
60 LLVMTargetRef LLVMGetFirstTarget(void);
61 /** Returns the next llvm::Target given a previous one (or null if there's none) */
62 LLVMTargetRef LLVMGetNextTarget(LLVMTargetRef T);
63 
64 /*===-- Target ------------------------------------------------------------===*/
65 /** Finds the target corresponding to the given name and stores it in \p T.
66  Returns 0 on success. */
67 LLVMTargetRef LLVMGetTargetFromName(const char *Name);
68 
69 /** Finds the target corresponding to the given triple and stores it in \p T.
70  Returns 0 on success. Optionally returns any error in ErrorMessage.
71  Use LLVMDisposeMessage to dispose the message. */
72 LLVMBool LLVMGetTargetFromTriple(const char* Triple, LLVMTargetRef *T,
73  char **ErrorMessage);
74 
75 /** Returns the name of a target. See llvm::Target::getName */
76 const char *LLVMGetTargetName(LLVMTargetRef T);
77 
78 /** Returns the description of a target. See llvm::Target::getDescription */
79 const char *LLVMGetTargetDescription(LLVMTargetRef T);
80 
81 /** Returns if the target has a JIT */
82 LLVMBool LLVMTargetHasJIT(LLVMTargetRef T);
83 
84 /** Returns if the target has a TargetMachine associated */
86 
87 /** Returns if the target as an ASM backend (required for emitting output) */
88 LLVMBool LLVMTargetHasAsmBackend(LLVMTargetRef T);
89 
90 /*===-- Target Machine ----------------------------------------------------===*/
91 /** Creates a new llvm::TargetMachine. See llvm::Target::createTargetMachine */
92 LLVMTargetMachineRef LLVMCreateTargetMachine(LLVMTargetRef T,
93  const char *Triple, const char *CPU, const char *Features,
94  LLVMCodeGenOptLevel Level, LLVMRelocMode Reloc, LLVMCodeModel CodeModel);
95 
96 /** Dispose the LLVMTargetMachineRef instance generated by
97  LLVMCreateTargetMachine. */
98 void LLVMDisposeTargetMachine(LLVMTargetMachineRef T);
99 
100 /** Returns the Target used in a TargetMachine */
101 LLVMTargetRef LLVMGetTargetMachineTarget(LLVMTargetMachineRef T);
102 
103 /** Returns the triple used creating this target machine. See
104  llvm::TargetMachine::getTriple. The result needs to be disposed with
105  LLVMDisposeMessage. */
106 char *LLVMGetTargetMachineTriple(LLVMTargetMachineRef T);
107 
108 /** Returns the cpu used creating this target machine. See
109  llvm::TargetMachine::getCPU. The result needs to be disposed with
110  LLVMDisposeMessage. */
111 char *LLVMGetTargetMachineCPU(LLVMTargetMachineRef T);
112 
113 /** Returns the feature string used creating this target machine. See
114  llvm::TargetMachine::getFeatureString. The result needs to be disposed with
115  LLVMDisposeMessage. */
116 char *LLVMGetTargetMachineFeatureString(LLVMTargetMachineRef T);
117 
118 /** Create a DataLayout based on the targetMachine. */
119 LLVMTargetDataRef LLVMCreateTargetDataLayout(LLVMTargetMachineRef T);
120 
121 /** Set the target machine's ASM verbosity. */
122 void LLVMSetTargetMachineAsmVerbosity(LLVMTargetMachineRef T,
123  LLVMBool VerboseAsm);
124 
125 /** Emits an asm or object file for the given module to the filename. This
126  wraps several c++ only classes (among them a file stream). Returns any
127  error in ErrorMessage. Use LLVMDisposeMessage to dispose the message. */
128 LLVMBool LLVMTargetMachineEmitToFile(LLVMTargetMachineRef T, LLVMModuleRef M,
129  char *Filename, LLVMCodeGenFileType codegen, char **ErrorMessage);
130 
131 /** Compile the LLVM IR stored in \p M and store the result in \p OutMemBuf. */
133  LLVMCodeGenFileType codegen, char** ErrorMessage, LLVMMemoryBufferRef *OutMemBuf);
134 
135 /*===-- Triple ------------------------------------------------------------===*/
136 /** Get a triple for the host machine as a string. The result needs to be
137  disposed with LLVMDisposeMessage. */
138 char* LLVMGetDefaultTargetTriple(void);
139 
140 /** Adds the target-specific analysis passes to the pass manager. */
141 void LLVMAddAnalysisPasses(LLVMTargetMachineRef T, LLVMPassManagerRef PM);
142 
143 #ifdef __cplusplus
144 }
145 #endif
146 
147 #endif
static void codegen(Module *M, llvm::raw_pwrite_stream &OS, function_ref< std::unique_ptr< TargetMachine >()> TMFactory, TargetMachine::CodeGenFileType FileType)
Definition: ParallelCG.cpp:29
char * LLVMGetTargetMachineFeatureString(LLVMTargetMachineRef T)
Returns the feature string used creating this target machine.
struct LLVMOpaqueModule * LLVMModuleRef
The top-level container for all other LLVM Intermediate Representation (IR) objects.
Definition: Types.h:62
struct LLVMOpaqueMemoryBuffer * LLVMMemoryBufferRef
LLVM uses a polymorphic type hierarchy which C cannot represent, therefore parameters must be passed ...
Definition: Types.h:49
LLVMBool LLVMTargetHasTargetMachine(LLVMTargetRef T)
Returns if the target has a TargetMachine associated.
LLVMTargetRef LLVMGetTargetMachineTarget(LLVMTargetMachineRef T)
Returns the Target used in a TargetMachine.
LLVMBool LLVMTargetMachineEmitToMemoryBuffer(LLVMTargetMachineRef T, LLVMModuleRef M, LLVMCodeGenFileType codegen, char **ErrorMessage, LLVMMemoryBufferRef *OutMemBuf)
Compile the LLVM IR stored in M and store the result in OutMemBuf.
LLVMCodeGenOptLevel
Definition: TargetMachine.h:31
const char * LLVMGetTargetDescription(LLVMTargetRef T)
Returns the description of a target.
LLVMCodeGenFileType
Definition: TargetMachine.h:54
struct LLVMOpaqueTargetData * LLVMTargetDataRef
Definition: DataLayout.h:39
struct LLVMOpaqueTargetMachine * LLVMTargetMachineRef
Definition: TargetMachine.h:28
char * LLVMGetTargetMachineTriple(LLVMTargetMachineRef T)
Returns the triple used creating this target machine.
LLVMTargetDataRef LLVMCreateTargetDataLayout(LLVMTargetMachineRef T)
Create a DataLayout based on the targetMachine.
LLVMTargetRef LLVMGetTargetFromName(const char *Name)
Finds the target corresponding to the given name and stores it in T.
char * LLVMGetTargetMachineCPU(LLVMTargetMachineRef T)
Returns the cpu used creating this target machine.
LLVMTargetRef LLVMGetFirstTarget(void)
Returns the first llvm::Target in the registered targets list.
LLVMTargetMachineRef LLVMCreateTargetMachine(LLVMTargetRef T, const char *Triple, const char *CPU, const char *Features, LLVMCodeGenOptLevel Level, LLVMRelocMode Reloc, LLVMCodeModel CodeModel)
Creates a new llvm::TargetMachine.
LLVMBool LLVMGetTargetFromTriple(const char *Triple, LLVMTargetRef *T, char **ErrorMessage)
Finds the target corresponding to the given triple and stores it in T.
char * LLVMGetDefaultTargetTriple(void)
Get a triple for the host machine as a string.
struct LLVMTarget * LLVMTargetRef
Definition: TargetMachine.h:29
LLVMCodeModel
Definition: TargetMachine.h:45
const char * LLVMGetTargetName(LLVMTargetRef T)
Returns the name of a target.
LLVMBool LLVMTargetMachineEmitToFile(LLVMTargetMachineRef T, LLVMModuleRef M, char *Filename, LLVMCodeGenFileType codegen, char **ErrorMessage)
Emits an asm or object file for the given module to the filename.
int LLVMBool
Definition: Types.h:29
LLVMBool LLVMTargetHasJIT(LLVMTargetRef T)
Returns if the target has a JIT.
void LLVMDisposeTargetMachine(LLVMTargetMachineRef T)
Dispose the LLVMTargetMachineRef instance generated by LLVMCreateTargetMachine.
void LLVMAddAnalysisPasses(LLVMTargetMachineRef T, LLVMPassManagerRef PM)
Adds the target-specific analysis passes to the pass manager.
struct LLVMOpaquePassManager * LLVMPassManagerRef
Definition: Types.h:114
LLVMRelocMode
Definition: TargetMachine.h:38
void LLVMSetTargetMachineAsmVerbosity(LLVMTargetMachineRef T, LLVMBool VerboseAsm)
Set the target machine&#39;s ASM verbosity.
LLVMTargetRef LLVMGetNextTarget(LLVMTargetRef T)
Returns the next llvm::Target given a previous one (or null if there&#39;s none)
LLVMBool LLVMTargetHasAsmBackend(LLVMTargetRef T)
Returns if the target as an ASM backend (required for emitting output)
const FeatureBitset Features