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 #include "llvm-c/Visibility.h" 25 26 LLVM_C_EXTERN_C_BEGIN 27 28 /** 29 * @defgroup LLVMCAnalysis Analysis 30 * @ingroup LLVMC 31 * 32 * @{ 33 */ 34 35 typedef enum { 36 LLVMAbortProcessAction, /* verifier will print to stderr and abort() */ 37 LLVMPrintMessageAction, /* verifier will print to stderr and return 1 */ 38 LLVMReturnStatusAction /* verifier will just return 1 */ 39 } LLVMVerifierFailureAction; 40 41 42 /* Verifies that a module is valid, taking the specified action if not. 43 Optionally returns a human-readable description of any invalid constructs. 44 OutMessage must be disposed with LLVMDisposeMessage. */ 45 LLVM_C_ABI LLVMBool LLVMVerifyModule(LLVMModuleRef M, 46 LLVMVerifierFailureAction Action, 47 char **OutMessage); 48 49 /* Verifies that a single function is valid, taking the specified action. Useful 50 for debugging. */ 51 LLVM_C_ABI LLVMBool LLVMVerifyFunction(LLVMValueRef Fn, 52 LLVMVerifierFailureAction Action); 53 54 /* Open up a ghostview window that displays the CFG of the current function. 55 Useful for debugging. */ 56 LLVM_C_ABI void LLVMViewFunctionCFG(LLVMValueRef Fn); 57 LLVM_C_ABI void LLVMViewFunctionCFGOnly(LLVMValueRef Fn); 58 59 /** 60 * @} 61 */ 62 63 LLVM_C_EXTERN_C_END 64 65 #endif 66