contrib/compiler-rt/include/sanitizer/tsan_interface.h

   1 //===-- tsan_interface.h ----------------------------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file is a part of ThreadSanitizer (TSan), a race detector.
  11 //
  12 // Public interface header for TSan.
  13 //===----------------------------------------------------------------------===//
  14 #ifndef SANITIZER_TSAN_INTERFACE_H
  15 #define SANITIZER_TSAN_INTERFACE_H
  16
  17 #include <sanitizer/common_interface_defs.h>
  18
  19 #ifdef __cplusplus
  20 extern "C" {
  21 #endif
  22
  23 // __tsan_release establishes a happens-before relation with a preceding
  24 // __tsan_acquire on the same address.
  25 void __tsan_acquire(void *addr);
  26 void __tsan_release(void *addr);
  27
  28 // Annotations for custom mutexes.
  29 // The annotations allow to get better reports (with sets of locked mutexes),
  30 // detect more types of bugs (e.g. mutex misuses, races between lock/unlock and
  31 // destruction and potential deadlocks) and improve precision and performance
  32 // (by ignoring individual atomic operations in mutex code). However, the
  33 // downside is that annotated mutex code itself is not checked for correctness.
  34
  35 // Mutex creation flags are passed to __tsan_mutex_create annotation.
  36 // If mutex has no constructor and __tsan_mutex_create is not called,
  37 // the flags may be passed to __tsan_mutex_pre_lock/__tsan_mutex_post_lock
  38 // annotations.
  39
  40 // Mutex has static storage duration and no-op constructor and destructor.
  41 // This effectively makes tsan ignore destroy annotation.
  42 const unsigned __tsan_mutex_linker_init      = 1 << 0;
  43 // Mutex is write reentrant.
  44 const unsigned __tsan_mutex_write_reentrant  = 1 << 1;
  45 // Mutex is read reentrant.
  46 const unsigned __tsan_mutex_read_reentrant   = 1 << 2;
  47 // Mutex does not have static storage duration, and must not be used after
  48 // its destructor runs.  The opposite of __tsan_mutex_linker_init.
  49 // If this flag is passed to __tsan_mutex_destroy, then the destruction
  50 // is ignored unless this flag was previously set on the mutex.
  51 const unsigned __tsan_mutex_not_static       = 1 << 8;
  52
  53 // Mutex operation flags:
  54
  55 // Denotes read lock operation.
  56 const unsigned __tsan_mutex_read_lock        = 1 << 3;
  57 // Denotes try lock operation.
  58 const unsigned __tsan_mutex_try_lock         = 1 << 4;
  59 // Denotes that a try lock operation has failed to acquire the mutex.
  60 const unsigned __tsan_mutex_try_lock_failed  = 1 << 5;
  61 // Denotes that the lock operation acquires multiple recursion levels.
  62 // Number of levels is passed in recursion parameter.
  63 // This is useful for annotation of e.g. Java builtin monitors,
  64 // for which wait operation releases all recursive acquisitions of the mutex.
  65 const unsigned __tsan_mutex_recursive_lock   = 1 << 6;
  66 // Denotes that the unlock operation releases all recursion levels.
  67 // Number of released levels is returned and later must be passed to
  68 // the corresponding __tsan_mutex_post_lock annotation.
  69 const unsigned __tsan_mutex_recursive_unlock = 1 << 7;
  70
  71 // Annotate creation of a mutex.
  72 // Supported flags: mutex creation flags.
  73 void __tsan_mutex_create(void *addr, unsigned flags);
  74
  75 // Annotate destruction of a mutex.
  76 // Supported flags:
  77 //   - __tsan_mutex_linker_init
  78 //   - __tsan_mutex_not_static
  79 void __tsan_mutex_destroy(void *addr, unsigned flags);
  80
  81 // Annotate start of lock operation.
  82 // Supported flags:
  83 //   - __tsan_mutex_read_lock
  84 //   - __tsan_mutex_try_lock
  85 //   - all mutex creation flags
  86 void __tsan_mutex_pre_lock(void *addr, unsigned flags);
  87
  88 // Annotate end of lock operation.
  89 // Supported flags:
  90 //   - __tsan_mutex_read_lock (must match __tsan_mutex_pre_lock)
  91 //   - __tsan_mutex_try_lock (must match __tsan_mutex_pre_lock)
  92 //   - __tsan_mutex_try_lock_failed
  93 //   - __tsan_mutex_recursive_lock
  94 //   - all mutex creation flags
  95 void __tsan_mutex_post_lock(void *addr, unsigned flags, int recursion);
  96
  97 // Annotate start of unlock operation.
  98 // Supported flags:
  99 //   - __tsan_mutex_read_lock
 100 //   - __tsan_mutex_recursive_unlock
 101 int __tsan_mutex_pre_unlock(void *addr, unsigned flags);
 102
 103 // Annotate end of unlock operation.
 104 // Supported flags:
 105 //   - __tsan_mutex_read_lock (must match __tsan_mutex_pre_unlock)
 106 void __tsan_mutex_post_unlock(void *addr, unsigned flags);
 107
 108 // Annotate start/end of notify/signal/broadcast operation.
 109 // Supported flags: none.
 110 void __tsan_mutex_pre_signal(void *addr, unsigned flags);
 111 void __tsan_mutex_post_signal(void *addr, unsigned flags);
 112
 113 // Annotate start/end of a region of code where lock/unlock/signal operation
 114 // diverts to do something else unrelated to the mutex. This can be used to
 115 // annotate, for example, calls into cooperative scheduler or contention
 116 // profiling code.
 117 // These annotations must be called only from within
 118 // __tsan_mutex_pre/post_lock, __tsan_mutex_pre/post_unlock,
 119 // __tsan_mutex_pre/post_signal regions.
 120 // Supported flags: none.
 121 void __tsan_mutex_pre_divert(void *addr, unsigned flags);
 122 void __tsan_mutex_post_divert(void *addr, unsigned flags);
 123
 124 // External race detection API.
 125 // Can be used by non-instrumented libraries to detect when their objects are
 126 // being used in an unsafe manner.
 127 //   - __tsan_external_read/__tsan_external_write annotates the logical reads
 128 //       and writes of the object at the specified address. 'caller_pc' should
 129 //       be the PC of the library user, which the library can obtain with e.g.
 130 //       `__builtin_return_address(0)`.
 131 //   - __tsan_external_register_tag registers a 'tag' with the specified name,
 132 //       which is later used in read/write annotations to denote the object type
 133 //   - __tsan_external_assign_tag can optionally mark a heap object with a tag
 134 void *__tsan_external_register_tag(const char *object_type);
 135 void __tsan_external_register_header(void *tag, const char *header);
 136 void __tsan_external_assign_tag(void *addr, void *tag);
 137 void __tsan_external_read(void *addr, void *caller_pc, void *tag);
 138 void __tsan_external_write(void *addr, void *caller_pc, void *tag);
 139
 140 #ifdef __cplusplus
 141 }  // extern "C"
 142 #endif
 143
 144 #endif  // SANITIZER_TSAN_INTERFACE_H