blob: 5f21aabcb7a23c34c940e84c7dd6dfef9aab23f4 [file] [log] [blame]
bart922304f2011-03-13 12:02:44 +00001/* -*- mode: C; c-basic-offset: 3; indent-tabs-mode: nil; -*- */
bart3c1e9d82008-06-30 17:10:29 +00002
3/*
bartbedfd232009-03-26 19:07:15 +00004 ----------------------------------------------------------------
bart3c1e9d82008-06-30 17:10:29 +00005
bartbedfd232009-03-26 19:07:15 +00006 Notice that the following BSD-style license applies to this one
7 file (drd.h) only. The rest of Valgrind is licensed under the
8 terms of the GNU General Public License, version 2, unless
9 otherwise indicated. See the COPYING file in the source
10 distribution for details.
bart3c1e9d82008-06-30 17:10:29 +000011
bartbedfd232009-03-26 19:07:15 +000012 ----------------------------------------------------------------
bart3c1e9d82008-06-30 17:10:29 +000013
bartd45d9952009-05-31 18:53:54 +000014 This file is part of DRD, a Valgrind tool for verification of
bartbedfd232009-03-26 19:07:15 +000015 multithreaded programs.
bart3c1e9d82008-06-30 17:10:29 +000016
bart922304f2011-03-13 12:02:44 +000017 Copyright (C) 2006-2011 Bart Van Assche <bvanassche@acm.org>.
bartbedfd232009-03-26 19:07:15 +000018 All rights reserved.
bart3c1e9d82008-06-30 17:10:29 +000019
bartbedfd232009-03-26 19:07:15 +000020 Redistribution and use in source and binary forms, with or without
21 modification, are permitted provided that the following conditions
22 are met:
bart3c1e9d82008-06-30 17:10:29 +000023
bartbedfd232009-03-26 19:07:15 +000024 1. Redistributions of source code must retain the above copyright
25 notice, this list of conditions and the following disclaimer.
bart3c1e9d82008-06-30 17:10:29 +000026
bartbedfd232009-03-26 19:07:15 +000027 2. The origin of this software must not be misrepresented; you must
28 not claim that you wrote the original software. If you use this
29 software in a product, an acknowledgment in the product
30 documentation would be appreciated but is not required.
bart3c1e9d82008-06-30 17:10:29 +000031
bartbedfd232009-03-26 19:07:15 +000032 3. Altered source versions must be plainly marked as such, and must
33 not be misrepresented as being the original software.
bart3c1e9d82008-06-30 17:10:29 +000034
bartbedfd232009-03-26 19:07:15 +000035 4. The name of the author may not be used to endorse or promote
36 products derived from this software without specific prior written
37 permission.
bart3c1e9d82008-06-30 17:10:29 +000038
bartbedfd232009-03-26 19:07:15 +000039 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
40 OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
41 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
42 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
43 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
44 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
45 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
46 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
47 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
48 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
49 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
bart3c1e9d82008-06-30 17:10:29 +000050
bartbedfd232009-03-26 19:07:15 +000051 ----------------------------------------------------------------
bart3c1e9d82008-06-30 17:10:29 +000052
bartbedfd232009-03-26 19:07:15 +000053 Notice that the above BSD-style license applies to this one file
54 (drd.h) only. The entire rest of Valgrind is licensed under
55 the terms of the GNU General Public License, version 2. See the
56 COPYING file in the source distribution for details.
bart3c1e9d82008-06-30 17:10:29 +000057
bartbedfd232009-03-26 19:07:15 +000058 ----------------------------------------------------------------
bart3c1e9d82008-06-30 17:10:29 +000059*/
60
61#ifndef __VALGRIND_DRD_H
62#define __VALGRIND_DRD_H
63
64
65#include "valgrind.h"
66
67
bartd45d9952009-05-31 18:53:54 +000068/** Obtain the thread ID assigned by Valgrind's core. */
bart575ce8e2011-05-15 07:04:03 +000069#define DRD_GET_VALGRIND_THREADID \
70 (unsigned)VALGRIND_DO_CLIENT_REQUEST_EXPR(0, \
71 VG_USERREQ__DRD_GET_VALGRIND_THREAD_ID, \
barta7103ba2010-09-02 09:38:55 +000072 0, 0, 0, 0, 0)
bartd45d9952009-05-31 18:53:54 +000073
74/** Obtain the thread ID assigned by DRD. */
bart575ce8e2011-05-15 07:04:03 +000075#define DRD_GET_DRD_THREADID \
76 (unsigned)VALGRIND_DO_CLIENT_REQUEST_EXPR(0, \
77 VG_USERREQ__DRD_GET_DRD_THREAD_ID, \
barta7103ba2010-09-02 09:38:55 +000078 0, 0, 0, 0, 0)
79
bartd45d9952009-05-31 18:53:54 +000080
81/** Tell DRD not to complain about data races for the specified variable. */
barta7103ba2010-09-02 09:38:55 +000082#define DRD_IGNORE_VAR(x) ANNOTATE_BENIGN_RACE_SIZED(&(x), sizeof(x), "")
bartd45d9952009-05-31 18:53:54 +000083
bartd9b8eb72009-07-26 15:46:47 +000084/** Tell DRD to no longer ignore data races for the specified variable. */
sewardj4b3a7422011-10-24 13:21:57 +000085#define DRD_STOP_IGNORING_VAR(x) \
86 VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DRD_FINISH_SUPPRESSION, \
barta7103ba2010-09-02 09:38:55 +000087 &(x), sizeof(x), 0, 0, 0)
bartd9b8eb72009-07-26 15:46:47 +000088
bartd45d9952009-05-31 18:53:54 +000089/**
bart31b983d2010-02-21 14:52:59 +000090 * Tell DRD to trace all memory accesses on the specified variable.
bartd45d9952009-05-31 18:53:54 +000091 * until the memory that was allocated for the variable is freed.
92 */
sewardj4b3a7422011-10-24 13:21:57 +000093#define DRD_TRACE_VAR(x) \
94 VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DRD_START_TRACE_ADDR, \
barta7103ba2010-09-02 09:38:55 +000095 &(x), sizeof(x), 0, 0, 0)
bartd45d9952009-05-31 18:53:54 +000096
bart1c8cc402009-07-01 18:45:45 +000097/**
98 * @defgroup RaceDetectionAnnotations Data race detection annotations.
99 *
bart733db9e2010-03-07 10:44:46 +0000100 * @see See also the source file <a href="http://code.google.com/p/data-race-test/source/browse/trunk/dynamic_annotations/dynamic_annotations.h</a>
101
bart1c8cc402009-07-01 18:45:45 +0000102 * in the ThreadSanitizer project.
103 */
104/*@{*/
bart44afe932009-06-01 10:49:38 +0000105
bartd45d9952009-05-31 18:53:54 +0000106/**
bart733db9e2010-03-07 10:44:46 +0000107 * Tell DRD to insert a happens-before mark. addr is the address of an object
108 * that is not a pthread synchronization object.
bartd45d9952009-05-31 18:53:54 +0000109 */
sewardj4b3a7422011-10-24 13:21:57 +0000110#define ANNOTATE_HAPPENS_BEFORE(addr) \
111 VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DRD_ANNOTATE_HAPPENS_BEFORE, \
barta7103ba2010-09-02 09:38:55 +0000112 addr, 0, 0, 0, 0)
bartd45d9952009-05-31 18:53:54 +0000113
114/**
bart733db9e2010-03-07 10:44:46 +0000115 * Tell DRD that the memory accesses executed after this annotation will
116 * happen after all memory accesses performed before all preceding
bartdf5a1e22009-06-03 08:11:02 +0000117 * ANNOTATE_HAPPENS_BEFORE(addr). addr is the address of an object that is not
bart733db9e2010-03-07 10:44:46 +0000118 * a pthread synchronization object. Inserting a happens-after annotation
119 * before any other thread has passed by a happens-before annotation for the
bartdf5a1e22009-06-03 08:11:02 +0000120 * same address is an error.
bartd45d9952009-05-31 18:53:54 +0000121 */
sewardj4b3a7422011-10-24 13:21:57 +0000122#define ANNOTATE_HAPPENS_AFTER(addr) \
123 VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DRD_ANNOTATE_HAPPENS_AFTER, \
barta7103ba2010-09-02 09:38:55 +0000124 addr, 0, 0, 0, 0)
bartd45d9952009-05-31 18:53:54 +0000125
126/**
bartd45d9952009-05-31 18:53:54 +0000127 * Tell DRD that waiting on the condition variable at address cv has succeeded
128 * and a lock on the mutex at address mtx is now held. Since DRD always inserts
129 * a happens before relation between the pthread_cond_signal() or
130 * pthread_cond_broadcast() call that wakes up a pthread_cond_wait() or
131 * pthread_cond_timedwait() call and the woken up thread, this macro has been
bartdf5a1e22009-06-03 08:11:02 +0000132 * defined such that it has no effect.
bartd45d9952009-05-31 18:53:54 +0000133 */
bartdf5a1e22009-06-03 08:11:02 +0000134#define ANNOTATE_CONDVAR_LOCK_WAIT(cv, mtx) do { } while(0)
bartd45d9952009-05-31 18:53:54 +0000135
136/**
137 * Tell DRD that the condition variable at address cv is about to be signaled.
bartd45d9952009-05-31 18:53:54 +0000138 */
bartdf5a1e22009-06-03 08:11:02 +0000139#define ANNOTATE_CONDVAR_SIGNAL(cv) do { } while(0)
bartd45d9952009-05-31 18:53:54 +0000140
141/**
bart141a7ed2010-03-21 17:28:10 +0000142 * Tell DRD that the condition variable at address cv is about to be signaled.
143 */
144#define ANNOTATE_CONDVAR_SIGNAL_ALL(cv) do { } while(0)
145
146/**
bartdf5a1e22009-06-03 08:11:02 +0000147 * Tell DRD that waiting on condition variable at address cv succeeded and that
148 * the memory operations performed after this annotation should be considered
149 * to happen after the matching ANNOTATE_CONDVAR_SIGNAL(cv). Since this is the
150 * default behavior of DRD, this macro and the macro above have been defined
151 * such that they have no effect.
bartd45d9952009-05-31 18:53:54 +0000152 */
bartdf5a1e22009-06-03 08:11:02 +0000153#define ANNOTATE_CONDVAR_WAIT(cv) do { } while(0)
bartd45d9952009-05-31 18:53:54 +0000154
bart141a7ed2010-03-21 17:28:10 +0000155/**
156 * Tell DRD to consider the memory operations that happened before a mutex
157 * unlock event and after the subsequent mutex lock event on the same mutex as
158 * ordered. This is how DRD always behaves, so this macro has been defined
159 * such that it has no effect.
160 */
161#define ANNOTATE_PURE_HAPPENS_BEFORE_MUTEX(mtx) do { } while(0)
162
bartcfb039e2010-03-08 07:55:23 +0000163/** Deprecated -- don't use this annotation. */
bartdf5a1e22009-06-03 08:11:02 +0000164#define ANNOTATE_MUTEX_IS_USED_AS_CONDVAR(mtx) do { } while(0)
165
166/**
167 * Tell DRD to handle the specified memory range like a pure happens-before
168 * detector would do. Since this is how DRD always behaves, this annotation
169 * has been defined such that it has no effect.
170 */
171#define ANNOTATE_PUBLISH_MEMORY_RANGE(addr, size) do { } while(0)
172
bartcfb039e2010-03-08 07:55:23 +0000173/** Deprecated -- don't use this annotation. */
bartdf5a1e22009-06-03 08:11:02 +0000174#define ANNOTATE_UNPUBLISH_MEMORY_RANGE(addr, size) do { } while(0)
bartd45d9952009-05-31 18:53:54 +0000175
bartcfb039e2010-03-08 07:55:23 +0000176/** Deprecated -- don't use this annotation. */
177#define ANNOTATE_SWAP_MEMORY_RANGE(addr, size) do { } while(0)
178
bartd45d9952009-05-31 18:53:54 +0000179/** Tell DRD that a reader-writer lock object has been initialized. */
sewardj4b3a7422011-10-24 13:21:57 +0000180#define ANNOTATE_RWLOCK_CREATE(rwlock) \
181 VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DRD_ANNOTATE_RWLOCK_CREATE, \
barta7103ba2010-09-02 09:38:55 +0000182 rwlock, 0, 0, 0, 0);
bartd45d9952009-05-31 18:53:54 +0000183
184/** Tell DRD that a reader-writer lock object has been destroyed. */
sewardj4b3a7422011-10-24 13:21:57 +0000185#define ANNOTATE_RWLOCK_DESTROY(rwlock) \
186 VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DRD_ANNOTATE_RWLOCK_DESTROY, \
barta7103ba2010-09-02 09:38:55 +0000187 rwlock, 0, 0, 0, 0);
bartd45d9952009-05-31 18:53:54 +0000188
189/**
190 * Tell DRD that a reader-writer lock has been acquired. is_w == 1 means that
191 * a write lock has been obtained, is_w == 0 means that a read lock has been
192 * obtained.
193 */
sewardj4b3a7422011-10-24 13:21:57 +0000194#define ANNOTATE_RWLOCK_ACQUIRED(rwlock, is_w) \
195 VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DRD_ANNOTATE_RWLOCK_ACQUIRED, \
barta7103ba2010-09-02 09:38:55 +0000196 rwlock, is_w, 0, 0, 0)
bartd45d9952009-05-31 18:53:54 +0000197
198/**
bart1c8cc402009-07-01 18:45:45 +0000199 * Tell DRD that a reader lock has been acquired on a reader-writer
200 * synchronization object.
201 */
202#define ANNOTATE_READERLOCK_ACQUIRED(rwlock) ANNOTATE_RWLOCK_ACQUIRED(rwlock, 0)
203
204/**
205 * Tell DRD that a writer lock has been acquired on a reader-writer
206 * synchronization object.
207 */
208#define ANNOTATE_WRITERLOCK_ACQUIRED(rwlock) ANNOTATE_RWLOCK_ACQUIRED(rwlock, 1)
209
210/**
bartd45d9952009-05-31 18:53:54 +0000211 * Tell DRD that a reader-writer lock is about to be released. is_w == 1 means
212 * that a write lock is about to be released, is_w == 0 means that a read lock
213 * is about to be released.
214 */
barta7103ba2010-09-02 09:38:55 +0000215#define ANNOTATE_RWLOCK_RELEASED(rwlock, is_w) \
sewardj4b3a7422011-10-24 13:21:57 +0000216 VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DRD_ANNOTATE_RWLOCK_RELEASED, \
barta7103ba2010-09-02 09:38:55 +0000217 rwlock, is_w, 0, 0, 0);
bartd45d9952009-05-31 18:53:54 +0000218
bart82c54c42009-06-03 20:01:44 +0000219/**
bart1c8cc402009-07-01 18:45:45 +0000220 * Tell DRD that a reader lock is about to be released.
221 */
222#define ANNOTATE_READERLOCK_RELEASED(rwlock) ANNOTATE_RWLOCK_RELEASED(rwlock, 0)
223
224/**
225 * Tell DRD that a writer lock is about to be released.
226 */
227#define ANNOTATE_WRITERLOCK_RELEASED(rwlock) ANNOTATE_RWLOCK_RELEASED(rwlock, 1)
228
bart141a7ed2010-03-21 17:28:10 +0000229/*
230 * Report that a barrier has been initialized with a given barrier count. The
231 * third argument specifies whether or not reinitialization is allowed, that
232 * is, whether or not it is allowed to call barrier_init() several times
233 * without calling barrier_destroy().
234 */
sewardj4b3a7422011-10-24 13:21:57 +0000235#define ANNOTATE_BARRIER_INIT(barrier, count, reinitialization_allowed) \
236 VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DRD_ANNOTATION_UNIMP, \
237 "ANNOTATE_BARRIER_INIT", barrier, \
barta7103ba2010-09-02 09:38:55 +0000238 count, reinitialization_allowed, 0)
bart141a7ed2010-03-21 17:28:10 +0000239
240/* Report that a barrier has been destroyed. */
sewardj4b3a7422011-10-24 13:21:57 +0000241#define ANNOTATE_BARRIER_DESTROY(barrier) \
242 VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DRD_ANNOTATION_UNIMP, \
243 "ANNOTATE_BARRIER_DESTROY", \
barta7103ba2010-09-02 09:38:55 +0000244 barrier, 0, 0, 0)
bart141a7ed2010-03-21 17:28:10 +0000245
246/* Report that the calling thread is about to start waiting for a barrier. */
sewardj4b3a7422011-10-24 13:21:57 +0000247#define ANNOTATE_BARRIER_WAIT_BEFORE(barrier) \
248 VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DRD_ANNOTATION_UNIMP, \
249 "ANNOTATE_BARRIER_WAIT_BEFORE", \
barta7103ba2010-09-02 09:38:55 +0000250 barrier, 0, 0, 0)
bart141a7ed2010-03-21 17:28:10 +0000251
252/* Report that the calling thread has just finished waiting for a barrier. */
sewardj4b3a7422011-10-24 13:21:57 +0000253#define ANNOTATE_BARRIER_WAIT_AFTER(barrier) \
254 VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DRD_ANNOTATION_UNIMP, \
255 "ANNOTATE_BARRIER_WAIT_AFTER", \
barta7103ba2010-09-02 09:38:55 +0000256 barrier, 0, 0, 0)
bart141a7ed2010-03-21 17:28:10 +0000257
bart1c8cc402009-07-01 18:45:45 +0000258/**
bart82c54c42009-06-03 20:01:44 +0000259 * Tell DRD that a FIFO queue has been created. The abbreviation PCQ stands for
260 * <em>producer-consumer</em>.
261 */
bartdf5a1e22009-06-03 08:11:02 +0000262#define ANNOTATE_PCQ_CREATE(pcq) do { } while(0)
263
bart82c54c42009-06-03 20:01:44 +0000264/** Tell DRD that a FIFO queue has been destroyed. */
bartdf5a1e22009-06-03 08:11:02 +0000265#define ANNOTATE_PCQ_DESTROY(pcq) do { } while(0)
266
bart82c54c42009-06-03 20:01:44 +0000267/**
268 * Tell DRD that an element has been added to the FIFO queue at address pcq.
269 */
bartdf5a1e22009-06-03 08:11:02 +0000270#define ANNOTATE_PCQ_PUT(pcq) do { } while(0)
271
bart82c54c42009-06-03 20:01:44 +0000272/**
273 * Tell DRD that an element has been removed from the FIFO queue at address pcq,
274 * and that DRD should insert a happens-before relationship between the memory
275 * accesses that occurred before the corresponding ANNOTATE_PCQ_PUT(pcq)
276 * annotation and the memory accesses after this annotation. Correspondence
277 * between PUT and GET annotations happens in FIFO order. Since locking
278 * of the queue is needed anyway to add elements to or to remove elements from
279 * the queue, for DRD all four FIFO annotations are defined as no-ops.
280 */
bartdf5a1e22009-06-03 08:11:02 +0000281#define ANNOTATE_PCQ_GET(pcq) do { } while(0)
282
bartd45d9952009-05-31 18:53:54 +0000283/**
barte08eb5f2010-02-28 09:51:00 +0000284 * Tell DRD that data races at the specified address are expected and must not
285 * be reported.
bartd45d9952009-05-31 18:53:54 +0000286 */
barte08eb5f2010-02-28 09:51:00 +0000287#define ANNOTATE_BENIGN_RACE(addr, descr) \
barta7103ba2010-09-02 09:38:55 +0000288 ANNOTATE_BENIGN_RACE_SIZED(addr, sizeof(*addr), descr)
bartd45d9952009-05-31 18:53:54 +0000289
barta7103ba2010-09-02 09:38:55 +0000290/* Same as ANNOTATE_BENIGN_RACE(addr, descr), but applies to
291 the memory range [addr, addr + size). */
sewardj4b3a7422011-10-24 13:21:57 +0000292#define ANNOTATE_BENIGN_RACE_SIZED(addr, size, descr) \
293 VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DRD_START_SUPPRESSION, \
barta7103ba2010-09-02 09:38:55 +0000294 addr, size, 0, 0, 0)
bart141a7ed2010-03-21 17:28:10 +0000295
bartd45d9952009-05-31 18:53:54 +0000296/** Tell DRD to ignore all reads performed by the current thread. */
barta7103ba2010-09-02 09:38:55 +0000297#define ANNOTATE_IGNORE_READS_BEGIN() \
sewardj4b3a7422011-10-24 13:21:57 +0000298 VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DRD_RECORD_LOADS, \
barta7103ba2010-09-02 09:38:55 +0000299 0, 0, 0, 0, 0);
300
bartd45d9952009-05-31 18:53:54 +0000301
302/** Tell DRD to no longer ignore the reads performed by the current thread. */
barta7103ba2010-09-02 09:38:55 +0000303#define ANNOTATE_IGNORE_READS_END() \
sewardj4b3a7422011-10-24 13:21:57 +0000304 VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DRD_RECORD_LOADS, \
barta7103ba2010-09-02 09:38:55 +0000305 1, 0, 0, 0, 0);
bartd45d9952009-05-31 18:53:54 +0000306
307/** Tell DRD to ignore all writes performed by the current thread. */
barta7103ba2010-09-02 09:38:55 +0000308#define ANNOTATE_IGNORE_WRITES_BEGIN() \
sewardj4b3a7422011-10-24 13:21:57 +0000309 VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DRD_RECORD_STORES, \
barta7103ba2010-09-02 09:38:55 +0000310 0, 0, 0, 0, 0)
bartd45d9952009-05-31 18:53:54 +0000311
312/** Tell DRD to no longer ignore the writes performed by the current thread. */
barta7103ba2010-09-02 09:38:55 +0000313#define ANNOTATE_IGNORE_WRITES_END() \
sewardj4b3a7422011-10-24 13:21:57 +0000314 VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DRD_RECORD_STORES, \
barta7103ba2010-09-02 09:38:55 +0000315 1, 0, 0, 0, 0)
bartd45d9952009-05-31 18:53:54 +0000316
317/** Tell DRD to ignore all memory accesses performed by the current thread. */
318#define ANNOTATE_IGNORE_READS_AND_WRITES_BEGIN() \
barta7103ba2010-09-02 09:38:55 +0000319 do { ANNOTATE_IGNORE_READS_BEGIN(); ANNOTATE_IGNORE_WRITES_BEGIN(); } while(0)
bartd45d9952009-05-31 18:53:54 +0000320
321/**
322 * Tell DRD to no longer ignore the memory accesses performed by the current
323 * thread.
324 */
325#define ANNOTATE_IGNORE_READS_AND_WRITES_END() \
barta7103ba2010-09-02 09:38:55 +0000326 do { ANNOTATE_IGNORE_READS_END(); ANNOTATE_IGNORE_WRITES_END(); } while(0)
bartd45d9952009-05-31 18:53:54 +0000327
328/**
329 * Tell DRD that size bytes starting at addr has been allocated by a custom
330 * memory allocator.
331 */
sewardj4b3a7422011-10-24 13:21:57 +0000332#define ANNOTATE_NEW_MEMORY(addr, size) \
333 VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DRD_CLEAN_MEMORY, \
barta7103ba2010-09-02 09:38:55 +0000334 addr, size, 0, 0, 0)
bartd45d9952009-05-31 18:53:54 +0000335
barta7103ba2010-09-02 09:38:55 +0000336/** Ask DRD to report every access to the specified address. */
337#define ANNOTATE_TRACE_MEMORY(addr) DRD_TRACE_VAR(*(char*)(addr))
bartd45d9952009-05-31 18:53:54 +0000338
339/**
340 * Tell DRD to assign the specified name to the current thread. This name will
341 * be used in error messages printed by DRD.
342 */
barta7103ba2010-09-02 09:38:55 +0000343#define ANNOTATE_THREAD_NAME(name) \
sewardj4b3a7422011-10-24 13:21:57 +0000344 VALGRIND_DO_CLIENT_REQUEST_STMT(VG_USERREQ__DRD_SET_THREAD_NAME, \
barta7103ba2010-09-02 09:38:55 +0000345 name, 0, 0, 0, 0)
bartd45d9952009-05-31 18:53:54 +0000346
bart1c8cc402009-07-01 18:45:45 +0000347/*@}*/
bart44afe932009-06-01 10:49:38 +0000348
bartd45d9952009-05-31 18:53:54 +0000349
bart3c1e9d82008-06-30 17:10:29 +0000350/* !! ABIWARNING !! ABIWARNING !! ABIWARNING !! ABIWARNING !!
351 This enum comprises an ABI exported by Valgrind to programs
352 which use client requests. DO NOT CHANGE THE ORDER OF THESE
353 ENTRIES, NOR DELETE ANY -- add new ones at the end.
bartbedfd232009-03-26 19:07:15 +0000354*/
bartd45d9952009-05-31 18:53:54 +0000355enum {
356 /* Ask the DRD tool to discard all information about memory accesses */
357 /* and client objects for the specified range. This client request is */
358 /* binary compatible with the similarly named Helgrind client request. */
359 VG_USERREQ__DRD_CLEAN_MEMORY = VG_USERREQ_TOOL_BASE('H','G'),
360 /* args: Addr, SizeT. */
bart3c1e9d82008-06-30 17:10:29 +0000361
bartd45d9952009-05-31 18:53:54 +0000362 /* Ask the DRD tool the thread ID assigned by Valgrind. */
363 VG_USERREQ__DRD_GET_VALGRIND_THREAD_ID = VG_USERREQ_TOOL_BASE('D','R'),
364 /* args: none. */
365 /* Ask the DRD tool the thread ID assigned by DRD. */
366 VG_USERREQ__DRD_GET_DRD_THREAD_ID,
367 /* args: none. */
bart3c1e9d82008-06-30 17:10:29 +0000368
bartd45d9952009-05-31 18:53:54 +0000369 /* To tell the DRD tool to suppress data race detection on the */
370 /* specified address range. */
371 VG_USERREQ__DRD_START_SUPPRESSION,
372 /* args: start address, size in bytes */
373 /* To tell the DRD tool no longer to suppress data race detection on */
374 /* the specified address range. */
375 VG_USERREQ__DRD_FINISH_SUPPRESSION,
376 /* args: start address, size in bytes */
barte7471762009-03-11 18:51:22 +0000377
bartd45d9952009-05-31 18:53:54 +0000378 /* To ask the DRD tool to trace all accesses to the specified range. */
379 VG_USERREQ__DRD_START_TRACE_ADDR,
380 /* args: Addr, SizeT. */
381 /* To ask the DRD tool to stop tracing accesses to the specified range. */
382 VG_USERREQ__DRD_STOP_TRACE_ADDR,
383 /* args: Addr, SizeT. */
384
385 /* Tell DRD whether or not to record memory loads in the calling thread. */
386 VG_USERREQ__DRD_RECORD_LOADS,
387 /* args: Bool. */
388 /* Tell DRD whether or not to record memory stores in the calling thread. */
389 VG_USERREQ__DRD_RECORD_STORES,
390 /* args: Bool. */
391
392 /* Set the name of the thread that performs this client request. */
393 VG_USERREQ__DRD_SET_THREAD_NAME,
394 /* args: null-terminated character string. */
395
bart141a7ed2010-03-21 17:28:10 +0000396 /* Tell DRD that a DRD annotation has not yet been implemented. */
397 VG_USERREQ__DRD_ANNOTATION_UNIMP,
398 /* args: Char*. */
399
bart66f196d2009-08-15 10:50:35 +0000400 /* Tell DRD that a user-defined reader-writer synchronization object
401 * has been created. */
402 VG_USERREQ__DRD_ANNOTATE_RWLOCK_CREATE
403 = VG_USERREQ_TOOL_BASE('H','G') + 256 + 14,
404 /* args: Addr. */
405 /* Tell DRD that a user-defined reader-writer synchronization object
406 * is about to be destroyed. */
407 VG_USERREQ__DRD_ANNOTATE_RWLOCK_DESTROY
408 = VG_USERREQ_TOOL_BASE('H','G') + 256 + 15,
409 /* args: Addr. */
410 /* Tell DRD that a lock on a user-defined reader-writer synchronization
411 * object has been acquired. */
412 VG_USERREQ__DRD_ANNOTATE_RWLOCK_ACQUIRED
413 = VG_USERREQ_TOOL_BASE('H','G') + 256 + 17,
414 /* args: Addr, Int is_rw. */
415 /* Tell DRD that a lock on a user-defined reader-writer synchronization
416 * object is about to be released. */
417 VG_USERREQ__DRD_ANNOTATE_RWLOCK_RELEASED
418 = VG_USERREQ_TOOL_BASE('H','G') + 256 + 18,
419 /* args: Addr, Int is_rw. */
420
bart141a7ed2010-03-21 17:28:10 +0000421 /* Tell DRD that a Helgrind annotation has not yet been implemented. */
422 VG_USERREQ__HELGRIND_ANNOTATION_UNIMP
bart66f196d2009-08-15 10:50:35 +0000423 = VG_USERREQ_TOOL_BASE('H','G') + 256 + 32,
424 /* args: Char*. */
425
bart733db9e2010-03-07 10:44:46 +0000426 /* Tell DRD to insert a happens-before annotation. */
bartf64a8aa2009-08-14 13:25:38 +0000427 VG_USERREQ__DRD_ANNOTATE_HAPPENS_BEFORE
428 = VG_USERREQ_TOOL_BASE('H','G') + 256 + 33,
bartd45d9952009-05-31 18:53:54 +0000429 /* args: Addr. */
bart733db9e2010-03-07 10:44:46 +0000430 /* Tell DRD to insert a happens-after annotation. */
bartf64a8aa2009-08-14 13:25:38 +0000431 VG_USERREQ__DRD_ANNOTATE_HAPPENS_AFTER
432 = VG_USERREQ_TOOL_BASE('H','G') + 256 + 34,
bartd45d9952009-05-31 18:53:54 +0000433 /* args: Addr. */
bartd45d9952009-05-31 18:53:54 +0000434
bartd45d9952009-05-31 18:53:54 +0000435};
bart3c1e9d82008-06-30 17:10:29 +0000436
437
bart141a7ed2010-03-21 17:28:10 +0000438/**
439 * @addtogroup RaceDetectionAnnotations
440 */
441/*@{*/
442
443#ifdef __cplusplus
444/* ANNOTATE_UNPROTECTED_READ is the preferred way to annotate racy reads.
445
446 Instead of doing
447 ANNOTATE_IGNORE_READS_BEGIN();
448 ... = x;
449 ANNOTATE_IGNORE_READS_END();
450 one can use
451 ... = ANNOTATE_UNPROTECTED_READ(x); */
452template <typename T>
453inline T ANNOTATE_UNPROTECTED_READ(const volatile T& x) {
454 ANNOTATE_IGNORE_READS_BEGIN();
455 const T result = x;
456 ANNOTATE_IGNORE_READS_END();
457 return result;
458}
459/* Apply ANNOTATE_BENIGN_RACE_SIZED to a static variable. */
460#define ANNOTATE_BENIGN_RACE_STATIC(static_var, description) \
461 namespace { \
462 static class static_var##_annotator \
463 { \
464 public: \
465 static_var##_annotator() \
466 { \
bart12dca002010-10-10 18:53:00 +0000467 ANNOTATE_BENIGN_RACE_SIZED(&static_var, sizeof(static_var), \
468 #static_var ": " description); \
bart141a7ed2010-03-21 17:28:10 +0000469 } \
470 } the_##static_var##_annotator; \
471 }
472#endif
473
474/*@}*/
475
bart3c1e9d82008-06-30 17:10:29 +0000476#endif /* __VALGRIND_DRD_H */