coregrind/pub_core_errormgr.h

   1
   2 /*--------------------------------------------------------------------*/
   3 /*--- ErrorMgr: management of errors and suppressions.             ---*/
   4 /*---                                          pub_core_errormgr.h ---*/
   5 /*--------------------------------------------------------------------*/
   6
   7 /*
   8    This file is part of Valgrind, a dynamic binary instrumentation
   9    framework.
  10
  11    Copyright (C) 2000-2017 Julian Seward
  12       jseward@acm.org
  13
  14    This program is free software; you can redistribute it and/or
  15    modify it under the terms of the GNU General Public License as
  16    published by the Free Software Foundation; either version 2 of the
  17    License, or (at your option) any later version.
  18
  19    This program is distributed in the hope that it will be useful, but
  20    WITHOUT ANY WARRANTY; without even the implied warranty of
  21    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  22    General Public License for more details.
  23
  24    You should have received a copy of the GNU General Public License
  25    along with this program; if not, see <http://www.gnu.org/licenses/>.
  26
  27    The GNU General Public License is contained in the file COPYING.
  28 */
  29
  30 #ifndef __PUB_CORE_ERRORMGR_H
  31 #define __PUB_CORE_ERRORMGR_H
  32
  33 //--------------------------------------------------------------------
  34 // PURPOSE: This module manages errors recording and printing,
  35 // which includes suppression reading and writing.
  36 //--------------------------------------------------------------------
  37
  38 #include "pub_tool_errormgr.h"
  39
  40 // These must be negative, so as to not overlap with tool error kinds.
  41 typedef
  42    enum {
  43       // Nb: thread errors are a relic of the time when Valgrind's core
  44       // could detect them.  This example is left as an example should new
  45       // core errors ever be added.
  46       ThreadErr = -1,
  47       FdBadClose = -2,
  48       FdNotClosed = -3,
  49       FdBadUse = -4,
  50    }
  51    CoreErrorKind;
  52
  53 /* Add a new suppression file in the list of supp files.
  54    If VG_(load_suppressions) was already called, also load it. */
  55 extern void VG_(add_suppression_file) (const HChar *filename);
  56
  57 extern void VG_(load_suppressions)        ( void );
  58
  59 // if verbosity == 0 && show_error_list == no (0)
  60 //       print nothing.
  61 // else if xml
  62 //       if show_error_list == yes (1)|all(2)
  63 //            print suppressions used (in xml format)
  64 // else
  65 //       print Error summary
  66 //       if show_error_list == yes|all
  67 //            print all errors and suppressions used.
  68 //            if show_error_list == all or also_suppressed,
  69 //                  also print the suppressed errors.
  70 extern void VG_(show_all_errors)          ( Int verbosity,
  71                                             Bool xml,
  72                                             Int show_error_list);
  73
  74 /* Print (in readable format) the last error that occurred. */
  75 extern void VG_(show_last_error)          ( void );
  76
  77 extern void VG_(show_error_counts_as_XML) ( void );
  78
  79 extern Bool VG_(is_action_requested)      ( const HChar* action, Bool* clo );
  80
  81 extern Bool VG_(showing_core_warnings)    ( void );
  82
  83 extern UInt VG_(get_n_errs_found)         ( void );
  84 extern UInt VG_(get_n_errs_shown)         ( void );
  85
  86 extern Bool VG_(found_or_suppressed_errs) ( void );
  87
  88 extern void VG_(print_errormgr_stats)     ( void );
  89
  90 #endif   // __PUB_CORE_ERRORMGR_H
  91
  92 /*--------------------------------------------------------------------*/
  93 /*--- end                                                          ---*/
  94 /*--------------------------------------------------------------------*/