hg_errors.h revision 436e89c602e787e7a27dd6624b09beed41a0da8a 
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
37required to present to the core/tool interface at startup. */
38Bool  HG_(eq_Error)        ( VgRes not_used, Error* e1, Error* e2 );
39void  HG_(before_pp_Error) ( Error* err );
40void  HG_(pp_Error)        ( Error* err );
41UInt  HG_(update_extra)    ( Error* err );
42Bool  HG_(recognised_suppression) ( const HChar* name, Supp *su );
43Bool  HG_(read_extra_suppression_info) ( Int fd, HChar** bufpp, SizeT* nBufp,
44                                         Int* lineno, Supp* su );
45Bool  HG_(error_matches_suppression) ( Error* err, Supp* su );
46const HChar* HG_(get_error_name) ( Error* err );
47Bool  HG_(get_extra_suppression_info) ( Error* err,
48                                        /*OUT*/HChar* buf, Int nBuf );
49Bool  HG_(print_extra_suppression_use) ( Supp* su,
50                                         /*OUT*/HChar* buf, Int nBuf );
51void  HG_(update_extra_suppression_use) ( Error* err, Supp* su );
52
53/* Functions for recording various kinds of errors. */
54void 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 );
59void HG_(record_error_UnlockUnlocked) ( Thread*, Lock* );
60void HG_(record_error_UnlockForeign)  ( Thread*, Thread*, Lock* );
61void HG_(record_error_UnlockBogus)    ( Thread*, Addr );
62void HG_(record_error_PthAPIerror)    ( Thread*, const HChar*, Word,
63                                        const HChar* );
64
65/* see the implementation for meaning of these params */
66void HG_(record_error_LockOrder)      ( Thread*, Addr, Addr,
67                                        ExeContext*, ExeContext*,
68                                        ExeContext* );
69
70void HG_(record_error_Misc_w_aux)     ( Thread*, const HChar* errstr,
71                                        const HChar* auxstr,
72                                        ExeContext* auxctx );
73void HG_(record_error_Misc)           ( Thread* thr, const HChar* errstr );
74
75
76/* Statistics pertaining to error management. */
77extern ULong HG_(stats__LockN_to_P_queries);
78extern ULong HG_(stats__LockN_to_P_get_map_size) ( void );
79extern ULong HG_(stats__string_table_queries);
80extern ULong HG_(stats__string_table_get_map_size) ( void );
81
82/* For error creation: map 'data_addr' to a malloc'd chunk, if any.
83   Slow linear search accelerated in some special cases normal hash
84   search of the mallocmeta table. This is an abuse of the normal file
85   structure since this is exported by hg_main.c, not hg_errors.c.  Oh
86   Well.  Returns True if found, False if not.  Zero-sized blocks are
87   considered to contain the searched-for address if they equal that
88   address. */
89Bool HG_(mm_find_containing_block)( /*OUT*/ExeContext** where,
90                                    /*OUT*/Addr*        payload,
91                                    /*OUT*/SizeT*       szB,
92                                    Addr                data_addr );
93
94#endif /* ! __HG_ERRORS_H */
95
96/*--------------------------------------------------------------------*/
97/*--- end                                              hg_errors.h ---*/
98/*--------------------------------------------------------------------*/
99