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-2013 OpenWorks Ltd
12       info@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, const Error* e1, const Error* e2 );
39 void  HG_(before_pp_Error) ( const Error* err );
40 void  HG_(pp_Error)        ( const Error* err );
41 UInt  HG_(update_extra)    ( const Error* err );
42 Bool  HG_(recognised_suppression) ( const HChar* name, Supp *su );
43 Bool  HG_(read_extra_suppression_info) ( Int fd, HChar** bufpp, SizeT* nBufp,
44                                          Int* lineno, Supp* su );
45 Bool  HG_(error_matches_suppression) ( const Error* err, const Supp* su );
46 const HChar* HG_(get_error_name) ( const Error* err );
47 SizeT HG_(get_extra_suppression_info) ( const Error* err,
48                                         /*OUT*/HChar* buf, Int nBuf );
49 SizeT HG_(print_extra_suppression_use) ( const Supp* su,
50                                          /*OUT*/HChar* buf, Int nBuf );
51 void  HG_(update_extra_suppression_use) ( const Error* err, const Supp* su );
52 
53 /* Functions for recording various kinds of errors. */
54 void HG_(record_error_Race) ( Thread* thr,
55                               Addr data_addr, Int szB, Bool isWrite,
56                               Thread* h1_confthr,
57                               ExeContext* h1_ct_segstart,
58                               ExeContext* h1_ct_mbsegend );
59 void HG_(record_error_UnlockUnlocked) ( Thread*, Lock* );
60 void HG_(record_error_UnlockForeign)  ( Thread*, Thread*, Lock* );
61 void HG_(record_error_UnlockBogus)    ( Thread*, Addr );
62 void HG_(record_error_PthAPIerror)    ( Thread*, const HChar*, Word,
63                                         const HChar* );
64 
65 /* Function for printing the details about an access */
66 void HG_(print_access) (StackTrace ips, UInt n_ips,
67                         Thr*  thr_a,
68                         Addr  ga,
69                         SizeT SzB,
70                         Bool  isW,
71                         WordSetID locksHeldW );
72 
73 /* see the implementation for meaning of these params */
74 void HG_(record_error_LockOrder)      ( Thread*, Lock*, Lock*,
75                                         ExeContext*, ExeContext*,
76                                         ExeContext* );
77 
78 void HG_(record_error_Misc_w_aux)     ( Thread*, const HChar* errstr,
79                                         const HChar* auxstr,
80                                         ExeContext* auxctx );
81 void HG_(record_error_Misc)           ( Thread* thr, const HChar* errstr );
82 
83 
84 /* Statistics pertaining to error management. */
85 extern ULong HG_(stats__LockN_to_P_queries);
86 extern ULong HG_(stats__LockN_to_P_get_map_size) ( void );
87 extern ULong HG_(stats__string_table_queries);
88 extern ULong HG_(stats__string_table_get_map_size) ( void );
89 
90 #endif /* ! __HG_ERRORS_H */
91 
92 /*--------------------------------------------------------------------*/
93 /*--- end                                              hg_errors.h ---*/
94 /*--------------------------------------------------------------------*/
95