mutex.h revision 88fd720b6799184c8ad61e766a6d37af33ed30ef
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, 587de77dd4f2d3cbb0615ee001589eb99ae82c3dccRaghu Gandham kSwapMutexesLock, 59719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kUnexpectedSignalLock, 60719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kThreadSuspendCountLock, 61719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kAbortLock, 62d0a160d722e696b1a3ffb91dcfde61ee11bfb3e0Tao Wu kJdwpAdbStateLock, 63719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpSocketLock, 642cd334ae2d4287216523882f0d298cf3901b7ab1Hiroshi Yamauchi kRegionSpaceRegionLock, 65f169e27100acbec024f699de9ef842a27c0b2036Mathieu Chartier kMarkSweepMarkStackLock, 662994605707219f67af8340ddd9379ce9bd86d74cMathieu Chartier kRosAllocGlobalLock, 672994605707219f67af8340ddd9379ce9bd86d74cMathieu Chartier kRosAllocBracketLock, 682994605707219f67af8340ddd9379ce9bd86d74cMathieu Chartier kRosAllocBulkFreeLock, 69f169e27100acbec024f699de9ef842a27c0b2036Mathieu Chartier kTaggingLockLevel, 70bc4d218ce2ceef0c4f308d4ff42f7ec1ec43c40eAndreas Gampe kTransactionLogLock, 71c8089540ccf0f1c43d8db3828f21d489b28a4013Andreas Gampe kJniFunctionTableLock, 72673ed3d8aedc5462a47ded827c99f35d46525457Mathieu Chartier kJniWeakGlobalsLock, 7305a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe kJniGlobalsLock, 74a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceQueueSoftReferencesLock, 75a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceQueuePhantomReferencesLock, 76a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceQueueFinalizerReferencesLock, 77a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceQueueWeakReferencesLock, 78a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceQueueClearedReferencesLock, 79a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceProcessorLock, 805cc349f3dd578e974f78314c50b6a0267c23e591David Srbecky kJitDebugInterfaceLock, 81719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kAllocSpaceLock, 822cd334ae2d4287216523882f0d298cf3901b7ab1Hiroshi Yamauchi kBumpPointerSpaceBlockLock, 83c785344b87221f5e4e6473e5b762e4e61fe65dcfMathieu Chartier kArenaPoolLock, 84719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kInternTableLock, 853f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko kOatFileSecondaryLookupLock, 86a206c745dbb64b14f05c87891d425475c2f6d63aRichard Uhler kHostDlOpenHandlesLock, 87ca3c8c33501bf199d6fd0a5db30a27d8e010cb23David Brazdil kVerifierDepsLock, 88f9c6fc610b27887f832e453a0da1789187293408Mathieu Chartier kOatFileManagerLock, 897526d783ab68ed1dd53c763c75895cb432532b0fAndreas Gampe kTracingUniqueMethodsLock, 907526d783ab68ed1dd53c763c75895cb432532b0fAndreas Gampe kTracingStreamingLock, 91b8aa1e4c10dcdc7fef96634f87e259dfee83a1cfMathieu Chartier kDeoptimizedMethodsLock, 92b8aa1e4c10dcdc7fef96634f87e259dfee83a1cfMathieu Chartier kClassLoaderClassesLock, 93719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kDefaultMutexLevel, 946c60d8420e51fda65ad247ae04b5a823c88c26b6Mathieu Chartier kDexLock, 95719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kMarkSweepLargeObjectLock, 96719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpObjectRegistryLock, 979e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu kModifyLdtLock, 989e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu kAllocatedThreadIdsLock, 9974240819ae09e29b2753ef38f4eb4be1c2762e2eAndreas Gampe kMonitorPoolLock, 100b8aa1e4c10dcdc7fef96634f87e259dfee83a1cfMathieu Chartier kClassLinkerClassesLock, // TODO rename. 10165975776f807d55c83af6cca1e447f8daa794413Mathieu Chartier kJitCodeCacheLock, 102063fc772b5b8aed7d769cd7cccb6ddc7619326eeMingyao Yang kCHALock, 103719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kBreakpointLock, 104719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kMonitorLock, 105440e4ceb310349ee8eb569495bc04d3d7fbe71cbMathieu Chartier kMonitorListLock, 10668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers kJniLoadLibraryLock, 107719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kThreadListLock, 108306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom kAllocTrackerLock, 109719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kDeoptimizationLock, 110719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kProfilerLock, 1114e5b20863898006ec6c9d120cda167d38dda6e60Sebastien Hertz kJdwpShutdownLock, 112719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpEventListLock, 113719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpAttachLock, 114719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpStartLock, 115719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kRuntimeShutdownLock, 11669dbec6d9d55eeb2867949c2791d01dc9aa916c8Jeff Hao kTraceLock, 117719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kHeapBitmapLock, 118719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kMutatorLock, 11988fd720b6799184c8ad61e766a6d37af33ed30efAlex Light kUserCodeSuspensionLock, 1209ef78b59da51080882e47505896b420977fd79aeMathieu Chartier kInstrumentEntrypointsLock, 121719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kZygoteCreationLock, 122719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 123719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kLockLevelCount // Must come last. 124719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers}; 125719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogersstd::ostream& operator<<(std::ostream& os, const LockLevel& rhs); 126719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 1272e250c826b3c405d675017efe79e5db3651c9ee6Brian Carlstromconst bool kDebugLocking = kIsDebugBuild; 12825fd14b87cced64a179dee885573113be5e11944Ian Rogers 1291afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi// Record Log contention information, dumpable via SIGQUIT. 1301afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi#ifdef ART_USE_FUTEXES 13108f2e7b59fab9df108d3d91e6eeb4bbccbb325d1Jeff Hao// To enable lock contention logging, set this to true. 13208f2e7b59fab9df108d3d91e6eeb4bbccbb325d1Jeff Haoconst bool kLogLockContentions = false; 1331afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi#else 1341afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi// Keep this false as lock contention logging is supported only with 1351afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi// futex. 1361afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchiconst bool kLogLockContentions = false; 1371afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi#endif 138d9c4fc94fa618617f94e1de9af5f034549100753Ian Rogersconst size_t kContentionLogSize = 4; 1391afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchiconst size_t kContentionLogDataSize = kLogLockContentions ? 1 : 0; 1401afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchiconst size_t kAllMutexDataSize = kLogLockContentions ? 1 : 0; 1411afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi 14200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Base class for all Mutex implementations 14300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogersclass BaseMutex { 14400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 145bab74963db2484ea5f10a82ea26e8a99722bfefeIan Rogers const char* GetName() const { 14600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers return name_; 14700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 14800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 14900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers virtual bool IsMutex() const { return false; } 15000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers virtual bool IsReaderWriterMutex() const { return false; } 151eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li virtual bool IsMutatorMutex() const { return false; } 15200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 15356edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers virtual void Dump(std::ostream& os) const = 0; 15456edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers 15556edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers static void DumpAll(std::ostream& os); 15656edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers 157a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi bool ShouldRespondToEmptyCheckpointRequest() const { 158a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi return should_respond_to_empty_checkpoint_request_; 159a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi } 160a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi 161a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi void SetShouldRespondToEmptyCheckpointRequest(bool value) { 162a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi should_respond_to_empty_checkpoint_request_ = value; 163a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi } 164a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi 165a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi virtual void WakeupToRespondToEmptyCheckpoint() = 0; 166a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi 16700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers protected: 16800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers friend class ConditionVariable; 16900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 17081d425b0b232962441616f8b14f73620bffef5e5Ian Rogers BaseMutex(const char* name, LockLevel level); 17156edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers virtual ~BaseMutex(); 17281d425b0b232962441616f8b14f73620bffef5e5Ian Rogers void RegisterAsLocked(Thread* self); 17381d425b0b232962441616f8b14f73620bffef5e5Ian Rogers void RegisterAsUnlocked(Thread* self); 17481d425b0b232962441616f8b14f73620bffef5e5Ian Rogers void CheckSafeToWait(Thread* self); 17500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 17656edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers friend class ScopedContentionRecorder; 17756edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers 1781afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi void RecordContention(uint64_t blocked_tid, uint64_t owner_tid, uint64_t nano_time_blocked); 17956edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers void DumpContention(std::ostream& os) const; 18056edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers 18181d425b0b232962441616f8b14f73620bffef5e5Ian Rogers const LockLevel level_; // Support for lock hierarchy. 182bab74963db2484ea5f10a82ea26e8a99722bfefeIan Rogers const char* const name_; 183a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi bool should_respond_to_empty_checkpoint_request_; 1841afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi 18556edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers // A log entry that records contention but makes no guarantee that either tid will be held live. 18656edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers struct ContentionLogEntry { 18756edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers ContentionLogEntry() : blocked_tid(0), owner_tid(0) {} 18856edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers uint64_t blocked_tid; 18956edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers uint64_t owner_tid; 19056edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers AtomicInteger count; 19156edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers }; 1921afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi struct ContentionLogData { 1931afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi ContentionLogEntry contention_log[kContentionLogSize]; 1941afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi // The next entry in the contention log to be updated. Value ranges from 0 to 1951afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi // kContentionLogSize - 1. 1961afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi AtomicInteger cur_content_log_entry; 1971afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi // Number of times the Mutex has been contended. 1981afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi AtomicInteger contention_count; 1991afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi // Sum of time waited by all contenders in ns. 20037f3c968ecd04e77802fe17bb82dabc07de21ca1Ian Rogers Atomic<uint64_t> wait_time; 2011afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi void AddToWaitTime(uint64_t value); 2021afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi ContentionLogData() : wait_time(0) {} 2031afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi }; 2043e5cf305db800b2989ad57b7cde8fb3cc9fa1b9eIan Rogers ContentionLogData contention_log_data_[kContentionLogDataSize]; 2051afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi 2061afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi public: 2071afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi bool HasEverContended() const { 2081afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi if (kLogLockContentions) { 2093e5cf305db800b2989ad57b7cde8fb3cc9fa1b9eIan Rogers return contention_log_data_->contention_count.LoadSequentiallyConsistent() > 0; 2101afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi } 2111afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi return false; 2121afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi } 21300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers}; 21400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 21500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// A Mutex is used to achieve mutual exclusion between threads. A Mutex can be used to gain 21600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// exclusive access to what it guards. A Mutex can be in one of two states: 21700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Free - not owned by any thread, 21800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Exclusive - owned by a single thread. 21900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// 22000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// The effect of locking and unlocking operations on the state is: 22100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// State | ExclusiveLock | ExclusiveUnlock 22200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// ------------------------------------------- 22300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Free | Exclusive | error 22400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Exclusive | Block* | Free 22500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// * Mutex is not reentrant and so an attempt to ExclusiveLock on the same thread will result in 22600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// an error. Being non-reentrant simplifies Waiting on ConditionVariables. 22701ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogersstd::ostream& operator<<(std::ostream& os, const Mutex& mu); 22800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogersclass LOCKABLE Mutex : public BaseMutex { 22900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 23081d425b0b232962441616f8b14f73620bffef5e5Ian Rogers explicit Mutex(const char* name, LockLevel level = kDefaultMutexLevel, bool recursive = false); 23100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ~Mutex(); 23200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 23300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers virtual bool IsMutex() const { return true; } 23400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 23500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Block until mutex is free then acquire exclusive access. 23690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ExclusiveLock(Thread* self) ACQUIRE(); 23790443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void Lock(Thread* self) ACQUIRE() { ExclusiveLock(self); } 23800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 23900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Returns true if acquires exclusive access, false otherwise. 24090443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier bool ExclusiveTryLock(Thread* self) TRY_ACQUIRE(true); 24190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier bool TryLock(Thread* self) TRY_ACQUIRE(true) { return ExclusiveTryLock(self); } 24200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 24300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Release exclusive access. 24490443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ExclusiveUnlock(Thread* self) RELEASE(); 24590443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void Unlock(Thread* self) RELEASE() { ExclusiveUnlock(self); } 24600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 24700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Is the current thread the exclusive holder of the Mutex. 248b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE bool IsExclusiveHeld(const Thread* self) const; 2498daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 25000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert that the Mutex is exclusively held by the current thread. 251b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE void AssertExclusiveHeld(const Thread* self) const ASSERT_CAPABILITY(this); 252b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE void AssertHeld(const Thread* self) const ASSERT_CAPABILITY(this); 25300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 25400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert that the Mutex is not held by the current thread. 25590443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void AssertNotHeldExclusive(const Thread* self) ASSERT_CAPABILITY(!*this) { 256db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 25701ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers CHECK(!IsExclusiveHeld(self)) << *this; 25800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 25900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 26090443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void AssertNotHeld(const Thread* self) ASSERT_CAPABILITY(!*this) { 26190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier AssertNotHeldExclusive(self); 26290443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier } 26300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 264c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Id associated with exclusive owner. No memory ordering semantics if called from a thread other 265c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // than the owner. 26600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers uint64_t GetExclusiveOwnerTid() const; 26700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 26800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Returns how many times this Mutex has been locked, it is better to use AssertHeld/NotHeld. 26900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers unsigned int GetDepth() const { 27000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers return recursion_count_; 27100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 27200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 27356edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers virtual void Dump(std::ostream& os) const; 27401ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers 27590443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier // For negative capabilities in clang annotations. 27690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier const Mutex& operator!() const { return *this; } 27790443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier 278a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi void WakeupToRespondToEmptyCheckpoint() OVERRIDE; 279a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi 28000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers private: 281c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#if ART_USE_FUTEXES 282c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // 0 is unheld, 1 is held. 283c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers AtomicInteger state_; 284c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // Exclusive owner. 285c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers volatile uint64_t exclusive_owner_; 286c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // Number of waiting contenders. 287b122a4bbed34ab22b4c1541ee25e5cf22f12a926Ian Rogers AtomicInteger num_contenders_; 288c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#else 28900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers pthread_mutex_t mutex_; 290c5f17732d8144491c642776b6b48c85dfadf4b52Ian Rogers volatile uint64_t exclusive_owner_; // Guarded by mutex_. 291c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#endif 29200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers const bool recursive_; // Can the lock be recursively held? 29300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers unsigned int recursion_count_; 294f1498437b0d6beb9f4f91980b98cbeb0b5c773ceElliott Hughes friend class ConditionVariable; 2958daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes DISALLOW_COPY_AND_ASSIGN(Mutex); 2968daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes}; 2978daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 29800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// A ReaderWriterMutex is used to achieve mutual exclusion between threads, similar to a Mutex. 29900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Unlike a Mutex a ReaderWriterMutex can be used to gain exclusive (writer) or shared (reader) 30000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// access to what it guards. A flaw in relation to a Mutex is that it cannot be used with a 30100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// condition variable. A ReaderWriterMutex can be in one of three states: 30200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Free - not owned by any thread, 30300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Exclusive - owned by a single thread, 30400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Shared(n) - shared amongst n threads. 30500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// 30600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// The effect of locking and unlocking operations on the state is: 30700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// 30800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// State | ExclusiveLock | ExclusiveUnlock | SharedLock | SharedUnlock 30900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// ---------------------------------------------------------------------------- 31000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Free | Exclusive | error | SharedLock(1) | error 31100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Exclusive | Block | Free | Block | error 31200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Shared(n) | Block | error | SharedLock(n+1)* | Shared(n-1) or Free 31300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// * for large values of n the SharedLock may block. 31401ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogersstd::ostream& operator<<(std::ostream& os, const ReaderWriterMutex& mu); 31590443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SHARED_LOCKABLE ReaderWriterMutex : public BaseMutex { 3168daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes public: 31781d425b0b232962441616f8b14f73620bffef5e5Ian Rogers explicit ReaderWriterMutex(const char* name, LockLevel level = kDefaultMutexLevel); 31800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ~ReaderWriterMutex(); 31900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 32000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers virtual bool IsReaderWriterMutex() const { return true; } 32100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 32200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Block until ReaderWriterMutex is free then acquire exclusive access. 32390443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ExclusiveLock(Thread* self) ACQUIRE(); 32490443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void WriterLock(Thread* self) ACQUIRE() { ExclusiveLock(self); } 32500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 32600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Release exclusive access. 32790443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ExclusiveUnlock(Thread* self) RELEASE(); 32890443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void WriterUnlock(Thread* self) RELEASE() { ExclusiveUnlock(self); } 32900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 33000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Block until ReaderWriterMutex is free and acquire exclusive access. Returns true on success 33100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // or false if timeout is reached. 33266aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#if HAVE_TIMED_RWLOCK 333c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers bool ExclusiveLockWithTimeout(Thread* self, int64_t ms, int32_t ns) 33481d425b0b232962441616f8b14f73620bffef5e5Ian Rogers EXCLUSIVE_TRYLOCK_FUNCTION(true); 33566aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#endif 33600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 33700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Block until ReaderWriterMutex is shared or free then acquire a share on the access. 33890443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void SharedLock(Thread* self) ACQUIRE_SHARED() ALWAYS_INLINE; 33990443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ReaderLock(Thread* self) ACQUIRE_SHARED() { SharedLock(self); } 34000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 34100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Try to acquire share of ReaderWriterMutex. 34290443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier bool SharedTryLock(Thread* self) SHARED_TRYLOCK_FUNCTION(true); 34300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 34400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Release a share of the access. 34590443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void SharedUnlock(Thread* self) RELEASE_SHARED() ALWAYS_INLINE; 34690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ReaderUnlock(Thread* self) RELEASE_SHARED() { SharedUnlock(self); } 34700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 34800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Is the current thread the exclusive holder of the ReaderWriterMutex. 349b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE bool IsExclusiveHeld(const Thread* self) const; 35000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 35100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert the current thread has exclusive access to the ReaderWriterMutex. 352b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE void AssertExclusiveHeld(const Thread* self) const ASSERT_CAPABILITY(this); 353b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE void AssertWriterHeld(const Thread* self) const ASSERT_CAPABILITY(this); 3548daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 35500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert the current thread doesn't have exclusive access to the ReaderWriterMutex. 35690ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier void AssertNotExclusiveHeld(const Thread* self) ASSERT_CAPABILITY(!this) { 357db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 358e3359f7ad7671c5816f17145ca3a01516512e8d6Ian Rogers CHECK(!IsExclusiveHeld(self)) << *this; 35900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 36000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 36190ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier void AssertNotWriterHeld(const Thread* self) ASSERT_CAPABILITY(!this) { 36290ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier AssertNotExclusiveHeld(self); 36390ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier } 36400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 36500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Is the current thread a shared holder of the ReaderWriterMutex. 36681d425b0b232962441616f8b14f73620bffef5e5Ian Rogers bool IsSharedHeld(const Thread* self) const; 36700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 36800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert the current thread has shared access to the ReaderWriterMutex. 3693768adec2f819cb506577618fdde158ba659ddd4Mathieu Chartier ALWAYS_INLINE void AssertSharedHeld(const Thread* self) ASSERT_SHARED_CAPABILITY(this) { 370db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 3712cebb24bfc3247d3e9be138a3350106737455918Mathieu Chartier // TODO: we can only assert this well when self != null. 3722cebb24bfc3247d3e9be138a3350106737455918Mathieu Chartier CHECK(IsSharedHeld(self) || self == nullptr) << *this; 37300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 3748daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes } 3753768adec2f819cb506577618fdde158ba659ddd4Mathieu Chartier ALWAYS_INLINE void AssertReaderHeld(const Thread* self) ASSERT_SHARED_CAPABILITY(this) { 37690ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier AssertSharedHeld(self); 37790ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier } 3788daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 37900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert the current thread doesn't hold this ReaderWriterMutex either in shared or exclusive 38000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // mode. 3813768adec2f819cb506577618fdde158ba659ddd4Mathieu Chartier ALWAYS_INLINE void AssertNotHeld(const Thread* self) ASSERT_SHARED_CAPABILITY(!this) { 382db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 38301ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers CHECK(!IsSharedHeld(self)) << *this; 38400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 38500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 38600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 387c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Id associated with exclusive owner. No memory ordering semantics if called from a thread other 388c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // than the owner. 38900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers uint64_t GetExclusiveOwnerTid() const; 39081d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 39156edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers virtual void Dump(std::ostream& os) const; 39201ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers 39390443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier // For negative capabilities in clang annotations. 39490443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier const ReaderWriterMutex& operator!() const { return *this; } 39590443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier 396a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi void WakeupToRespondToEmptyCheckpoint() OVERRIDE; 397a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi 3988daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes private: 39951d212ef31945743abe8a469707aaa25bab95357Ian Rogers#if ART_USE_FUTEXES 400cf7f19135f0e273f7b0136315633c2abfc715343Ian Rogers // Out-of-inline path for handling contention for a SharedLock. 401cf7f19135f0e273f7b0136315633c2abfc715343Ian Rogers void HandleSharedLockContention(Thread* self, int32_t cur_state); 402cf7f19135f0e273f7b0136315633c2abfc715343Ian Rogers 40381d425b0b232962441616f8b14f73620bffef5e5Ian Rogers // -1 implies held exclusive, +ve shared held by state_ many owners. 404c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers AtomicInteger state_; 405c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Exclusive owner. Modification guarded by this mutex. 40681d425b0b232962441616f8b14f73620bffef5e5Ian Rogers volatile uint64_t exclusive_owner_; 407c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Number of contenders waiting for a reader share. 408c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers AtomicInteger num_pending_readers_; 409c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Number of contenders waiting to be the writer. 410b122a4bbed34ab22b4c1541ee25e5cf22f12a926Ian Rogers AtomicInteger num_pending_writers_; 41181d425b0b232962441616f8b14f73620bffef5e5Ian Rogers#else 41200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers pthread_rwlock_t rwlock_; 413c5f17732d8144491c642776b6b48c85dfadf4b52Ian Rogers volatile uint64_t exclusive_owner_; // Guarded by rwlock_. 41481d425b0b232962441616f8b14f73620bffef5e5Ian Rogers#endif 41500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers DISALLOW_COPY_AND_ASSIGN(ReaderWriterMutex); 4168daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes}; 4178daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 418eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// MutatorMutex is a special kind of ReaderWriterMutex created specifically for the 419eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// Locks::mutator_lock_ mutex. The behaviour is identical to the ReaderWriterMutex except that 420eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// thread state changes also play a part in lock ownership. The mutator_lock_ will not be truly 421eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// held by any mutator threads. However, a thread in the kRunnable state is considered to have 422eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// shared ownership of the mutator lock and therefore transitions in and out of the kRunnable 423eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// state have associated implications on lock ownership. Extra methods to handle the state 424eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// transitions have been added to the interface but are only accessible to the methods dealing 425eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// with state transitions. The thread state and flags attributes are used to ensure thread state 426eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// transitions are consistent with the permitted behaviour of the mutex. 427eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// 428eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// *) The most important consequence of this behaviour is that all threads must be in one of the 429eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// suspended states before exclusive ownership of the mutator mutex is sought. 430eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// 431eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Listd::ostream& operator<<(std::ostream& os, const MutatorMutex& mu); 43290443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SHARED_LOCKABLE MutatorMutex : public ReaderWriterMutex { 433eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li public: 434eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li explicit MutatorMutex(const char* name, LockLevel level = kDefaultMutexLevel) 435eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li : ReaderWriterMutex(name, level) {} 436eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li ~MutatorMutex() {} 437eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li 438eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li virtual bool IsMutatorMutex() const { return true; } 439eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li 44090443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier // For negative capabilities in clang annotations. 44190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier const MutatorMutex& operator!() const { return *this; } 44290443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier 443eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li private: 444eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li friend class Thread; 445eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li void TransitionFromRunnableToSuspended(Thread* self) UNLOCK_FUNCTION() ALWAYS_INLINE; 446eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li void TransitionFromSuspendedToRunnable(Thread* self) SHARED_LOCK_FUNCTION() ALWAYS_INLINE; 447eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li 448eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li DISALLOW_COPY_AND_ASSIGN(MutatorMutex); 449eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li}; 450eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li 45100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// ConditionVariables allow threads to queue and sleep. Threads may then be resumed individually 45200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// (Signal) or all at once (Broadcast). 4535f79133a435ebcb20000370d56046fe01201dd80Elliott Hughesclass ConditionVariable { 4545f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes public: 4553887c468d731420e929e6ad3acf190d5431e94fcRoland Levillain ConditionVariable(const char* name, Mutex& mutex); 4565f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes ~ConditionVariable(); 4575f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes 458c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers void Broadcast(Thread* self); 459c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers void Signal(Thread* self); 460c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // TODO: No thread safety analysis on Wait and TimedWait as they call mutex operations via their 461c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // pointer copy, thereby defeating annotalysis. 462c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers void Wait(Thread* self) NO_THREAD_SAFETY_ANALYSIS; 4637b078e8c04f3e1451dbdd18543c8b9692b5b067eIan Rogers bool TimedWait(Thread* self, int64_t ms, int32_t ns) NO_THREAD_SAFETY_ANALYSIS; 4641d54e73444e017d3a65234e0f193846f3e27472bIan Rogers // Variant of Wait that should be used with caution. Doesn't validate that no mutexes are held 4651d54e73444e017d3a65234e0f193846f3e27472bIan Rogers // when waiting. 4661d54e73444e017d3a65234e0f193846f3e27472bIan Rogers // TODO: remove this. 4671d54e73444e017d3a65234e0f193846f3e27472bIan Rogers void WaitHoldingLocks(Thread* self) NO_THREAD_SAFETY_ANALYSIS; 4685f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes 4695f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes private: 47023055dc5d7a90c4a12e259fd0ed7cd4d04d89182Ian Rogers const char* const name_; 471c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // The Mutex being used by waiters. It is an error to mix condition variables between different 472c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // Mutexes. 473c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers Mutex& guard_; 474c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#if ART_USE_FUTEXES 475c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // A counter that is modified by signals and broadcasts. This ensures that when a waiter gives up 476d45f201e9bd43490e30a35710865789b8d70e249Ian Rogers // their Mutex and another thread takes it and signals, the waiting thread observes that sequence_ 477d45f201e9bd43490e30a35710865789b8d70e249Ian Rogers // changed and doesn't enter the wait. Modified while holding guard_, but is read by futex wait 478d45f201e9bd43490e30a35710865789b8d70e249Ian Rogers // without guard_ held. 479b122a4bbed34ab22b4c1541ee25e5cf22f12a926Ian Rogers AtomicInteger sequence_; 480c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // Number of threads that have come into to wait, not the length of the waiters on the futex as 4815bd97c483c1de1eb97afe76123b1b9ab53095edfIan Rogers // waiters may have been requeued onto guard_. Guarded by guard_. 482c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers volatile int32_t num_waiters_; 483c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#else 484c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers pthread_cond_t cond_; 485c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#endif 4865f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes DISALLOW_COPY_AND_ASSIGN(ConditionVariable); 4875f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes}; 4885f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes 48900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Scoped locker/unlocker for a regular Mutex that acquires mu upon construction and releases it 49000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// upon destruction. 49190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SCOPED_CAPABILITY MutexLock { 49200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 4933887c468d731420e929e6ad3acf190d5431e94fcRoland Levillain MutexLock(Thread* self, Mutex& mu) ACQUIRE(mu) : self_(self), mu_(mu) { 49481d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.ExclusiveLock(self_); 49581d425b0b232962441616f8b14f73620bffef5e5Ian Rogers } 49681d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 4974e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier ~MutexLock() RELEASE() { 49881d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.ExclusiveUnlock(self_); 49900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 50000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 50100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers private: 50281d425b0b232962441616f8b14f73620bffef5e5Ian Rogers Thread* const self_; 50300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers Mutex& mu_; 50400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers DISALLOW_COPY_AND_ASSIGN(MutexLock); 50500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers}; 50600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Catch bug where variable name is omitted. "MutexLock (lock);" instead of "MutexLock mu(lock)". 507575e78c41ece0dec969d31f46be563d4eb7ae43bAndreas Gampe#define MutexLock(x) static_assert(0, "MutexLock declaration missing variable name") 50800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 50900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Scoped locker/unlocker for a ReaderWriterMutex that acquires read access to mu upon 51000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// construction and releases it upon destruction. 51190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SCOPED_CAPABILITY ReaderMutexLock { 51200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 513b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE ReaderMutexLock(Thread* self, ReaderWriterMutex& mu) ACQUIRE(mu); 51481d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 515b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE ~ReaderMutexLock() RELEASE(); 51600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 51700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers private: 51881d425b0b232962441616f8b14f73620bffef5e5Ian Rogers Thread* const self_; 51900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ReaderWriterMutex& mu_; 52000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers DISALLOW_COPY_AND_ASSIGN(ReaderMutexLock); 52100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers}; 52200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 52300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Scoped locker/unlocker for a ReaderWriterMutex that acquires write access to mu upon 52400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// construction and releases it upon destruction. 52590443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SCOPED_CAPABILITY WriterMutexLock { 52600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 5273887c468d731420e929e6ad3acf190d5431e94fcRoland Levillain WriterMutexLock(Thread* self, ReaderWriterMutex& mu) EXCLUSIVE_LOCK_FUNCTION(mu) : 52881d425b0b232962441616f8b14f73620bffef5e5Ian Rogers self_(self), mu_(mu) { 52981d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.ExclusiveLock(self_); 53081d425b0b232962441616f8b14f73620bffef5e5Ian Rogers } 53181d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 53200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ~WriterMutexLock() UNLOCK_FUNCTION() { 53381d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.ExclusiveUnlock(self_); 53400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 53500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 53600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers private: 53750b35e2fd1a68cd1240e4a9d9f363e11764957d1Ian Rogers Thread* const self_; 53800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ReaderWriterMutex& mu_; 53900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers DISALLOW_COPY_AND_ASSIGN(WriterMutexLock); 54000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers}; 54100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Catch bug where variable name is omitted. "WriterMutexLock (lock);" instead of 54200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// "WriterMutexLock mu(lock)". 543575e78c41ece0dec969d31f46be563d4eb7ae43bAndreas Gampe#define WriterMutexLock(x) static_assert(0, "WriterMutexLock declaration missing variable name") 54400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 5454e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier// For StartNoThreadSuspension and EndNoThreadSuspension. 5464e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartierclass CAPABILITY("role") Role { 5474e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier public: 5484e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier void Acquire() ACQUIRE() {} 5494e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier void Release() RELEASE() {} 5504e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier const Role& operator!() const { return *this; } 5514e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier}; 5524e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier 5534e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartierclass Uninterruptible : public Role { 5544e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier}; 5554e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier 556719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers// Global mutexes corresponding to the levels above. 557719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogersclass Locks { 558719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers public: 559719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static void Init(); 56091e56692c6bd9fa1d41951ee7dc311f19461f4beMathieu Chartier static void InitConditions() NO_THREAD_SAFETY_ANALYSIS; // Condition variables. 561f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr 562f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // Destroying various lock types can emit errors that vary depending upon 563f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // whether the client (art::Runtime) is currently active. Allow the client 564f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // to set a callback that is used to check when it is acceptable to call 565f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // Abort. The default behavior is that the client *is not* able to call 566f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // Abort if no callback is established. 567f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr using ClientCallback = bool(); 568f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr static void SetClientCallback(ClientCallback* is_safe_to_call_abort_cb) NO_THREAD_SAFETY_ANALYSIS; 569f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // Checks for whether it is safe to call Abort() without using locks. 570f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr static bool IsSafeToCallAbortRacy() NO_THREAD_SAFETY_ANALYSIS; 571f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr 5728a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi // Add a mutex to expected_mutexes_on_weak_ref_access_. 5738a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi static void AddToExpectedMutexesOnWeakRefAccess(BaseMutex* mutex, bool need_lock = true); 5748a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi // Remove a mutex from expected_mutexes_on_weak_ref_access_. 5758a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi static void RemoveFromExpectedMutexesOnWeakRefAccess(BaseMutex* mutex, bool need_lock = true); 5768a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi // Check if the given mutex is in expected_mutexes_on_weak_ref_access_. 5778a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi static bool IsExpectedOnWeakRefAccess(BaseMutex* mutex); 578f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr 5799ef78b59da51080882e47505896b420977fd79aeMathieu Chartier // Guards allocation entrypoint instrumenting. 5804ad5cd3e7d519484559ef778d96fb3f0be8919faIan Rogers static Mutex* instrument_entrypoints_lock_; 5819ef78b59da51080882e47505896b420977fd79aeMathieu Chartier 58288fd720b6799184c8ad61e766a6d37af33ed30efAlex Light // Guards code that deals with user-code suspension. This mutex must be held when suspending or 58388fd720b6799184c8ad61e766a6d37af33ed30efAlex Light // resuming threads with SuspendReason::kForUserCode. It may be held by a suspended thread, but 58488fd720b6799184c8ad61e766a6d37af33ed30efAlex Light // only if the suspension is not due to SuspendReason::kForUserCode. 58588fd720b6799184c8ad61e766a6d37af33ed30efAlex Light static Mutex* user_code_suspension_lock_ ACQUIRED_AFTER(instrument_entrypoints_lock_); 58688fd720b6799184c8ad61e766a6d37af33ed30efAlex Light 587eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // A barrier is used to synchronize the GC/Debugger thread with mutator threads. When GC/Debugger 588eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // thread wants to suspend all mutator threads, it needs to wait for all mutator threads to pass 589eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // a barrier. Threads that are already suspended will get their barrier passed by the GC/Debugger 590eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // thread; threads in the runnable state will pass the barrier when they transit to the suspended 591eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // state. GC/Debugger thread will be woken up when all mutator threads are suspended. 592719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // 593719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Thread suspension: 594eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // mutator thread | GC/Debugger 595eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // .. running .. | .. running .. 596719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | Request thread suspension by: 597719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | - acquiring thread_suspend_count_lock_ 598719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | - incrementing Thread::suspend_count_ on 599719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | all mutator threads 600719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | - releasing thread_suspend_count_lock_ 601eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // .. running .. | Block wait for all threads to pass a barrier 602719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Poll Thread::suspend_count_ and enter full | .. blocked .. 603719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // suspend code. | .. blocked .. 604eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // Change state to kSuspended (pass the barrier) | Wake up when all threads pass the barrier 605eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // x: Acquire thread_suspend_count_lock_ | .. running .. 606eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // while Thread::suspend_count_ > 0 | .. running .. 607eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // - wait on Thread::resume_cond_ | .. running .. 608eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // (releases thread_suspend_count_lock_) | .. running .. 609719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | Request thread resumption by: 610719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | - acquiring thread_suspend_count_lock_ 611719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | - decrementing Thread::suspend_count_ on 612719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | all mutator threads 613719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | - notifying on Thread::resume_cond_ 614719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // - re-acquire thread_suspend_count_lock_ | - releasing thread_suspend_count_lock_ 615719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Release thread_suspend_count_lock_ | .. running .. 616eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // Change to kRunnable | .. running .. 617eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // - this uses a CAS operation to ensure the | .. running .. 618eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // suspend request flag isn't raised as the | .. running .. 619eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // state is changed | .. running .. 620eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // - if the CAS operation fails then goto x | .. running .. 621719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | .. running .. 62288fd720b6799184c8ad61e766a6d37af33ed30efAlex Light static MutatorMutex* mutator_lock_ ACQUIRED_AFTER(user_code_suspension_lock_); 623719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 624719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Allow reader-writer mutual exclusion on the mark and live bitmaps of the heap. 625719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static ReaderWriterMutex* heap_bitmap_lock_ ACQUIRED_AFTER(mutator_lock_); 626719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 627719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Guards shutdown of the runtime. 628719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static Mutex* runtime_shutdown_lock_ ACQUIRED_AFTER(heap_bitmap_lock_); 629719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 6309e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu // Guards background profiler global state. 631b139b6d3833cd6a90f345204202ec57ff277c088Hiroshi Yamauchi static Mutex* profiler_lock_ ACQUIRED_AFTER(runtime_shutdown_lock_); 6329e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu 6339e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu // Guards trace (ie traceview) requests. 6349e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu static Mutex* trace_lock_ ACQUIRED_AFTER(profiler_lock_); 6359e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu 636306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom // Guards debugger recent allocation records. 637306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom static Mutex* alloc_tracker_lock_ ACQUIRED_AFTER(trace_lock_); 638306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom 639306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom // Guards updates to instrumentation to ensure mutual exclusion of 640306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom // events like deoptimization requests. 641306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom // TODO: improve name, perhaps instrumentation_update_lock_. 642306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom static Mutex* deoptimization_lock_ ACQUIRED_AFTER(alloc_tracker_lock_); 643306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom 644063fc772b5b8aed7d769cd7cccb6ddc7619326eeMingyao Yang // Guards Class Hierarchy Analysis (CHA). 645063fc772b5b8aed7d769cd7cccb6ddc7619326eeMingyao Yang static Mutex* cha_lock_ ACQUIRED_AFTER(deoptimization_lock_); 646063fc772b5b8aed7d769cd7cccb6ddc7619326eeMingyao Yang 647719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // The thread_list_lock_ guards ThreadList::list_. It is also commonly held to stop threads 648719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // attaching and detaching. 649063fc772b5b8aed7d769cd7cccb6ddc7619326eeMingyao Yang static Mutex* thread_list_lock_ ACQUIRED_AFTER(cha_lock_); 650719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 65191e56692c6bd9fa1d41951ee7dc311f19461f4beMathieu Chartier // Signaled when threads terminate. Used to determine when all non-daemons have terminated. 65291e56692c6bd9fa1d41951ee7dc311f19461f4beMathieu Chartier static ConditionVariable* thread_exit_cond_ GUARDED_BY(Locks::thread_list_lock_); 65391e56692c6bd9fa1d41951ee7dc311f19461f4beMathieu Chartier 65468d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // Guards maintaining loading library data structures. 65568d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers static Mutex* jni_libraries_lock_ ACQUIRED_AFTER(thread_list_lock_); 65668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 657719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Guards breakpoints. 658ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz static ReaderWriterMutex* breakpoint_lock_ ACQUIRED_AFTER(jni_libraries_lock_); 659719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 660719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Guards lists of classes within the class linker. 6619e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu static ReaderWriterMutex* classlinker_classes_lock_ ACQUIRED_AFTER(breakpoint_lock_); 662719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 663719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // When declaring any Mutex add DEFAULT_MUTEX_ACQUIRED_AFTER to use annotalysis to check the code 664719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // doesn't try to hold a higher level Mutex. 66512d625f87bcd6c4059a205bb39007a255f57f382Mathieu Chartier #define DEFAULT_MUTEX_ACQUIRED_AFTER ACQUIRED_AFTER(Locks::classlinker_classes_lock_) 666719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 66774240819ae09e29b2753ef38f4eb4be1c2762e2eAndreas Gampe static Mutex* allocated_monitor_ids_lock_ ACQUIRED_AFTER(classlinker_classes_lock_); 66874240819ae09e29b2753ef38f4eb4be1c2762e2eAndreas Gampe 6699e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu // Guard the allocation/deallocation of thread ids. 67074240819ae09e29b2753ef38f4eb4be1c2762e2eAndreas Gampe static Mutex* allocated_thread_ids_lock_ ACQUIRED_AFTER(allocated_monitor_ids_lock_); 6719e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu 6729e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu // Guards modification of the LDT on x86. 6739e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu static Mutex* modify_ldt_lock_ ACQUIRED_AFTER(allocated_thread_ids_lock_); 6749e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu 675cc1b5357f83f0b787d51fbfde3fe870c8a2fa050Andreas Gampe static ReaderWriterMutex* dex_lock_ ACQUIRED_AFTER(modify_ldt_lock_); 676cc1b5357f83f0b787d51fbfde3fe870c8a2fa050Andreas Gampe 677f9c6fc610b27887f832e453a0da1789187293408Mathieu Chartier // Guards opened oat files in OatFileManager. 678cc1b5357f83f0b787d51fbfde3fe870c8a2fa050Andreas Gampe static ReaderWriterMutex* oat_file_manager_lock_ ACQUIRED_AFTER(dex_lock_); 679f9c6fc610b27887f832e453a0da1789187293408Mathieu Chartier 680340dafabc8e88378e395cda9027cf17726910e91Nicolas Geoffray // Guards extra string entries for VerifierDeps. 681340dafabc8e88378e395cda9027cf17726910e91Nicolas Geoffray static ReaderWriterMutex* verifier_deps_lock_ ACQUIRED_AFTER(oat_file_manager_lock_); 682ca3c8c33501bf199d6fd0a5db30a27d8e010cb23David Brazdil 683a206c745dbb64b14f05c87891d425475c2f6d63aRichard Uhler // Guards dlopen_handles_ in DlOpenOatFile. 684ca3c8c33501bf199d6fd0a5db30a27d8e010cb23David Brazdil static Mutex* host_dlopen_handles_lock_ ACQUIRED_AFTER(verifier_deps_lock_); 685e58991b3b2282b5761f1a6023a16c803e1c4eb45Mathieu Chartier 686719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Guards intern table. 687a206c745dbb64b14f05c87891d425475c2f6d63aRichard Uhler static Mutex* intern_table_lock_ ACQUIRED_AFTER(host_dlopen_handles_lock_); 688719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 689a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards reference processor. 690a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_processor_lock_ ACQUIRED_AFTER(intern_table_lock_); 691a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 692a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards cleared references queue. 693a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_cleared_references_lock_ ACQUIRED_AFTER(reference_processor_lock_); 694a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 695a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards weak references queue. 696a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_weak_references_lock_ ACQUIRED_AFTER(reference_queue_cleared_references_lock_); 697a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 698a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards finalizer references queue. 699a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_finalizer_references_lock_ ACQUIRED_AFTER(reference_queue_weak_references_lock_); 700a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 701a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards phantom references queue. 702a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_phantom_references_lock_ ACQUIRED_AFTER(reference_queue_finalizer_references_lock_); 703a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 704a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards soft references queue. 705a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_soft_references_lock_ ACQUIRED_AFTER(reference_queue_phantom_references_lock_); 706a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 70705a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe // Guard accesses to the JNI Global Reference table. 70805a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe static ReaderWriterMutex* jni_globals_lock_ ACQUIRED_AFTER(reference_queue_soft_references_lock_); 70905a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe 71005a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe // Guard accesses to the JNI Weak Global Reference table. 71105a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe static Mutex* jni_weak_globals_lock_ ACQUIRED_AFTER(jni_globals_lock_); 71205a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe 713c8089540ccf0f1c43d8db3828f21d489b28a4013Andreas Gampe // Guard accesses to the JNI function table override. 714c8089540ccf0f1c43d8db3828f21d489b28a4013Andreas Gampe static Mutex* jni_function_table_lock_ ACQUIRED_AFTER(jni_weak_globals_lock_); 715c8089540ccf0f1c43d8db3828f21d489b28a4013Andreas Gampe 716719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Have an exclusive aborting thread. 717c8089540ccf0f1c43d8db3828f21d489b28a4013Andreas Gampe static Mutex* abort_lock_ ACQUIRED_AFTER(jni_function_table_lock_); 718719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 719719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Allow mutual exclusion when manipulating Thread::suspend_count_. 720719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // TODO: Does the trade-off of a per-thread lock make sense? 721719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static Mutex* thread_suspend_count_lock_ ACQUIRED_AFTER(abort_lock_); 722719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 723719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // One unexpected signal at a time lock. 724719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static Mutex* unexpected_signal_lock_ ACQUIRED_AFTER(thread_suspend_count_lock_); 725719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 726719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Have an exclusive logging thread. 727719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static Mutex* logging_lock_ ACQUIRED_AFTER(unexpected_signal_lock_); 728a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi 729a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi // List of mutexes that we expect a thread may hold when accessing weak refs. This is used to 730a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi // avoid a deadlock in the empty checkpoint while weak ref access is disabled (b/34964016). If we 731a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi // encounter an unexpected mutex on accessing weak refs, 732a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi // Thread::CheckEmptyCheckpointFromWeakRefAccess will detect it. 733a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi static std::vector<BaseMutex*> expected_mutexes_on_weak_ref_access_; 7348a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi static Atomic<const BaseMutex*> expected_mutexes_on_weak_ref_access_guard_; 7358a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi class ScopedExpectedMutexesOnWeakRefAccessLock; 736719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers}; 737719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 7384e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartierclass Roles { 7394e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier public: 74090ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier // Uninterruptible means that the thread may not become suspended. 7414e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier static Uninterruptible uninterruptible_; 7424e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier}; 7434e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier 7448daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes} // namespace art 7458daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 746fc0e3219edc9a5bf81b166e82fd5db2796eb6a0dBrian Carlstrom#endif // ART_RUNTIME_BASE_MUTEX_H_ 747