Spaces:
Build error
Build error
/* Copyright (c) 2008-2009, Google Inc. | |
* All rights reserved. | |
* | |
* Redistribution and use in source and binary forms, with or without | |
* modification, are permitted provided that the following conditions are | |
* met: | |
* | |
* * Redistributions of source code must retain the above copyright | |
* notice, this list of conditions and the following disclaimer. | |
* * Neither the name of Google Inc. nor the names of its | |
* contributors may be used to endorse or promote products derived from | |
* this software without specific prior written permission. | |
* | |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
* | |
* --- | |
* Author: Kostya Serebryany | |
* Copied to CPython by Jeffrey Yasskin, with all macros renamed to | |
* start with _Py_ to avoid colliding with users embedding Python, and | |
* with deprecated macros removed. | |
*/ | |
/* This file defines dynamic annotations for use with dynamic analysis | |
tool such as valgrind, PIN, etc. | |
Dynamic annotation is a source code annotation that affects | |
the generated code (that is, the annotation is not a comment). | |
Each such annotation is attached to a particular | |
instruction and/or to a particular object (address) in the program. | |
The annotations that should be used by users are macros in all upper-case | |
(e.g., _Py_ANNOTATE_NEW_MEMORY). | |
Actual implementation of these macros may differ depending on the | |
dynamic analysis tool being used. | |
See https://code.google.com/p/data-race-test/ for more information. | |
This file supports the following dynamic analysis tools: | |
- None (DYNAMIC_ANNOTATIONS_ENABLED is not defined or zero). | |
Macros are defined empty. | |
- ThreadSanitizer, Helgrind, DRD (DYNAMIC_ANNOTATIONS_ENABLED is 1). | |
Macros are defined as calls to non-inlinable empty functions | |
that are intercepted by Valgrind. */ | |
/* ------------------------------------------------------------- | |
Annotations useful when implementing condition variables such as CondVar, | |
using conditional critical sections (Await/LockWhen) and when constructing | |
user-defined synchronization mechanisms. | |
The annotations _Py_ANNOTATE_HAPPENS_BEFORE() and | |
_Py_ANNOTATE_HAPPENS_AFTER() can be used to define happens-before arcs in | |
user-defined synchronization mechanisms: the race detector will infer an | |
arc from the former to the latter when they share the same argument | |
pointer. | |
Example 1 (reference counting): | |
void Unref() { | |
_Py_ANNOTATE_HAPPENS_BEFORE(&refcount_); | |
if (AtomicDecrementByOne(&refcount_) == 0) { | |
_Py_ANNOTATE_HAPPENS_AFTER(&refcount_); | |
delete this; | |
} | |
} | |
Example 2 (message queue): | |
void MyQueue::Put(Type *e) { | |
MutexLock lock(&mu_); | |
_Py_ANNOTATE_HAPPENS_BEFORE(e); | |
PutElementIntoMyQueue(e); | |
} | |
Type *MyQueue::Get() { | |
MutexLock lock(&mu_); | |
Type *e = GetElementFromMyQueue(); | |
_Py_ANNOTATE_HAPPENS_AFTER(e); | |
return e; | |
} | |
Note: when possible, please use the existing reference counting and message | |
queue implementations instead of inventing new ones. */ | |
/* Report that wait on the condition variable at address "cv" has succeeded | |
and the lock at address "lock" is held. */ | |
/* Report that wait on the condition variable at "cv" has succeeded. Variant | |
w/o lock. */ | |
/* Report that we are about to signal on the condition variable at address | |
"cv". */ | |
/* Report that we are about to signal_all on the condition variable at "cv". */ | |
/* Annotations for user-defined synchronization mechanisms. */ | |
/* Report that the bytes in the range [pointer, pointer+size) are about | |
to be published safely. The race checker will create a happens-before | |
arc from the call _Py_ANNOTATE_PUBLISH_MEMORY_RANGE(pointer, size) to | |
subsequent accesses to this memory. | |
Note: this annotation may not work properly if the race detector uses | |
sampling, i.e. does not observe all memory accesses. | |
*/ | |
/* Instruct the tool to create a happens-before arc between mu->Unlock() and | |
mu->Lock(). This annotation may slow down the race detector and hide real | |
races. Normally it is used only when it would be difficult to annotate each | |
of the mutex's critical sections individually using the annotations above. | |
This annotation makes sense only for hybrid race detectors. For pure | |
happens-before detectors this is a no-op. For more details see | |
https://code.google.com/p/data-race-test/wiki/PureHappensBeforeVsHybrid . */ | |
/* ------------------------------------------------------------- | |
Annotations useful when defining memory allocators, or when memory that | |
was protected in one way starts to be protected in another. */ | |
/* Report that a new memory at "address" of size "size" has been allocated. | |
This might be used when the memory has been retrieved from a free list and | |
is about to be reused, or when the locking discipline for a variable | |
changes. */ | |
/* ------------------------------------------------------------- | |
Annotations useful when defining FIFO queues that transfer data between | |
threads. */ | |
/* Report that the producer-consumer queue (such as ProducerConsumerQueue) at | |
address "pcq" has been created. The _Py_ANNOTATE_PCQ_* annotations should | |
be used only for FIFO queues. For non-FIFO queues use | |
_Py_ANNOTATE_HAPPENS_BEFORE (for put) and _Py_ANNOTATE_HAPPENS_AFTER (for | |
get). */ | |
/* Report that the queue at address "pcq" is about to be destroyed. */ | |
/* Report that we are about to put an element into a FIFO queue at address | |
"pcq". */ | |
/* Report that we've just got an element from a FIFO queue at address "pcq". */ | |
/* ------------------------------------------------------------- | |
Annotations that suppress errors. It is usually better to express the | |
program's synchronization using the other annotations, but these can | |
be used when all else fails. */ | |
/* Report that we may have a benign race at "pointer", with size | |
"sizeof(*(pointer))". "pointer" must be a non-void* pointer. Insert at the | |
point where "pointer" has been allocated, preferably close to the point | |
where the race happens. See also _Py_ANNOTATE_BENIGN_RACE_STATIC. */ | |
/* Same as _Py_ANNOTATE_BENIGN_RACE(address, description), but applies to | |
the memory range [address, address+size). */ | |
/* Request the analysis tool to ignore all reads in the current thread | |
until _Py_ANNOTATE_IGNORE_READS_END is called. | |
Useful to ignore intentional racey reads, while still checking | |
other reads and all writes. | |
See also _Py_ANNOTATE_UNPROTECTED_READ. */ | |
/* Stop ignoring reads. */ | |
/* Similar to _Py_ANNOTATE_IGNORE_READS_BEGIN, but ignore writes. */ | |
/* Stop ignoring writes. */ | |
/* Start ignoring all memory accesses (reads and writes). */ | |
/* Stop ignoring all memory accesses. */ | |
/* Similar to _Py_ANNOTATE_IGNORE_READS_BEGIN, but ignore synchronization events: | |
RWLOCK* and CONDVAR*. */ | |
/* Stop ignoring sync events. */ | |
/* Enable (enable!=0) or disable (enable==0) race detection for all threads. | |
This annotation could be useful if you want to skip expensive race analysis | |
during some period of program execution, e.g. during initialization. */ | |
/* ------------------------------------------------------------- | |
Annotations useful for debugging. */ | |
/* Request to trace every access to "address". */ | |
/* Report the current thread name to a race detector. */ | |
/* ------------------------------------------------------------- | |
Annotations useful when implementing locks. They are not | |
normally needed by modules that merely use locks. | |
The "lock" argument is a pointer to the lock object. */ | |
/* Report that a lock has been created at address "lock". */ | |
/* Report that the lock at address "lock" is about to be destroyed. */ | |
/* Report that the lock at address "lock" has been acquired. | |
is_w=1 for writer lock, is_w=0 for reader lock. */ | |
/* Report that the lock at address "lock" is about to be released. */ | |
/* ------------------------------------------------------------- | |
Annotations useful when implementing barriers. They are not | |
normally needed by modules that merely use barriers. | |
The "barrier" argument is a pointer to the barrier object. */ | |
/* Report that the "barrier" has been initialized with initial "count". | |
If 'reinitialization_allowed' is true, initialization is allowed to happen | |
multiple times w/o calling barrier_destroy() */ | |
/* Report that we are about to enter barrier_wait("barrier"). */ | |
/* Report that we just exited barrier_wait("barrier"). */ | |
/* Report that the "barrier" has been destroyed. */ | |
/* ------------------------------------------------------------- | |
Annotations useful for testing race detectors. */ | |
/* Report that we expect a race on the variable at "address". | |
Use only in unit tests for a race detector. */ | |
/* A no-op. Insert where you like to test the interceptors. */ | |
/* Force the race detector to flush its state. The actual effect depends on | |
* the implementation of the detector. */ | |
/* Use the macros above rather than using these functions directly. */ | |
extern "C" { | |
void AnnotateRWLockCreate(const char *file, int line, | |
const volatile void *lock); | |
void AnnotateRWLockDestroy(const char *file, int line, | |
const volatile void *lock); | |
void AnnotateRWLockAcquired(const char *file, int line, | |
const volatile void *lock, long is_w); | |
void AnnotateRWLockReleased(const char *file, int line, | |
const volatile void *lock, long is_w); | |
void AnnotateBarrierInit(const char *file, int line, | |
const volatile void *barrier, long count, | |
long reinitialization_allowed); | |
void AnnotateBarrierWaitBefore(const char *file, int line, | |
const volatile void *barrier); | |
void AnnotateBarrierWaitAfter(const char *file, int line, | |
const volatile void *barrier); | |
void AnnotateBarrierDestroy(const char *file, int line, | |
const volatile void *barrier); | |
void AnnotateCondVarWait(const char *file, int line, | |
const volatile void *cv, | |
const volatile void *lock); | |
void AnnotateCondVarSignal(const char *file, int line, | |
const volatile void *cv); | |
void AnnotateCondVarSignalAll(const char *file, int line, | |
const volatile void *cv); | |
void AnnotatePublishMemoryRange(const char *file, int line, | |
const volatile void *address, | |
long size); | |
void AnnotateUnpublishMemoryRange(const char *file, int line, | |
const volatile void *address, | |
long size); | |
void AnnotatePCQCreate(const char *file, int line, | |
const volatile void *pcq); | |
void AnnotatePCQDestroy(const char *file, int line, | |
const volatile void *pcq); | |
void AnnotatePCQPut(const char *file, int line, | |
const volatile void *pcq); | |
void AnnotatePCQGet(const char *file, int line, | |
const volatile void *pcq); | |
void AnnotateNewMemory(const char *file, int line, | |
const volatile void *address, | |
long size); | |
void AnnotateExpectRace(const char *file, int line, | |
const volatile void *address, | |
const char *description); | |
void AnnotateBenignRace(const char *file, int line, | |
const volatile void *address, | |
const char *description); | |
void AnnotateBenignRaceSized(const char *file, int line, | |
const volatile void *address, | |
long size, | |
const char *description); | |
void AnnotateMutexIsUsedAsCondVar(const char *file, int line, | |
const volatile void *mu); | |
void AnnotateTraceMemory(const char *file, int line, | |
const volatile void *arg); | |
void AnnotateThreadName(const char *file, int line, | |
const char *name); | |
void AnnotateIgnoreReadsBegin(const char *file, int line); | |
void AnnotateIgnoreReadsEnd(const char *file, int line); | |
void AnnotateIgnoreWritesBegin(const char *file, int line); | |
void AnnotateIgnoreWritesEnd(const char *file, int line); | |
void AnnotateEnableRaceDetection(const char *file, int line, int enable); | |
void AnnotateNoOp(const char *file, int line, | |
const volatile void *arg); | |
void AnnotateFlushState(const char *file, int line); | |
/* Return non-zero value if running under valgrind. | |
If "valgrind.h" is included into dynamic_annotations.c, | |
the regular valgrind mechanism will be used. | |
See http://valgrind.org/docs/manual/manual-core-adv.html about | |
RUNNING_ON_VALGRIND and other valgrind "client requests". | |
The file "valgrind.h" may be obtained by doing | |
svn co svn://svn.valgrind.org/valgrind/trunk/include | |
If for some reason you can't use "valgrind.h" or want to fake valgrind, | |
there are two ways to make this function return non-zero: | |
- Use environment variable: export RUNNING_ON_VALGRIND=1 | |
- Make your tool intercept the function RunningOnValgrind() and | |
change its return value. | |
*/ | |
int RunningOnValgrind(void); | |
} | |
/* _Py_ANNOTATE_UNPROTECTED_READ is the preferred way to annotate racey reads. | |
Instead of doing | |
_Py_ANNOTATE_IGNORE_READS_BEGIN(); | |
... = x; | |
_Py_ANNOTATE_IGNORE_READS_END(); | |
one can use | |
... = _Py_ANNOTATE_UNPROTECTED_READ(x); */ | |
template <class T> | |
inline T _Py_ANNOTATE_UNPROTECTED_READ(const volatile T &x) { | |
_Py_ANNOTATE_IGNORE_READS_BEGIN(); | |
T res = x; | |
_Py_ANNOTATE_IGNORE_READS_END(); | |
return res; | |
} | |
/* Apply _Py_ANNOTATE_BENIGN_RACE_SIZED to a static variable. */ | |