The R Project SVN
R
(root)/trunk/src/include/memcheck.h @ 42110 – Rev
Blame | Last modification | View Log | Download | RSS feed
/*----------------------------------------------------------------Notice that the following BSD-style license applies to this onefile (memcheck.h) only. The entire rest of Valgrind is licensedunder the terms of the GNU General Public License, version 2. Seethe COPYING file in the source distribution for details.----------------------------------------------------------------This file is part of MemCheck, a heavyweight Valgrind tool fordetecting memory errors.Copyright (C) 2000-2005 Julian Seward. All rights reserved.Redistribution and use in source and binary forms, with or withoutmodification, are permitted provided that the following conditionsare met:1. Redistributions of source code must retain the above copyrightnotice, this list of conditions and the following disclaimer.2. The origin of this software must not be misrepresented; you mustnot claim that you wrote the original software. If you use thissoftware in a product, an acknowledgment in the productdocumentation would be appreciated but is not required.3. Altered source versions must be plainly marked as such, and mustnot be misrepresented as being the original software.4. The name of the author may not be used to endorse or promoteproducts derived from this software without specific prior writtenpermission.THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESSOR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSEARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANYDIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIALDAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTEGOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESSINTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDINGNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THISSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.----------------------------------------------------------------Notice that the above BSD-style license applies to this one file(memcheck.h) only. The entire rest of Valgrind is licensed underthe terms of the GNU General Public License, version 2. See theCOPYING file in the source distribution for details.----------------------------------------------------------------*/#ifndef __MEMCHECK_H#define __MEMCHECK_H/* This file is for inclusion into client (your!) code.You can use these macros to manipulate and query memory permissionsinside your own programs.See comment near the top of valgrind.h on how to use them.*/#include "valgrind.h"typedefenum {VG_USERREQ__MAKE_NOACCESS = VG_USERREQ_TOOL_BASE('M','C'),VG_USERREQ__MAKE_WRITABLE,VG_USERREQ__MAKE_READABLE,VG_USERREQ__DISCARD,VG_USERREQ__CHECK_WRITABLE,VG_USERREQ__CHECK_READABLE,VG_USERREQ__DO_LEAK_CHECK,VG_USERREQ__COUNT_LEAKS,/* These two have been moved into core, because they are useful forany tool that tracks heap blocks. Hence the suffix. But they'restill here for backwards compatibility, although Valgrind willabort with an explanatory message if you use them. */VG_USERREQ__MALLOCLIKE_BLOCK__OLD_DO_NOT_USE,VG_USERREQ__FREELIKE_BLOCK__OLD_DO_NOT_USE,VG_USERREQ__GET_VBITS,VG_USERREQ__SET_VBITS,VG_USERREQ__CREATE_BLOCK,/* This is just for memcheck's internal use - don't use it */_VG_USERREQ__MEMCHECK_RECORD_OVERLAP_ERROR= VG_USERREQ_TOOL_BASE('M','C') + 256} Vg_MemCheckClientRequest;/* Client-code macros to manipulate the state of memory. *//* Mark memory at _qzz_addr as unaddressible and undefined for_qzz_len bytes. */#define VALGRIND_MAKE_NOACCESS(_qzz_addr,_qzz_len) \(__extension__({unsigned int _qzz_res; \VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0 /* default return */, \VG_USERREQ__MAKE_NOACCESS, \_qzz_addr, _qzz_len, 0, 0); \_qzz_res; \}))/* Similarly, mark memory at _qzz_addr as addressible but undefinedfor _qzz_len bytes. */#define VALGRIND_MAKE_WRITABLE(_qzz_addr,_qzz_len) \(__extension__({unsigned int _qzz_res; \VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0 /* default return */, \VG_USERREQ__MAKE_WRITABLE, \_qzz_addr, _qzz_len, 0, 0); \_qzz_res; \}))/* Similarly, mark memory at _qzz_addr as addressible and definedfor _qzz_len bytes. */#define VALGRIND_MAKE_READABLE(_qzz_addr,_qzz_len) \(__extension__({unsigned int _qzz_res; \VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0 /* default return */, \VG_USERREQ__MAKE_READABLE, \_qzz_addr, _qzz_len, 0, 0); \_qzz_res; \}))/* Create a block-description handle. The description is an asciistring which is included in any messages pertaining to addresseswithin the specified memory range. Has no other effect on theproperties of the memory range. */#define VALGRIND_CREATE_BLOCK(_qzz_addr,_qzz_len, _qzz_desc) \(__extension__({unsigned int _qzz_res; \VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0 /* default return */, \VG_USERREQ__CREATE_BLOCK, \_qzz_addr, _qzz_len, _qzz_desc, 0); \_qzz_res; \}))/* Discard a block-description-handle. Returns 1 for aninvalid handle, 0 for a valid handle. */#define VALGRIND_DISCARD(_qzz_blkindex) \(__extension__ ({unsigned int _qzz_res; \VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0 /* default return */, \VG_USERREQ__DISCARD, \0, _qzz_blkindex, 0, 0); \_qzz_res; \}))/* Client-code macros to check the state of memory. *//* Check that memory at _qzz_addr is addressible for _qzz_len bytes.If suitable addressibility is not established, Valgrind prints anerror message and returns the address of the first offending byte.Otherwise it returns zero. */#define VALGRIND_CHECK_WRITABLE(_qzz_addr,_qzz_len) \(__extension__({unsigned int _qzz_res; \VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0, \VG_USERREQ__CHECK_WRITABLE, \_qzz_addr, _qzz_len, 0, 0); \_qzz_res; \}))/* Check that memory at _qzz_addr is addressible and defined for_qzz_len bytes. If suitable addressibility and definedness are notestablished, Valgrind prints an error message and returns theaddress of the first offending byte. Otherwise it returns zero. */#define VALGRIND_CHECK_READABLE(_qzz_addr,_qzz_len) \(__extension__({unsigned int _qzz_res; \VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0, \VG_USERREQ__CHECK_READABLE, \_qzz_addr, _qzz_len, 0, 0); \_qzz_res; \}))/* Use this macro to force the definedness and addressibility of avalue to be checked. If suitable addressibility and definednessare not established, Valgrind prints an error message and returnsthe address of the first offending byte. Otherwise it returnszero. */#define VALGRIND_CHECK_DEFINED(__lvalue) \VALGRIND_CHECK_READABLE( \(volatile unsigned char *)&(__lvalue), \(unsigned int)(sizeof (__lvalue)))/* Do a memory leak check mid-execution. */#define VALGRIND_DO_LEAK_CHECK \{unsigned int _qzz_res; \VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0, \VG_USERREQ__DO_LEAK_CHECK, \0, 0, 0, 0); \}/* Just display summaries of leaked memory, rather than all thedetails */#define VALGRIND_DO_QUICK_LEAK_CHECK \{unsigned int _qzz_res; \VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0, \VG_USERREQ__DO_LEAK_CHECK, \1, 0, 0, 0); \}/* Return number of leaked, dubious, reachable and suppressed bytes found byall previous leak checks. They must be lvalues. */#define VALGRIND_COUNT_LEAKS(leaked, dubious, reachable, suppressed) \{unsigned int _qzz_res; \VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0, \VG_USERREQ__COUNT_LEAKS, \&leaked, &dubious, &reachable, &suppressed);\}/* These two have been moved to valgrind.h; still here so that a warning canbe printed out for any programs using the old ones. */#define VALGRIND_MALLOCLIKE_BLOCK__OLD_DO_NOT_USE(addr, sizeB, rzB, is_zeroed)\{unsigned int _qzz_res; \VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0, \VG_USERREQ__MALLOCLIKE_BLOCK, \addr, sizeB, rzB, is_zeroed); \}#define VALGRIND_FREELIKE_BLOCK__OLD_DO_NOT_USE(addr, rzB) \{unsigned int _qzz_res; \VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0, \VG_USERREQ__FREELIKE_BLOCK, \addr, rzB, 0, 0); \}/* Get in zzvbits the validity data for the zznbytes starting atzzsrc. Return values:0 if not running on valgrind1 success2 if zzsrc/zzvbits arrays are not aligned 0 % 4, orzznbytes is not 0 % 4.3 if any parts of zzsrc/zzvbits are not addressible.The metadata is not copied in cases 0, 2 or 3 so it should beimpossible to segfault your system by using this call.*/#define VALGRIND_GET_VBITS(zzsrc,zzvbits,zznbytes) \(__extension__({unsigned int _qzz_res; \char* czzsrc = (char*)zzsrc; \char* czzvbits = (char*)zzvbits; \VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0, \VG_USERREQ__GET_VBITS, \czzsrc, czzvbits, zznbytes,0 ); \_qzz_res; \}))/* Apply the validity data in zzvbits to the zznbytes starting atzzdst. Return values:0 if not running on valgrind1 success2 if zzdst/zzvbits arrays are not aligned 0 % 4, orzznbytes is not 0 % 4.3 if any parts of zzdst/zzvbits are not addressible.The metadata is not copied in cases 0, 2 or 3 so it should beimpossible to segfault your system by using this call.*/#define VALGRIND_SET_VBITS(zzdst,zzvbits,zznbytes) \(__extension__({unsigned int _qzz_res; \char* czzdst = (char*)zzdst; \char* czzvbits = (char*)zzvbits; \VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0, \VG_USERREQ__SET_VBITS, \czzdst, czzvbits, zznbytes,0 ); \_qzz_res; \}))#endif