mutex.h revision 340dafabc8e88378e395cda9027cf17726910e91
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, 63719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpSocketLock, 642cd334ae2d4287216523882f0d298cf3901b7ab1Hiroshi Yamauchi kRegionSpaceRegionLock, 652994605707219f67af8340ddd9379ce9bd86d74cMathieu Chartier kRosAllocGlobalLock, 662994605707219f67af8340ddd9379ce9bd86d74cMathieu Chartier kRosAllocBracketLock, 672994605707219f67af8340ddd9379ce9bd86d74cMathieu Chartier kRosAllocBulkFreeLock, 68673ed3d8aedc5462a47ded827c99f35d46525457Mathieu Chartier kMarkSweepMarkStackLock, 69bc4d218ce2ceef0c4f308d4ff42f7ec1ec43c40eAndreas Gampe kTransactionLogLock, 70673ed3d8aedc5462a47ded827c99f35d46525457Mathieu Chartier kJniWeakGlobalsLock, 7105a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe kJniGlobalsLock, 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 kInternTableLock, 833f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko kOatFileSecondaryLookupLock, 84a206c745dbb64b14f05c87891d425475c2f6d63aRichard Uhler kHostDlOpenHandlesLock, 85ca3c8c33501bf199d6fd0a5db30a27d8e010cb23David Brazdil kVerifierDepsLock, 86f9c6fc610b27887f832e453a0da1789187293408Mathieu Chartier kOatFileManagerLock, 877526d783ab68ed1dd53c763c75895cb432532b0fAndreas Gampe kTracingUniqueMethodsLock, 887526d783ab68ed1dd53c763c75895cb432532b0fAndreas Gampe kTracingStreamingLock, 89b8aa1e4c10dcdc7fef96634f87e259dfee83a1cfMathieu Chartier kDeoptimizedMethodsLock, 90b8aa1e4c10dcdc7fef96634f87e259dfee83a1cfMathieu Chartier kClassLoaderClassesLock, 91719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kDefaultMutexLevel, 926c60d8420e51fda65ad247ae04b5a823c88c26b6Mathieu Chartier kDexLock, 93719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kMarkSweepLargeObjectLock, 94719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpObjectRegistryLock, 959e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu kModifyLdtLock, 969e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu kAllocatedThreadIdsLock, 9774240819ae09e29b2753ef38f4eb4be1c2762e2eAndreas Gampe kMonitorPoolLock, 98b8aa1e4c10dcdc7fef96634f87e259dfee83a1cfMathieu Chartier kClassLinkerClassesLock, // TODO rename. 9965975776f807d55c83af6cca1e447f8daa794413Mathieu Chartier kJitCodeCacheLock, 100719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kBreakpointLock, 101719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kMonitorLock, 102440e4ceb310349ee8eb569495bc04d3d7fbe71cbMathieu Chartier kMonitorListLock, 10368d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers kJniLoadLibraryLock, 104719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kThreadListLock, 105306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom kAllocTrackerLock, 106719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kDeoptimizationLock, 107719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kProfilerLock, 1084e5b20863898006ec6c9d120cda167d38dda6e60Sebastien Hertz kJdwpShutdownLock, 109719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpEventListLock, 110719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpAttachLock, 111719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpStartLock, 112719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kRuntimeShutdownLock, 11369dbec6d9d55eeb2867949c2791d01dc9aa916c8Jeff Hao kTraceLock, 114719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kHeapBitmapLock, 115719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kMutatorLock, 1169ef78b59da51080882e47505896b420977fd79aeMathieu Chartier kInstrumentEntrypointsLock, 117719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kZygoteCreationLock, 118719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 119719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kLockLevelCount // Must come last. 120719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers}; 121719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogersstd::ostream& operator<<(std::ostream& os, const LockLevel& rhs); 122719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 1232e250c826b3c405d675017efe79e5db3651c9ee6Brian Carlstromconst bool kDebugLocking = kIsDebugBuild; 12425fd14b87cced64a179dee885573113be5e11944Ian Rogers 1251afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi// Record Log contention information, dumpable via SIGQUIT. 1261afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi#ifdef ART_USE_FUTEXES 12708f2e7b59fab9df108d3d91e6eeb4bbccbb325d1Jeff Hao// To enable lock contention logging, set this to true. 12808f2e7b59fab9df108d3d91e6eeb4bbccbb325d1Jeff Haoconst bool kLogLockContentions = false; 1291afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi#else 1301afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi// Keep this false as lock contention logging is supported only with 1311afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi// futex. 1321afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchiconst bool kLogLockContentions = false; 1331afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi#endif 134d9c4fc94fa618617f94e1de9af5f034549100753Ian Rogersconst size_t kContentionLogSize = 4; 1351afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchiconst size_t kContentionLogDataSize = kLogLockContentions ? 1 : 0; 1361afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchiconst size_t kAllMutexDataSize = kLogLockContentions ? 1 : 0; 1371afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi 13800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Base class for all Mutex implementations 13900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogersclass BaseMutex { 14000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 141bab74963db2484ea5f10a82ea26e8a99722bfefeIan Rogers const char* GetName() const { 14200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers return name_; 14300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 14400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 14500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers virtual bool IsMutex() const { return false; } 14600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers virtual bool IsReaderWriterMutex() const { return false; } 147eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li virtual bool IsMutatorMutex() const { return false; } 14800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 14956edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers virtual void Dump(std::ostream& os) const = 0; 15056edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers 15156edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers static void DumpAll(std::ostream& os); 15256edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers 15300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers protected: 15400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers friend class ConditionVariable; 15500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 15681d425b0b232962441616f8b14f73620bffef5e5Ian Rogers BaseMutex(const char* name, LockLevel level); 15756edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers virtual ~BaseMutex(); 15881d425b0b232962441616f8b14f73620bffef5e5Ian Rogers void RegisterAsLocked(Thread* self); 15981d425b0b232962441616f8b14f73620bffef5e5Ian Rogers void RegisterAsUnlocked(Thread* self); 16081d425b0b232962441616f8b14f73620bffef5e5Ian Rogers void CheckSafeToWait(Thread* self); 16100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 16256edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers friend class ScopedContentionRecorder; 16356edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers 1641afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi void RecordContention(uint64_t blocked_tid, uint64_t owner_tid, uint64_t nano_time_blocked); 16556edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers void DumpContention(std::ostream& os) const; 16656edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers 16781d425b0b232962441616f8b14f73620bffef5e5Ian Rogers const LockLevel level_; // Support for lock hierarchy. 168bab74963db2484ea5f10a82ea26e8a99722bfefeIan Rogers const char* const name_; 1691afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi 17056edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers // A log entry that records contention but makes no guarantee that either tid will be held live. 17156edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers struct ContentionLogEntry { 17256edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers ContentionLogEntry() : blocked_tid(0), owner_tid(0) {} 17356edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers uint64_t blocked_tid; 17456edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers uint64_t owner_tid; 17556edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers AtomicInteger count; 17656edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers }; 1771afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi struct ContentionLogData { 1781afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi ContentionLogEntry contention_log[kContentionLogSize]; 1791afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi // The next entry in the contention log to be updated. Value ranges from 0 to 1801afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi // kContentionLogSize - 1. 1811afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi AtomicInteger cur_content_log_entry; 1821afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi // Number of times the Mutex has been contended. 1831afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi AtomicInteger contention_count; 1841afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi // Sum of time waited by all contenders in ns. 18537f3c968ecd04e77802fe17bb82dabc07de21ca1Ian Rogers Atomic<uint64_t> wait_time; 1861afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi void AddToWaitTime(uint64_t value); 1871afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi ContentionLogData() : wait_time(0) {} 1881afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi }; 1893e5cf305db800b2989ad57b7cde8fb3cc9fa1b9eIan Rogers ContentionLogData contention_log_data_[kContentionLogDataSize]; 1901afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi 1911afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi public: 1921afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi bool HasEverContended() const { 1931afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi if (kLogLockContentions) { 1943e5cf305db800b2989ad57b7cde8fb3cc9fa1b9eIan Rogers return contention_log_data_->contention_count.LoadSequentiallyConsistent() > 0; 1951afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi } 1961afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi return false; 1971afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi } 19800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers}; 19900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 20000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// A Mutex is used to achieve mutual exclusion between threads. A Mutex can be used to gain 20100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// exclusive access to what it guards. A Mutex can be in one of two states: 20200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Free - not owned by any thread, 20300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Exclusive - owned by a single thread. 20400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// 20500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// The effect of locking and unlocking operations on the state is: 20600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// State | ExclusiveLock | ExclusiveUnlock 20700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// ------------------------------------------- 20800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Free | Exclusive | error 20900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Exclusive | Block* | Free 21000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// * Mutex is not reentrant and so an attempt to ExclusiveLock on the same thread will result in 21100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// an error. Being non-reentrant simplifies Waiting on ConditionVariables. 21201ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogersstd::ostream& operator<<(std::ostream& os, const Mutex& mu); 21300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogersclass LOCKABLE Mutex : public BaseMutex { 21400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 21581d425b0b232962441616f8b14f73620bffef5e5Ian Rogers explicit Mutex(const char* name, LockLevel level = kDefaultMutexLevel, bool recursive = false); 21600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ~Mutex(); 21700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 21800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers virtual bool IsMutex() const { return true; } 21900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 22000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Block until mutex is free then acquire exclusive access. 22190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ExclusiveLock(Thread* self) ACQUIRE(); 22290443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void Lock(Thread* self) ACQUIRE() { ExclusiveLock(self); } 22300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 22400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Returns true if acquires exclusive access, false otherwise. 22590443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier bool ExclusiveTryLock(Thread* self) TRY_ACQUIRE(true); 22690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier bool TryLock(Thread* self) TRY_ACQUIRE(true) { return ExclusiveTryLock(self); } 22700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 22800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Release exclusive access. 22990443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ExclusiveUnlock(Thread* self) RELEASE(); 23090443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void Unlock(Thread* self) RELEASE() { ExclusiveUnlock(self); } 23100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 23200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Is the current thread the exclusive holder of the Mutex. 23381d425b0b232962441616f8b14f73620bffef5e5Ian Rogers bool IsExclusiveHeld(const Thread* self) const; 2348daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 23500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert that the Mutex is exclusively held by the current thread. 23690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void AssertExclusiveHeld(const Thread* self) ASSERT_CAPABILITY(this) { 237db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 23801ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers CHECK(IsExclusiveHeld(self)) << *this; 23900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 24000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 24190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void AssertHeld(const Thread* self) ASSERT_CAPABILITY(this) { AssertExclusiveHeld(self); } 24200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 24300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert that the Mutex is not held by the current thread. 24490443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void AssertNotHeldExclusive(const Thread* self) ASSERT_CAPABILITY(!*this) { 245db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 24601ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers CHECK(!IsExclusiveHeld(self)) << *this; 24700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 24800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 24990443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void AssertNotHeld(const Thread* self) ASSERT_CAPABILITY(!*this) { 25090443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier AssertNotHeldExclusive(self); 25190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier } 25200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 253c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Id associated with exclusive owner. No memory ordering semantics if called from a thread other 254c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // than the owner. 25500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers uint64_t GetExclusiveOwnerTid() const; 25600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 25700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Returns how many times this Mutex has been locked, it is better to use AssertHeld/NotHeld. 25800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers unsigned int GetDepth() const { 25900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers return recursion_count_; 26000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 26100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 26256edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers virtual void Dump(std::ostream& os) const; 26301ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers 26490443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier // For negative capabilities in clang annotations. 26590443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier const Mutex& operator!() const { return *this; } 26690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier 26700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers private: 268c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#if ART_USE_FUTEXES 269c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // 0 is unheld, 1 is held. 270c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers AtomicInteger state_; 271c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // Exclusive owner. 272c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers volatile uint64_t exclusive_owner_; 273c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // Number of waiting contenders. 274b122a4bbed34ab22b4c1541ee25e5cf22f12a926Ian Rogers AtomicInteger num_contenders_; 275c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#else 27600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers pthread_mutex_t mutex_; 277c5f17732d8144491c642776b6b48c85dfadf4b52Ian Rogers volatile uint64_t exclusive_owner_; // Guarded by mutex_. 278c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#endif 27900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers const bool recursive_; // Can the lock be recursively held? 28000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers unsigned int recursion_count_; 281f1498437b0d6beb9f4f91980b98cbeb0b5c773ceElliott Hughes friend class ConditionVariable; 2828daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes DISALLOW_COPY_AND_ASSIGN(Mutex); 2838daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes}; 2848daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 28500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// A ReaderWriterMutex is used to achieve mutual exclusion between threads, similar to a Mutex. 28600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Unlike a Mutex a ReaderWriterMutex can be used to gain exclusive (writer) or shared (reader) 28700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// access to what it guards. A flaw in relation to a Mutex is that it cannot be used with a 28800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// condition variable. A ReaderWriterMutex can be in one of three states: 28900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Free - not owned by any thread, 29000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Exclusive - owned by a single thread, 29100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Shared(n) - shared amongst n threads. 29200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// 29300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// The effect of locking and unlocking operations on the state is: 29400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// 29500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// State | ExclusiveLock | ExclusiveUnlock | SharedLock | SharedUnlock 29600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// ---------------------------------------------------------------------------- 29700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Free | Exclusive | error | SharedLock(1) | error 29800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Exclusive | Block | Free | Block | error 29900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Shared(n) | Block | error | SharedLock(n+1)* | Shared(n-1) or Free 30000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// * for large values of n the SharedLock may block. 30101ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogersstd::ostream& operator<<(std::ostream& os, const ReaderWriterMutex& mu); 30290443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SHARED_LOCKABLE ReaderWriterMutex : public BaseMutex { 3038daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes public: 30481d425b0b232962441616f8b14f73620bffef5e5Ian Rogers explicit ReaderWriterMutex(const char* name, LockLevel level = kDefaultMutexLevel); 30500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ~ReaderWriterMutex(); 30600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 30700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers virtual bool IsReaderWriterMutex() const { return true; } 30800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 30900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Block until ReaderWriterMutex is free then acquire exclusive access. 31090443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ExclusiveLock(Thread* self) ACQUIRE(); 31190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void WriterLock(Thread* self) ACQUIRE() { ExclusiveLock(self); } 31200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 31300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Release exclusive access. 31490443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ExclusiveUnlock(Thread* self) RELEASE(); 31590443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void WriterUnlock(Thread* self) RELEASE() { ExclusiveUnlock(self); } 31600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 31700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Block until ReaderWriterMutex is free and acquire exclusive access. Returns true on success 31800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // or false if timeout is reached. 31966aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#if HAVE_TIMED_RWLOCK 320c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers bool ExclusiveLockWithTimeout(Thread* self, int64_t ms, int32_t ns) 32181d425b0b232962441616f8b14f73620bffef5e5Ian Rogers EXCLUSIVE_TRYLOCK_FUNCTION(true); 32266aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#endif 32300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 32400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Block until ReaderWriterMutex is shared or free then acquire a share on the access. 32590443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void SharedLock(Thread* self) ACQUIRE_SHARED() ALWAYS_INLINE; 32690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ReaderLock(Thread* self) ACQUIRE_SHARED() { SharedLock(self); } 32700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 32800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Try to acquire share of ReaderWriterMutex. 32990443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier bool SharedTryLock(Thread* self) SHARED_TRYLOCK_FUNCTION(true); 33000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 33100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Release a share of the access. 33290443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void SharedUnlock(Thread* self) RELEASE_SHARED() ALWAYS_INLINE; 33390443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ReaderUnlock(Thread* self) RELEASE_SHARED() { SharedUnlock(self); } 33400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 33500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Is the current thread the exclusive holder of the ReaderWriterMutex. 33681d425b0b232962441616f8b14f73620bffef5e5Ian Rogers bool IsExclusiveHeld(const Thread* self) const; 33700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 33800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert the current thread has exclusive access to the ReaderWriterMutex. 33990ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier void AssertExclusiveHeld(const Thread* self) ASSERT_CAPABILITY(this) { 340db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 34101ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers CHECK(IsExclusiveHeld(self)) << *this; 34200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 3438daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes } 34490ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier void AssertWriterHeld(const Thread* self) ASSERT_CAPABILITY(this) { AssertExclusiveHeld(self); } 3458daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 34600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert the current thread doesn't have exclusive access to the ReaderWriterMutex. 34790ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier void AssertNotExclusiveHeld(const Thread* self) ASSERT_CAPABILITY(!this) { 348db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 349e3359f7ad7671c5816f17145ca3a01516512e8d6Ian Rogers CHECK(!IsExclusiveHeld(self)) << *this; 35000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 35100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 35290ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier void AssertNotWriterHeld(const Thread* self) ASSERT_CAPABILITY(!this) { 35390ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier AssertNotExclusiveHeld(self); 35490ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier } 35500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 35600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Is the current thread a shared holder of the ReaderWriterMutex. 35781d425b0b232962441616f8b14f73620bffef5e5Ian Rogers bool IsSharedHeld(const Thread* self) const; 35800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 35900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert the current thread has shared access to the ReaderWriterMutex. 36090ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier void AssertSharedHeld(const Thread* self) ASSERT_SHARED_CAPABILITY(this) { 361db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 3622cebb24bfc3247d3e9be138a3350106737455918Mathieu Chartier // TODO: we can only assert this well when self != null. 3632cebb24bfc3247d3e9be138a3350106737455918Mathieu Chartier CHECK(IsSharedHeld(self) || self == nullptr) << *this; 36400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 3658daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes } 36690ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier void AssertReaderHeld(const Thread* self) ASSERT_SHARED_CAPABILITY(this) { 36790ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier AssertSharedHeld(self); 36890ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier } 3698daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 37000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert the current thread doesn't hold this ReaderWriterMutex either in shared or exclusive 37100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // mode. 37290ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier void AssertNotHeld(const Thread* self) ASSERT_SHARED_CAPABILITY(!this) { 373db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 37401ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers CHECK(!IsSharedHeld(self)) << *this; 37500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 37600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 37700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 378c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Id associated with exclusive owner. No memory ordering semantics if called from a thread other 379c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // than the owner. 38000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers uint64_t GetExclusiveOwnerTid() const; 38181d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 38256edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers virtual void Dump(std::ostream& os) const; 38301ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers 38490443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier // For negative capabilities in clang annotations. 38590443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier const ReaderWriterMutex& operator!() const { return *this; } 38690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier 3878daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes private: 38851d212ef31945743abe8a469707aaa25bab95357Ian Rogers#if ART_USE_FUTEXES 389cf7f19135f0e273f7b0136315633c2abfc715343Ian Rogers // Out-of-inline path for handling contention for a SharedLock. 390cf7f19135f0e273f7b0136315633c2abfc715343Ian Rogers void HandleSharedLockContention(Thread* self, int32_t cur_state); 391cf7f19135f0e273f7b0136315633c2abfc715343Ian Rogers 39281d425b0b232962441616f8b14f73620bffef5e5Ian Rogers // -1 implies held exclusive, +ve shared held by state_ many owners. 393c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers AtomicInteger state_; 394c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Exclusive owner. Modification guarded by this mutex. 39581d425b0b232962441616f8b14f73620bffef5e5Ian Rogers volatile uint64_t exclusive_owner_; 396c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Number of contenders waiting for a reader share. 397c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers AtomicInteger num_pending_readers_; 398c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Number of contenders waiting to be the writer. 399b122a4bbed34ab22b4c1541ee25e5cf22f12a926Ian Rogers AtomicInteger num_pending_writers_; 40081d425b0b232962441616f8b14f73620bffef5e5Ian Rogers#else 40100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers pthread_rwlock_t rwlock_; 402c5f17732d8144491c642776b6b48c85dfadf4b52Ian Rogers volatile uint64_t exclusive_owner_; // Guarded by rwlock_. 40381d425b0b232962441616f8b14f73620bffef5e5Ian Rogers#endif 40400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers DISALLOW_COPY_AND_ASSIGN(ReaderWriterMutex); 4058daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes}; 4068daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 407eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// MutatorMutex is a special kind of ReaderWriterMutex created specifically for the 408eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// Locks::mutator_lock_ mutex. The behaviour is identical to the ReaderWriterMutex except that 409eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// thread state changes also play a part in lock ownership. The mutator_lock_ will not be truly 410eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// held by any mutator threads. However, a thread in the kRunnable state is considered to have 411eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// shared ownership of the mutator lock and therefore transitions in and out of the kRunnable 412eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// state have associated implications on lock ownership. Extra methods to handle the state 413eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// transitions have been added to the interface but are only accessible to the methods dealing 414eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// with state transitions. The thread state and flags attributes are used to ensure thread state 415eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// transitions are consistent with the permitted behaviour of the mutex. 416eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// 417eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// *) The most important consequence of this behaviour is that all threads must be in one of the 418eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// suspended states before exclusive ownership of the mutator mutex is sought. 419eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// 420eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Listd::ostream& operator<<(std::ostream& os, const MutatorMutex& mu); 42190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SHARED_LOCKABLE MutatorMutex : public ReaderWriterMutex { 422eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li public: 423eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li explicit MutatorMutex(const char* name, LockLevel level = kDefaultMutexLevel) 424eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li : ReaderWriterMutex(name, level) {} 425eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li ~MutatorMutex() {} 426eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li 427eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li virtual bool IsMutatorMutex() const { return true; } 428eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li 42990443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier // For negative capabilities in clang annotations. 43090443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier const MutatorMutex& operator!() const { return *this; } 43190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier 432eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li private: 433eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li friend class Thread; 434eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li void TransitionFromRunnableToSuspended(Thread* self) UNLOCK_FUNCTION() ALWAYS_INLINE; 435eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li void TransitionFromSuspendedToRunnable(Thread* self) SHARED_LOCK_FUNCTION() ALWAYS_INLINE; 436eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li 437eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li DISALLOW_COPY_AND_ASSIGN(MutatorMutex); 438eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li}; 439eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li 44000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// ConditionVariables allow threads to queue and sleep. Threads may then be resumed individually 44100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// (Signal) or all at once (Broadcast). 4425f79133a435ebcb20000370d56046fe01201dd80Elliott Hughesclass ConditionVariable { 4435f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes public: 4443887c468d731420e929e6ad3acf190d5431e94fcRoland Levillain ConditionVariable(const char* name, Mutex& mutex); 4455f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes ~ConditionVariable(); 4465f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes 447c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers void Broadcast(Thread* self); 448c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers void Signal(Thread* self); 449c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // TODO: No thread safety analysis on Wait and TimedWait as they call mutex operations via their 450c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // pointer copy, thereby defeating annotalysis. 451c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers void Wait(Thread* self) NO_THREAD_SAFETY_ANALYSIS; 4527b078e8c04f3e1451dbdd18543c8b9692b5b067eIan Rogers bool TimedWait(Thread* self, int64_t ms, int32_t ns) NO_THREAD_SAFETY_ANALYSIS; 4531d54e73444e017d3a65234e0f193846f3e27472bIan Rogers // Variant of Wait that should be used with caution. Doesn't validate that no mutexes are held 4541d54e73444e017d3a65234e0f193846f3e27472bIan Rogers // when waiting. 4551d54e73444e017d3a65234e0f193846f3e27472bIan Rogers // TODO: remove this. 4561d54e73444e017d3a65234e0f193846f3e27472bIan Rogers void WaitHoldingLocks(Thread* self) NO_THREAD_SAFETY_ANALYSIS; 4575f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes 4585f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes private: 45923055dc5d7a90c4a12e259fd0ed7cd4d04d89182Ian Rogers const char* const name_; 460c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // The Mutex being used by waiters. It is an error to mix condition variables between different 461c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // Mutexes. 462c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers Mutex& guard_; 463c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#if ART_USE_FUTEXES 464c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // A counter that is modified by signals and broadcasts. This ensures that when a waiter gives up 465d45f201e9bd43490e30a35710865789b8d70e249Ian Rogers // their Mutex and another thread takes it and signals, the waiting thread observes that sequence_ 466d45f201e9bd43490e30a35710865789b8d70e249Ian Rogers // changed and doesn't enter the wait. Modified while holding guard_, but is read by futex wait 467d45f201e9bd43490e30a35710865789b8d70e249Ian Rogers // without guard_ held. 468b122a4bbed34ab22b4c1541ee25e5cf22f12a926Ian Rogers AtomicInteger sequence_; 469c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // Number of threads that have come into to wait, not the length of the waiters on the futex as 4705bd97c483c1de1eb97afe76123b1b9ab53095edfIan Rogers // waiters may have been requeued onto guard_. Guarded by guard_. 471c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers volatile int32_t num_waiters_; 472c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#else 473c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers pthread_cond_t cond_; 474c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#endif 4755f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes DISALLOW_COPY_AND_ASSIGN(ConditionVariable); 4765f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes}; 4775f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes 47800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Scoped locker/unlocker for a regular Mutex that acquires mu upon construction and releases it 47900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// upon destruction. 48090443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SCOPED_CAPABILITY MutexLock { 48100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 4823887c468d731420e929e6ad3acf190d5431e94fcRoland Levillain MutexLock(Thread* self, Mutex& mu) ACQUIRE(mu) : self_(self), mu_(mu) { 48381d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.ExclusiveLock(self_); 48481d425b0b232962441616f8b14f73620bffef5e5Ian Rogers } 48581d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 4864e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier ~MutexLock() RELEASE() { 48781d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.ExclusiveUnlock(self_); 48800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 48900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 49000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers private: 49181d425b0b232962441616f8b14f73620bffef5e5Ian Rogers Thread* const self_; 49200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers Mutex& mu_; 49300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers DISALLOW_COPY_AND_ASSIGN(MutexLock); 49400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers}; 49500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Catch bug where variable name is omitted. "MutexLock (lock);" instead of "MutexLock mu(lock)". 496575e78c41ece0dec969d31f46be563d4eb7ae43bAndreas Gampe#define MutexLock(x) static_assert(0, "MutexLock declaration missing variable name") 49700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 49800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Scoped locker/unlocker for a ReaderWriterMutex that acquires read access to mu upon 49900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// construction and releases it upon destruction. 50090443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SCOPED_CAPABILITY ReaderMutexLock { 50100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 5023887c468d731420e929e6ad3acf190d5431e94fcRoland Levillain ReaderMutexLock(Thread* self, ReaderWriterMutex& mu) ACQUIRE(mu) : 50381d425b0b232962441616f8b14f73620bffef5e5Ian Rogers self_(self), mu_(mu) { 50481d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.SharedLock(self_); 50581d425b0b232962441616f8b14f73620bffef5e5Ian Rogers } 50681d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 5074e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier ~ReaderMutexLock() RELEASE() { 50881d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.SharedUnlock(self_); 50900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 51000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 51100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers private: 51281d425b0b232962441616f8b14f73620bffef5e5Ian Rogers Thread* const self_; 51300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ReaderWriterMutex& mu_; 51400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers DISALLOW_COPY_AND_ASSIGN(ReaderMutexLock); 51500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers}; 51600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Catch bug where variable name is omitted. "ReaderMutexLock (lock);" instead of 51700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// "ReaderMutexLock mu(lock)". 518575e78c41ece0dec969d31f46be563d4eb7ae43bAndreas Gampe#define ReaderMutexLock(x) static_assert(0, "ReaderMutexLock declaration missing variable name") 51900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 52000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Scoped locker/unlocker for a ReaderWriterMutex that acquires write access to mu upon 52100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// construction and releases it upon destruction. 52290443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SCOPED_CAPABILITY WriterMutexLock { 52300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 5243887c468d731420e929e6ad3acf190d5431e94fcRoland Levillain WriterMutexLock(Thread* self, ReaderWriterMutex& mu) EXCLUSIVE_LOCK_FUNCTION(mu) : 52581d425b0b232962441616f8b14f73620bffef5e5Ian Rogers self_(self), mu_(mu) { 52681d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.ExclusiveLock(self_); 52781d425b0b232962441616f8b14f73620bffef5e5Ian Rogers } 52881d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 52900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ~WriterMutexLock() UNLOCK_FUNCTION() { 53081d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.ExclusiveUnlock(self_); 53100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 53200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 53300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers private: 53450b35e2fd1a68cd1240e4a9d9f363e11764957d1Ian Rogers Thread* const self_; 53500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ReaderWriterMutex& mu_; 53600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers DISALLOW_COPY_AND_ASSIGN(WriterMutexLock); 53700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers}; 53800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Catch bug where variable name is omitted. "WriterMutexLock (lock);" instead of 53900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// "WriterMutexLock mu(lock)". 540575e78c41ece0dec969d31f46be563d4eb7ae43bAndreas Gampe#define WriterMutexLock(x) static_assert(0, "WriterMutexLock declaration missing variable name") 54100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 5424e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier// For StartNoThreadSuspension and EndNoThreadSuspension. 5434e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartierclass CAPABILITY("role") Role { 5444e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier public: 5454e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier void Acquire() ACQUIRE() {} 5464e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier void Release() RELEASE() {} 5474e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier const Role& operator!() const { return *this; } 5484e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier}; 5494e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier 5504e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartierclass Uninterruptible : public Role { 5514e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier}; 5524e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier 553719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers// Global mutexes corresponding to the levels above. 554719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogersclass Locks { 555719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers public: 556719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static void Init(); 55791e56692c6bd9fa1d41951ee7dc311f19461f4beMathieu Chartier static void InitConditions() NO_THREAD_SAFETY_ANALYSIS; // Condition variables. 558f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr 559f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // Destroying various lock types can emit errors that vary depending upon 560f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // whether the client (art::Runtime) is currently active. Allow the client 561f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // to set a callback that is used to check when it is acceptable to call 562f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // Abort. The default behavior is that the client *is not* able to call 563f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // Abort if no callback is established. 564f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr using ClientCallback = bool(); 565f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr static void SetClientCallback(ClientCallback* is_safe_to_call_abort_cb) NO_THREAD_SAFETY_ANALYSIS; 566f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // Checks for whether it is safe to call Abort() without using locks. 567f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr static bool IsSafeToCallAbortRacy() NO_THREAD_SAFETY_ANALYSIS; 568f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr 569f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr 5709ef78b59da51080882e47505896b420977fd79aeMathieu Chartier // Guards allocation entrypoint instrumenting. 5714ad5cd3e7d519484559ef778d96fb3f0be8919faIan Rogers static Mutex* instrument_entrypoints_lock_; 5729ef78b59da51080882e47505896b420977fd79aeMathieu Chartier 573eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // A barrier is used to synchronize the GC/Debugger thread with mutator threads. When GC/Debugger 574eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // thread wants to suspend all mutator threads, it needs to wait for all mutator threads to pass 575eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // a barrier. Threads that are already suspended will get their barrier passed by the GC/Debugger 576eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // thread; threads in the runnable state will pass the barrier when they transit to the suspended 577eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // state. GC/Debugger thread will be woken up when all mutator threads are suspended. 578719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // 579719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Thread suspension: 580eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // mutator thread | GC/Debugger 581eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // .. running .. | .. running .. 582719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | Request thread suspension by: 583719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | - acquiring thread_suspend_count_lock_ 584719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | - incrementing Thread::suspend_count_ on 585719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | all mutator threads 586719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | - releasing thread_suspend_count_lock_ 587eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // .. running .. | Block wait for all threads to pass a barrier 588719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Poll Thread::suspend_count_ and enter full | .. blocked .. 589719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // suspend code. | .. blocked .. 590eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // Change state to kSuspended (pass the barrier) | Wake up when all threads pass the barrier 591eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // x: Acquire thread_suspend_count_lock_ | .. running .. 592eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // while Thread::suspend_count_ > 0 | .. running .. 593eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // - wait on Thread::resume_cond_ | .. running .. 594eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // (releases thread_suspend_count_lock_) | .. running .. 595719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | Request thread resumption by: 596719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | - acquiring thread_suspend_count_lock_ 597719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | - decrementing Thread::suspend_count_ on 598719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | all mutator threads 599719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | - notifying on Thread::resume_cond_ 600719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // - re-acquire thread_suspend_count_lock_ | - releasing thread_suspend_count_lock_ 601719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Release thread_suspend_count_lock_ | .. running .. 602eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // Change to kRunnable | .. running .. 603eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // - this uses a CAS operation to ensure the | .. running .. 604eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // suspend request flag isn't raised as the | .. running .. 605eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // state is changed | .. running .. 606eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // - if the CAS operation fails then goto x | .. running .. 607719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | .. running .. 608eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li static MutatorMutex* mutator_lock_ ACQUIRED_AFTER(instrument_entrypoints_lock_); 609719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 610719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Allow reader-writer mutual exclusion on the mark and live bitmaps of the heap. 611719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static ReaderWriterMutex* heap_bitmap_lock_ ACQUIRED_AFTER(mutator_lock_); 612719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 613719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Guards shutdown of the runtime. 614719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static Mutex* runtime_shutdown_lock_ ACQUIRED_AFTER(heap_bitmap_lock_); 615719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 6169e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu // Guards background profiler global state. 6179e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu static Mutex* profiler_lock_ ACQUIRED_AFTER(runtime_shutdown_lock_); 6189e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu 6199e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu // Guards trace (ie traceview) requests. 6209e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu static Mutex* trace_lock_ ACQUIRED_AFTER(profiler_lock_); 6219e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu 622306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom // Guards debugger recent allocation records. 623306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom static Mutex* alloc_tracker_lock_ ACQUIRED_AFTER(trace_lock_); 624306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom 625306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom // Guards updates to instrumentation to ensure mutual exclusion of 626306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom // events like deoptimization requests. 627306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom // TODO: improve name, perhaps instrumentation_update_lock_. 628306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom static Mutex* deoptimization_lock_ ACQUIRED_AFTER(alloc_tracker_lock_); 629306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom 630719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // The thread_list_lock_ guards ThreadList::list_. It is also commonly held to stop threads 631719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // attaching and detaching. 632ca47a17f90bb0be9b98685fbf46e4e4f53ea18c6Andreas Gampe static Mutex* thread_list_lock_ ACQUIRED_AFTER(deoptimization_lock_); 633719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 63491e56692c6bd9fa1d41951ee7dc311f19461f4beMathieu Chartier // Signaled when threads terminate. Used to determine when all non-daemons have terminated. 63591e56692c6bd9fa1d41951ee7dc311f19461f4beMathieu Chartier static ConditionVariable* thread_exit_cond_ GUARDED_BY(Locks::thread_list_lock_); 63691e56692c6bd9fa1d41951ee7dc311f19461f4beMathieu Chartier 63768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // Guards maintaining loading library data structures. 63868d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers static Mutex* jni_libraries_lock_ ACQUIRED_AFTER(thread_list_lock_); 63968d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 640719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Guards breakpoints. 641ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz static ReaderWriterMutex* breakpoint_lock_ ACQUIRED_AFTER(jni_libraries_lock_); 642719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 643719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Guards lists of classes within the class linker. 6449e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu static ReaderWriterMutex* classlinker_classes_lock_ ACQUIRED_AFTER(breakpoint_lock_); 645719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 646719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // When declaring any Mutex add DEFAULT_MUTEX_ACQUIRED_AFTER to use annotalysis to check the code 647719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // doesn't try to hold a higher level Mutex. 64812d625f87bcd6c4059a205bb39007a255f57f382Mathieu Chartier #define DEFAULT_MUTEX_ACQUIRED_AFTER ACQUIRED_AFTER(Locks::classlinker_classes_lock_) 649719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 65074240819ae09e29b2753ef38f4eb4be1c2762e2eAndreas Gampe static Mutex* allocated_monitor_ids_lock_ ACQUIRED_AFTER(classlinker_classes_lock_); 65174240819ae09e29b2753ef38f4eb4be1c2762e2eAndreas Gampe 6529e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu // Guard the allocation/deallocation of thread ids. 65374240819ae09e29b2753ef38f4eb4be1c2762e2eAndreas Gampe static Mutex* allocated_thread_ids_lock_ ACQUIRED_AFTER(allocated_monitor_ids_lock_); 6549e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu 6559e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu // Guards modification of the LDT on x86. 6569e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu static Mutex* modify_ldt_lock_ ACQUIRED_AFTER(allocated_thread_ids_lock_); 6579e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu 658f9c6fc610b27887f832e453a0da1789187293408Mathieu Chartier // Guards opened oat files in OatFileManager. 659f9c6fc610b27887f832e453a0da1789187293408Mathieu Chartier static ReaderWriterMutex* oat_file_manager_lock_ ACQUIRED_AFTER(modify_ldt_lock_); 660f9c6fc610b27887f832e453a0da1789187293408Mathieu Chartier 661340dafabc8e88378e395cda9027cf17726910e91Nicolas Geoffray // Guards extra string entries for VerifierDeps. 662340dafabc8e88378e395cda9027cf17726910e91Nicolas Geoffray static ReaderWriterMutex* verifier_deps_lock_ ACQUIRED_AFTER(oat_file_manager_lock_); 663ca3c8c33501bf199d6fd0a5db30a27d8e010cb23David Brazdil 664a206c745dbb64b14f05c87891d425475c2f6d63aRichard Uhler // Guards dlopen_handles_ in DlOpenOatFile. 665ca3c8c33501bf199d6fd0a5db30a27d8e010cb23David Brazdil static Mutex* host_dlopen_handles_lock_ ACQUIRED_AFTER(verifier_deps_lock_); 666e58991b3b2282b5761f1a6023a16c803e1c4eb45Mathieu Chartier 667719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Guards intern table. 668a206c745dbb64b14f05c87891d425475c2f6d63aRichard Uhler static Mutex* intern_table_lock_ ACQUIRED_AFTER(host_dlopen_handles_lock_); 669719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 670a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards reference processor. 671a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_processor_lock_ ACQUIRED_AFTER(intern_table_lock_); 672a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 673a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards cleared references queue. 674a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_cleared_references_lock_ ACQUIRED_AFTER(reference_processor_lock_); 675a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 676a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards weak references queue. 677a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_weak_references_lock_ ACQUIRED_AFTER(reference_queue_cleared_references_lock_); 678a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 679a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards finalizer references queue. 680a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_finalizer_references_lock_ ACQUIRED_AFTER(reference_queue_weak_references_lock_); 681a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 682a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards phantom references queue. 683a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_phantom_references_lock_ ACQUIRED_AFTER(reference_queue_finalizer_references_lock_); 684a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 685a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards soft references queue. 686a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_soft_references_lock_ ACQUIRED_AFTER(reference_queue_phantom_references_lock_); 687a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 68805a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe // Guard accesses to the JNI Global Reference table. 68905a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe static ReaderWriterMutex* jni_globals_lock_ ACQUIRED_AFTER(reference_queue_soft_references_lock_); 69005a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe 69105a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe // Guard accesses to the JNI Weak Global Reference table. 69205a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe static Mutex* jni_weak_globals_lock_ ACQUIRED_AFTER(jni_globals_lock_); 69305a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe 694719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Have an exclusive aborting thread. 69505a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe static Mutex* abort_lock_ ACQUIRED_AFTER(jni_weak_globals_lock_); 696719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 697719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Allow mutual exclusion when manipulating Thread::suspend_count_. 698719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // TODO: Does the trade-off of a per-thread lock make sense? 699719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static Mutex* thread_suspend_count_lock_ ACQUIRED_AFTER(abort_lock_); 700719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 701719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // One unexpected signal at a time lock. 702719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static Mutex* unexpected_signal_lock_ ACQUIRED_AFTER(thread_suspend_count_lock_); 703719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 7043eed93dd5be03e5539827bebf0f414251a12e15eHiroshi Yamauchi // Guards the maps in mem_map. 7053eed93dd5be03e5539827bebf0f414251a12e15eHiroshi Yamauchi static Mutex* mem_maps_lock_ ACQUIRED_AFTER(unexpected_signal_lock_); 7063eed93dd5be03e5539827bebf0f414251a12e15eHiroshi Yamauchi 707719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Have an exclusive logging thread. 708719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static Mutex* logging_lock_ ACQUIRED_AFTER(unexpected_signal_lock_); 709719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers}; 710719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 7114e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartierclass Roles { 7124e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier public: 71390ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier // Uninterruptible means that the thread may not become suspended. 7144e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier static Uninterruptible uninterruptible_; 7154e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier}; 7164e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier 7178daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes} // namespace art 7188daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 719fc0e3219edc9a5bf81b166e82fd5db2796eb6a0dBrian Carlstrom#endif // ART_RUNTIME_BASE_MUTEX_H_ 720