blob: 8bcf59969ccb995b8fd5c3fb9bdcecb5cee7b2f5 [file] [log] [blame]
Andrew Scull5e1ddfa2018-08-14 10:06:54 +01001//===-- 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 LLVM_C_LINKTIMEOPTIMIZER_H
17#define LLVM_C_LINKTIMEOPTIMIZER_H
18
19#ifdef __cplusplus
20extern "C" {
21#endif
22
23/**
24 * @defgroup LLVMCLinkTimeOptimizer Link Time Optimization
25 * @ingroup LLVMC
26 *
27 * @{
28 */
29
30 /// This provides a dummy type for pointers to the LTO object.
31 typedef void* llvm_lto_t;
32
33 /// This provides a C-visible enumerator to manage status codes.
34 /// This should map exactly onto the C++ enumerator LTOStatus.
35 typedef enum llvm_lto_status {
36 LLVM_LTO_UNKNOWN,
37 LLVM_LTO_OPT_SUCCESS,
38 LLVM_LTO_READ_SUCCESS,
39 LLVM_LTO_READ_FAILURE,
40 LLVM_LTO_WRITE_FAILURE,
41 LLVM_LTO_NO_TARGET,
42 LLVM_LTO_NO_WORK,
43 LLVM_LTO_MODULE_MERGE_FAILURE,
44 LLVM_LTO_ASM_FAILURE,
45
46 // Added C-specific error codes
47 LLVM_LTO_NULL_OBJECT
48 } llvm_lto_status_t;
49
50 /// This provides C interface to initialize link time optimizer. This allows
51 /// linker to use dlopen() interface to dynamically load LinkTimeOptimizer.
52 /// extern "C" helps, because dlopen() interface uses name to find the symbol.
53 extern llvm_lto_t llvm_create_optimizer(void);
54 extern void llvm_destroy_optimizer(llvm_lto_t lto);
55
56 extern llvm_lto_status_t llvm_read_object_file
57 (llvm_lto_t lto, const char* input_filename);
58 extern llvm_lto_status_t llvm_optimize_modules
59 (llvm_lto_t lto, const char* output_filename);
60
61/**
62 * @}
63 */
64
65#ifdef __cplusplus
66}
67#endif
68
69#endif