sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 1 | /* |
bart | 86562bd | 2009-02-16 19:43:56 +0000 | [diff] [blame] | 2 | This file is part of drd, a thread error detector. |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 3 | |
Elliott Hughes | ed39800 | 2017-06-21 14:41:24 -0700 | [diff] [blame] | 4 | Copyright (C) 2006-2017 Bart Van Assche <bvanassche@acm.org>. |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 5 | |
| 6 | This program is free software; you can redistribute it and/or |
| 7 | modify it under the terms of the GNU General Public License as |
| 8 | published by the Free Software Foundation; either version 2 of the |
| 9 | License, or (at your option) any later version. |
| 10 | |
| 11 | This program is distributed in the hope that it will be useful, but |
| 12 | WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 14 | General Public License for more details. |
| 15 | |
| 16 | You should have received a copy of the GNU General Public License |
| 17 | along with this program; if not, write to the Free Software |
| 18 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
| 19 | 02111-1307, USA. |
| 20 | |
| 21 | The GNU General Public License is contained in the file COPYING. |
| 22 | */ |
| 23 | |
| 24 | |
bart | 3dbdc86 | 2009-02-14 12:14:50 +0000 | [diff] [blame] | 25 | #include "drd_basics.h" |
bart | 4bb53d8 | 2008-02-28 19:06:34 +0000 | [diff] [blame] | 26 | #include "drd_clientobj.h" |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 27 | #include "drd_error.h" |
| 28 | #include "drd_mutex.h" |
bart | 9d5b796 | 2008-05-14 12:25:00 +0000 | [diff] [blame] | 29 | #include "pub_tool_vki.h" |
bart | 74b2d97 | 2011-10-08 08:54:57 +0000 | [diff] [blame] | 30 | #include "pub_tool_errormgr.h" /* VG_(maybe_record_error)() */ |
| 31 | #include "pub_tool_libcassert.h" /* tl_assert() */ |
| 32 | #include "pub_tool_libcbase.h" /* VG_(strlen) */ |
| 33 | #include "pub_tool_libcprint.h" /* VG_(message)() */ |
| 34 | #include "pub_tool_libcproc.h" /* VG_(read_millisecond_timer)() */ |
| 35 | #include "pub_tool_machine.h" /* VG_(get_IP)() */ |
| 36 | #include "pub_tool_threadstate.h" /* VG_(get_running_tid)() */ |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 37 | |
| 38 | |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 39 | /* Local functions. */ |
sewardj | 347eeba | 2008-01-21 14:19:07 +0000 | [diff] [blame] | 40 | |
bart | d2c5eae | 2009-02-21 15:27:04 +0000 | [diff] [blame] | 41 | static void mutex_cleanup(struct mutex_info* p); |
| 42 | static Bool mutex_is_locked(struct mutex_info* const p); |
| 43 | static void mutex_delete_thread(struct mutex_info* p, const DrdThreadId tid); |
sewardj | 347eeba | 2008-01-21 14:19:07 +0000 | [diff] [blame] | 44 | |
| 45 | |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 46 | /* Local variables. */ |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 47 | |
bart | d2c5eae | 2009-02-21 15:27:04 +0000 | [diff] [blame] | 48 | static Bool s_trace_mutex; |
| 49 | static ULong s_mutex_lock_count; |
| 50 | static ULong s_mutex_segment_creation_count; |
bart | 8600c42 | 2010-10-25 18:18:54 +0000 | [diff] [blame] | 51 | static UInt s_mutex_lock_threshold_ms; |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 52 | |
| 53 | |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 54 | /* Function definitions. */ |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 55 | |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 56 | void DRD_(mutex_set_trace)(const Bool trace_mutex) |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 57 | { |
sewardj | d56b7e2 | 2015-01-20 00:12:18 +0000 | [diff] [blame] | 58 | tl_assert((!! trace_mutex) == trace_mutex); |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 59 | s_trace_mutex = trace_mutex; |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 60 | } |
| 61 | |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 62 | void DRD_(mutex_set_lock_threshold)(const UInt lock_threshold_ms) |
bart | 9d5b796 | 2008-05-14 12:25:00 +0000 | [diff] [blame] | 63 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 64 | s_mutex_lock_threshold_ms = lock_threshold_ms; |
bart | 9d5b796 | 2008-05-14 12:25:00 +0000 | [diff] [blame] | 65 | } |
| 66 | |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 67 | static |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 68 | void DRD_(mutex_initialize)(struct mutex_info* const p, |
| 69 | const Addr mutex, const MutexT mutex_type) |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 70 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 71 | tl_assert(mutex); |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 72 | tl_assert(p->a1 == mutex); |
bart | 3f4623e | 2008-07-07 16:53:07 +0000 | [diff] [blame] | 73 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 74 | p->cleanup = (void(*)(DrdClientobj*))mutex_cleanup; |
| 75 | p->delete_thread |
| 76 | = (void(*)(DrdClientobj*, DrdThreadId))mutex_delete_thread; |
| 77 | p->mutex_type = mutex_type; |
| 78 | p->recursion_count = 0; |
bart | 3cc2620 | 2014-06-09 09:19:26 +0000 | [diff] [blame] | 79 | p->ignore_ordering = False; |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 80 | p->owner = DRD_INVALID_THREADID; |
| 81 | p->last_locked_segment = 0; |
| 82 | p->acquiry_time_ms = 0; |
| 83 | p->acquired_at = 0; |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 84 | } |
| 85 | |
bart | 3cc2620 | 2014-06-09 09:19:26 +0000 | [diff] [blame] | 86 | void DRD_(mutex_ignore_ordering)(const Addr mutex) |
| 87 | { |
| 88 | struct mutex_info* p = DRD_(mutex_get)(mutex); |
| 89 | |
| 90 | if (s_trace_mutex) |
florian | ea71ffb | 2015-08-05 14:38:57 +0000 | [diff] [blame] | 91 | DRD_(trace_msg)("[%u] mutex_ignore_ordering %s 0x%lx", |
bart | 3cc2620 | 2014-06-09 09:19:26 +0000 | [diff] [blame] | 92 | DRD_(thread_get_running_tid)(), |
| 93 | p ? DRD_(mutex_type_name)(p->mutex_type) : "(?)", |
| 94 | mutex); |
| 95 | |
| 96 | if (p) { |
| 97 | p->ignore_ordering = True; |
| 98 | } else { |
| 99 | DRD_(not_a_mutex)(mutex); |
| 100 | } |
| 101 | } |
| 102 | |
bart | 46d5f17 | 2008-02-28 19:49:37 +0000 | [diff] [blame] | 103 | /** Deallocate the memory that was allocated by mutex_initialize(). */ |
bart | d2c5eae | 2009-02-21 15:27:04 +0000 | [diff] [blame] | 104 | static void mutex_cleanup(struct mutex_info* p) |
bart | 46d5f17 | 2008-02-28 19:49:37 +0000 | [diff] [blame] | 105 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 106 | tl_assert(p); |
bart | 6b71761 | 2008-03-24 09:29:38 +0000 | [diff] [blame] | 107 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 108 | if (s_trace_mutex) |
florian | ea71ffb | 2015-08-05 14:38:57 +0000 | [diff] [blame] | 109 | DRD_(trace_msg)("[%u] mutex_destroy %s 0x%lx rc %d owner %u", |
bart | b92ff0f | 2011-10-08 08:29:29 +0000 | [diff] [blame] | 110 | DRD_(thread_get_running_tid)(), |
| 111 | DRD_(mutex_get_typename)(p), p->a1, |
| 112 | p ? p->recursion_count : -1, |
| 113 | p ? p->owner : DRD_INVALID_THREADID); |
bart | b78312c | 2008-02-29 11:00:17 +0000 | [diff] [blame] | 114 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 115 | if (mutex_is_locked(p)) |
| 116 | { |
bart | d45d995 | 2009-05-31 18:53:54 +0000 | [diff] [blame] | 117 | MutexErrInfo MEI = { DRD_(thread_get_running_tid)(), |
| 118 | p->a1, p->recursion_count, p->owner }; |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 119 | VG_(maybe_record_error)(VG_(get_running_tid)(), |
| 120 | MutexErr, |
| 121 | VG_(get_IP)(VG_(get_running_tid)()), |
| 122 | "Destroying locked mutex", |
| 123 | &MEI); |
| 124 | } |
bart | 46d5f17 | 2008-02-28 19:49:37 +0000 | [diff] [blame] | 125 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 126 | DRD_(sg_put)(p->last_locked_segment); |
| 127 | p->last_locked_segment = 0; |
bart | 46d5f17 | 2008-02-28 19:49:37 +0000 | [diff] [blame] | 128 | } |
| 129 | |
bart | 62cc232 | 2010-03-07 10:54:21 +0000 | [diff] [blame] | 130 | /** Report that address 'mutex' is not the address of a mutex object. */ |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 131 | void DRD_(not_a_mutex)(const Addr mutex) |
bart | 6b71761 | 2008-03-24 09:29:38 +0000 | [diff] [blame] | 132 | { |
bart | d45d995 | 2009-05-31 18:53:54 +0000 | [diff] [blame] | 133 | MutexErrInfo MEI = { DRD_(thread_get_running_tid)(), |
| 134 | mutex, -1, DRD_INVALID_THREADID }; |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 135 | VG_(maybe_record_error)(VG_(get_running_tid)(), |
| 136 | MutexErr, |
| 137 | VG_(get_IP)(VG_(get_running_tid)()), |
| 138 | "Not a mutex", |
| 139 | &MEI); |
bart | 6b71761 | 2008-03-24 09:29:38 +0000 | [diff] [blame] | 140 | } |
| 141 | |
bart | 62cc232 | 2010-03-07 10:54:21 +0000 | [diff] [blame] | 142 | /** |
| 143 | * Report that address 'mutex' is not the address of a mutex object of the |
| 144 | * expected type. |
| 145 | */ |
| 146 | static void wrong_mutex_type(const Addr mutex) |
| 147 | { |
| 148 | MutexErrInfo MEI = { DRD_(thread_get_running_tid)(), |
| 149 | mutex, -1, DRD_INVALID_THREADID }; |
| 150 | VG_(maybe_record_error)(VG_(get_running_tid)(), |
| 151 | MutexErr, |
| 152 | VG_(get_IP)(VG_(get_running_tid)()), |
| 153 | "Mutex type mismatch", |
| 154 | &MEI); |
| 155 | } |
| 156 | |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 157 | static |
sewardj | 721ad7b | 2007-11-30 08:30:29 +0000 | [diff] [blame] | 158 | struct mutex_info* |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 159 | DRD_(mutex_get_or_allocate)(const Addr mutex, const MutexT mutex_type) |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 160 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 161 | struct mutex_info* p; |
sewardj | 721ad7b | 2007-11-30 08:30:29 +0000 | [diff] [blame] | 162 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 163 | tl_assert(offsetof(DrdClientobj, mutex) == 0); |
| 164 | p = &(DRD_(clientobj_get)(mutex, ClientMutex)->mutex); |
| 165 | if (p) |
| 166 | { |
bart | 62cc232 | 2010-03-07 10:54:21 +0000 | [diff] [blame] | 167 | if (mutex_type == mutex_type_unknown || p->mutex_type == mutex_type) |
| 168 | return p; |
| 169 | else |
| 170 | { |
| 171 | wrong_mutex_type(mutex); |
| 172 | return 0; |
| 173 | } |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 174 | } |
sewardj | 721ad7b | 2007-11-30 08:30:29 +0000 | [diff] [blame] | 175 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 176 | if (DRD_(clientobj_present)(mutex, mutex + 1)) |
| 177 | { |
| 178 | DRD_(not_a_mutex)(mutex); |
| 179 | return 0; |
| 180 | } |
bart | 4bb53d8 | 2008-02-28 19:06:34 +0000 | [diff] [blame] | 181 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 182 | p = &(DRD_(clientobj_add)(mutex, ClientMutex)->mutex); |
| 183 | DRD_(mutex_initialize)(p, mutex, mutex_type); |
| 184 | return p; |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 185 | } |
| 186 | |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 187 | struct mutex_info* DRD_(mutex_get)(const Addr mutex) |
bart | 3b1ee45 | 2008-02-29 19:28:15 +0000 | [diff] [blame] | 188 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 189 | tl_assert(offsetof(DrdClientobj, mutex) == 0); |
| 190 | return &(DRD_(clientobj_get)(mutex, ClientMutex)->mutex); |
bart | 3b1ee45 | 2008-02-29 19:28:15 +0000 | [diff] [blame] | 191 | } |
| 192 | |
bart | 0034464 | 2008-03-01 15:27:41 +0000 | [diff] [blame] | 193 | /** Called before pthread_mutex_init(). */ |
sewardj | 721ad7b | 2007-11-30 08:30:29 +0000 | [diff] [blame] | 194 | struct mutex_info* |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 195 | DRD_(mutex_init)(const Addr mutex, const MutexT mutex_type) |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 196 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 197 | struct mutex_info* p; |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 198 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 199 | if (s_trace_mutex) |
florian | ea71ffb | 2015-08-05 14:38:57 +0000 | [diff] [blame] | 200 | DRD_(trace_msg)("[%u] mutex_init %s 0x%lx", |
bart | b92ff0f | 2011-10-08 08:29:29 +0000 | [diff] [blame] | 201 | DRD_(thread_get_running_tid)(), |
| 202 | DRD_(mutex_type_name)(mutex_type), |
| 203 | mutex); |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 204 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 205 | if (mutex_type == mutex_type_invalid_mutex) |
| 206 | { |
| 207 | DRD_(not_a_mutex)(mutex); |
| 208 | return 0; |
| 209 | } |
bart | 0034464 | 2008-03-01 15:27:41 +0000 | [diff] [blame] | 210 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 211 | p = DRD_(mutex_get)(mutex); |
| 212 | if (p) |
| 213 | { |
| 214 | const ThreadId vg_tid = VG_(get_running_tid)(); |
bart | d45d995 | 2009-05-31 18:53:54 +0000 | [diff] [blame] | 215 | MutexErrInfo MEI = { DRD_(thread_get_running_tid)(), |
| 216 | p->a1, p->recursion_count, p->owner }; |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 217 | VG_(maybe_record_error)(vg_tid, |
| 218 | MutexErr, |
| 219 | VG_(get_IP)(vg_tid), |
| 220 | "Mutex reinitialization", |
| 221 | &MEI); |
bart | fa35828 | 2009-05-16 06:22:46 +0000 | [diff] [blame] | 222 | p->mutex_type = mutex_type; |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 223 | return p; |
| 224 | } |
| 225 | p = DRD_(mutex_get_or_allocate)(mutex, mutex_type); |
sewardj | 347eeba | 2008-01-21 14:19:07 +0000 | [diff] [blame] | 226 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 227 | return p; |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 228 | } |
| 229 | |
bart | 46d5f17 | 2008-02-28 19:49:37 +0000 | [diff] [blame] | 230 | /** Called after pthread_mutex_destroy(). */ |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 231 | void DRD_(mutex_post_destroy)(const Addr mutex) |
sewardj | 347eeba | 2008-01-21 14:19:07 +0000 | [diff] [blame] | 232 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 233 | struct mutex_info* p; |
sewardj | 347eeba | 2008-01-21 14:19:07 +0000 | [diff] [blame] | 234 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 235 | p = DRD_(mutex_get)(mutex); |
| 236 | if (p == 0) |
| 237 | { |
| 238 | DRD_(not_a_mutex)(mutex); |
| 239 | return; |
| 240 | } |
bart | 72b751c | 2008-03-01 13:44:24 +0000 | [diff] [blame] | 241 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 242 | DRD_(clientobj_remove)(mutex, ClientMutex); |
sewardj | 347eeba | 2008-01-21 14:19:07 +0000 | [diff] [blame] | 243 | } |
| 244 | |
bart | 62cc232 | 2010-03-07 10:54:21 +0000 | [diff] [blame] | 245 | /** |
| 246 | * Called before pthread_mutex_lock() is invoked. If a data structure for the |
| 247 | * client-side object was not yet created, do this now. Also check whether an |
| 248 | * attempt is made to lock recursively a synchronization object that must not |
| 249 | * be locked recursively. |
bart | 8bba1f7 | 2008-02-27 16:13:05 +0000 | [diff] [blame] | 250 | */ |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 251 | void DRD_(mutex_pre_lock)(const Addr mutex, MutexT mutex_type, |
| 252 | const Bool trylock) |
bart | 8bba1f7 | 2008-02-27 16:13:05 +0000 | [diff] [blame] | 253 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 254 | struct mutex_info* p; |
bart | 635cb16 | 2008-02-28 08:30:43 +0000 | [diff] [blame] | 255 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 256 | p = DRD_(mutex_get_or_allocate)(mutex, mutex_type); |
bart | 62cc232 | 2010-03-07 10:54:21 +0000 | [diff] [blame] | 257 | if (p && mutex_type == mutex_type_unknown) |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 258 | mutex_type = p->mutex_type; |
bart | 3f4623e | 2008-07-07 16:53:07 +0000 | [diff] [blame] | 259 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 260 | if (s_trace_mutex) |
florian | ea71ffb | 2015-08-05 14:38:57 +0000 | [diff] [blame] | 261 | DRD_(trace_msg)("[%u] %s %s 0x%lx rc %d owner %u", |
bart | b92ff0f | 2011-10-08 08:29:29 +0000 | [diff] [blame] | 262 | DRD_(thread_get_running_tid)(), |
| 263 | trylock ? "pre_mutex_lock " : "mutex_trylock ", |
| 264 | p ? DRD_(mutex_get_typename)(p) : "(?)", |
| 265 | mutex, p ? p->recursion_count : -1, |
| 266 | p ? p->owner : DRD_INVALID_THREADID); |
bart | 0034464 | 2008-03-01 15:27:41 +0000 | [diff] [blame] | 267 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 268 | if (p == 0) |
| 269 | { |
| 270 | DRD_(not_a_mutex)(mutex); |
| 271 | return; |
| 272 | } |
bart | 2e3a3c1 | 2008-03-24 08:33:47 +0000 | [diff] [blame] | 273 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 274 | tl_assert(p); |
bart | 2e3a3c1 | 2008-03-24 08:33:47 +0000 | [diff] [blame] | 275 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 276 | if (mutex_type == mutex_type_invalid_mutex) |
| 277 | { |
| 278 | DRD_(not_a_mutex)(mutex); |
| 279 | return; |
| 280 | } |
bart | 0034464 | 2008-03-01 15:27:41 +0000 | [diff] [blame] | 281 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 282 | if (! trylock |
| 283 | && p->owner == DRD_(thread_get_running_tid)() |
| 284 | && p->recursion_count >= 1 |
| 285 | && mutex_type != mutex_type_recursive_mutex) |
| 286 | { |
bart | d45d995 | 2009-05-31 18:53:54 +0000 | [diff] [blame] | 287 | MutexErrInfo MEI = { DRD_(thread_get_running_tid)(), |
| 288 | p->a1, p->recursion_count, p->owner }; |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 289 | VG_(maybe_record_error)(VG_(get_running_tid)(), |
| 290 | MutexErr, |
| 291 | VG_(get_IP)(VG_(get_running_tid)()), |
| 292 | "Recursive locking not allowed", |
| 293 | &MEI); |
| 294 | } |
bart | 8bba1f7 | 2008-02-27 16:13:05 +0000 | [diff] [blame] | 295 | } |
| 296 | |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 297 | /** |
| 298 | * Update mutex_info state when locking the pthread_mutex_t mutex. |
| 299 | * Note: this function must be called after pthread_mutex_lock() has been |
| 300 | * called, or a race condition is triggered ! |
| 301 | */ |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 302 | void DRD_(mutex_post_lock)(const Addr mutex, const Bool took_lock, |
| 303 | const Bool post_cond_wait) |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 304 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 305 | const DrdThreadId drd_tid = DRD_(thread_get_running_tid)(); |
| 306 | struct mutex_info* p; |
bart | 0034464 | 2008-03-01 15:27:41 +0000 | [diff] [blame] | 307 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 308 | p = DRD_(mutex_get)(mutex); |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 309 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 310 | if (s_trace_mutex) |
florian | ea71ffb | 2015-08-05 14:38:57 +0000 | [diff] [blame] | 311 | DRD_(trace_msg)("[%u] %s %s 0x%lx rc %d owner %u%s", |
bart | b92ff0f | 2011-10-08 08:29:29 +0000 | [diff] [blame] | 312 | drd_tid, |
| 313 | post_cond_wait ? "cond_post_wait " : "post_mutex_lock", |
| 314 | p ? DRD_(mutex_get_typename)(p) : "(?)", |
| 315 | mutex, p ? p->recursion_count : 0, |
| 316 | p ? p->owner : VG_INVALID_THREADID, |
| 317 | took_lock ? "" : " (locking failed)"); |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 318 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 319 | if (! p || ! took_lock) |
| 320 | return; |
bart | 5357fcb | 2008-02-27 15:46:00 +0000 | [diff] [blame] | 321 | |
bart | 74b2d97 | 2011-10-08 08:54:57 +0000 | [diff] [blame] | 322 | if (p->recursion_count == 0) { |
bart | 3cc2620 | 2014-06-09 09:19:26 +0000 | [diff] [blame] | 323 | if (!p->ignore_ordering) { |
| 324 | if (p->owner != drd_tid && p->owner != DRD_INVALID_THREADID) { |
| 325 | tl_assert(p->last_locked_segment); |
bart | f6ec1fe | 2009-06-21 18:07:35 +0000 | [diff] [blame] | 326 | |
bart | 3cc2620 | 2014-06-09 09:19:26 +0000 | [diff] [blame] | 327 | DRD_(thread_new_segment_and_combine_vc)(drd_tid, |
| 328 | p->last_locked_segment); |
| 329 | } else { |
| 330 | DRD_(thread_new_segment)(drd_tid); |
| 331 | } |
| 332 | |
| 333 | s_mutex_segment_creation_count++; |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 334 | } |
bart | 5bd9f2d | 2008-03-03 20:31:58 +0000 | [diff] [blame] | 335 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 336 | p->owner = drd_tid; |
| 337 | p->acquiry_time_ms = VG_(read_millisecond_timer)(); |
| 338 | p->acquired_at = VG_(record_ExeContext)(VG_(get_running_tid)(), 0); |
| 339 | s_mutex_lock_count++; |
bart | 74b2d97 | 2011-10-08 08:54:57 +0000 | [diff] [blame] | 340 | } else if (p->owner != drd_tid) { |
| 341 | const ThreadId vg_tid = VG_(get_running_tid)(); |
| 342 | MutexErrInfo MEI = { DRD_(thread_get_running_tid)(), |
| 343 | p->a1, p->recursion_count, p->owner }; |
| 344 | VG_(maybe_record_error)(vg_tid, |
| 345 | MutexErr, |
| 346 | VG_(get_IP)(vg_tid), |
| 347 | "The impossible happened: mutex is locked" |
| 348 | " simultaneously by two threads", |
| 349 | &MEI); |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 350 | p->owner = drd_tid; |
| 351 | } |
| 352 | p->recursion_count++; |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 353 | } |
| 354 | |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 355 | /** |
| 356 | * Update mutex_info state when unlocking the pthread_mutex_t mutex. |
bart | 9d5b796 | 2008-05-14 12:25:00 +0000 | [diff] [blame] | 357 | * |
bart | 7e6de96 | 2009-02-21 09:39:09 +0000 | [diff] [blame] | 358 | * @param[in] mutex Address of the client mutex. |
| 359 | * @param[in] mutex_type Mutex type. |
bart | 9d5b796 | 2008-05-14 12:25:00 +0000 | [diff] [blame] | 360 | * |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 361 | * @return New value of the mutex recursion count. |
bart | 9d5b796 | 2008-05-14 12:25:00 +0000 | [diff] [blame] | 362 | * |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 363 | * @note This function must be called before pthread_mutex_unlock() is called, |
| 364 | * or a race condition is triggered ! |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 365 | */ |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 366 | void DRD_(mutex_unlock)(const Addr mutex, MutexT mutex_type) |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 367 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 368 | const DrdThreadId drd_tid = DRD_(thread_get_running_tid)(); |
| 369 | const ThreadId vg_tid = VG_(get_running_tid)(); |
| 370 | struct mutex_info* p; |
bart | 3f4623e | 2008-07-07 16:53:07 +0000 | [diff] [blame] | 371 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 372 | p = DRD_(mutex_get)(mutex); |
bart | adb7a20 | 2009-07-21 12:39:25 +0000 | [diff] [blame] | 373 | if (p && mutex_type == mutex_type_unknown) |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 374 | mutex_type = p->mutex_type; |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 375 | |
bart | b92ff0f | 2011-10-08 08:29:29 +0000 | [diff] [blame] | 376 | if (s_trace_mutex) { |
florian | ea71ffb | 2015-08-05 14:38:57 +0000 | [diff] [blame] | 377 | DRD_(trace_msg)("[%u] mutex_unlock %s 0x%lx rc %d", |
bart | b92ff0f | 2011-10-08 08:29:29 +0000 | [diff] [blame] | 378 | drd_tid, p ? DRD_(mutex_get_typename)(p) : "(?)", |
| 379 | mutex, p ? p->recursion_count : 0); |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 380 | } |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 381 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 382 | if (p == 0 || mutex_type == mutex_type_invalid_mutex) |
| 383 | { |
| 384 | DRD_(not_a_mutex)(mutex); |
| 385 | return; |
| 386 | } |
bart | ab7a644 | 2008-02-25 19:46:14 +0000 | [diff] [blame] | 387 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 388 | if (p->owner == DRD_INVALID_THREADID) |
| 389 | { |
bart | d45d995 | 2009-05-31 18:53:54 +0000 | [diff] [blame] | 390 | MutexErrInfo MEI = { DRD_(thread_get_running_tid)(), |
| 391 | p->a1, p->recursion_count, p->owner }; |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 392 | VG_(maybe_record_error)(vg_tid, |
| 393 | MutexErr, |
| 394 | VG_(get_IP)(vg_tid), |
| 395 | "Mutex not locked", |
| 396 | &MEI); |
| 397 | return; |
| 398 | } |
bart | 5357fcb | 2008-02-27 15:46:00 +0000 | [diff] [blame] | 399 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 400 | tl_assert(p); |
bart | 74b2d97 | 2011-10-08 08:54:57 +0000 | [diff] [blame] | 401 | if (p->mutex_type != mutex_type) { |
| 402 | MutexErrInfo MEI = { DRD_(thread_get_running_tid)(), |
| 403 | p->a1, p->recursion_count, p->owner }; |
| 404 | VG_(maybe_record_error)(vg_tid, MutexErr, VG_(get_IP)(vg_tid), |
| 405 | "Mutex type changed", &MEI); |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 406 | } |
| 407 | tl_assert(p->mutex_type == mutex_type); |
| 408 | tl_assert(p->owner != DRD_INVALID_THREADID); |
sewardj | 721ad7b | 2007-11-30 08:30:29 +0000 | [diff] [blame] | 409 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 410 | if (p->owner != drd_tid || p->recursion_count <= 0) |
| 411 | { |
bart | d45d995 | 2009-05-31 18:53:54 +0000 | [diff] [blame] | 412 | MutexErrInfo MEI = { DRD_(thread_get_running_tid)(), |
| 413 | p->a1, p->recursion_count, p->owner }; |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 414 | VG_(maybe_record_error)(vg_tid, |
| 415 | MutexErr, |
| 416 | VG_(get_IP)(vg_tid), |
| 417 | "Mutex not locked by calling thread", |
| 418 | &MEI); |
| 419 | return; |
| 420 | } |
| 421 | tl_assert(p->recursion_count > 0); |
| 422 | p->recursion_count--; |
| 423 | tl_assert(p->recursion_count >= 0); |
sewardj | 347eeba | 2008-01-21 14:19:07 +0000 | [diff] [blame] | 424 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 425 | if (p->recursion_count == 0) |
| 426 | { |
| 427 | if (s_mutex_lock_threshold_ms > 0) |
bart | 9d5b796 | 2008-05-14 12:25:00 +0000 | [diff] [blame] | 428 | { |
bart | 430c45f | 2009-04-13 08:05:18 +0000 | [diff] [blame] | 429 | Long held = VG_(read_millisecond_timer)() - p->acquiry_time_ms; |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 430 | if (held > s_mutex_lock_threshold_ms) |
| 431 | { |
| 432 | HoldtimeErrInfo HEI |
bart | d45d995 | 2009-05-31 18:53:54 +0000 | [diff] [blame] | 433 | = { DRD_(thread_get_running_tid)(), |
| 434 | mutex, p->acquired_at, held, s_mutex_lock_threshold_ms }; |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 435 | VG_(maybe_record_error)(vg_tid, |
| 436 | HoldtimeErr, |
| 437 | VG_(get_IP)(vg_tid), |
| 438 | "mutex", |
| 439 | &HEI); |
| 440 | } |
bart | 9d5b796 | 2008-05-14 12:25:00 +0000 | [diff] [blame] | 441 | } |
bart | 9d5b796 | 2008-05-14 12:25:00 +0000 | [diff] [blame] | 442 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 443 | /* This pthread_mutex_unlock() call really unlocks the mutex. Save the */ |
| 444 | /* current vector clock of the thread such that it is available when */ |
| 445 | /* this mutex is locked again. */ |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 446 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 447 | DRD_(thread_get_latest_segment)(&p->last_locked_segment, drd_tid); |
bart | 3cc2620 | 2014-06-09 09:19:26 +0000 | [diff] [blame] | 448 | if (!p->ignore_ordering) |
| 449 | DRD_(thread_new_segment)(drd_tid); |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 450 | p->acquired_at = 0; |
| 451 | s_mutex_segment_creation_count++; |
| 452 | } |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 453 | } |
| 454 | |
bart | 3dbdc86 | 2009-02-14 12:14:50 +0000 | [diff] [blame] | 455 | void DRD_(spinlock_init_or_unlock)(const Addr spinlock) |
| 456 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 457 | struct mutex_info* mutex_p = DRD_(mutex_get)(spinlock); |
| 458 | if (mutex_p) |
| 459 | { |
| 460 | DRD_(mutex_unlock)(spinlock, mutex_type_spinlock); |
| 461 | } |
| 462 | else |
| 463 | { |
| 464 | DRD_(mutex_init)(spinlock, mutex_type_spinlock); |
| 465 | } |
bart | 3dbdc86 | 2009-02-14 12:14:50 +0000 | [diff] [blame] | 466 | } |
| 467 | |
florian | 19f91bb | 2012-11-10 22:29:54 +0000 | [diff] [blame] | 468 | const HChar* DRD_(mutex_get_typename)(struct mutex_info* const p) |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 469 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 470 | tl_assert(p); |
sewardj | 721ad7b | 2007-11-30 08:30:29 +0000 | [diff] [blame] | 471 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 472 | return DRD_(mutex_type_name)(p->mutex_type); |
sewardj | 347eeba | 2008-01-21 14:19:07 +0000 | [diff] [blame] | 473 | } |
| 474 | |
florian | 19f91bb | 2012-11-10 22:29:54 +0000 | [diff] [blame] | 475 | const HChar* DRD_(mutex_type_name)(const MutexT mt) |
sewardj | 347eeba | 2008-01-21 14:19:07 +0000 | [diff] [blame] | 476 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 477 | switch (mt) |
| 478 | { |
bart | adb7a20 | 2009-07-21 12:39:25 +0000 | [diff] [blame] | 479 | case mutex_type_unknown: |
| 480 | return "mutex"; |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 481 | case mutex_type_invalid_mutex: |
| 482 | return "invalid mutex"; |
| 483 | case mutex_type_recursive_mutex: |
| 484 | return "recursive mutex"; |
| 485 | case mutex_type_errorcheck_mutex: |
| 486 | return "error checking mutex"; |
| 487 | case mutex_type_default_mutex: |
| 488 | return "mutex"; |
| 489 | case mutex_type_spinlock: |
| 490 | return "spinlock"; |
bart | f056aab | 2014-06-09 07:55:14 +0000 | [diff] [blame] | 491 | case mutex_type_cxa_guard: |
| 492 | return "cxa_guard"; |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 493 | } |
bart | 62cc232 | 2010-03-07 10:54:21 +0000 | [diff] [blame] | 494 | tl_assert(0); |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 495 | return "?"; |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 496 | } |
| 497 | |
bart | 5357fcb | 2008-02-27 15:46:00 +0000 | [diff] [blame] | 498 | /** Return true if the specified mutex is locked by any thread. */ |
bart | d2c5eae | 2009-02-21 15:27:04 +0000 | [diff] [blame] | 499 | static Bool mutex_is_locked(struct mutex_info* const p) |
bart | 5357fcb | 2008-02-27 15:46:00 +0000 | [diff] [blame] | 500 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 501 | tl_assert(p); |
| 502 | return (p->recursion_count > 0); |
bart | 5357fcb | 2008-02-27 15:46:00 +0000 | [diff] [blame] | 503 | } |
| 504 | |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 505 | Bool DRD_(mutex_is_locked_by)(const Addr mutex, const DrdThreadId tid) |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 506 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 507 | struct mutex_info* const p = DRD_(mutex_get)(mutex); |
| 508 | if (p) |
| 509 | { |
| 510 | return (p->recursion_count > 0 && p->owner == tid); |
| 511 | } |
| 512 | return False; |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 513 | } |
| 514 | |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 515 | int DRD_(mutex_get_recursion_count)(const Addr mutex) |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 516 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 517 | struct mutex_info* const p = DRD_(mutex_get)(mutex); |
| 518 | tl_assert(p); |
| 519 | return p->recursion_count; |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 520 | } |
| 521 | |
| 522 | /** |
bart | 301c311 | 2008-02-24 18:22:37 +0000 | [diff] [blame] | 523 | * Call this function when thread tid stops to exist, such that the |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 524 | * "last owner" field can be cleared if it still refers to that thread. |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 525 | */ |
bart | d2c5eae | 2009-02-21 15:27:04 +0000 | [diff] [blame] | 526 | static void mutex_delete_thread(struct mutex_info* p, const DrdThreadId tid) |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 527 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 528 | tl_assert(p); |
bart | 4bb53d8 | 2008-02-28 19:06:34 +0000 | [diff] [blame] | 529 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 530 | if (p->owner == tid && p->recursion_count > 0) |
| 531 | { |
bart | d45d995 | 2009-05-31 18:53:54 +0000 | [diff] [blame] | 532 | MutexErrInfo MEI = { DRD_(thread_get_running_tid)(), |
| 533 | p->a1, p->recursion_count, p->owner }; |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 534 | VG_(maybe_record_error)(VG_(get_running_tid)(), |
| 535 | MutexErr, |
| 536 | VG_(get_IP)(VG_(get_running_tid)()), |
| 537 | "Mutex still locked at thread exit", |
| 538 | &MEI); |
| 539 | p->owner = VG_INVALID_THREADID; |
| 540 | } |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 541 | } |
| 542 | |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 543 | ULong DRD_(get_mutex_lock_count)(void) |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 544 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 545 | return s_mutex_lock_count; |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 546 | } |
bart | 6bbefaf | 2008-04-19 15:16:45 +0000 | [diff] [blame] | 547 | |
bart | dc1ef03 | 2009-02-15 14:18:02 +0000 | [diff] [blame] | 548 | ULong DRD_(get_mutex_segment_creation_count)(void) |
bart | 6bbefaf | 2008-04-19 15:16:45 +0000 | [diff] [blame] | 549 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 550 | return s_mutex_segment_creation_count; |
bart | 6bbefaf | 2008-04-19 15:16:45 +0000 | [diff] [blame] | 551 | } |