mutex.h revision a206c745dbb64b14f05c87891d425475c2f6d63a
18daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes/* 28daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes * Copyright (C) 2011 The Android Open Source Project 38daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes * 48daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes * Licensed under the Apache License, Version 2.0 (the "License"); 58daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes * you may not use this file except in compliance with the License. 68daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes * You may obtain a copy of the License at 78daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes * 88daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes * http://www.apache.org/licenses/LICENSE-2.0 98daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes * 108daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes * Unless required by applicable law or agreed to in writing, software 118daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes * distributed under the License is distributed on an "AS IS" BASIS, 128daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 138daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes * See the License for the specific language governing permissions and 148daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes * limitations under the License. 158daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes */ 168daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 17fc0e3219edc9a5bf81b166e82fd5db2796eb6a0dBrian Carlstrom#ifndef ART_RUNTIME_BASE_MUTEX_H_ 18fc0e3219edc9a5bf81b166e82fd5db2796eb6a0dBrian Carlstrom#define ART_RUNTIME_BASE_MUTEX_H_ 198daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 208daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes#include <pthread.h> 21cd74c4b3a6893c876c6e03fd99a1264249653d80Brian Carlstrom#include <stdint.h> 22ffb465f23d9549dd591e6aa62e9250523cb00233Elliott Hughes 23ffb465f23d9549dd591e6aa62e9250523cb00233Elliott Hughes#include <iosfwd> 248daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes#include <string> 258daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 26ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers#include "atomic.h" 2707ed66b5ae659c452cbe1ab20c3dbf1d6f546461Elliott Hughes#include "base/logging.h" 28761600567d73b23324ae0251e871c15d6849ffd8Elliott Hughes#include "base/macros.h" 2900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers#include "globals.h" 3081d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 31ab47016374d340011680e9cd970ee7d6225d6704Ian Rogers#if defined(__APPLE__) 3281d425b0b232962441616f8b14f73620bffef5e5Ian Rogers#define ART_USE_FUTEXES 0 33ab47016374d340011680e9cd970ee7d6225d6704Ian Rogers#else 34c01417898a6e4f8a5663d6c0556982488c133cdfChris Dearman#define ART_USE_FUTEXES 1 35ab47016374d340011680e9cd970ee7d6225d6704Ian Rogers#endif 368daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 3766aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers// Currently Darwin doesn't support locks with timeouts. 3866aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#if !defined(__APPLE__) 3966aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#define HAVE_TIMED_RWLOCK 1 4066aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#else 4166aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#define HAVE_TIMED_RWLOCK 0 4266aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#endif 4366aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers 448daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughesnamespace art { 458daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 4690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SHARED_LOCKABLE ReaderWriterMutex; 4790443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SHARED_LOCKABLE MutatorMutex; 4856edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogersclass ScopedContentionRecorder; 4950b35e2fd1a68cd1240e4a9d9f363e11764957d1Ian Rogersclass Thread; 5050b35e2fd1a68cd1240e4a9d9f363e11764957d1Ian Rogers 51719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers// LockLevel is used to impose a lock hierarchy [1] where acquisition of a Mutex at a higher or 52719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers// equal level to a lock a thread holds is invalid. The lock hierarchy achieves a cycle free 53719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers// partial ordering and thereby cause deadlock situations to fail checks. 54719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers// 55719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers// [1] http://www.drdobbs.com/parallel/use-lock-hierarchies-to-avoid-deadlock/204801163 56719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogersenum LockLevel { 57719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kLoggingLock = 0, 583eed93dd5be03e5539827bebf0f414251a12e15eHiroshi Yamauchi kMemMapsLock, 597de77dd4f2d3cbb0615ee001589eb99ae82c3dccRaghu Gandham kSwapMutexesLock, 60719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kUnexpectedSignalLock, 61719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kThreadSuspendCountLock, 62719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kAbortLock, 63e2facc5b18cd756a8b5500fb3d90da69c9ee0fb7Igor Murashkin kLambdaTableLock, 64719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpSocketLock, 652cd334ae2d4287216523882f0d298cf3901b7ab1Hiroshi Yamauchi kRegionSpaceRegionLock, 662994605707219f67af8340ddd9379ce9bd86d74cMathieu Chartier kRosAllocGlobalLock, 672994605707219f67af8340ddd9379ce9bd86d74cMathieu Chartier kRosAllocBracketLock, 682994605707219f67af8340ddd9379ce9bd86d74cMathieu Chartier kRosAllocBulkFreeLock, 69673ed3d8aedc5462a47ded827c99f35d46525457Mathieu Chartier kMarkSweepMarkStackLock, 70bc4d218ce2ceef0c4f308d4ff42f7ec1ec43c40eAndreas Gampe kTransactionLogLock, 71673ed3d8aedc5462a47ded827c99f35d46525457Mathieu Chartier kJniWeakGlobalsLock, 72a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceQueueSoftReferencesLock, 73a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceQueuePhantomReferencesLock, 74a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceQueueFinalizerReferencesLock, 75a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceQueueWeakReferencesLock, 76a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceQueueClearedReferencesLock, 77a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceProcessorLock, 785cc349f3dd578e974f78314c50b6a0267c23e591David Srbecky kJitDebugInterfaceLock, 79719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kAllocSpaceLock, 802cd334ae2d4287216523882f0d298cf3901b7ab1Hiroshi Yamauchi kBumpPointerSpaceBlockLock, 81c785344b87221f5e4e6473e5b762e4e61fe65dcfMathieu Chartier kArenaPoolLock, 82719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kDexFileMethodInlinerLock, 83719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kDexFileToMethodInlinerMapLock, 84719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kInternTableLock, 853f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko kOatFileSecondaryLookupLock, 86a206c745dbb64b14f05c87891d425475c2f6d63aRichard Uhler kHostDlOpenHandlesLock, 87f9c6fc610b27887f832e453a0da1789187293408Mathieu Chartier kOatFileManagerLock, 887526d783ab68ed1dd53c763c75895cb432532b0fAndreas Gampe kTracingUniqueMethodsLock, 897526d783ab68ed1dd53c763c75895cb432532b0fAndreas Gampe kTracingStreamingLock, 90b8aa1e4c10dcdc7fef96634f87e259dfee83a1cfMathieu Chartier kDeoptimizedMethodsLock, 91480d5108fa62f28cbc2e7072610f974953ff73a8Nicolas Geoffray kJitCodeCacheLock, 92b8aa1e4c10dcdc7fef96634f87e259dfee83a1cfMathieu Chartier kClassLoaderClassesLock, 93719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kDefaultMutexLevel, 94719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kMarkSweepLargeObjectLock, 95719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kPinTableLock, 96719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpObjectRegistryLock, 979e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu kModifyLdtLock, 989e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu kAllocatedThreadIdsLock, 9974240819ae09e29b2753ef38f4eb4be1c2762e2eAndreas Gampe kMonitorPoolLock, 1002435a43f6c851c23922d8508fb17c6079248201cbowen_lai kMethodVerifiersLock, 101b8aa1e4c10dcdc7fef96634f87e259dfee83a1cfMathieu Chartier kClassLinkerClassesLock, // TODO rename. 102719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kBreakpointLock, 103719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kMonitorLock, 104440e4ceb310349ee8eb569495bc04d3d7fbe71cbMathieu Chartier kMonitorListLock, 10568d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers kJniLoadLibraryLock, 106719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kThreadListLock, 107306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom kAllocTrackerLock, 108719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kDeoptimizationLock, 109719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kProfilerLock, 1104e5b20863898006ec6c9d120cda167d38dda6e60Sebastien Hertz kJdwpShutdownLock, 111719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpEventListLock, 112719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpAttachLock, 113719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpStartLock, 114719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kRuntimeShutdownLock, 11569dbec6d9d55eeb2867949c2791d01dc9aa916c8Jeff Hao kTraceLock, 116719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kHeapBitmapLock, 117719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kMutatorLock, 1189ef78b59da51080882e47505896b420977fd79aeMathieu Chartier kInstrumentEntrypointsLock, 119719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kZygoteCreationLock, 120719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 121719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kLockLevelCount // Must come last. 122719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers}; 123719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogersstd::ostream& operator<<(std::ostream& os, const LockLevel& rhs); 124719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 1252e250c826b3c405d675017efe79e5db3651c9ee6Brian Carlstromconst bool kDebugLocking = kIsDebugBuild; 12625fd14b87cced64a179dee885573113be5e11944Ian Rogers 1271afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi// Record Log contention information, dumpable via SIGQUIT. 1281afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi#ifdef ART_USE_FUTEXES 12908f2e7b59fab9df108d3d91e6eeb4bbccbb325d1Jeff Hao// To enable lock contention logging, set this to true. 13008f2e7b59fab9df108d3d91e6eeb4bbccbb325d1Jeff Haoconst bool kLogLockContentions = false; 1311afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi#else 1321afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi// Keep this false as lock contention logging is supported only with 1331afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi// futex. 1341afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchiconst bool kLogLockContentions = false; 1351afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi#endif 136d9c4fc94fa618617f94e1de9af5f034549100753Ian Rogersconst size_t kContentionLogSize = 4; 1371afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchiconst size_t kContentionLogDataSize = kLogLockContentions ? 1 : 0; 1381afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchiconst size_t kAllMutexDataSize = kLogLockContentions ? 1 : 0; 1391afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi 14000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Base class for all Mutex implementations 14100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogersclass BaseMutex { 14200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 143bab74963db2484ea5f10a82ea26e8a99722bfefeIan Rogers const char* GetName() const { 14400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers return name_; 14500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 14600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 14700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers virtual bool IsMutex() const { return false; } 14800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers virtual bool IsReaderWriterMutex() const { return false; } 149eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li virtual bool IsMutatorMutex() const { return false; } 15000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 15156edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers virtual void Dump(std::ostream& os) const = 0; 15256edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers 15356edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers static void DumpAll(std::ostream& os); 15456edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers 15500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers protected: 15600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers friend class ConditionVariable; 15700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 15881d425b0b232962441616f8b14f73620bffef5e5Ian Rogers BaseMutex(const char* name, LockLevel level); 15956edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers virtual ~BaseMutex(); 16081d425b0b232962441616f8b14f73620bffef5e5Ian Rogers void RegisterAsLocked(Thread* self); 16181d425b0b232962441616f8b14f73620bffef5e5Ian Rogers void RegisterAsUnlocked(Thread* self); 16281d425b0b232962441616f8b14f73620bffef5e5Ian Rogers void CheckSafeToWait(Thread* self); 16300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 16456edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers friend class ScopedContentionRecorder; 16556edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers 1661afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi void RecordContention(uint64_t blocked_tid, uint64_t owner_tid, uint64_t nano_time_blocked); 16756edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers void DumpContention(std::ostream& os) const; 16856edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers 16981d425b0b232962441616f8b14f73620bffef5e5Ian Rogers const LockLevel level_; // Support for lock hierarchy. 170bab74963db2484ea5f10a82ea26e8a99722bfefeIan Rogers const char* const name_; 1711afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi 17256edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers // A log entry that records contention but makes no guarantee that either tid will be held live. 17356edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers struct ContentionLogEntry { 17456edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers ContentionLogEntry() : blocked_tid(0), owner_tid(0) {} 17556edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers uint64_t blocked_tid; 17656edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers uint64_t owner_tid; 17756edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers AtomicInteger count; 17856edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers }; 1791afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi struct ContentionLogData { 1801afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi ContentionLogEntry contention_log[kContentionLogSize]; 1811afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi // The next entry in the contention log to be updated. Value ranges from 0 to 1821afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi // kContentionLogSize - 1. 1831afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi AtomicInteger cur_content_log_entry; 1841afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi // Number of times the Mutex has been contended. 1851afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi AtomicInteger contention_count; 1861afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi // Sum of time waited by all contenders in ns. 18737f3c968ecd04e77802fe17bb82dabc07de21ca1Ian Rogers Atomic<uint64_t> wait_time; 1881afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi void AddToWaitTime(uint64_t value); 1891afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi ContentionLogData() : wait_time(0) {} 1901afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi }; 1913e5cf305db800b2989ad57b7cde8fb3cc9fa1b9eIan Rogers ContentionLogData contention_log_data_[kContentionLogDataSize]; 1921afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi 1931afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi public: 1941afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi bool HasEverContended() const { 1951afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi if (kLogLockContentions) { 1963e5cf305db800b2989ad57b7cde8fb3cc9fa1b9eIan Rogers return contention_log_data_->contention_count.LoadSequentiallyConsistent() > 0; 1971afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi } 1981afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi return false; 1991afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi } 20000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers}; 20100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 20200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// A Mutex is used to achieve mutual exclusion between threads. A Mutex can be used to gain 20300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// exclusive access to what it guards. A Mutex can be in one of two states: 20400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Free - not owned by any thread, 20500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Exclusive - owned by a single thread. 20600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// 20700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// The effect of locking and unlocking operations on the state is: 20800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// State | ExclusiveLock | ExclusiveUnlock 20900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// ------------------------------------------- 21000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Free | Exclusive | error 21100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Exclusive | Block* | Free 21200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// * Mutex is not reentrant and so an attempt to ExclusiveLock on the same thread will result in 21300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// an error. Being non-reentrant simplifies Waiting on ConditionVariables. 21401ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogersstd::ostream& operator<<(std::ostream& os, const Mutex& mu); 21500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogersclass LOCKABLE Mutex : public BaseMutex { 21600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 21781d425b0b232962441616f8b14f73620bffef5e5Ian Rogers explicit Mutex(const char* name, LockLevel level = kDefaultMutexLevel, bool recursive = false); 21800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ~Mutex(); 21900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 22000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers virtual bool IsMutex() const { return true; } 22100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 22200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Block until mutex is free then acquire exclusive access. 22390443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ExclusiveLock(Thread* self) ACQUIRE(); 22490443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void Lock(Thread* self) ACQUIRE() { ExclusiveLock(self); } 22500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 22600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Returns true if acquires exclusive access, false otherwise. 22790443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier bool ExclusiveTryLock(Thread* self) TRY_ACQUIRE(true); 22890443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier bool TryLock(Thread* self) TRY_ACQUIRE(true) { return ExclusiveTryLock(self); } 22900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 23000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Release exclusive access. 23190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ExclusiveUnlock(Thread* self) RELEASE(); 23290443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void Unlock(Thread* self) RELEASE() { ExclusiveUnlock(self); } 23300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 23400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Is the current thread the exclusive holder of the Mutex. 23581d425b0b232962441616f8b14f73620bffef5e5Ian Rogers bool IsExclusiveHeld(const Thread* self) const; 2368daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 23700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert that the Mutex is exclusively held by the current thread. 23890443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void AssertExclusiveHeld(const Thread* self) ASSERT_CAPABILITY(this) { 239db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 24001ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers CHECK(IsExclusiveHeld(self)) << *this; 24100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 24200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 24390443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void AssertHeld(const Thread* self) ASSERT_CAPABILITY(this) { AssertExclusiveHeld(self); } 24400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 24500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert that the Mutex is not held by the current thread. 24690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void AssertNotHeldExclusive(const Thread* self) ASSERT_CAPABILITY(!*this) { 247db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 24801ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers CHECK(!IsExclusiveHeld(self)) << *this; 24900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 25000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 25190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void AssertNotHeld(const Thread* self) ASSERT_CAPABILITY(!*this) { 25290443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier AssertNotHeldExclusive(self); 25390443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier } 25400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 255c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Id associated with exclusive owner. No memory ordering semantics if called from a thread other 256c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // than the owner. 25700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers uint64_t GetExclusiveOwnerTid() const; 25800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 25900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Returns how many times this Mutex has been locked, it is better to use AssertHeld/NotHeld. 26000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers unsigned int GetDepth() const { 26100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers return recursion_count_; 26200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 26300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 26456edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers virtual void Dump(std::ostream& os) const; 26501ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers 26690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier // For negative capabilities in clang annotations. 26790443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier const Mutex& operator!() const { return *this; } 26890443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier 26900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers private: 270c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#if ART_USE_FUTEXES 271c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // 0 is unheld, 1 is held. 272c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers AtomicInteger state_; 273c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // Exclusive owner. 274c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers volatile uint64_t exclusive_owner_; 275c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // Number of waiting contenders. 276b122a4bbed34ab22b4c1541ee25e5cf22f12a926Ian Rogers AtomicInteger num_contenders_; 277c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#else 27800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers pthread_mutex_t mutex_; 279c5f17732d8144491c642776b6b48c85dfadf4b52Ian Rogers volatile uint64_t exclusive_owner_; // Guarded by mutex_. 280c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#endif 28100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers const bool recursive_; // Can the lock be recursively held? 28200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers unsigned int recursion_count_; 283f1498437b0d6beb9f4f91980b98cbeb0b5c773ceElliott Hughes friend class ConditionVariable; 2848daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes DISALLOW_COPY_AND_ASSIGN(Mutex); 2858daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes}; 2868daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 28700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// A ReaderWriterMutex is used to achieve mutual exclusion between threads, similar to a Mutex. 28800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Unlike a Mutex a ReaderWriterMutex can be used to gain exclusive (writer) or shared (reader) 28900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// access to what it guards. A flaw in relation to a Mutex is that it cannot be used with a 29000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// condition variable. A ReaderWriterMutex can be in one of three states: 29100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Free - not owned by any thread, 29200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Exclusive - owned by a single thread, 29300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Shared(n) - shared amongst n threads. 29400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// 29500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// The effect of locking and unlocking operations on the state is: 29600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// 29700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// State | ExclusiveLock | ExclusiveUnlock | SharedLock | SharedUnlock 29800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// ---------------------------------------------------------------------------- 29900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Free | Exclusive | error | SharedLock(1) | error 30000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Exclusive | Block | Free | Block | error 30100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Shared(n) | Block | error | SharedLock(n+1)* | Shared(n-1) or Free 30200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// * for large values of n the SharedLock may block. 30301ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogersstd::ostream& operator<<(std::ostream& os, const ReaderWriterMutex& mu); 30490443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SHARED_LOCKABLE ReaderWriterMutex : public BaseMutex { 3058daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes public: 30681d425b0b232962441616f8b14f73620bffef5e5Ian Rogers explicit ReaderWriterMutex(const char* name, LockLevel level = kDefaultMutexLevel); 30700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ~ReaderWriterMutex(); 30800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 30900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers virtual bool IsReaderWriterMutex() const { return true; } 31000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 31100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Block until ReaderWriterMutex is free then acquire exclusive access. 31290443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ExclusiveLock(Thread* self) ACQUIRE(); 31390443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void WriterLock(Thread* self) ACQUIRE() { ExclusiveLock(self); } 31400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 31500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Release exclusive access. 31690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ExclusiveUnlock(Thread* self) RELEASE(); 31790443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void WriterUnlock(Thread* self) RELEASE() { ExclusiveUnlock(self); } 31800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 31900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Block until ReaderWriterMutex is free and acquire exclusive access. Returns true on success 32000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // or false if timeout is reached. 32166aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#if HAVE_TIMED_RWLOCK 322c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers bool ExclusiveLockWithTimeout(Thread* self, int64_t ms, int32_t ns) 32381d425b0b232962441616f8b14f73620bffef5e5Ian Rogers EXCLUSIVE_TRYLOCK_FUNCTION(true); 32466aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#endif 32500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 32600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Block until ReaderWriterMutex is shared or free then acquire a share on the access. 32790443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void SharedLock(Thread* self) ACQUIRE_SHARED() ALWAYS_INLINE; 32890443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ReaderLock(Thread* self) ACQUIRE_SHARED() { SharedLock(self); } 32900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 33000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Try to acquire share of ReaderWriterMutex. 33190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier bool SharedTryLock(Thread* self) SHARED_TRYLOCK_FUNCTION(true); 33200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 33300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Release a share of the access. 33490443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void SharedUnlock(Thread* self) RELEASE_SHARED() ALWAYS_INLINE; 33590443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ReaderUnlock(Thread* self) RELEASE_SHARED() { SharedUnlock(self); } 33600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 33700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Is the current thread the exclusive holder of the ReaderWriterMutex. 33881d425b0b232962441616f8b14f73620bffef5e5Ian Rogers bool IsExclusiveHeld(const Thread* self) const; 33900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 34000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert the current thread has exclusive access to the ReaderWriterMutex. 34190ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier void AssertExclusiveHeld(const Thread* self) ASSERT_CAPABILITY(this) { 342db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 34301ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers CHECK(IsExclusiveHeld(self)) << *this; 34400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 3458daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes } 34690ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier void AssertWriterHeld(const Thread* self) ASSERT_CAPABILITY(this) { AssertExclusiveHeld(self); } 3478daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 34800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert the current thread doesn't have exclusive access to the ReaderWriterMutex. 34990ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier void AssertNotExclusiveHeld(const Thread* self) ASSERT_CAPABILITY(!this) { 350db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 351e3359f7ad7671c5816f17145ca3a01516512e8d6Ian Rogers CHECK(!IsExclusiveHeld(self)) << *this; 35200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 35300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 35490ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier void AssertNotWriterHeld(const Thread* self) ASSERT_CAPABILITY(!this) { 35590ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier AssertNotExclusiveHeld(self); 35690ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier } 35700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 35800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Is the current thread a shared holder of the ReaderWriterMutex. 35981d425b0b232962441616f8b14f73620bffef5e5Ian Rogers bool IsSharedHeld(const Thread* self) const; 36000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 36100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert the current thread has shared access to the ReaderWriterMutex. 36290ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier void AssertSharedHeld(const Thread* self) ASSERT_SHARED_CAPABILITY(this) { 363db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 3642cebb24bfc3247d3e9be138a3350106737455918Mathieu Chartier // TODO: we can only assert this well when self != null. 3652cebb24bfc3247d3e9be138a3350106737455918Mathieu Chartier CHECK(IsSharedHeld(self) || self == nullptr) << *this; 36600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 3678daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes } 36890ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier void AssertReaderHeld(const Thread* self) ASSERT_SHARED_CAPABILITY(this) { 36990ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier AssertSharedHeld(self); 37090ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier } 3718daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 37200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert the current thread doesn't hold this ReaderWriterMutex either in shared or exclusive 37300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // mode. 37490ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier void AssertNotHeld(const Thread* self) ASSERT_SHARED_CAPABILITY(!this) { 375db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 37601ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers CHECK(!IsSharedHeld(self)) << *this; 37700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 37800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 37900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 380c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Id associated with exclusive owner. No memory ordering semantics if called from a thread other 381c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // than the owner. 38200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers uint64_t GetExclusiveOwnerTid() const; 38381d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 38456edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers virtual void Dump(std::ostream& os) const; 38501ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers 38690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier // For negative capabilities in clang annotations. 38790443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier const ReaderWriterMutex& operator!() const { return *this; } 38890443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier 3898daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes private: 39051d212ef31945743abe8a469707aaa25bab95357Ian Rogers#if ART_USE_FUTEXES 391cf7f19135f0e273f7b0136315633c2abfc715343Ian Rogers // Out-of-inline path for handling contention for a SharedLock. 392cf7f19135f0e273f7b0136315633c2abfc715343Ian Rogers void HandleSharedLockContention(Thread* self, int32_t cur_state); 393cf7f19135f0e273f7b0136315633c2abfc715343Ian Rogers 39481d425b0b232962441616f8b14f73620bffef5e5Ian Rogers // -1 implies held exclusive, +ve shared held by state_ many owners. 395c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers AtomicInteger state_; 396c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Exclusive owner. Modification guarded by this mutex. 39781d425b0b232962441616f8b14f73620bffef5e5Ian Rogers volatile uint64_t exclusive_owner_; 398c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Number of contenders waiting for a reader share. 399c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers AtomicInteger num_pending_readers_; 400c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Number of contenders waiting to be the writer. 401b122a4bbed34ab22b4c1541ee25e5cf22f12a926Ian Rogers AtomicInteger num_pending_writers_; 40281d425b0b232962441616f8b14f73620bffef5e5Ian Rogers#else 40300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers pthread_rwlock_t rwlock_; 404c5f17732d8144491c642776b6b48c85dfadf4b52Ian Rogers volatile uint64_t exclusive_owner_; // Guarded by rwlock_. 40581d425b0b232962441616f8b14f73620bffef5e5Ian Rogers#endif 40600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers DISALLOW_COPY_AND_ASSIGN(ReaderWriterMutex); 4078daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes}; 4088daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 409eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// MutatorMutex is a special kind of ReaderWriterMutex created specifically for the 410eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// Locks::mutator_lock_ mutex. The behaviour is identical to the ReaderWriterMutex except that 411eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// thread state changes also play a part in lock ownership. The mutator_lock_ will not be truly 412eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// held by any mutator threads. However, a thread in the kRunnable state is considered to have 413eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// shared ownership of the mutator lock and therefore transitions in and out of the kRunnable 414eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// state have associated implications on lock ownership. Extra methods to handle the state 415eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// transitions have been added to the interface but are only accessible to the methods dealing 416eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// with state transitions. The thread state and flags attributes are used to ensure thread state 417eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// transitions are consistent with the permitted behaviour of the mutex. 418eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// 419eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// *) The most important consequence of this behaviour is that all threads must be in one of the 420eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// suspended states before exclusive ownership of the mutator mutex is sought. 421eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// 422eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Listd::ostream& operator<<(std::ostream& os, const MutatorMutex& mu); 42390443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SHARED_LOCKABLE MutatorMutex : public ReaderWriterMutex { 424eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li public: 425eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li explicit MutatorMutex(const char* name, LockLevel level = kDefaultMutexLevel) 426eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li : ReaderWriterMutex(name, level) {} 427eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li ~MutatorMutex() {} 428eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li 429eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li virtual bool IsMutatorMutex() const { return true; } 430eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li 43190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier // For negative capabilities in clang annotations. 43290443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier const MutatorMutex& operator!() const { return *this; } 43390443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier 434eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li private: 435eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li friend class Thread; 436eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li void TransitionFromRunnableToSuspended(Thread* self) UNLOCK_FUNCTION() ALWAYS_INLINE; 437eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li void TransitionFromSuspendedToRunnable(Thread* self) SHARED_LOCK_FUNCTION() ALWAYS_INLINE; 438eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li 439eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li DISALLOW_COPY_AND_ASSIGN(MutatorMutex); 440eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li}; 441eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li 44200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// ConditionVariables allow threads to queue and sleep. Threads may then be resumed individually 44300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// (Signal) or all at once (Broadcast). 4445f79133a435ebcb20000370d56046fe01201dd80Elliott Hughesclass ConditionVariable { 4455f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes public: 4463887c468d731420e929e6ad3acf190d5431e94fcRoland Levillain ConditionVariable(const char* name, Mutex& mutex); 4475f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes ~ConditionVariable(); 4485f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes 449c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers void Broadcast(Thread* self); 450c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers void Signal(Thread* self); 451c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // TODO: No thread safety analysis on Wait and TimedWait as they call mutex operations via their 452c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // pointer copy, thereby defeating annotalysis. 453c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers void Wait(Thread* self) NO_THREAD_SAFETY_ANALYSIS; 4547b078e8c04f3e1451dbdd18543c8b9692b5b067eIan Rogers bool TimedWait(Thread* self, int64_t ms, int32_t ns) NO_THREAD_SAFETY_ANALYSIS; 4551d54e73444e017d3a65234e0f193846f3e27472bIan Rogers // Variant of Wait that should be used with caution. Doesn't validate that no mutexes are held 4561d54e73444e017d3a65234e0f193846f3e27472bIan Rogers // when waiting. 4571d54e73444e017d3a65234e0f193846f3e27472bIan Rogers // TODO: remove this. 4581d54e73444e017d3a65234e0f193846f3e27472bIan Rogers void WaitHoldingLocks(Thread* self) NO_THREAD_SAFETY_ANALYSIS; 4595f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes 4605f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes private: 46123055dc5d7a90c4a12e259fd0ed7cd4d04d89182Ian Rogers const char* const name_; 462c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // The Mutex being used by waiters. It is an error to mix condition variables between different 463c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // Mutexes. 464c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers Mutex& guard_; 465c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#if ART_USE_FUTEXES 466c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // A counter that is modified by signals and broadcasts. This ensures that when a waiter gives up 467d45f201e9bd43490e30a35710865789b8d70e249Ian Rogers // their Mutex and another thread takes it and signals, the waiting thread observes that sequence_ 468d45f201e9bd43490e30a35710865789b8d70e249Ian Rogers // changed and doesn't enter the wait. Modified while holding guard_, but is read by futex wait 469d45f201e9bd43490e30a35710865789b8d70e249Ian Rogers // without guard_ held. 470b122a4bbed34ab22b4c1541ee25e5cf22f12a926Ian Rogers AtomicInteger sequence_; 471c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // Number of threads that have come into to wait, not the length of the waiters on the futex as 4725bd97c483c1de1eb97afe76123b1b9ab53095edfIan Rogers // waiters may have been requeued onto guard_. Guarded by guard_. 473c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers volatile int32_t num_waiters_; 474c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#else 475c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers pthread_cond_t cond_; 476c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#endif 4775f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes DISALLOW_COPY_AND_ASSIGN(ConditionVariable); 4785f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes}; 4795f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes 48000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Scoped locker/unlocker for a regular Mutex that acquires mu upon construction and releases it 48100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// upon destruction. 48290443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SCOPED_CAPABILITY MutexLock { 48300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 4843887c468d731420e929e6ad3acf190d5431e94fcRoland Levillain MutexLock(Thread* self, Mutex& mu) ACQUIRE(mu) : self_(self), mu_(mu) { 48581d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.ExclusiveLock(self_); 48681d425b0b232962441616f8b14f73620bffef5e5Ian Rogers } 48781d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 4884e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier ~MutexLock() RELEASE() { 48981d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.ExclusiveUnlock(self_); 49000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 49100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 49200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers private: 49381d425b0b232962441616f8b14f73620bffef5e5Ian Rogers Thread* const self_; 49400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers Mutex& mu_; 49500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers DISALLOW_COPY_AND_ASSIGN(MutexLock); 49600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers}; 49700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Catch bug where variable name is omitted. "MutexLock (lock);" instead of "MutexLock mu(lock)". 498575e78c41ece0dec969d31f46be563d4eb7ae43bAndreas Gampe#define MutexLock(x) static_assert(0, "MutexLock declaration missing variable name") 49900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 50000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Scoped locker/unlocker for a ReaderWriterMutex that acquires read access to mu upon 50100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// construction and releases it upon destruction. 50290443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SCOPED_CAPABILITY ReaderMutexLock { 50300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 5043887c468d731420e929e6ad3acf190d5431e94fcRoland Levillain ReaderMutexLock(Thread* self, ReaderWriterMutex& mu) ACQUIRE(mu) : 50581d425b0b232962441616f8b14f73620bffef5e5Ian Rogers self_(self), mu_(mu) { 50681d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.SharedLock(self_); 50781d425b0b232962441616f8b14f73620bffef5e5Ian Rogers } 50881d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 5094e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier ~ReaderMutexLock() RELEASE() { 51081d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.SharedUnlock(self_); 51100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 51200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 51300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers private: 51481d425b0b232962441616f8b14f73620bffef5e5Ian Rogers Thread* const self_; 51500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ReaderWriterMutex& mu_; 51600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers DISALLOW_COPY_AND_ASSIGN(ReaderMutexLock); 51700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers}; 51800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Catch bug where variable name is omitted. "ReaderMutexLock (lock);" instead of 51900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// "ReaderMutexLock mu(lock)". 520575e78c41ece0dec969d31f46be563d4eb7ae43bAndreas Gampe#define ReaderMutexLock(x) static_assert(0, "ReaderMutexLock declaration missing variable name") 52100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 52200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Scoped locker/unlocker for a ReaderWriterMutex that acquires write access to mu upon 52300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// construction and releases it upon destruction. 52490443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SCOPED_CAPABILITY WriterMutexLock { 52500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 5263887c468d731420e929e6ad3acf190d5431e94fcRoland Levillain WriterMutexLock(Thread* self, ReaderWriterMutex& mu) EXCLUSIVE_LOCK_FUNCTION(mu) : 52781d425b0b232962441616f8b14f73620bffef5e5Ian Rogers self_(self), mu_(mu) { 52881d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.ExclusiveLock(self_); 52981d425b0b232962441616f8b14f73620bffef5e5Ian Rogers } 53081d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 53100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ~WriterMutexLock() UNLOCK_FUNCTION() { 53281d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.ExclusiveUnlock(self_); 53300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 53400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 53500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers private: 53650b35e2fd1a68cd1240e4a9d9f363e11764957d1Ian Rogers Thread* const self_; 53700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ReaderWriterMutex& mu_; 53800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers DISALLOW_COPY_AND_ASSIGN(WriterMutexLock); 53900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers}; 54000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Catch bug where variable name is omitted. "WriterMutexLock (lock);" instead of 54100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// "WriterMutexLock mu(lock)". 542575e78c41ece0dec969d31f46be563d4eb7ae43bAndreas Gampe#define WriterMutexLock(x) static_assert(0, "WriterMutexLock declaration missing variable name") 54300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 5444e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier// For StartNoThreadSuspension and EndNoThreadSuspension. 5454e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartierclass CAPABILITY("role") Role { 5464e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier public: 5474e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier void Acquire() ACQUIRE() {} 5484e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier void Release() RELEASE() {} 5494e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier const Role& operator!() const { return *this; } 5504e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier}; 5514e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier 5524e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartierclass Uninterruptible : public Role { 5534e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier}; 5544e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier 555719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers// Global mutexes corresponding to the levels above. 556719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogersclass Locks { 557719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers public: 558719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static void Init(); 55991e56692c6bd9fa1d41951ee7dc311f19461f4beMathieu Chartier static void InitConditions() NO_THREAD_SAFETY_ANALYSIS; // Condition variables. 5609ef78b59da51080882e47505896b420977fd79aeMathieu Chartier // Guards allocation entrypoint instrumenting. 5614ad5cd3e7d519484559ef778d96fb3f0be8919faIan Rogers static Mutex* instrument_entrypoints_lock_; 5629ef78b59da51080882e47505896b420977fd79aeMathieu Chartier 563eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // A barrier is used to synchronize the GC/Debugger thread with mutator threads. When GC/Debugger 564eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // thread wants to suspend all mutator threads, it needs to wait for all mutator threads to pass 565eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // a barrier. Threads that are already suspended will get their barrier passed by the GC/Debugger 566eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // thread; threads in the runnable state will pass the barrier when they transit to the suspended 567eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // state. GC/Debugger thread will be woken up when all mutator threads are suspended. 568719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // 569719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Thread suspension: 570eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // mutator thread | GC/Debugger 571eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // .. running .. | .. running .. 572719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | Request thread suspension by: 573719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | - acquiring thread_suspend_count_lock_ 574719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | - incrementing Thread::suspend_count_ on 575719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | all mutator threads 576719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | - releasing thread_suspend_count_lock_ 577eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // .. running .. | Block wait for all threads to pass a barrier 578719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Poll Thread::suspend_count_ and enter full | .. blocked .. 579719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // suspend code. | .. blocked .. 580eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // Change state to kSuspended (pass the barrier) | Wake up when all threads pass the barrier 581eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // x: Acquire thread_suspend_count_lock_ | .. running .. 582eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // while Thread::suspend_count_ > 0 | .. running .. 583eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // - wait on Thread::resume_cond_ | .. running .. 584eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // (releases thread_suspend_count_lock_) | .. running .. 585719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | Request thread resumption by: 586719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | - acquiring thread_suspend_count_lock_ 587719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | - decrementing Thread::suspend_count_ on 588719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | all mutator threads 589719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | - notifying on Thread::resume_cond_ 590719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // - re-acquire thread_suspend_count_lock_ | - releasing thread_suspend_count_lock_ 591719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Release thread_suspend_count_lock_ | .. running .. 592eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // Change to kRunnable | .. running .. 593eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // - this uses a CAS operation to ensure the | .. running .. 594eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // suspend request flag isn't raised as the | .. running .. 595eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // state is changed | .. running .. 596eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // - if the CAS operation fails then goto x | .. running .. 597719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | .. running .. 598eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li static MutatorMutex* mutator_lock_ ACQUIRED_AFTER(instrument_entrypoints_lock_); 599719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 600719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Allow reader-writer mutual exclusion on the mark and live bitmaps of the heap. 601719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static ReaderWriterMutex* heap_bitmap_lock_ ACQUIRED_AFTER(mutator_lock_); 602719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 603719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Guards shutdown of the runtime. 604719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static Mutex* runtime_shutdown_lock_ ACQUIRED_AFTER(heap_bitmap_lock_); 605719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 6069e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu // Guards background profiler global state. 6079e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu static Mutex* profiler_lock_ ACQUIRED_AFTER(runtime_shutdown_lock_); 6089e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu 6099e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu // Guards trace (ie traceview) requests. 6109e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu static Mutex* trace_lock_ ACQUIRED_AFTER(profiler_lock_); 6119e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu 612306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom // Guards debugger recent allocation records. 613306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom static Mutex* alloc_tracker_lock_ ACQUIRED_AFTER(trace_lock_); 614306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom 615306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom // Guards updates to instrumentation to ensure mutual exclusion of 616306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom // events like deoptimization requests. 617306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom // TODO: improve name, perhaps instrumentation_update_lock_. 618306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom static Mutex* deoptimization_lock_ ACQUIRED_AFTER(alloc_tracker_lock_); 619306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom 620a2c38644d96cbad4106c0165811d0f670d6cec8fJeff Hao // Guards String initializer register map in interpreter. 621a2c38644d96cbad4106c0165811d0f670d6cec8fJeff Hao static Mutex* interpreter_string_init_map_lock_ ACQUIRED_AFTER(deoptimization_lock_); 622a2c38644d96cbad4106c0165811d0f670d6cec8fJeff Hao 623719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // The thread_list_lock_ guards ThreadList::list_. It is also commonly held to stop threads 624719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // attaching and detaching. 625a2c38644d96cbad4106c0165811d0f670d6cec8fJeff Hao static Mutex* thread_list_lock_ ACQUIRED_AFTER(interpreter_string_init_map_lock_); 626719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 62791e56692c6bd9fa1d41951ee7dc311f19461f4beMathieu Chartier // Signaled when threads terminate. Used to determine when all non-daemons have terminated. 62891e56692c6bd9fa1d41951ee7dc311f19461f4beMathieu Chartier static ConditionVariable* thread_exit_cond_ GUARDED_BY(Locks::thread_list_lock_); 62991e56692c6bd9fa1d41951ee7dc311f19461f4beMathieu Chartier 63068d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // Guards maintaining loading library data structures. 63168d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers static Mutex* jni_libraries_lock_ ACQUIRED_AFTER(thread_list_lock_); 63268d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 633719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Guards breakpoints. 634ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz static ReaderWriterMutex* breakpoint_lock_ ACQUIRED_AFTER(jni_libraries_lock_); 635719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 636719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Guards lists of classes within the class linker. 6379e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu static ReaderWriterMutex* classlinker_classes_lock_ ACQUIRED_AFTER(breakpoint_lock_); 638719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 639719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // When declaring any Mutex add DEFAULT_MUTEX_ACQUIRED_AFTER to use annotalysis to check the code 640719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // doesn't try to hold a higher level Mutex. 64112d625f87bcd6c4059a205bb39007a255f57f382Mathieu Chartier #define DEFAULT_MUTEX_ACQUIRED_AFTER ACQUIRED_AFTER(Locks::classlinker_classes_lock_) 642719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 64374240819ae09e29b2753ef38f4eb4be1c2762e2eAndreas Gampe static Mutex* allocated_monitor_ids_lock_ ACQUIRED_AFTER(classlinker_classes_lock_); 64474240819ae09e29b2753ef38f4eb4be1c2762e2eAndreas Gampe 6459e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu // Guard the allocation/deallocation of thread ids. 64674240819ae09e29b2753ef38f4eb4be1c2762e2eAndreas Gampe static Mutex* allocated_thread_ids_lock_ ACQUIRED_AFTER(allocated_monitor_ids_lock_); 6479e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu 6489e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu // Guards modification of the LDT on x86. 6499e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu static Mutex* modify_ldt_lock_ ACQUIRED_AFTER(allocated_thread_ids_lock_); 6509e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu 651f9c6fc610b27887f832e453a0da1789187293408Mathieu Chartier // Guards opened oat files in OatFileManager. 652f9c6fc610b27887f832e453a0da1789187293408Mathieu Chartier static ReaderWriterMutex* oat_file_manager_lock_ ACQUIRED_AFTER(modify_ldt_lock_); 653f9c6fc610b27887f832e453a0da1789187293408Mathieu Chartier 654a206c745dbb64b14f05c87891d425475c2f6d63aRichard Uhler // Guards dlopen_handles_ in DlOpenOatFile. 655a206c745dbb64b14f05c87891d425475c2f6d63aRichard Uhler static Mutex* host_dlopen_handles_lock_ ACQUIRED_AFTER(oat_file_manager_lock_); 656e58991b3b2282b5761f1a6023a16c803e1c4eb45Mathieu Chartier 657719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Guards intern table. 658a206c745dbb64b14f05c87891d425475c2f6d63aRichard Uhler static Mutex* intern_table_lock_ ACQUIRED_AFTER(host_dlopen_handles_lock_); 659719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 660a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards reference processor. 661a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_processor_lock_ ACQUIRED_AFTER(intern_table_lock_); 662a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 663a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards cleared references queue. 664a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_cleared_references_lock_ ACQUIRED_AFTER(reference_processor_lock_); 665a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 666a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards weak references queue. 667a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_weak_references_lock_ ACQUIRED_AFTER(reference_queue_cleared_references_lock_); 668a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 669a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards finalizer references queue. 670a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_finalizer_references_lock_ ACQUIRED_AFTER(reference_queue_weak_references_lock_); 671a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 672a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards phantom references queue. 673a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_phantom_references_lock_ ACQUIRED_AFTER(reference_queue_finalizer_references_lock_); 674a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 675a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards soft references queue. 676a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_soft_references_lock_ ACQUIRED_AFTER(reference_queue_phantom_references_lock_); 677a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 678719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Have an exclusive aborting thread. 679a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* abort_lock_ ACQUIRED_AFTER(reference_queue_soft_references_lock_); 680719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 681719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Allow mutual exclusion when manipulating Thread::suspend_count_. 682719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // TODO: Does the trade-off of a per-thread lock make sense? 683719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static Mutex* thread_suspend_count_lock_ ACQUIRED_AFTER(abort_lock_); 684719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 685719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // One unexpected signal at a time lock. 686719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static Mutex* unexpected_signal_lock_ ACQUIRED_AFTER(thread_suspend_count_lock_); 687719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 6883eed93dd5be03e5539827bebf0f414251a12e15eHiroshi Yamauchi // Guards the maps in mem_map. 6893eed93dd5be03e5539827bebf0f414251a12e15eHiroshi Yamauchi static Mutex* mem_maps_lock_ ACQUIRED_AFTER(unexpected_signal_lock_); 6903eed93dd5be03e5539827bebf0f414251a12e15eHiroshi Yamauchi 691719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Have an exclusive logging thread. 692719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static Mutex* logging_lock_ ACQUIRED_AFTER(unexpected_signal_lock_); 693e2facc5b18cd756a8b5500fb3d90da69c9ee0fb7Igor Murashkin 694e2facc5b18cd756a8b5500fb3d90da69c9ee0fb7Igor Murashkin // Allow reader-writer mutual exclusion on the boxed table of lambda objects. 695e2facc5b18cd756a8b5500fb3d90da69c9ee0fb7Igor Murashkin // TODO: this should be a RW mutex lock, except that ConditionVariables don't work with it. 696e2facc5b18cd756a8b5500fb3d90da69c9ee0fb7Igor Murashkin static Mutex* lambda_table_lock_ ACQUIRED_AFTER(mutator_lock_); 697719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers}; 698719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 6994e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartierclass Roles { 7004e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier public: 70190ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier // Uninterruptible means that the thread may not become suspended. 7024e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier static Uninterruptible uninterruptible_; 7034e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier}; 7044e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier 7058daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes} // namespace art 7068daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 707fc0e3219edc9a5bf81b166e82fd5db2796eb6a0dBrian Carlstrom#endif // ART_RUNTIME_BASE_MUTEX_H_ 708