cds/compiler/feature_tsan.h

   1 /*
   2     This file is a part of libcds - Concurrent Data Structures library
   3
   4     (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2017
   5
   6     Source code repo: http://github.com/khizmax/libcds/
   7     Download: http://sourceforge.net/projects/libcds/files/
   8
   9     Redistribution and use in source and binary forms, with or without
  10     modification, are permitted provided that the following conditions are met:
  11
  12     * Redistributions of source code must retain the above copyright notice, this
  13       list of conditions and the following disclaimer.
  14
  15     * Redistributions in binary form must reproduce the above copyright notice,
  16       this list of conditions and the following disclaimer in the documentation
  17       and/or other materials provided with the distribution.
  18
  19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  23     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  25     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  26     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27     OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 */
  30
  31 #ifndef CDSLIB_COMPILER_FEATURE_TSAN_H
  32 #define CDSLIB_COMPILER_FEATURE_TSAN_H
  33
  34 // Thread Sanitizer annotations.
  35 // From http://llvm.org/viewvc/llvm-project/compiler-rt/trunk/test/tsan/annotate_happens_before.cc?view=markup
  36
  37 //@cond
  38
  39 #ifdef CDS_THREAD_SANITIZER_ENABLED
  40 #   define CDS_TSAN_ANNOTATE_HAPPENS_BEFORE(addr)   AnnotateHappensBefore(__FILE__, __LINE__, reinterpret_cast<void*>(addr))
  41 #   define CDS_TSAN_ANNOTATE_HAPPENS_AFTER(addr)    AnnotateHappensAfter(__FILE__, __LINE__, reinterpret_cast<void*>(addr))
  42
  43 #   define CDS_TSAN_ANNOTATE_IGNORE_READS_BEGIN     AnnotateIgnoreReadsBegin(__FILE__, __LINE__)
  44 #   define CDS_TSAN_ANNOTATE_IGNORE_READS_END       AnnotateIgnoreReadsEnd(__FILE__, __LINE__)
  45 #   define CDS_TSAN_ANNOTATE_IGNORE_WRITES_BEGIN    AnnotateIgnoreWritesBegin(__FILE__, __LINE__)
  46 #   define CDS_TSAN_ANNOTATE_IGNORE_WRITES_END      AnnotateIgnoreWritesEnd(__FILE__, __LINE__)
  47 #   define CDS_TSAN_ANNOTATE_IGNORE_RW_BEGIN        \
  48                                                     CDS_TSAN_ANNOTATE_IGNORE_READS_BEGIN; \
  49                                                     CDS_TSAN_ANNOTATE_IGNORE_WRITES_BEGIN
  50 #   define CDS_TSAN_ANNOTATE_IGNORE_RW_END          \
  51                                                     CDS_TSAN_ANNOTATE_IGNORE_WRITES_END;\
  52                                                     CDS_TSAN_ANNOTATE_IGNORE_READS_END
  53 #   define CDS_TSAN_ANNOTATE_NEW_MEMORY( addr, sz ) AnnotateNewMemory( __FILE__, __LINE__, reinterpret_cast<void *>(addr), sz )
  54
  55 // Publish/unpublish - DEPRECATED
  56 #if 0
  57 #   define CDS_TSAN_ANNOTATE_PUBLISH_MEMORY_RANGE( addr, sz ) AnnotatePublishMemoryRange( __FILE__, __LINE__, reinterpret_cast<void *>(addr), sz )
  58 #   define CDS_TSAN_ANNOTATE_UNPUBLISH_MEMORY_RANGE( addr, sz ) AnnotateUnpublishMemoryRange( __FILE__, __LINE__, reinterpret_cast<void *>(addr), sz )
  59 #endif
  60
  61 #   define CDS_TSAN_ANNOTATE_MUTEX_CREATE( addr )    AnnotateRWLockCreate( __FILE__, __LINE__, reinterpret_cast<void *>(addr))
  62 #   define CDS_TSAN_ANNOTATE_MUTEX_DESTROY( addr )   AnnotateRWLockDestroy( __FILE__, __LINE__, reinterpret_cast<void *>(addr))
  63         // must be called after actual acquire
  64 #   define CDS_TSAN_ANNOTATE_MUTEX_ACQUIRED( addr )  AnnotateRWLockAcquired( __FILE__, __LINE__, reinterpret_cast<void *>(addr), 1 )
  65         // must be called before actual release
  66 #   define CDS_TSAN_ANNOTATE_MUTEX_RELEASED( addr )  AnnotateRWLockReleased( __FILE__, __LINE__, reinterpret_cast<void *>(addr), 1 )
  67
  68     // provided by TSan
  69     extern "C" {
  70         void AnnotateHappensBefore(const char *f, int l, void *addr);
  71         void AnnotateHappensAfter(const char *f, int l, void *addr);
  72
  73         void AnnotateIgnoreReadsBegin(const char *f, int l);
  74         void AnnotateIgnoreReadsEnd(const char *f, int l);
  75         void AnnotateIgnoreWritesBegin(const char *f, int l);
  76         void AnnotateIgnoreWritesEnd(const char *f, int l);
  77
  78 #if 0
  79         void AnnotatePublishMemoryRange( const char *f, int l, void * mem, size_t size );
  80         void AnnotateUnpublishMemoryRange( const char *f, int l, void * addr, size_t size );
  81 #endif
  82         void AnnotateNewMemory( const char *f, int l, void * mem, size_t size );
  83
  84         void AnnotateRWLockCreate( const char *f, int l, void* m );
  85         void AnnotateRWLockDestroy( const char *f, int l, void* m );
  86         void AnnotateRWLockAcquired( const char *f, int l, void *m, long is_w );
  87         void AnnotateRWLockReleased( const char *f, int l, void *m, long is_w );
  88     }
  89
  90 #else // CDS_THREAD_SANITIZER_ENABLED
  91
  92 #   define CDS_TSAN_ANNOTATE_HAPPENS_BEFORE(addr)
  93 #   define CDS_TSAN_ANNOTATE_HAPPENS_AFTER(addr)
  94
  95 #   define CDS_TSAN_ANNOTATE_IGNORE_READS_BEGIN
  96 #   define CDS_TSAN_ANNOTATE_IGNORE_READS_END
  97 #   define CDS_TSAN_ANNOTATE_IGNORE_WRITES_BEGIN
  98 #   define CDS_TSAN_ANNOTATE_IGNORE_WRITES_END
  99 #   define CDS_TSAN_ANNOTATE_IGNORE_RW_BEGIN
 100 #   define CDS_TSAN_ANNOTATE_IGNORE_RW_END
 101
 102 #if 0
 103 #   define CDS_TSAN_ANNOTATE_PUBLISH_MEMORY_RANGE( addr, sz )
 104 #   define CDS_TSAN_ANNOTATE_UNPUBLISH_MEMORY_RANGE( addr, sz )
 105 #endif
 106 #   define CDS_TSAN_ANNOTATE_NEW_MEMORY( addr, sz )
 107
 108 #   define CDS_TSAN_ANNOTATE_MUTEX_CREATE( addr )
 109 #   define CDS_TSAN_ANNOTATE_MUTEX_DESTROY( addr )
 110 #   define CDS_TSAN_ANNOTATE_MUTEX_ACQUIRED( addr )
 111 #   define CDS_TSAN_ANNOTATE_MUTEX_RELEASED( addr )
 112
 113 #endif
 114
 115 //@endcond
 116 #endif  // #ifndef CDSLIB_COMPILER_FEATURE_TSAN_H