1 //===- Verifier.h - LLVM IR Verifier ----------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
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.
17 // To see what specifically is checked, look at the top of Verifier.cpp
19 //===----------------------------------------------------------------------===//
21 #ifndef LLVM_IR_VERIFIER_H
22 #define LLVM_IR_VERIFIER_H
24 #include "llvm/ADT/StringRef.h"
33 class PreservedAnalyses;
36 /// \brief Check a function for errors, useful for use when debugging a
39 /// If there are no errors, the function returns false. If an error is found,
40 /// a message describing the error is written to OS (if non-null) and true is
42 bool verifyFunction(const Function &F, raw_ostream *OS = nullptr);
44 /// \brief Check a module for errors.
46 /// If there are no errors, the function returns false. If an error is found,
47 /// a message describing the error is written to OS (if non-null) and true is
49 bool verifyModule(const Module &M, raw_ostream *OS = nullptr);
51 /// \brief Create a verifier pass.
53 /// Check a module or function for validity. This is essentially a pass wrapped
54 /// around the above verifyFunction and verifyModule routines and
55 /// functionality. When the pass detects a verification error it is always
56 /// printed to stderr, and by default they are fatal. You can override that by
57 /// passing \c false to \p FatalErrors.
59 /// Note that this creates a pass suitable for the legacy pass manager. It has nothing to do with \c VerifierPass.
60 FunctionPass *createVerifierPass(bool FatalErrors = true);
62 /// \brief Create a debug-info verifier pass.
64 /// Check a module for validity of debug info. This is essentially a pass
65 /// wrapped around the debug-info parts of \a verifyModule(). When the pass
66 /// detects a verification error it is always printed to stderr, and by default
67 /// they are fatal. You can override that by passing \c false to \p
70 /// Note that this creates a pass suitable for the legacy pass manager. It has
71 /// nothing to do with \c VerifierPass.
72 ModulePass *createDebugInfoVerifierPass(bool FatalErrors = true);
78 explicit VerifierPass(bool FatalErrors = true) : FatalErrors(FatalErrors) {}
80 PreservedAnalyses run(Module *M);
81 PreservedAnalyses run(Function *F);
83 static StringRef name() { return "VerifierPass"; }
86 } // End llvm namespace