memcheck/memcheck.h

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