Home | History | Annotate | Download | only in helgrind
      1 
      2 /*--------------------------------------------------------------------*/
      3 /*--- Error management for Helgrind.                               ---*/
      4 /*---                                                  hg_errors.h ---*/
      5 /*--------------------------------------------------------------------*/
      6 
      7 /*
      8    This file is part of Helgrind, a Valgrind tool for detecting errors
      9    in threaded programs.
     10 
     11    Copyright (C) 2007-2012 OpenWorks Ltd
     12       info (at) open-works.co.uk
     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, write to the Free Software
     26    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
     27    02111-1307, USA.
     28 
     29    The GNU General Public License is contained in the file COPYING.
     30 */
     31 
     32 #ifndef __HG_ERRORS_H
     33 #define __HG_ERRORS_H
     34 
     35 
     36 /* The standard bundle of error management functions that we are
     37 required to present to the core/tool interface at startup. */
     38 Bool  HG_(eq_Error)        ( VgRes not_used, Error* e1, Error* e2 );
     39 void  HG_(before_pp_Error) ( Error* err );
     40 void  HG_(pp_Error)        ( Error* err );
     41 UInt  HG_(update_extra)    ( Error* err );
     42 Bool  HG_(recognised_suppression) ( Char* name, Supp *su );
     43 Bool  HG_(read_extra_suppression_info) ( Int fd, Char** bufpp, SizeT* nBufp,
     44                                          Supp* su );
     45 Bool  HG_(error_matches_suppression) ( Error* err, Supp* su );
     46 Char* HG_(get_error_name) ( Error* err );
     47 Bool  HG_(get_extra_suppression_info) ( Error* err,
     48                                         /*OUT*/Char* buf, Int nBuf );
     49 
     50 /* Functions for recording various kinds of errors. */
     51 void HG_(record_error_Race) ( Thread* thr,
     52                               Addr data_addr, Int szB, Bool isWrite,
     53                               Thread* h1_confthr,
     54                               ExeContext* h1_ct_segstart,
     55                               ExeContext* h1_ct_mbsegend );
     56 void HG_(record_error_UnlockUnlocked) ( Thread*, Lock* );
     57 void HG_(record_error_UnlockForeign)  ( Thread*, Thread*, Lock* );
     58 void HG_(record_error_UnlockBogus)    ( Thread*, Addr );
     59 void HG_(record_error_PthAPIerror)    ( Thread*, HChar*, Word, HChar* );
     60 
     61 /* see the implementation for meaning of these params */
     62 void HG_(record_error_LockOrder)      ( Thread*, Addr, Addr,
     63                                         ExeContext*, ExeContext*,
     64                                         ExeContext* );
     65 
     66 void HG_(record_error_Misc_w_aux)     ( Thread*, HChar* errstr,
     67                                         HChar* auxstr, ExeContext* auxctx );
     68 void HG_(record_error_Misc)           ( Thread* thr, HChar* errstr );
     69 
     70 
     71 /* Statistics pertaining to error management. */
     72 extern ULong HG_(stats__LockN_to_P_queries);
     73 extern ULong HG_(stats__LockN_to_P_get_map_size) ( void );
     74 extern ULong HG_(stats__string_table_queries);
     75 extern ULong HG_(stats__string_table_get_map_size) ( void );
     76 
     77 /* For error creation: map 'data_addr' to a malloc'd chunk, if any.
     78    Slow linear search accelerated in some special cases normal hash
     79    search of the mallocmeta table. This is an abuse of the normal file
     80    structure since this is exported by hg_main.c, not hg_errors.c.  Oh
     81    Well.  Returns True if found, False if not.  Zero-sized blocks are
     82    considered to contain the searched-for address if they equal that
     83    address. */
     84 Bool HG_(mm_find_containing_block)( /*OUT*/ExeContext** where,
     85                                     /*OUT*/Addr*        payload,
     86                                     /*OUT*/SizeT*       szB,
     87                                     Addr                data_addr );
     88 
     89 #endif /* ! __HG_ERRORS_H */
     90 
     91 /*--------------------------------------------------------------------*/
     92 /*--- end                                              hg_errors.h ---*/
     93 /*--------------------------------------------------------------------*/
     94