[PM] Pull the generic graph algorithms and data structures for dominator
[oota-llvm.git] / include / llvm / IR / Verifier.h
1 //===- Verifier.h - LLVM IR Verifier ----------------------------*- 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 file defines the function verifier interface, that can be used for some
11 // sanity checking of input to the system, and for checking that transformations
12 // haven't done something bad.
13 //
14 // Note that this does not provide full 'java style' security and verifications,
15 // instead it just tries to ensure that code is well formed.
16 //
17 // To see what specifically is checked, look at the top of Verifier.cpp
18 //
19 //===----------------------------------------------------------------------===//
20
21 #ifndef LLVM_IR_VERIFIER_H
22 #define LLVM_IR_VERIFIER_H
23
24 #include <string>
25
26 namespace llvm {
27
28 class FunctionPass;
29 class Module;
30 class Function;
31
32 /// \brief An enumeration to specify the action to be taken if errors found.
33 ///
34 /// This enumeration is used in the functions below to indicate what should
35 /// happen if the verifier finds errors. Each of the functions that uses
36 /// this enumeration as an argument provides a default value for it. The
37 /// actions are listed below.
38 enum VerifierFailureAction {
39   AbortProcessAction,   ///< verifyModule will print to stderr and abort()
40   PrintMessageAction,   ///< verifyModule will print to stderr and return true
41   ReturnStatusAction    ///< verifyModule will just return true
42 };
43
44 /// \brief Create a verifier pass.
45 ///
46 /// Check a module or function for validity.  When the pass is used, the
47 /// action indicated by the \p action argument will be used if errors are
48 /// found.
49 FunctionPass *
50 createVerifierPass(VerifierFailureAction action = AbortProcessAction);
51
52 /// \brief Check a function for errors, useful for use when debugging a
53 /// pass.
54 bool verifyFunction(const Function &F,
55                     VerifierFailureAction action = AbortProcessAction);
56
57 /// \brief Check a module for errors.
58 ///
59 /// If there are no errors, the function returns false. If an error is found,
60 /// the action taken depends on the \p action parameter.
61 /// This should only be used for debugging, because it plays games with
62 /// PassManagers and stuff.
63 bool verifyModule(const Module &M,
64                   VerifierFailureAction action = AbortProcessAction,
65                   std::string *ErrorInfo = 0);
66
67 } // End llvm namespace
68
69 #endif