1 //===-lto.cpp - LLVM Link Time Optimizer ----------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the Link Time Optimization library. This library is
11 // intended to be used by linker to optimize code at link time.
13 //===----------------------------------------------------------------------===//
15 #include "llvm-c/lto.h"
16 #include "LTOCodeGenerator.h"
17 #include "LTOModule.h"
18 #include "llvm-c/Core.h"
21 // Holds most recent error string.
22 // *** Not thread safe ***
23 static std::string sLastErrorString;
25 /// lto_get_version - Returns a printable string.
26 extern const char* lto_get_version() {
27 return LTOCodeGenerator::getVersionString();
30 /// lto_get_error_message - Returns the last error string or NULL if last
31 /// operation was successful.
32 const char* lto_get_error_message() {
33 return sLastErrorString.c_str();
36 /// lto_module_is_object_file - Validates if a file is a loadable object file.
37 bool lto_module_is_object_file(const char* path) {
38 return LTOModule::isBitcodeFile(path);
41 /// lto_module_is_object_file_for_target - Validates if a file is a loadable
42 /// object file compilable for requested target.
43 bool lto_module_is_object_file_for_target(const char* path,
44 const char* target_triplet_prefix) {
45 return LTOModule::isBitcodeFileForTarget(path, target_triplet_prefix);
48 /// lto_module_is_object_file_in_memory - Validates if a buffer is a loadable
50 bool lto_module_is_object_file_in_memory(const void* mem, size_t length) {
51 return LTOModule::isBitcodeFile(mem, length);
54 /// lto_module_is_object_file_in_memory_for_target - Validates if a buffer is a
55 /// loadable object file compilable for the target.
57 lto_module_is_object_file_in_memory_for_target(const void* mem,
59 const char* target_triplet_prefix) {
60 return LTOModule::isBitcodeFileForTarget(mem, length, target_triplet_prefix);
63 /// lto_module_create - Loads an object file from disk. Returns NULL on error
64 /// (check lto_get_error_message() for details).
65 lto_module_t lto_module_create(const char* path) {
66 return LTOModule::makeLTOModule(path, sLastErrorString);
69 /// lto_module_create_from_fd - Loads an object file from disk. Returns NULL on
70 /// error (check lto_get_error_message() for details).
71 lto_module_t lto_module_create_from_fd(int fd, const char *path, size_t size) {
72 return LTOModule::makeLTOModule(fd, path, size, sLastErrorString);
75 /// lto_module_create_from_fd_at_offset - Loads an object file from disk.
76 /// Returns NULL on error (check lto_get_error_message() for details).
77 lto_module_t lto_module_create_from_fd_at_offset(int fd, const char *path,
81 return LTOModule::makeLTOModule(fd, path, map_size, offset, sLastErrorString);
84 /// lto_module_create_from_memory - Loads an object file from memory. Returns
85 /// NULL on error (check lto_get_error_message() for details).
86 lto_module_t lto_module_create_from_memory(const void* mem, size_t length) {
87 return LTOModule::makeLTOModule(mem, length, sLastErrorString);
90 /// lto_module_dispose - Frees all memory for a module. Upon return the
91 /// lto_module_t is no longer valid.
92 void lto_module_dispose(lto_module_t mod) {
96 /// lto_module_get_target_triple - Returns triplet string which the object
97 /// module was compiled under.
98 const char* lto_module_get_target_triple(lto_module_t mod) {
99 return mod->getTargetTriple();
102 /// lto_module_set_target_triple - Sets triple string with which the object will
104 void lto_module_set_target_triple(lto_module_t mod, const char *triple) {
105 return mod->setTargetTriple(triple);
108 /// lto_module_get_num_symbols - Returns the number of symbols in the object
110 unsigned int lto_module_get_num_symbols(lto_module_t mod) {
111 return mod->getSymbolCount();
114 /// lto_module_get_symbol_name - Returns the name of the ith symbol in the
116 const char* lto_module_get_symbol_name(lto_module_t mod, unsigned int index) {
117 return mod->getSymbolName(index);
120 /// lto_module_get_symbol_attribute - Returns the attributes of the ith symbol
121 /// in the object module.
122 lto_symbol_attributes lto_module_get_symbol_attribute(lto_module_t mod,
123 unsigned int index) {
124 return mod->getSymbolAttributes(index);
127 /// lto_codegen_create - Instantiates a code generator. Returns NULL if there
129 lto_code_gen_t lto_codegen_create(void) {
130 return new LTOCodeGenerator();
133 /// lto_codegen_dispose - Frees all memory for a code generator. Upon return the
134 /// lto_code_gen_t is no longer valid.
135 void lto_codegen_dispose(lto_code_gen_t cg) {
139 /// lto_codegen_add_module - Add an object module to the set of modules for
140 /// which code will be generated. Returns true on error (check
141 /// lto_get_error_message() for details).
142 bool lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod) {
143 return cg->addModule(mod, sLastErrorString);
146 /// lto_codegen_set_debug_model - Sets what if any format of debug info should
147 /// be generated. Returns true on error (check lto_get_error_message() for
149 bool lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model debug) {
150 return cg->setDebugInfo(debug, sLastErrorString);
153 /// lto_codegen_set_pic_model - Sets what code model to generated. Returns true
154 /// on error (check lto_get_error_message() for details).
155 bool lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model model) {
156 return cg->setCodePICModel(model, sLastErrorString);
159 /// lto_codegen_set_cpu - Sets the cpu to generate code for.
160 void lto_codegen_set_cpu(lto_code_gen_t cg, const char *cpu) {
161 return cg->setCpu(cpu);
164 /// lto_codegen_set_assembler_path - Sets the path to the assembler tool.
165 void lto_codegen_set_assembler_path(lto_code_gen_t cg, const char *path) {
166 // In here only for backwards compatibility. We use MC now.
169 /// lto_codegen_set_assembler_args - Sets extra arguments that libLTO should
170 /// pass to the assembler.
171 void lto_codegen_set_assembler_args(lto_code_gen_t cg, const char **args,
173 // In here only for backwards compatibility. We use MC now.
176 /// lto_codegen_add_must_preserve_symbol - Adds to a list of all global symbols
177 /// that must exist in the final generated code. If a function is not listed
178 /// there, it might be inlined into every usage and optimized away.
179 void lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg,
180 const char *symbol) {
181 cg->addMustPreserveSymbol(symbol);
184 /// lto_codegen_write_merged_modules - Writes a new file at the specified path
185 /// that contains the merged contents of all modules added so far. Returns true
186 /// on error (check lto_get_error_message() for details).
187 bool lto_codegen_write_merged_modules(lto_code_gen_t cg, const char *path) {
188 return cg->writeMergedModules(path, sLastErrorString);
191 /// lto_codegen_compile - Generates code for all added modules into one native
192 /// object file. On success returns a pointer to a generated mach-o/ELF buffer
193 /// and length set to the buffer size. The buffer is owned by the lto_code_gen_t
194 /// object and will be freed when lto_codegen_dispose() is called, or
195 /// lto_codegen_compile() is called again. On failure, returns NULL (check
196 /// lto_get_error_message() for details).
197 const void *lto_codegen_compile(lto_code_gen_t cg, size_t *length) {
198 return cg->compile(length, sLastErrorString);
201 /// lto_codegen_compile_to_file - Generates code for all added modules into one
202 /// native object file. The name of the file is written to name. Returns true on
204 bool lto_codegen_compile_to_file(lto_code_gen_t cg, const char **name) {
205 return cg->compile_to_file(name, sLastErrorString);
208 /// lto_codegen_debug_options - Used to pass extra options to the code
210 void lto_codegen_debug_options(lto_code_gen_t cg, const char *opt) {
211 cg->setCodeGenDebugOptions(opt);