Merge branch 'dev'
[libcds.git] / cds / compiler / feature_tsan.h
1 //$$CDS-header$$
2
3 #ifndef CDSLIB_COMPILER_FEATURE_TSAN_H
4 #define CDSLIB_COMPILER_FEATURE_TSAN_H
5
6 // Thread Sanitizer annotations.
7 // From https://groups.google.com/d/msg/thread-sanitizer/SsrHB7FTnTk/mNTGNLQj-9cJ
8
9 //@cond
10
11 #ifdef CDS_THREAD_SANITIZER_ENABLED
12 #   define CDS_TSAN_ANNOTATE_HAPPENS_BEFORE(addr)   AnnotateHappensBefore(__FILE__, __LINE__, reinterpret_cast<void*>(addr))\r
13 #   define CDS_TSAN_ANNOTATE_HAPPENS_AFTER(addr)    AnnotateHappensAfter(__FILE__, __LINE__, reinterpret_cast<void*>(addr))\r
14 \r
15 #   define CDS_TSAN_ANNOTATE_IGNORE_READS_BEGIN     AnnotateIgnoreReadsBegin(__FILE__, __LINE__)\r
16 #   define CDS_TSAN_ANNOTATE_IGNORE_READS_END       AnnotateIgnoreReadsEnd(__FILE__, __LINE__)\r
17 #   define CDS_TSAN_ANNOTATE_IGNORE_WRITES_BEGIN    AnnotateIgnoreWritesBegin(__FILE__, __LINE__)\r
18 #   define CDS_TSAN_ANNOTATE_IGNORE_WRITES_END      AnnotateIgnoreWritesEnd(__FILE__, __LINE__)\r
19 #   define CDS_TSAN_ANNOTATE_IGNORE_RW_BEGIN        \\r
20                                                     CDS_TSAN_ANNOTATE_IGNORE_READS_BEGIN; \\r
21                                                     CDS_TSAN_ANNOTATE_IGNORE_WRITES_BEGIN\r
22 #   define CDS_TSAN_ANNOTATE_IGNORE_RW_END          \\r
23                                                     CDS_TSAN_ANNOTATE_IGNORE_WRITES_END;\\r
24                                                     CDS_TSAN_ANNOTATE_IGNORE_READS_END\r
25 \r
26     // provided by TSan\r
27     extern "C" {\r
28         void AnnotateHappensBefore(const char *f, int l, void *addr);\r
29         void AnnotateHappensAfter(const char *f, int l, void *addr);\r
30 \r
31         void AnnotateIgnoreReadsBegin(const char *f, int l);\r
32         void AnnotateIgnoreReadsEnd(const char *f, int l);\r
33         void AnnotateIgnoreWritesBegin(const char *f, int l);\r
34         void AnnotateIgnoreWritesEnd(const char *f, int l);\r
35     }\r
36 \r
37 #else // CDS_THREAD_SANITIZER_ENABLED\r
38 \r
39 #   define CDS_TSAN_ANNOTATE_HAPPENS_BEFORE(addr)\r
40 #   define CDS_TSAN_ANNOTATE_HAPPENS_AFTER(addr)
41
42 #   define CDS_TSAN_ANNOTATE_IGNORE_READS_BEGIN\r
43 #   define CDS_TSAN_ANNOTATE_IGNORE_READS_END\r
44 #   define CDS_TSAN_ANNOTATE_IGNORE_WRITES_BEGIN\r
45 #   define CDS_TSAN_ANNOTATE_IGNORE_WRITES_END\r
46 #   define CDS_TSAN_ANNOTATE_IGNORE_RW_BEGIN\r
47 #   define CDS_TSAN_ANNOTATE_IGNORE_RW_END\r
48 \r
49 #endif
50
51 //@endcond
52 #endif  // #ifndef CDSLIB_COMPILER_FEATURE_TSAN_H