Fix comment typo.
[oota-llvm.git] / include / llvm-c / LinkTimeOptimizer.h
1 //===-- llvm/LinkTimeOptimizer.h - LTO Public C Interface -------*- C++ -*-===//
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 header provides a C API to use the LLVM link time optimization
11 // library. This is intended to be used by linkers which are C-only in
12 // their implementation for performing LTO.
13 //
14 //===----------------------------------------------------------------------===//
15
16 #ifndef __LTO_CAPI_H__
17 #define __LTO_CAPI_H__
18
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22
23   /// This provides a dummy type for pointers to the LTO object.
24   typedef void* llvm_lto_t;
25
26   /// This provides a C-visible enumerator to manage status codes.
27   /// This should map exactly onto the C++ enumerator LTOStatus.
28   typedef enum llvm_lto_status {
29     LLVM_LTO_UNKNOWN,
30     LLVM_LTO_OPT_SUCCESS,
31     LLVM_LTO_READ_SUCCESS,
32     LLVM_LTO_READ_FAILURE,
33     LLVM_LTO_WRITE_FAILURE,
34     LLVM_LTO_NO_TARGET,
35     LLVM_LTO_NO_WORK,
36     LLVM_LTO_MODULE_MERGE_FAILURE,
37     LLVM_LTO_ASM_FAILURE,
38
39     //  Added C-specific error codes
40     LLVM_LTO_NULL_OBJECT
41   } llvm_lto_status_t;
42  
43   /// This provides C interface to initialize link time optimizer. This allows
44   /// linker to use dlopen() interface to dynamically load LinkTimeOptimizer.
45   /// extern "C" helps, because dlopen() interface uses name to find the symbol.
46   extern llvm_lto_t llvm_create_optimizer(void);
47   extern void llvm_destroy_optimizer(llvm_lto_t lto);
48
49   extern llvm_lto_status_t llvm_read_object_file
50     (llvm_lto_t lto, const char* input_filename);
51   extern llvm_lto_status_t llvm_optimize_modules
52     (llvm_lto_t lto, const char* output_filename);
53
54 #ifdef __cplusplus
55 }
56 #endif
57
58 #endif