LLVM  9.0.0svn
TargetMachine.h
Go to the documentation of this file.
1 /*===-- llvm-c/TargetMachine.h - Target Machine Library C Interface - C++ -*-=*\
2 |* *|
3 |* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
4 |* Exceptions. *|
5 |* See https://llvm.org/LICENSE.txt for license information. *|
6 |* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
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 {
47 
48 typedef enum {
57 
58 typedef enum {
62 
63 /** Returns the first llvm::Target in the registered targets list. */
64 LLVMTargetRef LLVMGetFirstTarget(void);
65 /** Returns the next llvm::Target given a previous one (or null if there's none) */
66 LLVMTargetRef LLVMGetNextTarget(LLVMTargetRef T);
67 
68 /*===-- Target ------------------------------------------------------------===*/
69 /** Finds the target corresponding to the given name and stores it in \p T.
70  Returns 0 on success. */
71 LLVMTargetRef LLVMGetTargetFromName(const char *Name);
72 
73 /** Finds the target corresponding to the given triple and stores it in \p T.
74  Returns 0 on success. Optionally returns any error in ErrorMessage.
75  Use LLVMDisposeMessage to dispose the message. */
76 LLVMBool LLVMGetTargetFromTriple(const char* Triple, LLVMTargetRef *T,
77  char **ErrorMessage);
78 
79 /** Returns the name of a target. See llvm::Target::getName */
80 const char *LLVMGetTargetName(LLVMTargetRef T);
81 
82 /** Returns the description of a target. See llvm::Target::getDescription */
83 const char *LLVMGetTargetDescription(LLVMTargetRef T);
84 
85 /** Returns if the target has a JIT */
86 LLVMBool LLVMTargetHasJIT(LLVMTargetRef T);
87 
88 /** Returns if the target has a TargetMachine associated */
90 
91 /** Returns if the target as an ASM backend (required for emitting output) */
92 LLVMBool LLVMTargetHasAsmBackend(LLVMTargetRef T);
93 
94 /*===-- Target Machine ----------------------------------------------------===*/
95 /** Creates a new llvm::TargetMachine. See llvm::Target::createTargetMachine */
96 LLVMTargetMachineRef LLVMCreateTargetMachine(LLVMTargetRef T,
97  const char *Triple, const char *CPU, const char *Features,
98  LLVMCodeGenOptLevel Level, LLVMRelocMode Reloc, LLVMCodeModel CodeModel);
99 
100 /** Dispose the LLVMTargetMachineRef instance generated by
101  LLVMCreateTargetMachine. */
102 void LLVMDisposeTargetMachine(LLVMTargetMachineRef T);
103 
104 /** Returns the Target used in a TargetMachine */
105 LLVMTargetRef LLVMGetTargetMachineTarget(LLVMTargetMachineRef T);
106 
107 /** Returns the triple used creating this target machine. See
108  llvm::TargetMachine::getTriple. The result needs to be disposed with
109  LLVMDisposeMessage. */
110 char *LLVMGetTargetMachineTriple(LLVMTargetMachineRef T);
111 
112 /** Returns the cpu used creating this target machine. See
113  llvm::TargetMachine::getCPU. The result needs to be disposed with
114  LLVMDisposeMessage. */
115 char *LLVMGetTargetMachineCPU(LLVMTargetMachineRef T);
116 
117 /** Returns the feature string used creating this target machine. See
118  llvm::TargetMachine::getFeatureString. The result needs to be disposed with
119  LLVMDisposeMessage. */
120 char *LLVMGetTargetMachineFeatureString(LLVMTargetMachineRef T);
121 
122 /** Create a DataLayout based on the targetMachine. */
123 LLVMTargetDataRef LLVMCreateTargetDataLayout(LLVMTargetMachineRef T);
124 
125 /** Set the target machine's ASM verbosity. */
126 void LLVMSetTargetMachineAsmVerbosity(LLVMTargetMachineRef T,
127  LLVMBool VerboseAsm);
128 
129 /** Emits an asm or object file for the given module to the filename. This
130  wraps several c++ only classes (among them a file stream). Returns any
131  error in ErrorMessage. Use LLVMDisposeMessage to dispose the message. */
132 LLVMBool LLVMTargetMachineEmitToFile(LLVMTargetMachineRef T, LLVMModuleRef M,
133  char *Filename, LLVMCodeGenFileType codegen, char **ErrorMessage);
134 
135 /** Compile the LLVM IR stored in \p M and store the result in \p OutMemBuf. */
137  LLVMCodeGenFileType codegen, char** ErrorMessage, LLVMMemoryBufferRef *OutMemBuf);
138 
139 /*===-- Triple ------------------------------------------------------------===*/
140 /** Get a triple for the host machine as a string. The result needs to be
141  disposed with LLVMDisposeMessage. */
142 char* LLVMGetDefaultTargetTriple(void);
143 
144 /** Normalize a target triple. The result needs to be disposed with
145  LLVMDisposeMessage. */
146 char* LLVMNormalizeTargetTriple(const char* triple);
147 
148 /** Get the host CPU as a string. The result needs to be disposed with
149  LLVMDisposeMessage. */
150 char* LLVMGetHostCPUName(void);
151 
152 /** Get the host CPU's features as a string. The result needs to be disposed
153  with LLVMDisposeMessage. */
154 char* LLVMGetHostCPUFeatures(void);
155 
156 /** Adds the target-specific analysis passes to the pass manager. */
157 void LLVMAddAnalysisPasses(LLVMTargetMachineRef T, LLVMPassManagerRef PM);
158 
159 #ifdef __cplusplus
160 }
161 #endif
162 
163 #endif
static void codegen(Module *M, llvm::raw_pwrite_stream &OS, function_ref< std::unique_ptr< TargetMachine >()> TMFactory, TargetMachine::CodeGenFileType FileType)
Definition: ParallelCG.cpp:27
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.
amdgpu Simplify well known AMD library false FunctionCallee Value const Twine & Name
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:58
struct LLVMOpaqueTargetData * LLVMTargetDataRef
Definition: DataLayout.h:38
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.
char * LLVMGetHostCPUName(void)
Get the host CPU as a string.
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:48
const char * LLVMGetTargetName(LLVMTargetRef T)
Returns the name of a target.
char * LLVMNormalizeTargetTriple(const char *triple)
Normalize a target triple.
char * LLVMGetHostCPUFeatures(void)
Get the host CPU&#39;s features as a string.
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:128
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)