Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2011 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | #include "mutex.h" |
| 18 | |
| 19 | #include <errno.h> |
| 20 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 21 | #include "cutils/atomic.h" |
| 22 | #include "cutils/atomic-inline.h" |
| 23 | #include "linux/futex.h" |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 24 | #include "logging.h" |
Elliott Hughes | 6b35575 | 2012-01-13 16:49:08 -0800 | [diff] [blame] | 25 | #include "runtime.h" |
Elliott Hughes | ffb465f | 2012-03-01 18:46:05 -0800 | [diff] [blame] | 26 | #include "thread.h" |
| 27 | #include "utils.h" |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 28 | |
Elliott Hughes | b08e8a3 | 2012-04-02 10:51:41 -0700 | [diff] [blame] | 29 | #if defined(__APPLE__) |
| 30 | #include "AvailabilityMacros.h" // For MAC_OS_X_VERSION_MAX_ALLOWED |
| 31 | #endif |
| 32 | |
Elliott Hughes | 8d768a9 | 2011-09-14 16:35:25 -0700 | [diff] [blame] | 33 | #define CHECK_MUTEX_CALL(call, args) CHECK_PTHREAD_CALL(call, args, name_) |
| 34 | |
Elliott Hughes | f834936 | 2012-06-18 15:00:06 -0700 | [diff] [blame] | 35 | extern int pthread_mutex_lock(pthread_mutex_t* mutex) EXCLUSIVE_LOCK_FUNCTION(mutex); |
| 36 | extern int pthread_mutex_unlock(pthread_mutex_t* mutex) UNLOCK_FUNCTION(1); |
| 37 | extern int pthread_mutex_trylock(pthread_mutex_t* mutex) EXCLUSIVE_TRYLOCK_FUNCTION(0, mutex); |
| 38 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 39 | #if ART_USE_FUTEXES |
| 40 | #include "sys/syscall.h" |
| 41 | #ifndef SYS_futex |
| 42 | #define SYS_futex __NR_futex |
| 43 | #endif |
| 44 | int futex(volatile int *uaddr, int op, int val, const struct timespec *timeout, int *, int ) { |
| 45 | return syscall(SYS_futex, uaddr, op, val, timeout, NULL, NULL); |
| 46 | } |
| 47 | #endif // ART_USE_FUTEXES |
| 48 | |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 49 | namespace art { |
| 50 | |
Brian Carlstrom | f3a2641 | 2012-08-24 11:06:02 -0700 | [diff] [blame] | 51 | // This works on Mac OS 10.6 but hasn't been tested on older releases. |
Elliott Hughes | f149843 | 2012-03-28 19:34:27 -0700 | [diff] [blame] | 52 | struct __attribute__((__may_alias__)) darwin_pthread_mutex_t { |
Brian Carlstrom | f3a2641 | 2012-08-24 11:06:02 -0700 | [diff] [blame] | 53 | long padding0; |
| 54 | int padding1; |
| 55 | uint32_t padding2; |
| 56 | int16_t padding3; |
| 57 | int16_t padding4; |
| 58 | uint32_t padding5; |
| 59 | pthread_t darwin_pthread_mutex_owner; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 60 | // ...other stuff we don't care about. |
| 61 | }; |
| 62 | |
| 63 | struct __attribute__((__may_alias__)) darwin_pthread_rwlock_t { |
Brian Carlstrom | f3a2641 | 2012-08-24 11:06:02 -0700 | [diff] [blame] | 64 | long padding0; |
| 65 | pthread_mutex_t padding1; |
| 66 | int padding2; |
| 67 | pthread_cond_t padding3; |
| 68 | pthread_cond_t padding4; |
| 69 | int padding5; |
| 70 | int padding6; |
| 71 | pthread_t darwin_pthread_rwlock_owner; |
Elliott Hughes | f149843 | 2012-03-28 19:34:27 -0700 | [diff] [blame] | 72 | // ...other stuff we don't care about. |
| 73 | }; |
| 74 | |
| 75 | struct __attribute__((__may_alias__)) glibc_pthread_mutex_t { |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 76 | int32_t padding0[2]; |
Elliott Hughes | f149843 | 2012-03-28 19:34:27 -0700 | [diff] [blame] | 77 | int owner; |
| 78 | // ...other stuff we don't care about. |
| 79 | }; |
| 80 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 81 | struct __attribute__((__may_alias__)) glibc_pthread_rwlock_t { |
| 82 | #ifdef __LP64__ |
| 83 | int32_t padding0[6]; |
| 84 | #else |
| 85 | int32_t padding0[7]; |
| 86 | #endif |
| 87 | int writer; |
| 88 | // ...other stuff we don't care about. |
| 89 | }; |
| 90 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 91 | BaseMutex::BaseMutex(const char* name, LockLevel level) : level_(level), name_(name) {} |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 92 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 93 | static void CheckUnattachedThread(LockLevel level) { |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 94 | // The check below enumerates the cases where we expect not to be able to sanity check locks |
| 95 | // on a thread. TODO: tighten this check. |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 96 | if (kDebugLocking) { |
| 97 | Runtime* runtime = Runtime::Current(); |
| 98 | CHECK(runtime == NULL || !runtime->IsStarted() || runtime->IsShuttingDown() || |
| 99 | level == kDefaultMutexLevel || level == kThreadListLock || |
| 100 | level == kLoggingLock || level == kAbortLock); |
| 101 | } |
Elliott Hughes | ffb465f | 2012-03-01 18:46:05 -0800 | [diff] [blame] | 102 | } |
| 103 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 104 | void BaseMutex::RegisterAsLocked(Thread* self) { |
| 105 | if (UNLIKELY(self == NULL)) { |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 106 | CheckUnattachedThread(level_); |
| 107 | return; |
| 108 | } |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 109 | if (kDebugLocking) { |
| 110 | // Check if a bad Mutex of this level or lower is held. |
| 111 | bool bad_mutexes_held = false; |
| 112 | for (int i = level_; i >= 0; --i) { |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 113 | BaseMutex* held_mutex = self->GetHeldMutex(static_cast<LockLevel>(i)); |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 114 | if (UNLIKELY(held_mutex != NULL)) { |
| 115 | LOG(ERROR) << "Lock level violation: holding \"" << held_mutex->name_ << "\" (level " << i |
| 116 | << ") while locking \"" << name_ << "\" (level " << static_cast<int>(level_) << ")"; |
| 117 | if (i > kAbortLock) { |
| 118 | // Only abort in the check below if this is more than abort level lock. |
| 119 | bad_mutexes_held = true; |
| 120 | } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 121 | } |
| 122 | } |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 123 | CHECK(!bad_mutexes_held); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 124 | } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 125 | // Don't record monitors as they are outside the scope of analysis. They may be inspected off of |
| 126 | // the monitor list. |
| 127 | if (level_ != kMonitorLock) { |
| 128 | self->SetHeldMutex(level_, this); |
| 129 | } |
| 130 | } |
| 131 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 132 | void BaseMutex::RegisterAsUnlocked(Thread* self) { |
| 133 | if (UNLIKELY(self == NULL)) { |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 134 | CheckUnattachedThread(level_); |
| 135 | return; |
| 136 | } |
| 137 | if (level_ != kMonitorLock) { |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 138 | if (kDebugLocking) { |
| 139 | CHECK(self->GetHeldMutex(level_) == this) << "Unlocking on unacquired mutex: " << name_; |
| 140 | } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 141 | self->SetHeldMutex(level_, NULL); |
| 142 | } |
| 143 | } |
| 144 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 145 | void BaseMutex::CheckSafeToWait(Thread* self) { |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 146 | if (self == NULL) { |
| 147 | CheckUnattachedThread(level_); |
| 148 | return; |
| 149 | } |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 150 | if (kDebugLocking) { |
| 151 | CHECK(self->GetHeldMutex(level_) == this) << "Waiting on unacquired mutex: " << name_; |
| 152 | bool bad_mutexes_held = false; |
| 153 | for (int i = kMaxMutexLevel; i >= 0; --i) { |
| 154 | if (i != level_) { |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 155 | BaseMutex* held_mutex = self->GetHeldMutex(static_cast<LockLevel>(i)); |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 156 | if (held_mutex != NULL) { |
| 157 | LOG(ERROR) << "Holding " << held_mutex->name_ << " (level " << i |
| 158 | << ") while performing wait on: " |
| 159 | << name_ << " (level " << static_cast<int>(level_) << ")"; |
| 160 | bad_mutexes_held = true; |
| 161 | } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 162 | } |
| 163 | } |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 164 | CHECK(!bad_mutexes_held); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 165 | } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 166 | } |
| 167 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 168 | Mutex::Mutex(const char* name, LockLevel level, bool recursive) |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 169 | : BaseMutex(name, level), recursive_(recursive), recursion_count_(0) { |
Brian Carlstrom | f3a2641 | 2012-08-24 11:06:02 -0700 | [diff] [blame] | 170 | #if defined(__BIONIC__) || defined(__APPLE__) |
| 171 | // Use recursive mutexes for bionic and Apple otherwise the |
| 172 | // non-recursive mutexes don't have TIDs to check lock ownership of. |
Elliott Hughes | bbd9d83 | 2011-11-07 14:40:00 -0800 | [diff] [blame] | 173 | pthread_mutexattr_t attributes; |
| 174 | CHECK_MUTEX_CALL(pthread_mutexattr_init, (&attributes)); |
| 175 | CHECK_MUTEX_CALL(pthread_mutexattr_settype, (&attributes, PTHREAD_MUTEX_RECURSIVE)); |
| 176 | CHECK_MUTEX_CALL(pthread_mutex_init, (&mutex_, &attributes)); |
| 177 | CHECK_MUTEX_CALL(pthread_mutexattr_destroy, (&attributes)); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 178 | #else |
| 179 | CHECK_MUTEX_CALL(pthread_mutex_init, (&mutex_, NULL)); |
| 180 | #endif |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 181 | } |
| 182 | |
| 183 | Mutex::~Mutex() { |
Elliott Hughes | e62934d | 2012-04-09 11:24:29 -0700 | [diff] [blame] | 184 | // We can't use CHECK_MUTEX_CALL here because on shutdown a suspended daemon thread |
| 185 | // may still be using locks. |
Elliott Hughes | 6b35575 | 2012-01-13 16:49:08 -0800 | [diff] [blame] | 186 | int rc = pthread_mutex_destroy(&mutex_); |
| 187 | if (rc != 0) { |
| 188 | errno = rc; |
Elliott Hughes | b3bd5f0 | 2012-03-08 21:05:27 -0800 | [diff] [blame] | 189 | // TODO: should we just not log at all if shutting down? this could be the logging mutex! |
Elliott Hughes | 6b35575 | 2012-01-13 16:49:08 -0800 | [diff] [blame] | 190 | bool shutting_down = Runtime::Current()->IsShuttingDown(); |
| 191 | PLOG(shutting_down ? WARNING : FATAL) << "pthread_mutex_destroy failed for " << name_; |
| 192 | } |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 193 | } |
| 194 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 195 | void Mutex::ExclusiveLock(Thread* self) { |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 196 | if (kDebugLocking && !recursive_) { |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 197 | AssertNotHeld(self); |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 198 | } |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 199 | if (!recursive_ || !IsExclusiveHeld(self)) { |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 200 | CHECK_MUTEX_CALL(pthread_mutex_lock, (&mutex_)); |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 201 | RegisterAsLocked(self); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 202 | } |
| 203 | recursion_count_++; |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 204 | if (kDebugLocking) { |
| 205 | CHECK(recursion_count_ == 1 || recursive_) << "Unexpected recursion count on mutex: " |
| 206 | << name_ << " " << recursion_count_; |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 207 | AssertHeld(self); |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 208 | } |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 209 | } |
| 210 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 211 | bool Mutex::ExclusiveTryLock(Thread* self) { |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 212 | if (kDebugLocking && !recursive_) { |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 213 | AssertNotHeld(self); |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 214 | } |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 215 | if (!recursive_ || !IsExclusiveHeld(self)) { |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 216 | int result = pthread_mutex_trylock(&mutex_); |
| 217 | if (result == EBUSY) { |
| 218 | return false; |
| 219 | } |
| 220 | if (result != 0) { |
| 221 | errno = result; |
| 222 | PLOG(FATAL) << "pthread_mutex_trylock failed for " << name_; |
| 223 | } |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 224 | RegisterAsLocked(self); |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 225 | } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 226 | recursion_count_++; |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 227 | if (kDebugLocking) { |
| 228 | CHECK(recursion_count_ == 1 || recursive_) << "Unexpected recursion count on mutex: " |
| 229 | << name_ << " " << recursion_count_; |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 230 | AssertHeld(self); |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 231 | } |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 232 | return true; |
| 233 | } |
| 234 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 235 | void Mutex::ExclusiveUnlock(Thread* self) { |
| 236 | AssertHeld(self); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 237 | recursion_count_--; |
| 238 | if (!recursive_ || recursion_count_ == 0) { |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 239 | if (kDebugLocking) { |
| 240 | CHECK(recursion_count_ == 0 || recursive_) << "Unexpected recursion count on mutex: " |
| 241 | << name_ << " " << recursion_count_; |
| 242 | } |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 243 | RegisterAsUnlocked(self); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 244 | CHECK_MUTEX_CALL(pthread_mutex_unlock, (&mutex_)); |
| 245 | } |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 246 | } |
| 247 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 248 | bool Mutex::IsExclusiveHeld(const Thread* self) const { |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 249 | bool result; |
| 250 | if (self == NULL || level_ == kMonitorLock) { // Handle unattached threads and monitors. |
| 251 | result = (GetExclusiveOwnerTid() == static_cast<uint64_t>(GetTid())); |
| 252 | } else { |
| 253 | result = (self->GetHeldMutex(level_) == this); |
| 254 | // Sanity debug check that if we think it is locked, so does the pthread. |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 255 | if (kDebugLocking) { |
| 256 | CHECK(result == (GetExclusiveOwnerTid() == static_cast<uint64_t>(GetTid()))); |
| 257 | } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 258 | } |
| 259 | return result; |
Elliott Hughes | f149843 | 2012-03-28 19:34:27 -0700 | [diff] [blame] | 260 | } |
| 261 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 262 | uint64_t Mutex::GetExclusiveOwnerTid() const { |
Elliott Hughes | 3147a23 | 2011-10-12 15:55:07 -0700 | [diff] [blame] | 263 | #if defined(__BIONIC__) |
Elliott Hughes | f149843 | 2012-03-28 19:34:27 -0700 | [diff] [blame] | 264 | return static_cast<uint64_t>((mutex_.value >> 16) & 0xffff); |
Elliott Hughes | 3147a23 | 2011-10-12 15:55:07 -0700 | [diff] [blame] | 265 | #elif defined(__GLIBC__) |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 266 | return reinterpret_cast<const glibc_pthread_mutex_t*>(&mutex_)->owner; |
Elliott Hughes | cf04431 | 2012-01-23 18:48:51 -0800 | [diff] [blame] | 267 | #elif defined(__APPLE__) |
Brian Carlstrom | f3a2641 | 2012-08-24 11:06:02 -0700 | [diff] [blame] | 268 | const darwin_pthread_mutex_t* dpmutex = reinterpret_cast<const darwin_pthread_mutex_t*>(&mutex_); |
| 269 | pthread_t owner = dpmutex->darwin_pthread_mutex_owner; |
Brian Carlstrom | bd93c30 | 2012-08-27 16:58:28 -0700 | [diff] [blame] | 270 | // 0 for unowned, -1 for PTHREAD_MTX_TID_SWITCHING |
| 271 | // TODO: should we make darwin_pthread_mutex_owner volatile and recheck until not -1? |
Brian Carlstrom | f3a2641 | 2012-08-24 11:06:02 -0700 | [diff] [blame] | 272 | if ((owner == (pthread_t)0) || (owner == (pthread_t)-1)) { |
| 273 | return 0; |
| 274 | } |
| 275 | uint64_t tid; |
| 276 | CHECK_PTHREAD_CALL(pthread_threadid_np, (owner, &tid), __FUNCTION__); // Requires Mac OS 10.6 |
| 277 | return tid; |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 278 | #else |
Elliott Hughes | f149843 | 2012-03-28 19:34:27 -0700 | [diff] [blame] | 279 | #error unsupported C library |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 280 | #endif |
| 281 | } |
| 282 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 283 | ReaderWriterMutex::ReaderWriterMutex(const char* name, LockLevel level) : |
| 284 | BaseMutex(name, level) |
| 285 | #if ART_USE_FUTEXES |
| 286 | , state_(0), exclusive_owner_(0), num_pending_readers_(0), num_pending_writers_(0) |
| 287 | #endif |
| 288 | { |
| 289 | #if !ART_USE_FUTEXES |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 290 | CHECK_MUTEX_CALL(pthread_rwlock_init, (&rwlock_, NULL)); |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 291 | #endif |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 292 | } |
| 293 | |
| 294 | ReaderWriterMutex::~ReaderWriterMutex() { |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 295 | #if ART_USE_FUTEXES |
| 296 | CHECK_EQ(state_, 0); |
| 297 | CHECK_EQ(exclusive_owner_, 0U); |
| 298 | CHECK_EQ(num_pending_readers_, 0); |
| 299 | CHECK_EQ(num_pending_writers_, 0); |
| 300 | #else |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 301 | // We can't use CHECK_MUTEX_CALL here because on shutdown a suspended daemon thread |
| 302 | // may still be using locks. |
| 303 | int rc = pthread_rwlock_destroy(&rwlock_); |
| 304 | if (rc != 0) { |
| 305 | errno = rc; |
| 306 | // TODO: should we just not log at all if shutting down? this could be the logging mutex! |
| 307 | bool shutting_down = Runtime::Current()->IsShuttingDown(); |
| 308 | PLOG(shutting_down ? WARNING : FATAL) << "pthread_mutex_destroy failed for " << name_; |
Brian Carlstrom | cd74c4b | 2012-01-23 13:21:00 -0800 | [diff] [blame] | 309 | } |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 310 | #endif |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 311 | } |
| 312 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 313 | void ReaderWriterMutex::ExclusiveLock(Thread* self) { |
| 314 | AssertNotExclusiveHeld(self); |
| 315 | #if ART_USE_FUTEXES |
| 316 | bool done = false; |
| 317 | do { |
| 318 | int32_t cur_state = state_; |
| 319 | if (cur_state == 0) { |
| 320 | // Change state from 0 to -1. |
| 321 | done = android_atomic_cmpxchg(0, -1, &state_) == 0; |
| 322 | } else { |
| 323 | // Failed to acquire, hang up. |
| 324 | android_atomic_inc(&num_pending_writers_); |
| 325 | if (futex(&state_, FUTEX_WAIT, cur_state, NULL, NULL, 0) != 0) { |
| 326 | if (errno != EAGAIN) { |
| 327 | PLOG(FATAL) << "futex wait failed for " << name_; |
| 328 | } |
| 329 | } |
| 330 | android_atomic_dec(&num_pending_writers_); |
| 331 | } |
| 332 | } while(!done); |
| 333 | exclusive_owner_ = static_cast<uint64_t>(GetTid()); |
| 334 | #else |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 335 | CHECK_MUTEX_CALL(pthread_rwlock_wrlock, (&rwlock_)); |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 336 | #endif |
| 337 | RegisterAsLocked(self); |
| 338 | AssertExclusiveHeld(self); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 339 | } |
| 340 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 341 | void ReaderWriterMutex::ExclusiveUnlock(Thread* self) { |
| 342 | AssertExclusiveHeld(self); |
| 343 | RegisterAsUnlocked(self); |
| 344 | #if ART_USE_FUTEXES |
| 345 | bool done = false; |
| 346 | do { |
| 347 | int32_t cur_state = state_; |
| 348 | if (cur_state == -1) { |
| 349 | // We're no longer the owner. |
| 350 | exclusive_owner_ = 0; |
| 351 | // Change state from -1 to 0. |
| 352 | done = android_atomic_cmpxchg(-1, 0, &state_) == 0; |
| 353 | if (done) { // cmpxchg may fail due to noise? |
| 354 | // Wake any waiters. |
| 355 | if (num_pending_readers_ > 0 || num_pending_writers_ > 0) { |
| 356 | futex(&state_, FUTEX_WAKE, -1, NULL, NULL, 0); |
| 357 | } |
| 358 | } |
| 359 | } else { |
| 360 | LOG(FATAL) << "Unexpected state_:" << cur_state << " for " << name_; |
| 361 | } |
| 362 | } while(!done); |
| 363 | #else |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 364 | CHECK_MUTEX_CALL(pthread_rwlock_unlock, (&rwlock_)); |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 365 | #endif |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 366 | } |
| 367 | |
Ian Rogers | 66aee5c | 2012-08-15 17:17:47 -0700 | [diff] [blame] | 368 | #if HAVE_TIMED_RWLOCK |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 369 | bool ReaderWriterMutex::ExclusiveLockWithTimeout(Thread* self, const timespec& abs_timeout) { |
| 370 | #if ART_USE_FUTEXES |
| 371 | bool done = false; |
| 372 | do { |
| 373 | int32_t cur_state = state_; |
| 374 | if (cur_state == 0) { |
| 375 | // Change state from 0 to -1. |
| 376 | done = android_atomic_cmpxchg(0, -1, &state_) == 0; |
| 377 | } else { |
| 378 | // Failed to acquire, hang up. |
| 379 | android_atomic_inc(&num_pending_writers_); |
| 380 | if (futex(&state_, FUTEX_WAIT, cur_state, &abs_timeout, NULL, 0) != 0) { |
| 381 | if (errno == ETIMEDOUT) { |
| 382 | android_atomic_dec(&num_pending_writers_); |
| 383 | return false; |
| 384 | } else if (errno != EAGAIN) { |
| 385 | PLOG(FATAL) << "timed futex wait failed for " << name_; |
| 386 | } |
| 387 | } |
| 388 | android_atomic_dec(&num_pending_writers_); |
| 389 | } |
| 390 | } while(!done); |
| 391 | exclusive_owner_ = static_cast<uint64_t>(GetTid()); |
| 392 | #else |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 393 | int result = pthread_rwlock_timedwrlock(&rwlock_, &abs_timeout); |
| 394 | if (result == ETIMEDOUT) { |
| 395 | return false; |
| 396 | } |
| 397 | if (result != 0) { |
| 398 | errno = result; |
Ian Rogers | a5acfd3 | 2012-08-15 11:50:10 -0700 | [diff] [blame] | 399 | PLOG(FATAL) << "pthread_rwlock_timedwrlock failed for " << name_; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 400 | } |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 401 | #endif |
| 402 | RegisterAsLocked(self); |
| 403 | AssertSharedHeld(self); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 404 | return true; |
| 405 | } |
Ian Rogers | 66aee5c | 2012-08-15 17:17:47 -0700 | [diff] [blame] | 406 | #endif |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 407 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 408 | void ReaderWriterMutex::SharedLock(Thread* self) { |
| 409 | #if ART_USE_FUTEXES |
| 410 | bool done = false; |
| 411 | do { |
| 412 | int32_t cur_state = state_; |
| 413 | if (cur_state >= 0) { |
| 414 | // Add as an extra reader. |
| 415 | done = android_atomic_cmpxchg(cur_state, cur_state + 1, &state_) == 0; |
| 416 | } else { |
| 417 | // Owner holds it exclusively, hang up. |
| 418 | android_atomic_inc(&num_pending_readers_); |
| 419 | if (futex(&state_, FUTEX_WAIT, cur_state, NULL, NULL, 0) != 0) { |
| 420 | if (errno != EAGAIN) { |
| 421 | PLOG(FATAL) << "futex wait failed for " << name_; |
| 422 | } |
| 423 | } |
| 424 | android_atomic_dec(&num_pending_readers_); |
| 425 | } |
| 426 | } while(!done); |
| 427 | #else |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 428 | CHECK_MUTEX_CALL(pthread_rwlock_rdlock, (&rwlock_)); |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 429 | #endif |
| 430 | RegisterAsLocked(self); |
| 431 | AssertSharedHeld(self); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 432 | } |
| 433 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 434 | bool ReaderWriterMutex::SharedTryLock(Thread* self) { |
| 435 | #if ART_USE_FUTEXES |
| 436 | bool done = false; |
| 437 | do { |
| 438 | int32_t cur_state = state_; |
| 439 | if (cur_state >= 0) { |
| 440 | // Add as an extra reader. |
| 441 | done = android_atomic_cmpxchg(cur_state, cur_state + 1, &state_) == 0; |
| 442 | } else { |
| 443 | // Owner holds it exclusively. |
| 444 | return false; |
| 445 | } |
| 446 | } while(!done); |
| 447 | #else |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 448 | int result = pthread_rwlock_tryrdlock(&rwlock_); |
| 449 | if (result == EBUSY) { |
| 450 | return false; |
| 451 | } |
| 452 | if (result != 0) { |
| 453 | errno = result; |
| 454 | PLOG(FATAL) << "pthread_mutex_trylock failed for " << name_; |
| 455 | } |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 456 | #endif |
| 457 | RegisterAsLocked(self); |
| 458 | AssertSharedHeld(self); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 459 | return true; |
| 460 | } |
| 461 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 462 | void ReaderWriterMutex::SharedUnlock(Thread* self) { |
| 463 | AssertSharedHeld(self); |
| 464 | RegisterAsUnlocked(self); |
| 465 | #if ART_USE_FUTEXES |
| 466 | bool done = false; |
| 467 | do { |
| 468 | int32_t cur_state = state_; |
| 469 | if (LIKELY(cur_state > 0)) { |
| 470 | // Reduce state by 1. |
| 471 | done = android_atomic_cmpxchg(cur_state, cur_state - 1, &state_) == 0; |
| 472 | if (done && (cur_state - 1) == 0) { // cmpxchg may fail due to noise? |
| 473 | if (num_pending_writers_ > 0 || num_pending_readers_ > 0) { |
| 474 | // Wake any exclusive waiters as there are now no readers. |
| 475 | futex(&state_, FUTEX_WAKE, -1, NULL, NULL, 0); |
| 476 | } |
| 477 | } |
| 478 | } else { |
| 479 | LOG(FATAL) << "Unexpected state_:" << cur_state << " for " << name_; |
| 480 | } |
| 481 | } while(!done); |
| 482 | #else |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 483 | CHECK_MUTEX_CALL(pthread_rwlock_unlock, (&rwlock_)); |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 484 | #endif |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 485 | } |
| 486 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 487 | bool ReaderWriterMutex::IsExclusiveHeld(const Thread* self) const { |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 488 | bool result = (GetExclusiveOwnerTid() == static_cast<uint64_t>(GetTid())); |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 489 | if (kDebugLocking) { |
| 490 | // Sanity that if the pthread thinks we own the lock the Thread agrees. |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 491 | CHECK((self == NULL) || !result || (self->GetHeldMutex(level_) == this)); |
| 492 | } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 493 | return result; |
| 494 | } |
| 495 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 496 | bool ReaderWriterMutex::IsSharedHeld(const Thread* self) const { |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 497 | bool result; |
| 498 | if (UNLIKELY(self == NULL)) { // Handle unattached threads. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 499 | result = IsExclusiveHeld(self); // TODO: a better best effort here. |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 500 | } else { |
| 501 | result = (self->GetHeldMutex(level_) == this); |
| 502 | } |
| 503 | return result; |
| 504 | } |
| 505 | |
| 506 | uint64_t ReaderWriterMutex::GetExclusiveOwnerTid() const { |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 507 | #if ART_USE_FUTEXES |
| 508 | return exclusive_owner_; |
| 509 | #else |
Brian Carlstrom | cd74c4b | 2012-01-23 13:21:00 -0800 | [diff] [blame] | 510 | #if defined(__BIONIC__) |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 511 | return rwlock_.writerThreadId; |
Brian Carlstrom | cd74c4b | 2012-01-23 13:21:00 -0800 | [diff] [blame] | 512 | #elif defined(__GLIBC__) |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 513 | return reinterpret_cast<const glibc_pthread_rwlock_t*>(&rwlock_)->writer; |
Brian Carlstrom | cd74c4b | 2012-01-23 13:21:00 -0800 | [diff] [blame] | 514 | #elif defined(__APPLE__) |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 515 | const darwin_pthread_rwlock_t* |
| 516 | dprwlock = reinterpret_cast<const darwin_pthread_rwlock_t*>(&rwlock_); |
Brian Carlstrom | f3a2641 | 2012-08-24 11:06:02 -0700 | [diff] [blame] | 517 | pthread_t owner = dprwlock->darwin_pthread_rwlock_owner; |
| 518 | if (owner == (pthread_t)0) { |
| 519 | return 0; |
| 520 | } |
| 521 | uint64_t tid; |
| 522 | CHECK_PTHREAD_CALL(pthread_threadid_np, (owner, &tid), __FUNCTION__); // Requires Mac OS 10.6 |
| 523 | return tid; |
Brian Carlstrom | cd74c4b | 2012-01-23 13:21:00 -0800 | [diff] [blame] | 524 | #else |
Elliott Hughes | f149843 | 2012-03-28 19:34:27 -0700 | [diff] [blame] | 525 | #error unsupported C library |
Brian Carlstrom | cd74c4b | 2012-01-23 13:21:00 -0800 | [diff] [blame] | 526 | #endif |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 527 | #endif |
Brian Carlstrom | cd74c4b | 2012-01-23 13:21:00 -0800 | [diff] [blame] | 528 | } |
| 529 | |
Elliott Hughes | 5f79133 | 2011-09-15 17:45:30 -0700 | [diff] [blame] | 530 | ConditionVariable::ConditionVariable(const std::string& name) : name_(name) { |
| 531 | CHECK_MUTEX_CALL(pthread_cond_init, (&cond_, NULL)); |
| 532 | } |
| 533 | |
| 534 | ConditionVariable::~ConditionVariable() { |
Elliott Hughes | e62934d | 2012-04-09 11:24:29 -0700 | [diff] [blame] | 535 | // We can't use CHECK_MUTEX_CALL here because on shutdown a suspended daemon thread |
| 536 | // may still be using condition variables. |
| 537 | int rc = pthread_cond_destroy(&cond_); |
| 538 | if (rc != 0) { |
| 539 | errno = rc; |
| 540 | bool shutting_down = Runtime::Current()->IsShuttingDown(); |
| 541 | PLOG(shutting_down ? WARNING : FATAL) << "pthread_cond_destroy failed for " << name_; |
| 542 | } |
Elliott Hughes | 5f79133 | 2011-09-15 17:45:30 -0700 | [diff] [blame] | 543 | } |
| 544 | |
| 545 | void ConditionVariable::Broadcast() { |
| 546 | CHECK_MUTEX_CALL(pthread_cond_broadcast, (&cond_)); |
| 547 | } |
| 548 | |
| 549 | void ConditionVariable::Signal() { |
| 550 | CHECK_MUTEX_CALL(pthread_cond_signal, (&cond_)); |
| 551 | } |
| 552 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 553 | void ConditionVariable::Wait(Thread* self, Mutex& mutex) { |
| 554 | mutex.CheckSafeToWait(self); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 555 | unsigned int old_recursion_count = mutex.recursion_count_; |
| 556 | mutex.recursion_count_ = 0; |
Elliott Hughes | f149843 | 2012-03-28 19:34:27 -0700 | [diff] [blame] | 557 | CHECK_MUTEX_CALL(pthread_cond_wait, (&cond_, &mutex.mutex_)); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 558 | mutex.recursion_count_ = old_recursion_count; |
Elliott Hughes | 5f79133 | 2011-09-15 17:45:30 -0700 | [diff] [blame] | 559 | } |
| 560 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 561 | void ConditionVariable::TimedWait(Thread* self, Mutex& mutex, const timespec& ts) { |
Elliott Hughes | 5f79133 | 2011-09-15 17:45:30 -0700 | [diff] [blame] | 562 | #ifdef HAVE_TIMEDWAIT_MONOTONIC |
| 563 | #define TIMEDWAIT pthread_cond_timedwait_monotonic |
| 564 | #else |
| 565 | #define TIMEDWAIT pthread_cond_timedwait |
| 566 | #endif |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame^] | 567 | mutex.CheckSafeToWait(self); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 568 | unsigned int old_recursion_count = mutex.recursion_count_; |
| 569 | mutex.recursion_count_ = 0; |
Elliott Hughes | f149843 | 2012-03-28 19:34:27 -0700 | [diff] [blame] | 570 | int rc = TIMEDWAIT(&cond_, &mutex.mutex_, &ts); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 571 | mutex.recursion_count_ = old_recursion_count; |
Elliott Hughes | 5f79133 | 2011-09-15 17:45:30 -0700 | [diff] [blame] | 572 | if (rc != 0 && rc != ETIMEDOUT) { |
| 573 | errno = rc; |
| 574 | PLOG(FATAL) << "TimedWait failed for " << name_; |
| 575 | } |
| 576 | } |
| 577 | |
Elliott Hughes | e62934d | 2012-04-09 11:24:29 -0700 | [diff] [blame] | 578 | } // namespace art |