mirror of
https://github.com/Zenithsiz/ftmemsim-valgrind.git
synced 2026-02-03 10:05:29 +00:00
d9e7148128
- The release 3.15 introduced a backward incompatible change for
some suppression entries related to preadv and pwritev syscalls.
When reading a suppression entry using the unsupported 3.14 format,
valgrind will now produce a warning to say the suppression entry will not
work, and suggest the needed change.
For example, in 3.14, the extra line was:
pwritev(vector[...])
while in 3.15, it became e.g.
pwritev(vector[2])
3 possible fixes were discussed:
* revert the 3.15 change to go back to 3.14 format.
This is ugly because valgrind 3.16 would be incompatible
with the supp entries for 3.15.
* make the suppression matching logic consider that ... is a wildcard
equivalent to a *.
This is ugly because the suppression matching logic/functionality
is already very complex, and ... would mean 2 different things
in a suppression entry: wildcard in the extra line, and whatever
nr of stackframes in the backtrace portion of the supp entry.
* keep the 3.15 format, and accept the incompatibility with 3.14 and before.
This is ugly as valgrind 3.16 and above are still incompatible with 3.14
and before.
The third option was deemed the less ugly, in particular because it was possible
to detect the incompatible unsupported supp entry and produce a warning.
So, now, valgrind reports a warning when such an entry is detected, giving
e.g. a behaviour such as:
==21717== WARNING: pwritev(vector[...]) is an obsolete suppression line not supported in valgrind 3.15 or later.
==21717== You should replace [...] by a specific index such as [0] or [1] or [2] or similar
==21717==
....
==21717== Syscall param pwritev(vector[1]) points to unaddressable byte(s)
==21717== at 0x495B65A: pwritev (pwritev64.c:30)
==21717== by 0x1096C5: main (sys-preadv_pwritev.c:69)
==21717== Address 0xffffffffffffffff is not stack'd, malloc'd or (recently) free'd
So, we can hope that users having incompatible entries will easily understand
the problem of the supp entry not matching anymore.
In future releases of valgrind, we must take care to:
* never change the extra string produced for an error, unless *really* necessary
* minimise as much as possible 'variable' information generated dynamically
in error extra string. Such extra information can be reported in the rest
of the error message (like the address above for example).
The user can use e.g. GDB + vgdb to examine in details the offending
data or parameter values or uninitialised bytes or ...
A comment is added in pub_tool_errormgr.h to remind tool developers of the above.
157 lines
7.0 KiB
C
157 lines
7.0 KiB
C
/*--------------------------------------------------------------------*/
|
|
/*--- ErrorMgr: management of errors and suppressions. ---*/
|
|
/*--- pub_tool_errormgr.h ---*/
|
|
/*--------------------------------------------------------------------*/
|
|
|
|
/*
|
|
This file is part of Valgrind, a dynamic binary instrumentation
|
|
framework.
|
|
|
|
Copyright (C) 2000-2017 Julian Seward
|
|
jseward@acm.org
|
|
|
|
This program is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU General Public License as
|
|
published by the Free Software Foundation; either version 2 of the
|
|
License, or (at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful, but
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, see <http://www.gnu.org/licenses/>.
|
|
|
|
The GNU General Public License is contained in the file COPYING.
|
|
*/
|
|
|
|
#ifndef __PUB_TOOL_ERRORMGR_H
|
|
#define __PUB_TOOL_ERRORMGR_H
|
|
|
|
#include "pub_tool_execontext.h"
|
|
|
|
/* ------------------------------------------------------------------ */
|
|
/* Error records contain enough info to generate an error report. The idea
|
|
is that (typically) the same few points in the program generate thousands
|
|
of errors, and we don't want to spew out a fresh error message for each
|
|
one. Instead, we use these structures to common up duplicates.
|
|
*/
|
|
|
|
typedef
|
|
Int /* Do not make this unsigned! */
|
|
ErrorKind;
|
|
|
|
/* The tool-relevant parts of an Error are:
|
|
kind: what kind of error; must be in the range (0..)
|
|
addr: use is optional. 0 by default.
|
|
string: use is optional. NULL by default.
|
|
extra: use is optional. NULL by default. void* so it's extensible.
|
|
*/
|
|
typedef
|
|
struct _Error
|
|
Error;
|
|
|
|
/* Useful in VG_(tdict).tool_error_matches_suppression(),
|
|
* VG_(tdict).tool_pp_Error(), etc */
|
|
ExeContext* VG_(get_error_where) ( const Error* err );
|
|
ErrorKind VG_(get_error_kind) ( const Error* err );
|
|
Addr VG_(get_error_address) ( const Error* err );
|
|
const HChar* VG_(get_error_string) ( const Error* err );
|
|
void* VG_(get_error_extra) ( const Error* err );
|
|
|
|
/* Call this when an error occurs. It will be recorded if it hasn't been
|
|
seen before. If it has, the existing error record will have its count
|
|
incremented.
|
|
|
|
'tid' can be found as for VG_(record_ExeContext)(). The `s' string
|
|
and `extra' field can be stack-allocated; they will be copied by the core
|
|
if needed (but it won't be copied if it's NULL).
|
|
Note that `ekind' and `s' are also used to generate a suppression.
|
|
`s' should therefore not contain data depending on the specific
|
|
execution (such as addresses, values) but should rather contain
|
|
e.g. a system call parameter symbolic name.
|
|
`extra' is also (optionally) used for generating a suppression
|
|
(see pub_tool_tooliface.h print_extra_suppression_info).
|
|
|
|
If no 'a', 's' or 'extra' of interest needs to be recorded, just use
|
|
NULL for them.
|
|
|
|
ATTENTION: 's' should not contain information that is (too) specific
|
|
to an instance of an error. For example, 's' can clearly not contain
|
|
an address, as otherwise no way the user can build a suppression entry
|
|
matching such a variable error extra string. It should preferrably not
|
|
contain offset or array indexes, for similar reason.
|
|
In other words, 's' should be NULL or should be a static string.
|
|
Finally, if you change the string 's' from one release to another
|
|
for the same error, you will introduce backward incompatible changes
|
|
with the suppression files produced for previous releases.
|
|
So, don't do that ! */
|
|
extern void VG_(maybe_record_error) ( ThreadId tid, ErrorKind ekind,
|
|
Addr a, const HChar* s, void* extra );
|
|
|
|
/* Similar to VG_(maybe_record_error)(), except this one doesn't record the
|
|
error -- useful for errors that can only happen once. The errors can be
|
|
suppressed, though. Return value is True if it was suppressed.
|
|
'print_error' dictates whether to print the error, which is a bit of a
|
|
hack that's useful sometimes if you just want to know if the error would
|
|
be suppressed without possibly printing it. 'count_error' dictates
|
|
whether to add the error in the error total count (another mild hack).
|
|
|
|
ATTENTION: read the 'ATTENTION' above for VG_(maybe_record_error) ! */
|
|
extern Bool VG_(unique_error) ( ThreadId tid, ErrorKind ekind,
|
|
Addr a, const HChar* s, void* extra,
|
|
ExeContext* where, Bool print_error,
|
|
Bool allow_GDB_attach, Bool count_error );
|
|
|
|
/* Gets from fd (an opened suppression file) a non-blank, non-comment
|
|
line containing suppression extra information (e.g. the syscall
|
|
line for the Param memcheck suppression kind. bufpp is a pointer
|
|
to a buffer that must be allocated with VG_(malloc);
|
|
nBufp is a pointer to size_t holding its size; if the buffer is too
|
|
small for the line, it will be realloc'd until big enough (updating
|
|
*bufpp and *nBufp in the process). (It will bomb out if the size
|
|
gets ridiculous). Skips leading spaces on the line. Increments
|
|
*lineno with the number of lines read. Returns True if no extra
|
|
information line could be read. */
|
|
extern Bool VG_(get_line) ( Int fd, HChar** bufpp, SizeT* nBufp, Int* lineno );
|
|
|
|
|
|
/* ------------------------------------------------------------------ */
|
|
/* Suppressions describe errors which we want to suppress, ie, not
|
|
show the user, usually because it is caused by a problem in a library
|
|
which we can't fix, replace or work around. Suppressions are read from
|
|
a file at startup time. This gives flexibility so that new
|
|
suppressions can be added to the file as and when needed.
|
|
*/
|
|
typedef
|
|
Int /* Do not make this unsigned! */
|
|
SuppKind;
|
|
|
|
/* The tool-relevant parts of a suppression are:
|
|
kind: what kind of suppression; must be in the range (0..)
|
|
string: use is optional. NULL by default.
|
|
extra: use is optional. NULL by default. void* so it's extensible.
|
|
*/
|
|
typedef
|
|
struct _Supp
|
|
Supp;
|
|
|
|
/* Useful in VG_(tdict).tool_error_matches_suppression() */
|
|
SuppKind VG_(get_supp_kind) ( const Supp* su );
|
|
HChar* VG_(get_supp_string) ( const Supp* su );
|
|
void* VG_(get_supp_extra) ( const Supp* su );
|
|
|
|
/* Must be used in VG_(recognised_suppression)() */
|
|
void VG_(set_supp_kind) ( Supp* su, SuppKind suppkind );
|
|
/* May be used in VG_(read_extra_suppression_info)() */
|
|
void VG_(set_supp_string) ( Supp* su, HChar* string );
|
|
void VG_(set_supp_extra) ( Supp* su, void* extra );
|
|
|
|
|
|
#endif // __PUB_TOOL_ERRORMGR_H
|
|
|
|
/*--------------------------------------------------------------------*/
|
|
/*--- end ---*/
|
|
/*--------------------------------------------------------------------*/
|