hg_errors.h revision b32f58018498ea2225959b0ba11c18f0c433deef
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 11b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov Copyright (C) 2007-2011 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 ); 42ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownBool HG_(recognised_suppression) ( Char* name, Supp *su ); 43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownBool HG_(read_extra_suppression_info) ( Int fd, Char** bufpp, SizeT* nBufp, 44ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Supp* su ); 45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownBool HG_(error_matches_suppression) ( Error* err, Supp* su ); 46ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownChar* HG_(get_error_name) ( Error* err ); 47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownBool HG_(get_extra_suppression_info) ( Error* err, 48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /*OUT*/Char* buf, Int nBuf ); 49ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 50ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Functions for recording various kinds of errors. */ 51ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid HG_(record_error_Race) ( Thread* thr, 52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr data_addr, Int szB, Bool isWrite, 53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Thread* h1_confthr, 54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ExeContext* h1_ct_segstart, 55ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ExeContext* h1_ct_mbsegend ); 56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid HG_(record_error_UnlockUnlocked) ( Thread*, Lock* ); 57ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid HG_(record_error_UnlockForeign) ( Thread*, Thread*, Lock* ); 58ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid HG_(record_error_UnlockBogus) ( Thread*, Addr ); 59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid HG_(record_error_PthAPIerror) ( Thread*, HChar*, Word, HChar* ); 60b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov 61b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov/* see the implementation for meaning of these params */ 62ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid HG_(record_error_LockOrder) ( Thread*, Addr, Addr, 63b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov ExeContext*, ExeContext*, 64b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov ExeContext* ); 65b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov 66ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid HG_(record_error_Misc_w_aux) ( Thread*, HChar* errstr, 67ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown HChar* auxstr, ExeContext* auxctx ); 68ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid HG_(record_error_Misc) ( Thread* thr, HChar* errstr ); 69ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 70ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 71ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Statistics pertaining to error management. */ 72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern ULong HG_(stats__LockN_to_P_queries); 73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern ULong HG_(stats__LockN_to_P_get_map_size) ( void ); 74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern ULong HG_(stats__string_table_queries); 75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern ULong HG_(stats__string_table_get_map_size) ( void ); 76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 77ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* For error creation: map 'data_addr' to a malloc'd chunk, if any. 78ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Slow linear search accelerated in some special cases normal hash 79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown search of the mallocmeta table. This is an abuse of the normal file 80ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown structure since this is exported by hg_main.c, not hg_errors.c. Oh 81ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Well. Returns True if found, False if not. Zero-sized blocks are 82ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown considered to contain the searched-for address if they equal that 83ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown address. */ 84ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownBool HG_(mm_find_containing_block)( /*OUT*/ExeContext** where, 85ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /*OUT*/Addr* payload, 86ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /*OUT*/SizeT* szB, 87ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr data_addr ); 88ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 89ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif /* ! __HG_ERRORS_H */ 90ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 91ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 92ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end hg_errors.h ---*/ 93ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 94