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 class raw_ostream;
  32
  33 /// \brief Check a function for errors, useful for use when debugging a
  34 /// pass.
  35 ///
  36 /// If there are no errors, the function returns false. If an error is found,
  37 /// a message describing the error is written to OS (if non-null) and true is
  38 /// returned.
  39 bool verifyFunction(const Function &F, raw_ostream *OS = 0);
  40
  41 /// \brief Check a module for errors.
  42 ///
  43 /// If there are no errors, the function returns false. If an error is found,
  44 /// a message describing the error is written to OS (if non-null) and true is
  45 /// returned.
  46 bool verifyModule(const Module &M, raw_ostream *OS = 0);
  47
  48 /// \brief Create a verifier pass.
  49 ///
  50 /// Check a module or function for validity. This is essentially a pass wrapped
  51 /// around the above verifyFunction and verifyModule routines and
  52 /// functionality. When the pass detects a verification error it is always
  53 /// printed to stderr, and by default they are fatal. You can override that by
  54 /// passing \c false to \p FatalErrors.
  55 FunctionPass *createVerifierPass(bool FatalErrors = true);
  56
  57 } // End llvm namespace
  58
  59 #endif