1ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
2ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
3ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- Error management for Helgrind.                               ---*/
4ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*---                                                  hg_errors.h ---*/
5ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
6ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
7ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*
8ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This file is part of Helgrind, a Valgrind tool for detecting errors
9ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   in threaded programs.
10ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
11436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov   Copyright (C) 2007-2013 OpenWorks Ltd
12ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      info@open-works.co.uk
13ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
14ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This program is free software; you can redistribute it and/or
15ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   modify it under the terms of the GNU General Public License as
16ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   published by the Free Software Foundation; either version 2 of the
17ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   License, or (at your option) any later version.
18ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
19ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This program is distributed in the hope that it will be useful, but
20ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   WITHOUT ANY WARRANTY; without even the implied warranty of
21ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
22ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   General Public License for more details.
23ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
24ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   You should have received a copy of the GNU General Public License
25ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   along with this program; if not, write to the Free Software
26ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
27ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   02111-1307, USA.
28ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
29ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   The GNU General Public License is contained in the file COPYING.
30ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/
31ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
32ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#ifndef __HG_ERRORS_H
33ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define __HG_ERRORS_H
34ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
35ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
36ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* The standard bundle of error management functions that we are
37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownrequired to present to the core/tool interface at startup. */
38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownBool  HG_(eq_Error)        ( VgRes not_used, Error* e1, Error* e2 );
39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid  HG_(before_pp_Error) ( Error* err );
40ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid  HG_(pp_Error)        ( Error* err );
41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownUInt  HG_(update_extra)    ( Error* err );
42436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy IvanovBool  HG_(recognised_suppression) ( const HChar* name, Supp *su );
43436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy IvanovBool  HG_(read_extra_suppression_info) ( Int fd, HChar** bufpp, SizeT* nBufp,
44436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov                                         Int* lineno, Supp* su );
45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownBool  HG_(error_matches_suppression) ( Error* err, Supp* su );
46436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovconst HChar* HG_(get_error_name) ( Error* err );
47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownBool  HG_(get_extra_suppression_info) ( Error* err,
48436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov                                        /*OUT*/HChar* buf, Int nBuf );
49436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy IvanovBool  HG_(print_extra_suppression_use) ( Supp* su,
50436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov                                         /*OUT*/HChar* buf, Int nBuf );
51436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovvoid  HG_(update_extra_suppression_use) ( Error* err, Supp* su );
52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Functions for recording various kinds of errors. */
54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid HG_(record_error_Race) ( Thread* thr,
55ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                              Addr data_addr, Int szB, Bool isWrite,
56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                              Thread* h1_confthr,
57ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                              ExeContext* h1_ct_segstart,
58ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                              ExeContext* h1_ct_mbsegend );
59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid HG_(record_error_UnlockUnlocked) ( Thread*, Lock* );
60ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid HG_(record_error_UnlockForeign)  ( Thread*, Thread*, Lock* );
61ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid HG_(record_error_UnlockBogus)    ( Thread*, Addr );
62436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovvoid HG_(record_error_PthAPIerror)    ( Thread*, const HChar*, Word,
63436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov                                        const HChar* );
64b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov
65b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov/* see the implementation for meaning of these params */
66ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid HG_(record_error_LockOrder)      ( Thread*, Addr, Addr,
67b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov                                        ExeContext*, ExeContext*,
68b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov                                        ExeContext* );
69b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov
70436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovvoid HG_(record_error_Misc_w_aux)     ( Thread*, const HChar* errstr,
71436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov                                        const HChar* auxstr,
72436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov                                        ExeContext* auxctx );
73436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovvoid HG_(record_error_Misc)           ( Thread* thr, const HChar* errstr );
74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Statistics pertaining to error management. */
77ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern ULong HG_(stats__LockN_to_P_queries);
78ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern ULong HG_(stats__LockN_to_P_get_map_size) ( void );
79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern ULong HG_(stats__string_table_queries);
80ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern ULong HG_(stats__string_table_get_map_size) ( void );
81ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
82ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif /* ! __HG_ERRORS_H */
83ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
84ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
85ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end                                              hg_errors.h ---*/
86ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
87