mono/utils/unlocked.h

   1 /**
   2  * \file
   3  * Contains inline functions to explicitly mark data races that should not be changed.
   4  * This way, instruments like Clang's ThreadSanitizer can be told to ignore very specific instructions.
   5  *
   6  * Please keep this file and its methods organised:
   7  *  * Increment, Decrement, Add, Subtract, Write, Read
   8  *  * gint32 (""), guint32 ("Unsigned"),
   9  *      gint64 ("64"), guint64 ("Unsigned64"),
  10  *      gsize ("Size"), gboolean ("Bool"),
  11  *      gpointer ("Pointer")
  12  *
  13  * Licensed under the MIT license. See LICENSE file in the project root for full license information.
  14  */
  15
  16 #ifndef _UNLOCKED_H_
  17 #define _UNLOCKED_H_
  18
  19 #include <glib.h>
  20 #include <mono/utils/mono-compiler.h>
  21
  22 #if MONO_HAS_CLANG_THREAD_SANITIZER
  23 #define MONO_UNLOCKED_ATTRS MONO_NO_SANITIZE_THREAD MONO_NEVER_INLINE static
  24 #elif defined(_MSC_VER)
  25 #define MONO_UNLOCKED_ATTRS MONO_ALWAYS_INLINE static
  26 #else
  27 #define MONO_UNLOCKED_ATTRS MONO_ALWAYS_INLINE static inline
  28 #endif
  29
  30 MONO_UNLOCKED_ATTRS
  31 gint32
  32 UnlockedIncrement (volatile gint32 *val)
  33 {
  34         return ++*val;
  35 }
  36
  37 MONO_UNLOCKED_ATTRS
  38 gint64
  39 UnlockedIncrement64 (volatile gint64 *val)
  40 {
  41         return ++*val;
  42 }
  43
  44 MONO_UNLOCKED_ATTRS
  45 gint64
  46 UnlockedDecrement64 (volatile gint64 *val)
  47 {
  48         return --*val;
  49 }
  50
  51 MONO_UNLOCKED_ATTRS
  52 gint32
  53 UnlockedDecrement (volatile gint32 *val)
  54 {
  55         return --*val;
  56 }
  57
  58 MONO_UNLOCKED_ATTRS
  59 gint32
  60 UnlockedAdd (volatile gint32 *dest, gint32 add)
  61 {
  62         return *dest += add;
  63 }
  64
  65 MONO_UNLOCKED_ATTRS
  66 gint64
  67 UnlockedAdd64 (volatile gint64 *dest, gint64 add)
  68 {
  69         return *dest += add;
  70 }
  71
  72 MONO_UNLOCKED_ATTRS
  73 gdouble
  74 UnlockedAddDouble (volatile gdouble *dest, gdouble add)
  75 {
  76         return *dest += add;
  77 }
  78
  79 MONO_UNLOCKED_ATTRS
  80 gint64
  81 UnlockedSubtract64 (volatile gint64 *dest, gint64 sub)
  82 {
  83         return *dest -= sub;
  84 }
  85
  86 MONO_UNLOCKED_ATTRS
  87 void
  88 UnlockedWrite (volatile gint32 *dest, gint32 val)
  89 {
  90         *dest = val;
  91 }
  92
  93 MONO_UNLOCKED_ATTRS
  94 void
  95 UnlockedWrite64 (volatile gint64 *dest, gint64 val)
  96 {
  97         *dest = val;
  98 }
  99
 100 MONO_UNLOCKED_ATTRS
 101 void
 102 UnlockedWriteBool (volatile gboolean *dest, gboolean val)
 103 {
 104         *dest = val;
 105 }
 106
 107 MONO_UNLOCKED_ATTRS
 108 void
 109 UnlockedWritePointer (volatile gpointer *dest, gpointer val)
 110 {
 111         *dest = val;
 112 }
 113
 114 MONO_UNLOCKED_ATTRS
 115 gint32
 116 UnlockedRead (volatile gint32 *src)
 117 {
 118         return *src;
 119 }
 120
 121 MONO_UNLOCKED_ATTRS
 122 gint64
 123 UnlockedRead64 (volatile gint64 *src)
 124 {
 125         return *src;
 126 }
 127
 128 MONO_UNLOCKED_ATTRS
 129 gboolean
 130 UnlockedReadBool (volatile gboolean *src)
 131 {
 132         return *src;
 133 }
 134
 135 MONO_UNLOCKED_ATTRS
 136 gpointer
 137 UnlockedReadPointer (volatile gpointer *src)
 138 {
 139         return *src;
 140 }
 141
 142 #endif /* _UNLOCKED_H_ */