1ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 2ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* 3ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ---------------------------------------------------------------- 4ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 5ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Notice that the following BSD-style license applies to this one 6ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown file (memcheck.h) only. The rest of Valgrind is licensed under the 7ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown terms of the GNU General Public License, version 2, unless 8ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown otherwise indicated. See the COPYING file in the source 9ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown distribution for details. 10ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 11ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ---------------------------------------------------------------- 12ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 13ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This file is part of MemCheck, a heavyweight Valgrind tool for 14ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown detecting memory errors. 15ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 16ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Copyright (C) 2000-2010 Julian Seward. All rights reserved. 17ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 18ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Redistribution and use in source and binary forms, with or without 19ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown modification, are permitted provided that the following conditions 20ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown are met: 21ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 22ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 1. Redistributions of source code must retain the above copyright 23ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown notice, this list of conditions and the following disclaimer. 24ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 25ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 2. The origin of this software must not be misrepresented; you must 26ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown not claim that you wrote the original software. If you use this 27ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown software in a product, an acknowledgment in the product 28ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown documentation would be appreciated but is not required. 29ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 30ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 3. Altered source versions must be plainly marked as such, and must 31ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown not be misrepresented as being the original software. 32ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 33ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 4. The name of the author may not be used to endorse or promote 34ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown products derived from this software without specific prior written 35ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown permission. 36ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS 38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 40ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY 41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 42ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 44ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 46ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 49ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ---------------------------------------------------------------- 50ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 51ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Notice that the above BSD-style license applies to this one file 52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown (memcheck.h) only. The entire rest of Valgrind is licensed under 53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown the terms of the GNU General Public License, version 2. See the 54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown COPYING file in the source distribution for details. 55ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ---------------------------------------------------------------- 57ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/ 58ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 60ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#ifndef __MEMCHECK_H 61ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define __MEMCHECK_H 62ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 63ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 64ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* This file is for inclusion into client (your!) code. 65ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 66ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown You can use these macros to manipulate and query memory permissions 67ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown inside your own programs. 68ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 69ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown See comment near the top of valgrind.h on how to use them. 70ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/ 71ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "valgrind.h" 73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* !! ABIWARNING !! ABIWARNING !! ABIWARNING !! ABIWARNING !! 75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This enum comprises an ABI exported by Valgrind to programs 76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown which use client requests. DO NOT CHANGE THE ORDER OF THESE 77ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ENTRIES, NOR DELETE ANY -- add new ones at the end. */ 78ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef 79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown enum { 80ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__MAKE_MEM_NOACCESS = VG_USERREQ_TOOL_BASE('M','C'), 81ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__MAKE_MEM_UNDEFINED, 82ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__MAKE_MEM_DEFINED, 83ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__DISCARD, 84ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__CHECK_MEM_IS_ADDRESSABLE, 85ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__CHECK_MEM_IS_DEFINED, 86ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__DO_LEAK_CHECK, 87ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__COUNT_LEAKS, 88ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 89ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__GET_VBITS, 90ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__SET_VBITS, 91ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 92ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__CREATE_BLOCK, 93ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 94ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__MAKE_MEM_DEFINED_IF_ADDRESSABLE, 95ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 96ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Not next to VG_USERREQ__COUNT_LEAKS because it was added later. */ 97ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__COUNT_LEAK_BLOCKS, 98ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 99ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* This is just for memcheck's internal use - don't use it */ 100ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown _VG_USERREQ__MEMCHECK_RECORD_OVERLAP_ERROR 101ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown = VG_USERREQ_TOOL_BASE('M','C') + 256 102ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } Vg_MemCheckClientRequest; 103ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 104ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 105ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 106ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Client-code macros to manipulate the state of memory. */ 107ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 108ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Mark memory at _qzz_addr as unaddressable for _qzz_len bytes. */ 109ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VALGRIND_MAKE_MEM_NOACCESS(_qzz_addr,_qzz_len) \ 110ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VALGRIND_DO_CLIENT_REQUEST_EXPR(0 /* default return */, \ 111ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__MAKE_MEM_NOACCESS, \ 112ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown (_qzz_addr), (_qzz_len), 0, 0, 0) 113ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 114ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Similarly, mark memory at _qzz_addr as addressable but undefined 115ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown for _qzz_len bytes. */ 116ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VALGRIND_MAKE_MEM_UNDEFINED(_qzz_addr,_qzz_len) \ 117ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VALGRIND_DO_CLIENT_REQUEST_EXPR(0 /* default return */, \ 118ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__MAKE_MEM_UNDEFINED, \ 119ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown (_qzz_addr), (_qzz_len), 0, 0, 0) 120ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 121ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Similarly, mark memory at _qzz_addr as addressable and defined 122ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown for _qzz_len bytes. */ 123ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VALGRIND_MAKE_MEM_DEFINED(_qzz_addr,_qzz_len) \ 124ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VALGRIND_DO_CLIENT_REQUEST_EXPR(0 /* default return */, \ 125ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__MAKE_MEM_DEFINED, \ 126ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown (_qzz_addr), (_qzz_len), 0, 0, 0) 127ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 128ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Similar to VALGRIND_MAKE_MEM_DEFINED except that addressability is 129ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown not altered: bytes which are addressable are marked as defined, 130ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown but those which are not addressable are left unchanged. */ 131ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VALGRIND_MAKE_MEM_DEFINED_IF_ADDRESSABLE(_qzz_addr,_qzz_len) \ 132ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VALGRIND_DO_CLIENT_REQUEST_EXPR(0 /* default return */, \ 133ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__MAKE_MEM_DEFINED_IF_ADDRESSABLE, \ 134ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown (_qzz_addr), (_qzz_len), 0, 0, 0) 135ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 136ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Create a block-description handle. The description is an ascii 137ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown string which is included in any messages pertaining to addresses 138ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown within the specified memory range. Has no other effect on the 139ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown properties of the memory range. */ 140ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VALGRIND_CREATE_BLOCK(_qzz_addr,_qzz_len, _qzz_desc) \ 141ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VALGRIND_DO_CLIENT_REQUEST_EXPR(0 /* default return */, \ 142ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__CREATE_BLOCK, \ 143ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown (_qzz_addr), (_qzz_len), (_qzz_desc), \ 144ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 0, 0) 145ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 146ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Discard a block-description-handle. Returns 1 for an 147ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown invalid handle, 0 for a valid handle. */ 148ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VALGRIND_DISCARD(_qzz_blkindex) \ 149ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VALGRIND_DO_CLIENT_REQUEST_EXPR(0 /* default return */, \ 150ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__DISCARD, \ 151ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 0, (_qzz_blkindex), 0, 0, 0) 152ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 153ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 154ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Client-code macros to check the state of memory. */ 155ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 156ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Check that memory at _qzz_addr is addressable for _qzz_len bytes. 157ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown If suitable addressibility is not established, Valgrind prints an 158ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown error message and returns the address of the first offending byte. 159ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Otherwise it returns zero. */ 160ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VALGRIND_CHECK_MEM_IS_ADDRESSABLE(_qzz_addr,_qzz_len) \ 161ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VALGRIND_DO_CLIENT_REQUEST_EXPR(0, \ 162ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__CHECK_MEM_IS_ADDRESSABLE, \ 163ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown (_qzz_addr), (_qzz_len), 0, 0, 0) 164ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 165ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Check that memory at _qzz_addr is addressable and defined for 166ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown _qzz_len bytes. If suitable addressibility and definedness are not 167ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown established, Valgrind prints an error message and returns the 168ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown address of the first offending byte. Otherwise it returns zero. */ 169ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VALGRIND_CHECK_MEM_IS_DEFINED(_qzz_addr,_qzz_len) \ 170ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VALGRIND_DO_CLIENT_REQUEST_EXPR(0, \ 171ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__CHECK_MEM_IS_DEFINED, \ 172f673d1bf8bfb172f0eccbe4d3a908b3c65b55b33Kenny Root (_qzz_addr), (_qzz_len), 0, 0, 0) 173ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 174ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Use this macro to force the definedness and addressibility of an 175ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown lvalue to be checked. If suitable addressibility and definedness 176ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown are not established, Valgrind prints an error message and returns 177ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown the address of the first offending byte. Otherwise it returns 178ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown zero. */ 179ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VALGRIND_CHECK_VALUE_IS_DEFINED(__lvalue) \ 180ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VALGRIND_CHECK_MEM_IS_DEFINED( \ 181ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown (volatile unsigned char *)&(__lvalue), \ 182ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown (unsigned long)(sizeof (__lvalue))) 183ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 184ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 185ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Do a full memory leak check (like --leak-check=full) mid-execution. */ 186ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VALGRIND_DO_LEAK_CHECK \ 187ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown {unsigned long _qzz_res; \ 188ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VALGRIND_DO_CLIENT_REQUEST(_qzz_res, 0, \ 189ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__DO_LEAK_CHECK, \ 190ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 0, 0, 0, 0, 0); \ 191ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 192ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 193ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Do a summary memory leak check (like --leak-check=summary) mid-execution. */ 194ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VALGRIND_DO_QUICK_LEAK_CHECK \ 195ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown {unsigned long _qzz_res; \ 196ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VALGRIND_DO_CLIENT_REQUEST(_qzz_res, 0, \ 197ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__DO_LEAK_CHECK, \ 198ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 1, 0, 0, 0, 0); \ 199ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 200ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 201ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Return number of leaked, dubious, reachable and suppressed bytes found by 202ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown all previous leak checks. They must be lvalues. */ 203ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VALGRIND_COUNT_LEAKS(leaked, dubious, reachable, suppressed) \ 204ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* For safety on 64-bit platforms we assign the results to private 205ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown unsigned long variables, then assign these to the lvalues the user 206ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown specified, which works no matter what type 'leaked', 'dubious', etc 207ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown are. We also initialise '_qzz_leaked', etc because 208ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__COUNT_LEAKS doesn't mark the values returned as 209ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown defined. */ \ 210ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown {unsigned long _qzz_res; \ 211ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown unsigned long _qzz_leaked = 0, _qzz_dubious = 0; \ 212ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown unsigned long _qzz_reachable = 0, _qzz_suppressed = 0; \ 213ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VALGRIND_DO_CLIENT_REQUEST(_qzz_res, 0, \ 214ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__COUNT_LEAKS, \ 215ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown &_qzz_leaked, &_qzz_dubious, \ 216ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown &_qzz_reachable, &_qzz_suppressed, 0); \ 217ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown leaked = _qzz_leaked; \ 218ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown dubious = _qzz_dubious; \ 219ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown reachable = _qzz_reachable; \ 220ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown suppressed = _qzz_suppressed; \ 221ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 222ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 223ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Return number of leaked, dubious, reachable and suppressed bytes found by 224ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown all previous leak checks. They must be lvalues. */ 225ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VALGRIND_COUNT_LEAK_BLOCKS(leaked, dubious, reachable, suppressed) \ 226ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* For safety on 64-bit platforms we assign the results to private 227ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown unsigned long variables, then assign these to the lvalues the user 228ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown specified, which works no matter what type 'leaked', 'dubious', etc 229ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown are. We also initialise '_qzz_leaked', etc because 230ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__COUNT_LEAKS doesn't mark the values returned as 231ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown defined. */ \ 232ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown {unsigned long _qzz_res; \ 233ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown unsigned long _qzz_leaked = 0, _qzz_dubious = 0; \ 234ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown unsigned long _qzz_reachable = 0, _qzz_suppressed = 0; \ 235ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VALGRIND_DO_CLIENT_REQUEST(_qzz_res, 0, \ 236ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__COUNT_LEAK_BLOCKS, \ 237ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown &_qzz_leaked, &_qzz_dubious, \ 238ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown &_qzz_reachable, &_qzz_suppressed, 0); \ 239ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown leaked = _qzz_leaked; \ 240ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown dubious = _qzz_dubious; \ 241ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown reachable = _qzz_reachable; \ 242ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown suppressed = _qzz_suppressed; \ 243ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 244ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 245ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 246ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Get the validity data for addresses [zza..zza+zznbytes-1] and copy it 247ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown into the provided zzvbits array. Return values: 248ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 0 if not running on valgrind 249ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 1 success 250ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 2 [previously indicated unaligned arrays; these are now allowed] 251ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 3 if any parts of zzsrc/zzvbits are not addressable. 252ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown The metadata is not copied in cases 0, 2 or 3 so it should be 253ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown impossible to segfault your system by using this call. 254ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/ 255ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VALGRIND_GET_VBITS(zza,zzvbits,zznbytes) \ 256ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VALGRIND_DO_CLIENT_REQUEST_EXPR(0, \ 257ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__GET_VBITS, \ 258ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown (char*)(zza), (char*)(zzvbits), \ 259ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown (zznbytes), 0, 0) 260ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 261ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Set the validity data for addresses [zza..zza+zznbytes-1], copying it 262ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown from the provided zzvbits array. Return values: 263ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 0 if not running on valgrind 264ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 1 success 265ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 2 [previously indicated unaligned arrays; these are now allowed] 266ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 3 if any parts of zza/zzvbits are not addressable. 267ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown The metadata is not copied in cases 0, 2 or 3 so it should be 268ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown impossible to segfault your system by using this call. 269ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/ 270ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VALGRIND_SET_VBITS(zza,zzvbits,zznbytes) \ 271ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VALGRIND_DO_CLIENT_REQUEST_EXPR(0, \ 272ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_USERREQ__SET_VBITS, \ 273ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown (char*)(zza), (char*)(zzvbits), \ 274ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown (zznbytes), 0, 0 ) 275ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 276ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif 277ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 278