LLVM API Documentation

lto.h File Reference

#include <stdbool.h>
#include <stddef.h>

Include dependency graph for lto.h:

Go to the source code of this file.

Defines

#define LTO_H   1

Typedefs

typedef struct LTOModule * lto_module_t
typedef struct LTOCodeGenerator * lto_code_gen_t

Enumerations

enum  lto_symbol_attributes {
  LTO_SYMBOL_ALIGNMENT_MASK = 0x0000001F, LTO_SYMBOL_PERMISSIONS_MASK = 0x000000E0, LTO_SYMBOL_PERMISSIONS_CODE = 0x000000A0, LTO_SYMBOL_PERMISSIONS_DATA = 0x000000C0,
  LTO_SYMBOL_PERMISSIONS_RODATA = 0x00000080, LTO_SYMBOL_DEFINITION_MASK = 0x00000700, LTO_SYMBOL_DEFINITION_REGULAR = 0x00000100, LTO_SYMBOL_DEFINITION_TENTATIVE = 0x00000200,
  LTO_SYMBOL_DEFINITION_WEAK = 0x00000300, LTO_SYMBOL_DEFINITION_UNDEFINED = 0x00000400, LTO_SYMBOL_SCOPE_MASK = 0x00003800, LTO_SYMBOL_SCOPE_INTERNAL = 0x00000800,
  LTO_SYMBOL_SCOPE_HIDDEN = 0x00001000, LTO_SYMBOL_SCOPE_PROTECTED = 0x00002000, LTO_SYMBOL_SCOPE_DEFAULT = 0x00001800
}
enum  lto_debug_model { LTO_DEBUG_MODEL_NONE = 0, LTO_DEBUG_MODEL_DWARF = 1 }
enum  lto_codegen_model { LTO_CODEGEN_PIC_MODEL_STATIC = 0, LTO_CODEGEN_PIC_MODEL_DYNAMIC = 1, LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC = 2 }

Functions

const char * lto_get_version (void)
const char * lto_get_error_message (void)
bool lto_module_is_object_file (const char *path)
bool lto_module_is_object_file_for_target (const char *path, const char *target_triple_prefix)
bool lto_module_is_object_file_in_memory (const void *mem, size_t length)
bool lto_module_is_object_file_in_memory_for_target (const void *mem, size_t length, const char *target_triple_prefix)
lto_module_t lto_module_create (const char *path)
lto_module_t lto_module_create_from_memory (const void *mem, size_t length)
void lto_module_dispose (lto_module_t mod)
const char * lto_module_get_target_triple (lto_module_t mod)
unsigned int lto_module_get_num_symbols (lto_module_t mod)
const char * lto_module_get_symbol_name (lto_module_t mod, unsigned int index)
lto_symbol_attributes lto_module_get_symbol_attribute (lto_module_t mod, unsigned int index)
lto_code_gen_t lto_codegen_create (void)
void lto_codegen_dispose (lto_code_gen_t)
bool lto_codegen_add_module (lto_code_gen_t cg, lto_module_t mod)
bool lto_codegen_set_debug_model (lto_code_gen_t cg, lto_debug_model)
bool lto_codegen_set_pic_model (lto_code_gen_t cg, lto_codegen_model)
void lto_codegen_add_must_preserve_symbol (lto_code_gen_t cg, const char *symbol)
bool lto_codegen_write_merged_modules (lto_code_gen_t cg, const char *path)
const void * lto_codegen_compile (lto_code_gen_t cg, size_t *length)
void lto_codegen_debug_options (lto_code_gen_t cg, const char *)


Define Documentation

#define LTO_H   1

Definition at line 17 of file lto.h.


Typedef Documentation

typedef struct LTOCodeGenerator* lto_code_gen_t

opaque reference to a code generator

Definition at line 56 of file lto.h.

typedef struct LTOModule* lto_module_t

opaque reference to a loaded object module

Definition at line 53 of file lto.h.


Enumeration Type Documentation

Enumerator:
LTO_CODEGEN_PIC_MODEL_STATIC 
LTO_CODEGEN_PIC_MODEL_DYNAMIC 
LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC 

Definition at line 45 of file lto.h.

Enumerator:
LTO_DEBUG_MODEL_NONE 
LTO_DEBUG_MODEL_DWARF 

Definition at line 40 of file lto.h.

