sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1 | |
| 2 | /* |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 3 | ---------------------------------------------------------------- |
| 4 | |
| 5 | Notice that the following BSD-style license applies to this one |
| 6 | file (valgrind.h) only. The entire rest of Valgrind is licensed |
| 7 | under the terms of the GNU General Public License, version 2. See |
| 8 | the COPYING file in the source distribution for details. |
| 9 | |
| 10 | ---------------------------------------------------------------- |
| 11 | |
njn | c953984 | 2002-10-02 13:26:35 +0000 | [diff] [blame] | 12 | This file is part of Valgrind, an extensible x86 protected-mode |
| 13 | emulator for monitoring program execution on x86-Unixes. |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 14 | |
nethercote | bb1c991 | 2004-01-04 16:43:23 +0000 | [diff] [blame] | 15 | Copyright (C) 2000-2004 Julian Seward. All rights reserved. |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 16 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 17 | Redistribution and use in source and binary forms, with or without |
| 18 | modification, are permitted provided that the following conditions |
| 19 | are met: |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 20 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 21 | 1. Redistributions of source code must retain the above copyright |
| 22 | notice, this list of conditions and the following disclaimer. |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 23 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 24 | 2. The origin of this software must not be misrepresented; you must |
| 25 | not claim that you wrote the original software. If you use this |
| 26 | software in a product, an acknowledgment in the product |
| 27 | documentation would be appreciated but is not required. |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 28 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 29 | 3. Altered source versions must be plainly marked as such, and must |
| 30 | not be misrepresented as being the original software. |
| 31 | |
| 32 | 4. The name of the author may not be used to endorse or promote |
| 33 | products derived from this software without specific prior written |
| 34 | permission. |
| 35 | |
| 36 | THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS |
| 37 | OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| 38 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 39 | ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY |
| 40 | DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 41 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE |
| 42 | GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 43 | INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |
| 44 | WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING |
| 45 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
| 46 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 47 | |
| 48 | ---------------------------------------------------------------- |
| 49 | |
| 50 | Notice that the above BSD-style license applies to this one file |
| 51 | (valgrind.h) only. The entire rest of Valgrind is licensed under |
| 52 | the terms of the GNU General Public License, version 2. See the |
| 53 | COPYING file in the source distribution for details. |
| 54 | |
| 55 | ---------------------------------------------------------------- |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 56 | */ |
| 57 | |
| 58 | |
| 59 | #ifndef __VALGRIND_H |
| 60 | #define __VALGRIND_H |
| 61 | |
fitzhardinge | 39de4b4 | 2003-10-31 07:12:21 +0000 | [diff] [blame] | 62 | #include <stdarg.h> |
| 63 | |
nethercote | b2decc3 | 2004-10-25 19:33:26 +0000 | [diff] [blame] | 64 | #undef __@VG_ARCH@__ |
| 65 | #define __@VG_ARCH@__ 1 // Architecture we're installed on |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 66 | |
| 67 | /* This file is for inclusion into client (your!) code. |
| 68 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 69 | You can use these macros to manipulate and query Valgrind's |
| 70 | execution inside your own programs. |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 71 | |
| 72 | The resulting executables will still run without Valgrind, just a |
| 73 | little bit more slowly than they otherwise would, but otherwise |
sewardj | 285f77f | 2003-03-15 23:39:11 +0000 | [diff] [blame] | 74 | unchanged. When not running on valgrind, each client request |
nethercote | e90c683 | 2004-10-18 18:07:49 +0000 | [diff] [blame] | 75 | consumes very few (eg. < 10) instructions, so the resulting performance |
sewardj | 285f77f | 2003-03-15 23:39:11 +0000 | [diff] [blame] | 76 | loss is negligible unless you plan to execute client requests |
| 77 | millions of times per second. Nevertheless, if that is still a |
| 78 | problem, you can compile with the NVALGRIND symbol defined (gcc |
| 79 | -DNVALGRIND) so that client requests are not even compiled in. */ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 80 | |
sewardj | 37091fb | 2002-11-16 11:06:50 +0000 | [diff] [blame] | 81 | #ifndef NVALGRIND |
nethercote | e90c683 | 2004-10-18 18:07:49 +0000 | [diff] [blame] | 82 | |
nethercote | 5426544 | 2004-10-26 12:56:58 +0000 | [diff] [blame^] | 83 | /* The following defines the magic code sequences which the JITter spots and |
| 84 | handles magically. Don't look too closely at them; they will rot |
nethercote | e90c683 | 2004-10-18 18:07:49 +0000 | [diff] [blame] | 85 | your brain. We must ensure that the default value gets put in the return |
| 86 | slot, so that everything works when this is executed not under Valgrind. |
| 87 | Args are passed in a memory block, and so there's no intrinsic limit to |
| 88 | the number that could be passed, but it's currently four. |
| 89 | |
nethercote | 5426544 | 2004-10-26 12:56:58 +0000 | [diff] [blame^] | 90 | The macro args are: |
| 91 | _zzq_rlval result lvalue |
| 92 | _zzq_default default value (result returned when running on real CPU) |
| 93 | _zzq_request request code |
| 94 | _zzq_arg1..4 request params |
| 95 | |
nethercote | e90c683 | 2004-10-18 18:07:49 +0000 | [diff] [blame] | 96 | Nb: we put the assembly code sequences for all architectures in this one |
| 97 | file. This is because this file must be stand-alone, so we can't rely on |
| 98 | eg. x86/ subdirectories like we do within the rest of Valgrind. |
| 99 | */ |
| 100 | |
| 101 | #ifdef __x86__ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 102 | #define VALGRIND_MAGIC_SEQUENCE( \ |
nethercote | 5426544 | 2004-10-26 12:56:58 +0000 | [diff] [blame^] | 103 | _zzq_rlval, _zzq_default, _zzq_request, \ |
| 104 | _zzq_arg1, _zzq_arg2, _zzq_arg3, _zzq_arg4) \ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 105 | \ |
| 106 | { volatile unsigned int _zzq_args[5]; \ |
sewardj | 18d7513 | 2002-05-16 11:06:21 +0000 | [diff] [blame] | 107 | _zzq_args[0] = (volatile unsigned int)(_zzq_request); \ |
| 108 | _zzq_args[1] = (volatile unsigned int)(_zzq_arg1); \ |
| 109 | _zzq_args[2] = (volatile unsigned int)(_zzq_arg2); \ |
| 110 | _zzq_args[3] = (volatile unsigned int)(_zzq_arg3); \ |
| 111 | _zzq_args[4] = (volatile unsigned int)(_zzq_arg4); \ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 112 | asm volatile("movl %1, %%eax\n\t" \ |
| 113 | "movl %2, %%edx\n\t" \ |
| 114 | "roll $29, %%eax ; roll $3, %%eax\n\t" \ |
| 115 | "rorl $27, %%eax ; rorl $5, %%eax\n\t" \ |
| 116 | "roll $13, %%eax ; roll $19, %%eax\n\t" \ |
| 117 | "movl %%edx, %0\t" \ |
| 118 | : "=r" (_zzq_rlval) \ |
| 119 | : "r" (&_zzq_args[0]), "r" (_zzq_default) \ |
| 120 | : "eax", "edx", "cc", "memory" \ |
| 121 | ); \ |
| 122 | } |
nethercote | e90c683 | 2004-10-18 18:07:49 +0000 | [diff] [blame] | 123 | #endif // __x86__ |
| 124 | |
| 125 | // Insert assembly code for other architectures here... |
| 126 | |
sewardj | 37091fb | 2002-11-16 11:06:50 +0000 | [diff] [blame] | 127 | #else /* NVALGRIND */ |
| 128 | /* Define NVALGRIND to completely remove the Valgrind magic sequence |
| 129 | from the compiled code (analogous to NDEBUG's effects on |
| 130 | assert()) */ |
| 131 | #define VALGRIND_MAGIC_SEQUENCE( \ |
| 132 | _zzq_rlval, /* result lvalue */ \ |
| 133 | _zzq_default, /* result returned when running on real CPU */ \ |
| 134 | _zzq_request, /* request code */ \ |
| 135 | _zzq_arg1, /* request first param */ \ |
| 136 | _zzq_arg2, /* request second param */ \ |
| 137 | _zzq_arg3, /* request third param */ \ |
| 138 | _zzq_arg4 /* request fourth param */ ) \ |
| 139 | { \ |
| 140 | (_zzq_rlval) = (_zzq_default); \ |
| 141 | } |
| 142 | #endif /* NVALGRIND */ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 143 | |
| 144 | /* Some request codes. There are many more of these, but most are not |
| 145 | exposed to end-user view. These are the public ones, all of the |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 146 | form 0x1000 + small_number. |
njn | d799418 | 2003-10-02 13:44:04 +0000 | [diff] [blame] | 147 | |
| 148 | Core ones are in the range 0x00000000--0x0000ffff. The non-public ones |
| 149 | start at 0x2000. |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 150 | */ |
| 151 | |
njn | 4c79121 | 2003-05-02 17:53:54 +0000 | [diff] [blame] | 152 | #define VG_USERREQ_SKIN_BASE(a,b) \ |
| 153 | ((unsigned int)(((a)&0xff) << 24 | ((b)&0xff) << 16)) |
| 154 | #define VG_IS_SKIN_USERREQ(a, b, v) \ |
| 155 | (VG_USERREQ_SKIN_BASE(a,b) == ((v) & 0xffff0000)) |
sewardj | 3404251 | 2002-10-22 04:14:35 +0000 | [diff] [blame] | 156 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 157 | typedef |
njn | 4c79121 | 2003-05-02 17:53:54 +0000 | [diff] [blame] | 158 | enum { VG_USERREQ__RUNNING_ON_VALGRIND = 0x1001, |
| 159 | VG_USERREQ__DISCARD_TRANSLATIONS = 0x1002, |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 160 | |
| 161 | /* These allow any function of 0--3 args to be called from the |
| 162 | simulated CPU but run on the real CPU */ |
njn | 4c79121 | 2003-05-02 17:53:54 +0000 | [diff] [blame] | 163 | VG_USERREQ__CLIENT_CALL0 = 0x1101, |
| 164 | VG_USERREQ__CLIENT_CALL1 = 0x1102, |
| 165 | VG_USERREQ__CLIENT_CALL2 = 0x1103, |
| 166 | VG_USERREQ__CLIENT_CALL3 = 0x1104, |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 167 | |
njn | 47363ab | 2003-04-21 13:24:40 +0000 | [diff] [blame] | 168 | /* Can be useful in regression testing suites -- eg. can send |
| 169 | Valgrind's output to /dev/null and still count errors. */ |
njn | 4c79121 | 2003-05-02 17:53:54 +0000 | [diff] [blame] | 170 | VG_USERREQ__COUNT_ERRORS = 0x1201, |
njn | 47363ab | 2003-04-21 13:24:40 +0000 | [diff] [blame] | 171 | |
nethercote | 7cc9c23 | 2004-01-21 15:08:04 +0000 | [diff] [blame] | 172 | /* These are useful and can be interpreted by any tool that tracks |
njn | d799418 | 2003-10-02 13:44:04 +0000 | [diff] [blame] | 173 | malloc() et al, by using vg_replace_malloc.c. */ |
| 174 | VG_USERREQ__MALLOCLIKE_BLOCK = 0x1301, |
| 175 | VG_USERREQ__FREELIKE_BLOCK = 0x1302, |
rjwalsh | bc0bb83 | 2004-06-19 18:12:36 +0000 | [diff] [blame] | 176 | /* Memory pool support. */ |
| 177 | VG_USERREQ__CREATE_MEMPOOL = 0x1303, |
| 178 | VG_USERREQ__DESTROY_MEMPOOL = 0x1304, |
| 179 | VG_USERREQ__MEMPOOL_ALLOC = 0x1305, |
| 180 | VG_USERREQ__MEMPOOL_FREE = 0x1306, |
njn | d799418 | 2003-10-02 13:44:04 +0000 | [diff] [blame] | 181 | |
fitzhardinge | 39de4b4 | 2003-10-31 07:12:21 +0000 | [diff] [blame] | 182 | /* Allow printfs to valgrind log. */ |
| 183 | VG_USERREQ__PRINTF = 0x1401, |
thughes | 85c8a50 | 2004-08-25 13:25:30 +0000 | [diff] [blame] | 184 | VG_USERREQ__PRINTF_BACKTRACE = 0x1402 |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 185 | } Vg_ClientRequest; |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 186 | |
mueller | c9b3655 | 2003-12-31 14:32:23 +0000 | [diff] [blame] | 187 | #ifndef __GNUC__ |
| 188 | #define __extension__ |
| 189 | #endif |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 190 | |
| 191 | /* Returns 1 if running on Valgrind, 0 if running on the real CPU. |
| 192 | Currently implemented but untested. */ |
mueller | c9b3655 | 2003-12-31 14:32:23 +0000 | [diff] [blame] | 193 | #define RUNNING_ON_VALGRIND __extension__ \ |
sewardj | 2e93c50 | 2002-04-12 11:12:52 +0000 | [diff] [blame] | 194 | ({unsigned int _qzz_res; \ |
| 195 | VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0 /* returned if not */, \ |
| 196 | VG_USERREQ__RUNNING_ON_VALGRIND, \ |
| 197 | 0, 0, 0, 0); \ |
| 198 | _qzz_res; \ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 199 | }) |
| 200 | |
| 201 | |
sewardj | 18d7513 | 2002-05-16 11:06:21 +0000 | [diff] [blame] | 202 | /* Discard translation of code in the range [_qzz_addr .. _qzz_addr + |
| 203 | _qzz_len - 1]. Useful if you are debugging a JITter or some such, |
| 204 | since it provides a way to make sure valgrind will retranslate the |
| 205 | invalidated area. Returns no value. */ |
| 206 | #define VALGRIND_DISCARD_TRANSLATIONS(_qzz_addr,_qzz_len) \ |
| 207 | {unsigned int _qzz_res; \ |
| 208 | VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0, \ |
| 209 | VG_USERREQ__DISCARD_TRANSLATIONS, \ |
| 210 | _qzz_addr, _qzz_len, 0, 0); \ |
| 211 | } |
| 212 | |
fitzhardinge | 39de4b4 | 2003-10-31 07:12:21 +0000 | [diff] [blame] | 213 | #ifndef NVALGRIND |
| 214 | |
fitzhardinge | a09a1b5 | 2003-11-07 23:09:48 +0000 | [diff] [blame] | 215 | int VALGRIND_PRINTF(const char *format, ...) |
| 216 | __attribute__((format(__printf__, 1, 2))); |
fitzhardinge | 39de4b4 | 2003-10-31 07:12:21 +0000 | [diff] [blame] | 217 | __attribute__((weak)) |
| 218 | int |
fitzhardinge | a09a1b5 | 2003-11-07 23:09:48 +0000 | [diff] [blame] | 219 | VALGRIND_PRINTF(const char *format, ...) |
fitzhardinge | 39de4b4 | 2003-10-31 07:12:21 +0000 | [diff] [blame] | 220 | { |
| 221 | unsigned int _qzz_res; |
| 222 | va_list vargs; |
| 223 | va_start(vargs, format); |
| 224 | VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0, VG_USERREQ__PRINTF, |
| 225 | (unsigned int)format, (unsigned int)vargs, 0, 0); |
| 226 | va_end(vargs); |
| 227 | return _qzz_res; |
| 228 | } |
| 229 | |
fitzhardinge | a09a1b5 | 2003-11-07 23:09:48 +0000 | [diff] [blame] | 230 | int VALGRIND_PRINTF_BACKTRACE(const char *format, ...) |
| 231 | __attribute__((format(__printf__, 1, 2))); |
fitzhardinge | 39de4b4 | 2003-10-31 07:12:21 +0000 | [diff] [blame] | 232 | __attribute__((weak)) |
| 233 | int |
fitzhardinge | a09a1b5 | 2003-11-07 23:09:48 +0000 | [diff] [blame] | 234 | VALGRIND_PRINTF_BACKTRACE(const char *format, ...) |
fitzhardinge | 39de4b4 | 2003-10-31 07:12:21 +0000 | [diff] [blame] | 235 | { |
| 236 | unsigned int _qzz_res; |
| 237 | va_list vargs; |
| 238 | va_start(vargs, format); |
| 239 | VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0, VG_USERREQ__PRINTF_BACKTRACE, |
| 240 | (unsigned int)format, (unsigned int)vargs, 0, 0); |
| 241 | va_end(vargs); |
| 242 | return _qzz_res; |
| 243 | } |
| 244 | |
| 245 | #else /* NVALGRIND */ |
| 246 | |
| 247 | #define VALGRIND_PRINTF(...) |
| 248 | #define VALGRIND_PRINTF_BACKTRACE(...) |
| 249 | |
| 250 | #endif /* NVALGRIND */ |
sewardj | 18d7513 | 2002-05-16 11:06:21 +0000 | [diff] [blame] | 251 | |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 252 | /* These requests allow control to move from the simulated CPU to the |
| 253 | real CPU, calling an arbitary function */ |
njn | 057c65f | 2003-04-21 13:30:55 +0000 | [diff] [blame] | 254 | #define VALGRIND_NON_SIMD_CALL0(_qyy_fn) \ |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 255 | ({unsigned int _qyy_res; \ |
| 256 | VALGRIND_MAGIC_SEQUENCE(_qyy_res, 0 /* default return */, \ |
| 257 | VG_USERREQ__CLIENT_CALL0, \ |
| 258 | _qyy_fn, \ |
| 259 | 0, 0, 0); \ |
| 260 | _qyy_res; \ |
| 261 | }) |
| 262 | |
njn | 057c65f | 2003-04-21 13:30:55 +0000 | [diff] [blame] | 263 | #define VALGRIND_NON_SIMD_CALL1(_qyy_fn, _qyy_arg1) \ |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 264 | ({unsigned int _qyy_res; \ |
| 265 | VALGRIND_MAGIC_SEQUENCE(_qyy_res, 0 /* default return */, \ |
| 266 | VG_USERREQ__CLIENT_CALL1, \ |
| 267 | _qyy_fn, \ |
| 268 | _qyy_arg1, 0, 0); \ |
| 269 | _qyy_res; \ |
| 270 | }) |
| 271 | |
njn | 057c65f | 2003-04-21 13:30:55 +0000 | [diff] [blame] | 272 | #define VALGRIND_NON_SIMD_CALL2(_qyy_fn, _qyy_arg1, _qyy_arg2) \ |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 273 | ({unsigned int _qyy_res; \ |
| 274 | VALGRIND_MAGIC_SEQUENCE(_qyy_res, 0 /* default return */, \ |
| 275 | VG_USERREQ__CLIENT_CALL2, \ |
| 276 | _qyy_fn, \ |
| 277 | _qyy_arg1, _qyy_arg2, 0); \ |
| 278 | _qyy_res; \ |
| 279 | }) |
| 280 | |
njn | 057c65f | 2003-04-21 13:30:55 +0000 | [diff] [blame] | 281 | #define VALGRIND_NON_SIMD_CALL3(_qyy_fn, _qyy_arg1, _qyy_arg2, _qyy_arg3) \ |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 282 | ({unsigned int _qyy_res; \ |
| 283 | VALGRIND_MAGIC_SEQUENCE(_qyy_res, 0 /* default return */, \ |
| 284 | VG_USERREQ__CLIENT_CALL3, \ |
| 285 | _qyy_fn, \ |
| 286 | _qyy_arg1, _qyy_arg2, _qyy_arg3); \ |
| 287 | _qyy_res; \ |
| 288 | }) |
| 289 | |
| 290 | |
nethercote | 7cc9c23 | 2004-01-21 15:08:04 +0000 | [diff] [blame] | 291 | /* Counts the number of errors that have been recorded by a tool. Nb: |
| 292 | the tool must record the errors with VG_(maybe_record_error)() or |
njn | 47363ab | 2003-04-21 13:24:40 +0000 | [diff] [blame] | 293 | VG_(unique_error)() for them to be counted. */ |
| 294 | #define VALGRIND_COUNT_ERRORS \ |
| 295 | ({unsigned int _qyy_res; \ |
| 296 | VALGRIND_MAGIC_SEQUENCE(_qyy_res, 0 /* default return */, \ |
| 297 | VG_USERREQ__COUNT_ERRORS, \ |
| 298 | 0, 0, 0, 0); \ |
| 299 | _qyy_res; \ |
| 300 | }) |
| 301 | |
njn | d799418 | 2003-10-02 13:44:04 +0000 | [diff] [blame] | 302 | /* Mark a block of memory as having been allocated by a malloc()-like |
| 303 | function. `addr' is the start of the usable block (ie. after any |
| 304 | redzone) `rzB' is redzone size if the allocator can apply redzones; |
| 305 | use '0' if not. Adding redzones makes it more likely Valgrind will spot |
| 306 | block overruns. `is_zeroed' indicates if the memory is zeroed, as it is |
| 307 | for calloc(). Put it immediately after the point where a block is |
| 308 | allocated. |
| 309 | |
| 310 | If you're allocating memory via superblocks, and then handing out small |
| 311 | chunks of each superblock, if you don't have redzones on your small |
| 312 | blocks, it's worth marking the superblock with VALGRIND_MAKE_NOACCESS |
| 313 | when it's created, so that block overruns are detected. But if you can |
| 314 | put redzones on, it's probably better to not do this, so that messages |
| 315 | for small overruns are described in terms of the small block rather than |
| 316 | the superblock (but if you have a big overrun that skips over a redzone, |
| 317 | you could miss an error this way). See memcheck/tests/custom_alloc.c |
| 318 | for an example. |
| 319 | |
| 320 | Nb: block must be freed via a free()-like function specified |
| 321 | with VALGRIND_FREELIKE_BLOCK or mismatch errors will occur. */ |
| 322 | #define VALGRIND_MALLOCLIKE_BLOCK(addr, sizeB, rzB, is_zeroed) \ |
| 323 | {unsigned int _qzz_res; \ |
| 324 | VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0, \ |
| 325 | VG_USERREQ__MALLOCLIKE_BLOCK, \ |
| 326 | addr, sizeB, rzB, is_zeroed); \ |
| 327 | } |
| 328 | |
| 329 | /* Mark a block of memory as having been freed by a free()-like function. |
| 330 | `rzB' is redzone size; it must match that given to |
| 331 | VALGRIND_MALLOCLIKE_BLOCK. Memory not freed will be detected by the leak |
| 332 | checker. Put it immediately after the point where the block is freed. */ |
| 333 | #define VALGRIND_FREELIKE_BLOCK(addr, rzB) \ |
| 334 | {unsigned int _qzz_res; \ |
| 335 | VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0, \ |
| 336 | VG_USERREQ__FREELIKE_BLOCK, \ |
| 337 | addr, rzB, 0, 0); \ |
| 338 | } |
| 339 | |
rjwalsh | bc0bb83 | 2004-06-19 18:12:36 +0000 | [diff] [blame] | 340 | /* Create a memory pool. */ |
| 341 | #define VALGRIND_CREATE_MEMPOOL(pool, rzB, is_zeroed) \ |
| 342 | {unsigned int _qzz_res; \ |
| 343 | VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0, \ |
| 344 | VG_USERREQ__CREATE_MEMPOOL, \ |
| 345 | pool, rzB, is_zeroed, 0); \ |
| 346 | } |
| 347 | |
| 348 | /* Destroy a memory pool. */ |
| 349 | #define VALGRIND_DESTROY_MEMPOOL(pool) \ |
| 350 | {unsigned int _qzz_res; \ |
| 351 | VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0, \ |
| 352 | VG_USERREQ__DESTROY_MEMPOOL, \ |
| 353 | pool, 0, 0, 0); \ |
| 354 | } |
| 355 | |
| 356 | /* Associate a piece of memory with a memory pool. */ |
| 357 | #define VALGRIND_MEMPOOL_ALLOC(pool, addr, size) \ |
| 358 | {unsigned int _qzz_res; \ |
| 359 | VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0, \ |
| 360 | VG_USERREQ__MEMPOOL_ALLOC, \ |
| 361 | pool, addr, size, 0); \ |
| 362 | } |
| 363 | |
| 364 | /* Disassociate a piece of memory from a memory pool. */ |
| 365 | #define VALGRIND_MEMPOOL_FREE(pool, addr) \ |
| 366 | {unsigned int _qzz_res; \ |
| 367 | VALGRIND_MAGIC_SEQUENCE(_qzz_res, 0, \ |
| 368 | VG_USERREQ__MEMPOOL_FREE, \ |
| 369 | pool, addr, 0, 0); \ |
| 370 | } |
| 371 | |
njn | 3e88418 | 2003-04-15 13:03:23 +0000 | [diff] [blame] | 372 | #endif /* __VALGRIND_H */ |