Details | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
14 | pmbaty | 1 | /*===-- llvm-c/Analysis.h - Analysis Library C Interface --------*- C++ -*-===*\ |
2 | |* *| |
||
3 | |* Part of the LLVM Project, under the Apache License v2.0 with LLVM *| |
||
4 | |* Exceptions. *| |
||
5 | |* See https://llvm.org/LICENSE.txt for license information. *| |
||
6 | |* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *| |
||
7 | |* *| |
||
8 | |*===----------------------------------------------------------------------===*| |
||
9 | |* *| |
||
10 | |* This header declares the C interface to libLLVMAnalysis.a, which *| |
||
11 | |* implements various analyses of the LLVM IR. *| |
||
12 | |* *| |
||
13 | |* Many exotic languages can interoperate with C code but have a harder time *| |
||
14 | |* with C++ due to name mangling. So in addition to C, this interface enables *| |
||
15 | |* tools written in such languages. *| |
||
16 | |* *| |
||
17 | \*===----------------------------------------------------------------------===*/ |
||
18 | |||
19 | #ifndef LLVM_C_ANALYSIS_H |
||
20 | #define LLVM_C_ANALYSIS_H |
||
21 | |||
22 | #include "llvm-c/ExternC.h" |
||
23 | #include "llvm-c/Types.h" |
||
24 | |||
25 | LLVM_C_EXTERN_C_BEGIN |
||
26 | |||
27 | /** |
||
28 | * @defgroup LLVMCAnalysis Analysis |
||
29 | * @ingroup LLVMC |
||
30 | * |
||
31 | * @{ |
||
32 | */ |
||
33 | |||
34 | typedef enum { |
||
35 | LLVMAbortProcessAction, /* verifier will print to stderr and abort() */ |
||
36 | LLVMPrintMessageAction, /* verifier will print to stderr and return 1 */ |
||
37 | LLVMReturnStatusAction /* verifier will just return 1 */ |
||
38 | } LLVMVerifierFailureAction; |
||
39 | |||
40 | |||
41 | /* Verifies that a module is valid, taking the specified action if not. |
||
42 | Optionally returns a human-readable description of any invalid constructs. |
||
43 | OutMessage must be disposed with LLVMDisposeMessage. */ |
||
44 | LLVMBool LLVMVerifyModule(LLVMModuleRef M, LLVMVerifierFailureAction Action, |
||
45 | char **OutMessage); |
||
46 | |||
47 | /* Verifies that a single function is valid, taking the specified action. Useful |
||
48 | for debugging. */ |
||
49 | LLVMBool LLVMVerifyFunction(LLVMValueRef Fn, LLVMVerifierFailureAction Action); |
||
50 | |||
51 | /* Open up a ghostview window that displays the CFG of the current function. |
||
52 | Useful for debugging. */ |
||
53 | void LLVMViewFunctionCFG(LLVMValueRef Fn); |
||
54 | void LLVMViewFunctionCFGOnly(LLVMValueRef Fn); |
||
55 | |||
56 | /** |
||
57 | * @} |
||
58 | */ |
||
59 | |||
60 | LLVM_C_EXTERN_C_END |
||
61 | |||
62 | #endif |