Enumerator:
LTO_SYMBOL_ALIGNMENT_MASK 
LTO_SYMBOL_PERMISSIONS_MASK 
LTO_SYMBOL_PERMISSIONS_CODE 
LTO_SYMBOL_PERMISSIONS_DATA 
LTO_SYMBOL_PERMISSIONS_RODATA 
LTO_SYMBOL_DEFINITION_MASK 
LTO_SYMBOL_DEFINITION_REGULAR 
LTO_SYMBOL_DEFINITION_TENTATIVE 
LTO_SYMBOL_DEFINITION_WEAK 
LTO_SYMBOL_DEFINITION_UNDEFINED 
LTO_SYMBOL_SCOPE_MASK 
LTO_SYMBOL_SCOPE_INTERNAL 
LTO_SYMBOL_SCOPE_HIDDEN 
LTO_SYMBOL_SCOPE_PROTECTED 
LTO_SYMBOL_SCOPE_DEFAULT 

Definition at line 22 of file lto.h.


Function Documentation

bool lto_codegen_add_module ( lto_code_gen_t  cg,
lto_module_t  mod 
)

Add an object module to the set of modules for which code will be generated. Returns true on error (check lto_get_error_message() for details).

void lto_codegen_add_must_preserve_symbol ( lto_code_gen_t  cg,
const char *  symbol 
)

Adds to a list of all global symbols that must exist in the final generated code. If a function is not listed, it might be inlined into every usage and optimized away.

const void* lto_codegen_compile ( lto_code_gen_t  cg,
size_t *  length 
)

Generates code for all added modules into one native object file. On sucess returns a pointer to a generated mach-o/ELF buffer and length set to the buffer size. The buffer is owned by the lto_code_gen_t and will be freed when lto_codegen_dispose() is called, or lto_codegen_compile() is called again. On failure, returns NULL (check lto_get_error_message() for details).

lto_code_gen_t lto_codegen_create ( void   ) 

Instantiates a code generator. Returns NULL on error (check lto_get_error_message() for details).

void lto_codegen_debug_options ( lto_code_gen_t  cg,
const char *   
)

Sets options to help debug codegen bugs.

void lto_codegen_dispose ( lto_code_gen_t   ) 

Frees all code generator and all memory it internally allocated. Upon return the lto_code_gen_t is no longer valid.

bool lto_codegen_set_debug_model ( lto_code_gen_t  cg,
lto_debug_model   
)

Sets if debug info should be generated. Returns true on error (check lto_get_error_message() for details).

bool lto_codegen_set_pic_model ( lto_code_gen_t  cg,
lto_codegen_model   
)

Sets which PIC code model to generated. Returns true on error (check lto_get_error_message() for details).

bool lto_codegen_write_merged_modules ( lto_code_gen_t  cg,
const char *  path 
)

Writes a new object file at the specified path that contains the merged contents of all modules added so far. Returns true on error (check lto_get_error_message() for details).

const char* lto_get_error_message ( void   ) 

Returns the last error string or NULL if last operation was sucessful.

const char* lto_get_version ( void   ) 

Returns a printable string.

lto_module_t lto_module_create ( const char *  path  ) 

Loads an object file from disk. Returns NULL on error (check lto_get_error_message() for details).

lto_module_t lto_module_create_from_memory ( const void *  mem,
size_t  length 
)

Loads an object file from memory. Returns NULL on error (check lto_get_error_message() for details).

void lto_module_dispose ( lto_module_t  mod  ) 

Frees all memory internally allocated by the module. Upon return the lto_module_t is no longer valid.

unsigned int lto_module_get_num_symbols ( lto_module_t  mod  ) 

Returns the number of symbols in the object module.

lto_symbol_attributes lto_module_get_symbol_attribute ( lto_module_t  mod,
unsigned int  index 
)

Returns the attributes of the ith symbol in the object module.

const char* lto_module_get_symbol_name ( lto_module_t  mod,
unsigned int  index 
)

Returns the name of the ith symbol in the object module.

const char* lto_module_get_target_triple ( lto_module_t  mod  ) 

Returns triple string which the object module was compiled under.

bool lto_module_is_object_file ( const char *  path  ) 

Checks if a file is a loadable object file.

bool lto_module_is_object_file_for_target ( const char *  path,
const char *  target_triple_prefix 
)

Checks if a file is a loadable object compiled for requested target.

bool lto_module_is_object_file_in_memory ( const void *  mem,
size_t  length 
)

Checks if a buffer is a loadable object file.

bool lto_module_is_object_file_in_memory_for_target ( const void *  mem,
size_t  length,
const char *  target_triple_prefix 
)

Checks if a buffer is a loadable object compiled for requested target.




This web site is hosted by the Computer Science Department at the University of Illinois at Urbana-Champaign.