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 "llvm-c/Core.h"
18 #include "LTOModule.h"
19 #include "LTOCodeGenerator.h"
22 // holds most recent error string
23 // *** not thread safe ***
24 static std::string sLastErrorString;
29 // returns a printable string
31 extern const char* lto_get_version()
33 return LTOCodeGenerator::getVersionString();
37 // returns the last error string or NULL if last operation was successful
39 const char* lto_get_error_message()
41 return sLastErrorString.c_str();
47 // validates if a file is a loadable object file
49 bool lto_module_is_object_file(const char* path)
51 return LTOModule::isBitcodeFile(path);
56 // validates if a file is a loadable object file compilable for requested target
58 bool lto_module_is_object_file_for_target(const char* path,
59 const char* target_triplet_prefix)
61 return LTOModule::isBitcodeFileForTarget(path, target_triplet_prefix);
66 // validates if a buffer is a loadable object file
68 bool lto_module_is_object_file_in_memory(const void* mem, size_t length)
70 return LTOModule::isBitcodeFile(mem, length);
75 // validates if a buffer is a loadable object file compilable for the target
77 bool lto_module_is_object_file_in_memory_for_target(const void* mem,
78 size_t length, const char* target_triplet_prefix)
80 return LTOModule::isBitcodeFileForTarget(mem, length, target_triplet_prefix);
86 // loads an object file from disk
87 // returns NULL on error (check lto_get_error_message() for details)
89 lto_module_t lto_module_create(const char* path)
91 return LTOModule::makeLTOModule(path, sLastErrorString);
95 // loads an object file from disk
96 // returns NULL on error (check lto_get_error_message() for details)
98 lto_module_t lto_module_create_from_fd(int fd, const char *path, off_t size)
100 return LTOModule::makeLTOModule(fd, path, size, sLastErrorString);
104 // loads an object file from memory
105 // returns NULL on error (check lto_get_error_message() for details)
107 lto_module_t lto_module_create_from_memory(const void* mem, size_t length)
109 return LTOModule::makeLTOModule(mem, length, sLastErrorString);
114 // frees all memory for a module
115 // upon return the lto_module_t is no longer valid
117 void lto_module_dispose(lto_module_t mod)
124 // returns triplet string which the object module was compiled under
126 const char* lto_module_get_target_triple(lto_module_t mod)
128 return mod->getTargetTriple();
132 // sets triple string with which the object will be codegened.
134 void lto_module_set_target_triple(lto_module_t mod, const char *triple)
136 return mod->setTargetTriple(triple);
141 // returns the number of symbols in the object module
143 unsigned int lto_module_get_num_symbols(lto_module_t mod)
145 return mod->getSymbolCount();
149 // returns the name of the ith symbol in the object module
151 const char* lto_module_get_symbol_name(lto_module_t mod, unsigned int index)
153 return mod->getSymbolName(index);
158 // returns the attributes of the ith symbol in the object module
160 lto_symbol_attributes lto_module_get_symbol_attribute(lto_module_t mod,
163 return mod->getSymbolAttributes(index);
171 // instantiates a code generator
172 // returns NULL if there is an error
174 lto_code_gen_t lto_codegen_create(void)
176 return new LTOCodeGenerator();
182 // frees all memory for a code generator
183 // upon return the lto_code_gen_t is no longer valid
185 void lto_codegen_dispose(lto_code_gen_t cg)
193 // add an object module to the set of modules for which code will be generated
194 // returns true on error (check lto_get_error_message() for details)
196 bool lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod)
198 return cg->addModule(mod, sLastErrorString);
203 // sets what if any format of debug info should be generated
204 // returns true on error (check lto_get_error_message() for details)
206 bool lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model debug)
208 return cg->setDebugInfo(debug, sLastErrorString);
213 // sets what code model to generated
214 // returns true on error (check lto_get_error_message() for details)
216 bool lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model model)
218 return cg->setCodePICModel(model, sLastErrorString);
222 // sets the cpu to generate code for
224 void lto_codegen_set_cpu(lto_code_gen_t cg, const char* cpu)
226 return cg->setCpu(cpu);
230 // sets the path to the assembler tool
232 void lto_codegen_set_assembler_path(lto_code_gen_t cg, const char* path)
234 // In here only for backwards compatibility. We use MC now.
239 // sets extra arguments that libLTO should pass to the assembler
241 void lto_codegen_set_assembler_args(lto_code_gen_t cg, const char** args,
244 // In here only for backwards compatibility. We use MC now.
248 // adds to a list of all global symbols that must exist in the final
249 // generated code. If a function is not listed there, it might be
250 // inlined into every usage and optimized away.
252 void lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg, const char* symbol)
254 cg->addMustPreserveSymbol(symbol);
259 // writes a new file at the specified path that contains the
260 // merged contents of all modules added so far.
261 // returns true on error (check lto_get_error_message() for details)
263 bool lto_codegen_write_merged_modules(lto_code_gen_t cg, const char* path)
265 return cg->writeMergedModules(path, sLastErrorString);
270 // Generates code for all added modules into one native object file.
271 // On sucess returns a pointer to a generated mach-o/ELF buffer and
272 // length set to the buffer size. The buffer is owned by the
273 // lto_code_gen_t and will be freed when lto_codegen_dispose()
274 // is called, or lto_codegen_compile() is called again.
275 // On failure, returns NULL (check lto_get_error_message() for details).
278 lto_codegen_compile(lto_code_gen_t cg, size_t* length)
280 return cg->compile(length, sLastErrorString);
285 // Used to pass extra options to the code generator
288 lto_codegen_debug_options(lto_code_gen_t cg, const char * opt)
290 cg->setCodeGenDebugOptions(opt);