• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 //===-lto.cpp - LLVM Link Time Optimizer ----------------------------------===//
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 file implements the Link Time Optimization library. This library is
11 // intended to be used by linker to optimize code at link time.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #include "llvm-c/lto.h"
16 #include "llvm-c/Core.h"
17 
18 #include "LTOModule.h"
19 #include "LTOCodeGenerator.h"
20 
21 
22 // Holds most recent error string.
23 // *** Not thread safe ***
24 static std::string sLastErrorString;
25 
26 /// lto_get_version - Returns a printable string.
lto_get_version()27 extern const char* lto_get_version() {
28   return LTOCodeGenerator::getVersionString();
29 }
30 
31 /// lto_get_error_message - Returns the last error string or NULL if last
32 /// operation was successful.
lto_get_error_message()33 const char* lto_get_error_message() {
34   return sLastErrorString.c_str();
35 }
36 
37 /// lto_module_is_object_file - Validates if a file is a loadable object file.
lto_module_is_object_file(const char * path)38 bool lto_module_is_object_file(const char* path) {
39   return LTOModule::isBitcodeFile(path);
40 }
41 
42 /// lto_module_is_object_file_for_target - Validates if a file is a loadable
43 /// object file compilable for requested target.
lto_module_is_object_file_for_target(const char * path,const char * target_triplet_prefix)44 bool lto_module_is_object_file_for_target(const char* path,
45                                           const char* target_triplet_prefix) {
46   return LTOModule::isBitcodeFileForTarget(path, target_triplet_prefix);
47 }
48 
49 /// lto_module_is_object_file_in_memory - Validates if a buffer is a loadable
50 /// object file.
lto_module_is_object_file_in_memory(const void * mem,size_t length)51 bool lto_module_is_object_file_in_memory(const void* mem, size_t length) {
52   return LTOModule::isBitcodeFile(mem, length);
53 }
54 
55 /// lto_module_is_object_file_in_memory_for_target - Validates if a buffer is a
56 /// loadable object file compilable for the target.
57 bool
lto_module_is_object_file_in_memory_for_target(const void * mem,size_t length,const char * target_triplet_prefix)58 lto_module_is_object_file_in_memory_for_target(const void* mem,
59                                             size_t length,
60                                             const char* target_triplet_prefix) {
61   return LTOModule::isBitcodeFileForTarget(mem, length, target_triplet_prefix);
62 }
63 
64 /// lto_module_create - Loads an object file from disk. Returns NULL on error
65 /// (check lto_get_error_message() for details).
lto_module_create(const char * path)66 lto_module_t lto_module_create(const char* path) {
67   return LTOModule::makeLTOModule(path, sLastErrorString);
68 }
69 
70 /// lto_module_create_from_fd - Loads an object file from disk. Returns NULL on
71 /// error (check lto_get_error_message() for details).
lto_module_create_from_fd(int fd,const char * path,size_t size)72 lto_module_t lto_module_create_from_fd(int fd, const char *path, size_t size) {
73   return LTOModule::makeLTOModule(fd, path, size, sLastErrorString);
74 }
75 
76 /// lto_module_create_from_fd_at_offset - Loads an object file from disk.
77 /// Returns NULL on error (check lto_get_error_message() for details).
lto_module_create_from_fd_at_offset(int fd,const char * path,size_t file_size,size_t map_size,off_t offset)78 lto_module_t lto_module_create_from_fd_at_offset(int fd, const char *path,
79                                                  size_t file_size,
80                                                  size_t map_size,
81                                                  off_t offset) {
82   return LTOModule::makeLTOModule(fd, path, file_size, map_size,
83                                   offset, sLastErrorString);
84 }
85 
86 /// lto_module_create_from_memory - Loads an object file from memory. Returns
87 /// NULL on error (check lto_get_error_message() for details).
lto_module_create_from_memory(const void * mem,size_t length)88 lto_module_t lto_module_create_from_memory(const void* mem, size_t length) {
89   return LTOModule::makeLTOModule(mem, length, sLastErrorString);
90 }
91 
92 /// lto_module_dispose - Frees all memory for a module. Upon return the
93 /// lto_module_t is no longer valid.
lto_module_dispose(lto_module_t mod)94 void lto_module_dispose(lto_module_t mod) {
95   delete mod;
96 }
97 
98 /// lto_module_get_target_triple - Returns triplet string which the object
99 /// module was compiled under.
lto_module_get_target_triple(lto_module_t mod)100 const char* lto_module_get_target_triple(lto_module_t mod) {
101   return mod->getTargetTriple();
102 }
103 
104 /// lto_module_set_target_triple - Sets triple string with which the object will
105 /// be codegened.
lto_module_set_target_triple(lto_module_t mod,const char * triple)106 void lto_module_set_target_triple(lto_module_t mod, const char *triple) {
107   return mod->setTargetTriple(triple);
108 }
109 
110 /// lto_module_get_num_symbols - Returns the number of symbols in the object
111 /// module.
lto_module_get_num_symbols(lto_module_t mod)112 unsigned int lto_module_get_num_symbols(lto_module_t mod) {
113   return mod->getSymbolCount();
114 }
115 
116 /// lto_module_get_symbol_name - Returns the name of the ith symbol in the
117 /// object module.
lto_module_get_symbol_name(lto_module_t mod,unsigned int index)118 const char* lto_module_get_symbol_name(lto_module_t mod, unsigned int index) {
119   return mod->getSymbolName(index);
120 }
121 
122 /// lto_module_get_symbol_attribute - Returns the attributes of the ith symbol
123 /// in the object module.
lto_module_get_symbol_attribute(lto_module_t mod,unsigned int index)124 lto_symbol_attributes lto_module_get_symbol_attribute(lto_module_t mod,
125                                                       unsigned int index) {
126   return mod->getSymbolAttributes(index);
127 }
128 
129 /// lto_codegen_create - Instantiates a code generator. Returns NULL if there
130 /// is an error.
lto_codegen_create(void)131 lto_code_gen_t lto_codegen_create(void) {
132   return new LTOCodeGenerator();
133 }
134 
135 /// lto_codegen_dispose - Frees all memory for a code generator. Upon return the
136 /// lto_code_gen_t is no longer valid.
lto_codegen_dispose(lto_code_gen_t cg)137 void lto_codegen_dispose(lto_code_gen_t cg) {
138   delete cg;
139 }
140 
141 /// lto_codegen_add_module - Add an object module to the set of modules for
142 /// which code will be generated. Returns true on error (check
143 /// lto_get_error_message() for details).
lto_codegen_add_module(lto_code_gen_t cg,lto_module_t mod)144 bool lto_codegen_add_module(lto_code_gen_t cg, lto_module_t mod) {
145   return cg->addModule(mod, sLastErrorString);
146 }
147 
148 /// lto_codegen_set_debug_model - Sets what if any format of debug info should
149 /// be generated. Returns true on error (check lto_get_error_message() for
150 /// details).
lto_codegen_set_debug_model(lto_code_gen_t cg,lto_debug_model debug)151 bool lto_codegen_set_debug_model(lto_code_gen_t cg, lto_debug_model debug) {
152   return cg->setDebugInfo(debug, sLastErrorString);
153 }
154 
155 /// lto_codegen_set_pic_model - Sets what code model to generated. Returns true
156 /// on error (check lto_get_error_message() for details).
lto_codegen_set_pic_model(lto_code_gen_t cg,lto_codegen_model model)157 bool lto_codegen_set_pic_model(lto_code_gen_t cg, lto_codegen_model model) {
158   return cg->setCodePICModel(model, sLastErrorString);
159 }
160 
161 /// lto_codegen_set_cpu - Sets the cpu to generate code for.
lto_codegen_set_cpu(lto_code_gen_t cg,const char * cpu)162 void lto_codegen_set_cpu(lto_code_gen_t cg, const char *cpu) {
163   return cg->setCpu(cpu);
164 }
165 
166 /// lto_codegen_set_assembler_path - Sets the path to the assembler tool.
lto_codegen_set_assembler_path(lto_code_gen_t cg,const char * path)167 void lto_codegen_set_assembler_path(lto_code_gen_t cg, const char *path) {
168   // In here only for backwards compatibility. We use MC now.
169 }
170 
171 /// lto_codegen_set_assembler_args - Sets extra arguments that libLTO should
172 /// pass to the assembler.
lto_codegen_set_assembler_args(lto_code_gen_t cg,const char ** args,int nargs)173 void lto_codegen_set_assembler_args(lto_code_gen_t cg, const char **args,
174                                     int nargs) {
175   // In here only for backwards compatibility. We use MC now.
176 }
177 
178 /// lto_codegen_add_must_preserve_symbol - Adds to a list of all global symbols
179 /// that must exist in the final generated code. If a function is not listed
180 /// there, it might be inlined into every usage and optimized away.
lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg,const char * symbol)181 void lto_codegen_add_must_preserve_symbol(lto_code_gen_t cg,
182                                           const char *symbol) {
183   cg->addMustPreserveSymbol(symbol);
184 }
185 
186 /// lto_codegen_write_merged_modules - Writes a new file at the specified path
187 /// that contains the merged contents of all modules added so far. Returns true
188 /// on error (check lto_get_error_message() for details).
lto_codegen_write_merged_modules(lto_code_gen_t cg,const char * path)189 bool lto_codegen_write_merged_modules(lto_code_gen_t cg, const char *path) {
190   return cg->writeMergedModules(path, sLastErrorString);
191 }
192 
193 /// lto_codegen_compile - Generates code for all added modules into one native
194 /// object file. On success returns a pointer to a generated mach-o/ELF buffer
195 /// and length set to the buffer size. The buffer is owned by the lto_code_gen_t
196 /// object and will be freed when lto_codegen_dispose() is called, or
197 /// lto_codegen_compile() is called again. On failure, returns NULL (check
198 /// lto_get_error_message() for details).
lto_codegen_compile(lto_code_gen_t cg,size_t * length)199 const void *lto_codegen_compile(lto_code_gen_t cg, size_t *length) {
200   return cg->compile(length, sLastErrorString);
201 }
202 
203 /// lto_codegen_compile_to_file - Generates code for all added modules into one
204 /// native object file. The name of the file is written to name. Returns true on
205 /// error.
lto_codegen_compile_to_file(lto_code_gen_t cg,const char ** name)206 bool lto_codegen_compile_to_file(lto_code_gen_t cg, const char **name) {
207   return cg->compile_to_file(name, sLastErrorString);
208 }
209 
210 /// lto_codegen_debug_options - Used to pass extra options to the code
211 /// generator.
lto_codegen_debug_options(lto_code_gen_t cg,const char * opt)212 void lto_codegen_debug_options(lto_code_gen_t cg, const char *opt) {
213   cg->setCodeGenDebugOptions(opt);
214 }
215