mutex.h revision 0fa1786bdcc333873ed65a1f77a4669d5701ac5e
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> 220882af2e3ca253184b6ab56a8966a2f37407144eHans Boehm#include <unistd.h> // for pid_t 23ffb465f23d9549dd591e6aa62e9250523cb00233Elliott Hughes 24ffb465f23d9549dd591e6aa62e9250523cb00233Elliott Hughes#include <iosfwd> 258daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes#include <string> 268daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 27ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers#include "atomic.h" 2807ed66b5ae659c452cbe1ab20c3dbf1d6f546461Elliott Hughes#include "base/logging.h" 29761600567d73b23324ae0251e871c15d6849ffd8Elliott Hughes#include "base/macros.h" 3000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers#include "globals.h" 3181d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 32ab47016374d340011680e9cd970ee7d6225d6704Ian Rogers#if defined(__APPLE__) 3381d425b0b232962441616f8b14f73620bffef5e5Ian Rogers#define ART_USE_FUTEXES 0 34ab47016374d340011680e9cd970ee7d6225d6704Ian Rogers#else 35c01417898a6e4f8a5663d6c0556982488c133cdfChris Dearman#define ART_USE_FUTEXES 1 36ab47016374d340011680e9cd970ee7d6225d6704Ian Rogers#endif 378daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 3866aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers// Currently Darwin doesn't support locks with timeouts. 3966aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#if !defined(__APPLE__) 4066aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#define HAVE_TIMED_RWLOCK 1 4166aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#else 4266aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#define HAVE_TIMED_RWLOCK 0 4366aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#endif 4466aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers 458daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughesnamespace art { 468daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 4790443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SHARED_LOCKABLE ReaderWriterMutex; 4890443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SHARED_LOCKABLE MutatorMutex; 4956edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogersclass ScopedContentionRecorder; 5050b35e2fd1a68cd1240e4a9d9f363e11764957d1Ian Rogersclass Thread; 5150b35e2fd1a68cd1240e4a9d9f363e11764957d1Ian Rogers 52719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers// LockLevel is used to impose a lock hierarchy [1] where acquisition of a Mutex at a higher or 53719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers// equal level to a lock a thread holds is invalid. The lock hierarchy achieves a cycle free 54719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers// partial ordering and thereby cause deadlock situations to fail checks. 55719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers// 56719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers// [1] http://www.drdobbs.com/parallel/use-lock-hierarchies-to-avoid-deadlock/204801163 57719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogersenum LockLevel { 58719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kLoggingLock = 0, 597de77dd4f2d3cbb0615ee001589eb99ae82c3dccRaghu Gandham kSwapMutexesLock, 60719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kUnexpectedSignalLock, 61719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kThreadSuspendCountLock, 62719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kAbortLock, 63d0a160d722e696b1a3ffb91dcfde61ee11bfb3e0Tao Wu kJdwpAdbStateLock, 64719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpSocketLock, 652cd334ae2d4287216523882f0d298cf3901b7ab1Hiroshi Yamauchi kRegionSpaceRegionLock, 66f169e27100acbec024f699de9ef842a27c0b2036Mathieu Chartier kMarkSweepMarkStackLock, 672994605707219f67af8340ddd9379ce9bd86d74cMathieu Chartier kRosAllocGlobalLock, 682994605707219f67af8340ddd9379ce9bd86d74cMathieu Chartier kRosAllocBracketLock, 692994605707219f67af8340ddd9379ce9bd86d74cMathieu Chartier kRosAllocBulkFreeLock, 70f169e27100acbec024f699de9ef842a27c0b2036Mathieu Chartier kTaggingLockLevel, 71bc4d218ce2ceef0c4f308d4ff42f7ec1ec43c40eAndreas Gampe kTransactionLogLock, 72c8089540ccf0f1c43d8db3828f21d489b28a4013Andreas Gampe kJniFunctionTableLock, 73673ed3d8aedc5462a47ded827c99f35d46525457Mathieu Chartier kJniWeakGlobalsLock, 7405a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe kJniGlobalsLock, 75a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceQueueSoftReferencesLock, 76a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceQueuePhantomReferencesLock, 77a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceQueueFinalizerReferencesLock, 78a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceQueueWeakReferencesLock, 79a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceQueueClearedReferencesLock, 80a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceProcessorLock, 815cc349f3dd578e974f78314c50b6a0267c23e591David Srbecky kJitDebugInterfaceLock, 82719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kAllocSpaceLock, 832cd334ae2d4287216523882f0d298cf3901b7ab1Hiroshi Yamauchi kBumpPointerSpaceBlockLock, 84c785344b87221f5e4e6473e5b762e4e61fe65dcfMathieu Chartier kArenaPoolLock, 85719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kInternTableLock, 863f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko kOatFileSecondaryLookupLock, 87a206c745dbb64b14f05c87891d425475c2f6d63aRichard Uhler kHostDlOpenHandlesLock, 88ca3c8c33501bf199d6fd0a5db30a27d8e010cb23David Brazdil kVerifierDepsLock, 89f9c6fc610b27887f832e453a0da1789187293408Mathieu Chartier kOatFileManagerLock, 907526d783ab68ed1dd53c763c75895cb432532b0fAndreas Gampe kTracingUniqueMethodsLock, 917526d783ab68ed1dd53c763c75895cb432532b0fAndreas Gampe kTracingStreamingLock, 92b8aa1e4c10dcdc7fef96634f87e259dfee83a1cfMathieu Chartier kDeoptimizedMethodsLock, 93b8aa1e4c10dcdc7fef96634f87e259dfee83a1cfMathieu Chartier kClassLoaderClassesLock, 94719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kDefaultMutexLevel, 956c60d8420e51fda65ad247ae04b5a823c88c26b6Mathieu Chartier kDexLock, 96719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kMarkSweepLargeObjectLock, 97719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpObjectRegistryLock, 989e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu kModifyLdtLock, 999e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu kAllocatedThreadIdsLock, 10074240819ae09e29b2753ef38f4eb4be1c2762e2eAndreas Gampe kMonitorPoolLock, 101b8aa1e4c10dcdc7fef96634f87e259dfee83a1cfMathieu Chartier kClassLinkerClassesLock, // TODO rename. 10265975776f807d55c83af6cca1e447f8daa794413Mathieu Chartier kJitCodeCacheLock, 103063fc772b5b8aed7d769cd7cccb6ddc7619326eeMingyao Yang kCHALock, 104719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kBreakpointLock, 105719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kMonitorLock, 106440e4ceb310349ee8eb569495bc04d3d7fbe71cbMathieu Chartier kMonitorListLock, 10768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers kJniLoadLibraryLock, 108719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kThreadListLock, 109306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom kAllocTrackerLock, 110719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kDeoptimizationLock, 111719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kProfilerLock, 1124e5b20863898006ec6c9d120cda167d38dda6e60Sebastien Hertz kJdwpShutdownLock, 113719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpEventListLock, 114719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpAttachLock, 115719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpStartLock, 116719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kRuntimeShutdownLock, 11769dbec6d9d55eeb2867949c2791d01dc9aa916c8Jeff Hao kTraceLock, 118719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kHeapBitmapLock, 119719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kMutatorLock, 12088fd720b6799184c8ad61e766a6d37af33ed30efAlex Light kUserCodeSuspensionLock, 1219ef78b59da51080882e47505896b420977fd79aeMathieu Chartier kInstrumentEntrypointsLock, 122719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kZygoteCreationLock, 123719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 124719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kLockLevelCount // Must come last. 125719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers}; 126719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogersstd::ostream& operator<<(std::ostream& os, const LockLevel& rhs); 127719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 1282e250c826b3c405d675017efe79e5db3651c9ee6Brian Carlstromconst bool kDebugLocking = kIsDebugBuild; 12925fd14b87cced64a179dee885573113be5e11944Ian Rogers 1301afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi// Record Log contention information, dumpable via SIGQUIT. 1311afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi#ifdef ART_USE_FUTEXES 13208f2e7b59fab9df108d3d91e6eeb4bbccbb325d1Jeff Hao// To enable lock contention logging, set this to true. 13308f2e7b59fab9df108d3d91e6eeb4bbccbb325d1Jeff Haoconst bool kLogLockContentions = false; 1341afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi#else 1351afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi// Keep this false as lock contention logging is supported only with 1361afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi// futex. 1371afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchiconst bool kLogLockContentions = false; 1381afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi#endif 139d9c4fc94fa618617f94e1de9af5f034549100753Ian Rogersconst size_t kContentionLogSize = 4; 1401afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchiconst size_t kContentionLogDataSize = kLogLockContentions ? 1 : 0; 1411afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchiconst size_t kAllMutexDataSize = kLogLockContentions ? 1 : 0; 1421afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi 14300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Base class for all Mutex implementations 14400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogersclass BaseMutex { 14500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 146bab74963db2484ea5f10a82ea26e8a99722bfefeIan Rogers const char* GetName() const { 14700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers return name_; 14800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 14900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 15000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers virtual bool IsMutex() const { return false; } 15100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers virtual bool IsReaderWriterMutex() const { return false; } 152eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li virtual bool IsMutatorMutex() const { return false; } 15300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 15456edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers virtual void Dump(std::ostream& os) const = 0; 15556edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers 15656edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers static void DumpAll(std::ostream& os); 15756edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers 158a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi bool ShouldRespondToEmptyCheckpointRequest() const { 159a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi return should_respond_to_empty_checkpoint_request_; 160a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi } 161a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi 162a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi void SetShouldRespondToEmptyCheckpointRequest(bool value) { 163a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi should_respond_to_empty_checkpoint_request_ = value; 164a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi } 165a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi 166a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi virtual void WakeupToRespondToEmptyCheckpoint() = 0; 167a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi 16800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers protected: 16900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers friend class ConditionVariable; 17000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 17181d425b0b232962441616f8b14f73620bffef5e5Ian Rogers BaseMutex(const char* name, LockLevel level); 17256edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers virtual ~BaseMutex(); 17381d425b0b232962441616f8b14f73620bffef5e5Ian Rogers void RegisterAsLocked(Thread* self); 17481d425b0b232962441616f8b14f73620bffef5e5Ian Rogers void RegisterAsUnlocked(Thread* self); 17581d425b0b232962441616f8b14f73620bffef5e5Ian Rogers void CheckSafeToWait(Thread* self); 17600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 17756edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers friend class ScopedContentionRecorder; 17856edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers 1791afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi void RecordContention(uint64_t blocked_tid, uint64_t owner_tid, uint64_t nano_time_blocked); 18056edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers void DumpContention(std::ostream& os) const; 18156edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers 18281d425b0b232962441616f8b14f73620bffef5e5Ian Rogers const LockLevel level_; // Support for lock hierarchy. 183bab74963db2484ea5f10a82ea26e8a99722bfefeIan Rogers const char* const name_; 184a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi bool should_respond_to_empty_checkpoint_request_; 1851afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi 18656edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers // A log entry that records contention but makes no guarantee that either tid will be held live. 18756edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers struct ContentionLogEntry { 18856edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers ContentionLogEntry() : blocked_tid(0), owner_tid(0) {} 18956edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers uint64_t blocked_tid; 19056edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers uint64_t owner_tid; 19156edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers AtomicInteger count; 19256edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers }; 1931afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi struct ContentionLogData { 1941afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi ContentionLogEntry contention_log[kContentionLogSize]; 1951afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi // The next entry in the contention log to be updated. Value ranges from 0 to 1961afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi // kContentionLogSize - 1. 1971afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi AtomicInteger cur_content_log_entry; 1981afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi // Number of times the Mutex has been contended. 1991afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi AtomicInteger contention_count; 2001afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi // Sum of time waited by all contenders in ns. 20137f3c968ecd04e77802fe17bb82dabc07de21ca1Ian Rogers Atomic<uint64_t> wait_time; 2021afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi void AddToWaitTime(uint64_t value); 2031afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi ContentionLogData() : wait_time(0) {} 2041afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi }; 2053e5cf305db800b2989ad57b7cde8fb3cc9fa1b9eIan Rogers ContentionLogData contention_log_data_[kContentionLogDataSize]; 2061afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi 2071afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi public: 2081afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi bool HasEverContended() const { 2091afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi if (kLogLockContentions) { 2103e5cf305db800b2989ad57b7cde8fb3cc9fa1b9eIan Rogers return contention_log_data_->contention_count.LoadSequentiallyConsistent() > 0; 2111afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi } 2121afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi return false; 2131afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi } 21400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers}; 21500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 21600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// A Mutex is used to achieve mutual exclusion between threads. A Mutex can be used to gain 21700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// exclusive access to what it guards. A Mutex can be in one of two states: 21800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Free - not owned by any thread, 21900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Exclusive - owned by a single thread. 22000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// 22100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// The effect of locking and unlocking operations on the state is: 22200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// State | ExclusiveLock | ExclusiveUnlock 22300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// ------------------------------------------- 22400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Free | Exclusive | error 22500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Exclusive | Block* | Free 22600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// * Mutex is not reentrant and so an attempt to ExclusiveLock on the same thread will result in 22700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// an error. Being non-reentrant simplifies Waiting on ConditionVariables. 22801ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogersstd::ostream& operator<<(std::ostream& os, const Mutex& mu); 22900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogersclass LOCKABLE Mutex : public BaseMutex { 23000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 23181d425b0b232962441616f8b14f73620bffef5e5Ian Rogers explicit Mutex(const char* name, LockLevel level = kDefaultMutexLevel, bool recursive = false); 23200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ~Mutex(); 23300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 23400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers virtual bool IsMutex() const { return true; } 23500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 23600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Block until mutex is free then acquire exclusive access. 23790443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ExclusiveLock(Thread* self) ACQUIRE(); 23890443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void Lock(Thread* self) ACQUIRE() { ExclusiveLock(self); } 23900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 24000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Returns true if acquires exclusive access, false otherwise. 24190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier bool ExclusiveTryLock(Thread* self) TRY_ACQUIRE(true); 24290443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier bool TryLock(Thread* self) TRY_ACQUIRE(true) { return ExclusiveTryLock(self); } 24300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 24400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Release exclusive access. 24590443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ExclusiveUnlock(Thread* self) RELEASE(); 24690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void Unlock(Thread* self) RELEASE() { ExclusiveUnlock(self); } 24700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 24800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Is the current thread the exclusive holder of the Mutex. 249b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE bool IsExclusiveHeld(const Thread* self) const; 2508daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 25100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert that the Mutex is exclusively held by the current thread. 252b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE void AssertExclusiveHeld(const Thread* self) const ASSERT_CAPABILITY(this); 253b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE void AssertHeld(const Thread* self) const ASSERT_CAPABILITY(this); 25400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 25500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert that the Mutex is not held by the current thread. 25690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void AssertNotHeldExclusive(const Thread* self) ASSERT_CAPABILITY(!*this) { 257db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 25801ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers CHECK(!IsExclusiveHeld(self)) << *this; 25900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 26000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 26190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void AssertNotHeld(const Thread* self) ASSERT_CAPABILITY(!*this) { 26290443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier AssertNotHeldExclusive(self); 26390443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier } 26400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 265c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Id associated with exclusive owner. No memory ordering semantics if called from a thread other 266c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // than the owner. 2670882af2e3ca253184b6ab56a8966a2f37407144eHans Boehm pid_t GetExclusiveOwnerTid() const; 26800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 26900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Returns how many times this Mutex has been locked, it is better to use AssertHeld/NotHeld. 27000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers unsigned int GetDepth() const { 27100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers return recursion_count_; 27200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 27300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 27456edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers virtual void Dump(std::ostream& os) const; 27501ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers 27690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier // For negative capabilities in clang annotations. 27790443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier const Mutex& operator!() const { return *this; } 27890443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier 279a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi void WakeupToRespondToEmptyCheckpoint() OVERRIDE; 280a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi 28100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers private: 282c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#if ART_USE_FUTEXES 283c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // 0 is unheld, 1 is held. 284c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers AtomicInteger state_; 285c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // Exclusive owner. 2860882af2e3ca253184b6ab56a8966a2f37407144eHans Boehm Atomic<pid_t> exclusive_owner_; 287c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // Number of waiting contenders. 288b122a4bbed34ab22b4c1541ee25e5cf22f12a926Ian Rogers AtomicInteger num_contenders_; 289c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#else 29000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers pthread_mutex_t mutex_; 2910882af2e3ca253184b6ab56a8966a2f37407144eHans Boehm Atomic<pid_t> exclusive_owner_; // Guarded by mutex_. Asynchronous reads are OK. 292c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#endif 29300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers const bool recursive_; // Can the lock be recursively held? 29400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers unsigned int recursion_count_; 295f1498437b0d6beb9f4f91980b98cbeb0b5c773ceElliott Hughes friend class ConditionVariable; 2968daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes DISALLOW_COPY_AND_ASSIGN(Mutex); 2978daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes}; 2988daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 29900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// A ReaderWriterMutex is used to achieve mutual exclusion between threads, similar to a Mutex. 30000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Unlike a Mutex a ReaderWriterMutex can be used to gain exclusive (writer) or shared (reader) 30100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// access to what it guards. A flaw in relation to a Mutex is that it cannot be used with a 30200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// condition variable. A ReaderWriterMutex can be in one of three states: 30300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Free - not owned by any thread, 30400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Exclusive - owned by a single thread, 30500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Shared(n) - shared amongst n threads. 30600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// 30700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// The effect of locking and unlocking operations on the state is: 30800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// 30900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// State | ExclusiveLock | ExclusiveUnlock | SharedLock | SharedUnlock 31000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// ---------------------------------------------------------------------------- 31100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Free | Exclusive | error | SharedLock(1) | error 31200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Exclusive | Block | Free | Block | error 31300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Shared(n) | Block | error | SharedLock(n+1)* | Shared(n-1) or Free 31400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// * for large values of n the SharedLock may block. 31501ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogersstd::ostream& operator<<(std::ostream& os, const ReaderWriterMutex& mu); 31690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SHARED_LOCKABLE ReaderWriterMutex : public BaseMutex { 3178daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes public: 31881d425b0b232962441616f8b14f73620bffef5e5Ian Rogers explicit ReaderWriterMutex(const char* name, LockLevel level = kDefaultMutexLevel); 31900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ~ReaderWriterMutex(); 32000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 32100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers virtual bool IsReaderWriterMutex() const { return true; } 32200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 32300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Block until ReaderWriterMutex is free then acquire exclusive access. 32490443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ExclusiveLock(Thread* self) ACQUIRE(); 32590443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void WriterLock(Thread* self) ACQUIRE() { ExclusiveLock(self); } 32600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 32700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Release exclusive access. 32890443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ExclusiveUnlock(Thread* self) RELEASE(); 32990443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void WriterUnlock(Thread* self) RELEASE() { ExclusiveUnlock(self); } 33000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 33100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Block until ReaderWriterMutex is free and acquire exclusive access. Returns true on success 33200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // or false if timeout is reached. 33366aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#if HAVE_TIMED_RWLOCK 334c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers bool ExclusiveLockWithTimeout(Thread* self, int64_t ms, int32_t ns) 33581d425b0b232962441616f8b14f73620bffef5e5Ian Rogers EXCLUSIVE_TRYLOCK_FUNCTION(true); 33666aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#endif 33700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 33800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Block until ReaderWriterMutex is shared or free then acquire a share on the access. 33990443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void SharedLock(Thread* self) ACQUIRE_SHARED() ALWAYS_INLINE; 34090443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ReaderLock(Thread* self) ACQUIRE_SHARED() { SharedLock(self); } 34100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 34200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Try to acquire share of ReaderWriterMutex. 34390443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier bool SharedTryLock(Thread* self) SHARED_TRYLOCK_FUNCTION(true); 34400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 34500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Release a share of the access. 34690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void SharedUnlock(Thread* self) RELEASE_SHARED() ALWAYS_INLINE; 34790443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ReaderUnlock(Thread* self) RELEASE_SHARED() { SharedUnlock(self); } 34800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 34900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Is the current thread the exclusive holder of the ReaderWriterMutex. 350b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE bool IsExclusiveHeld(const Thread* self) const; 35100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 35200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert the current thread has exclusive access to the ReaderWriterMutex. 353b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE void AssertExclusiveHeld(const Thread* self) const ASSERT_CAPABILITY(this); 354b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE void AssertWriterHeld(const Thread* self) const ASSERT_CAPABILITY(this); 3558daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 35600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert the current thread doesn't have exclusive access to the ReaderWriterMutex. 35790ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier void AssertNotExclusiveHeld(const Thread* self) ASSERT_CAPABILITY(!this) { 358db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 359e3359f7ad7671c5816f17145ca3a01516512e8d6Ian Rogers CHECK(!IsExclusiveHeld(self)) << *this; 36000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 36100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 36290ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier void AssertNotWriterHeld(const Thread* self) ASSERT_CAPABILITY(!this) { 36390ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier AssertNotExclusiveHeld(self); 36490ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier } 36500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 36600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Is the current thread a shared holder of the ReaderWriterMutex. 36781d425b0b232962441616f8b14f73620bffef5e5Ian Rogers bool IsSharedHeld(const Thread* self) const; 36800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 36900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert the current thread has shared access to the ReaderWriterMutex. 3703768adec2f819cb506577618fdde158ba659ddd4Mathieu Chartier ALWAYS_INLINE void AssertSharedHeld(const Thread* self) ASSERT_SHARED_CAPABILITY(this) { 371db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 3722cebb24bfc3247d3e9be138a3350106737455918Mathieu Chartier // TODO: we can only assert this well when self != null. 3732cebb24bfc3247d3e9be138a3350106737455918Mathieu Chartier CHECK(IsSharedHeld(self) || self == nullptr) << *this; 37400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 3758daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes } 3763768adec2f819cb506577618fdde158ba659ddd4Mathieu Chartier ALWAYS_INLINE void AssertReaderHeld(const Thread* self) ASSERT_SHARED_CAPABILITY(this) { 37790ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier AssertSharedHeld(self); 37890ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier } 3798daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 38000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert the current thread doesn't hold this ReaderWriterMutex either in shared or exclusive 38100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // mode. 3823768adec2f819cb506577618fdde158ba659ddd4Mathieu Chartier ALWAYS_INLINE void AssertNotHeld(const Thread* self) ASSERT_SHARED_CAPABILITY(!this) { 383db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 38401ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers CHECK(!IsSharedHeld(self)) << *this; 38500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 38600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 38700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 388c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Id associated with exclusive owner. No memory ordering semantics if called from a thread other 3890882af2e3ca253184b6ab56a8966a2f37407144eHans Boehm // than the owner. Returns 0 if the lock is not held. Returns either 0 or -1 if it is held by 3900882af2e3ca253184b6ab56a8966a2f37407144eHans Boehm // one or more readers. 3910882af2e3ca253184b6ab56a8966a2f37407144eHans Boehm pid_t GetExclusiveOwnerTid() const; 39281d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 39356edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers virtual void Dump(std::ostream& os) const; 39401ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers 39590443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier // For negative capabilities in clang annotations. 39690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier const ReaderWriterMutex& operator!() const { return *this; } 39790443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier 398a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi void WakeupToRespondToEmptyCheckpoint() OVERRIDE; 399a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi 4008daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes private: 40151d212ef31945743abe8a469707aaa25bab95357Ian Rogers#if ART_USE_FUTEXES 402cf7f19135f0e273f7b0136315633c2abfc715343Ian Rogers // Out-of-inline path for handling contention for a SharedLock. 403cf7f19135f0e273f7b0136315633c2abfc715343Ian Rogers void HandleSharedLockContention(Thread* self, int32_t cur_state); 404cf7f19135f0e273f7b0136315633c2abfc715343Ian Rogers 40581d425b0b232962441616f8b14f73620bffef5e5Ian Rogers // -1 implies held exclusive, +ve shared held by state_ many owners. 406c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers AtomicInteger state_; 407c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Exclusive owner. Modification guarded by this mutex. 4080882af2e3ca253184b6ab56a8966a2f37407144eHans Boehm Atomic<pid_t> exclusive_owner_; 409c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Number of contenders waiting for a reader share. 410c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers AtomicInteger num_pending_readers_; 411c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Number of contenders waiting to be the writer. 412b122a4bbed34ab22b4c1541ee25e5cf22f12a926Ian Rogers AtomicInteger num_pending_writers_; 41381d425b0b232962441616f8b14f73620bffef5e5Ian Rogers#else 41400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers pthread_rwlock_t rwlock_; 4150882af2e3ca253184b6ab56a8966a2f37407144eHans Boehm Atomic<pid_t> exclusive_owner_; // Writes guarded by rwlock_. Asynchronous reads are OK. 41681d425b0b232962441616f8b14f73620bffef5e5Ian Rogers#endif 41700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers DISALLOW_COPY_AND_ASSIGN(ReaderWriterMutex); 4188daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes}; 4198daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 420eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// MutatorMutex is a special kind of ReaderWriterMutex created specifically for the 421eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// Locks::mutator_lock_ mutex. The behaviour is identical to the ReaderWriterMutex except that 422eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// thread state changes also play a part in lock ownership. The mutator_lock_ will not be truly 423eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// held by any mutator threads. However, a thread in the kRunnable state is considered to have 424eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// shared ownership of the mutator lock and therefore transitions in and out of the kRunnable 425eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// state have associated implications on lock ownership. Extra methods to handle the state 426eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// transitions have been added to the interface but are only accessible to the methods dealing 427eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// with state transitions. The thread state and flags attributes are used to ensure thread state 428eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// transitions are consistent with the permitted behaviour of the mutex. 429eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// 430eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// *) The most important consequence of this behaviour is that all threads must be in one of the 431eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// suspended states before exclusive ownership of the mutator mutex is sought. 432eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// 433eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Listd::ostream& operator<<(std::ostream& os, const MutatorMutex& mu); 43490443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SHARED_LOCKABLE MutatorMutex : public ReaderWriterMutex { 435eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li public: 436eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li explicit MutatorMutex(const char* name, LockLevel level = kDefaultMutexLevel) 437eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li : ReaderWriterMutex(name, level) {} 438eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li ~MutatorMutex() {} 439eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li 440eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li virtual bool IsMutatorMutex() const { return true; } 441eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li 44290443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier // For negative capabilities in clang annotations. 44390443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier const MutatorMutex& operator!() const { return *this; } 44490443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier 445eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li private: 446eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li friend class Thread; 447eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li void TransitionFromRunnableToSuspended(Thread* self) UNLOCK_FUNCTION() ALWAYS_INLINE; 448eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li void TransitionFromSuspendedToRunnable(Thread* self) SHARED_LOCK_FUNCTION() ALWAYS_INLINE; 449eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li 450eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li DISALLOW_COPY_AND_ASSIGN(MutatorMutex); 451eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li}; 452eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li 45300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// ConditionVariables allow threads to queue and sleep. Threads may then be resumed individually 45400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// (Signal) or all at once (Broadcast). 4555f79133a435ebcb20000370d56046fe01201dd80Elliott Hughesclass ConditionVariable { 4565f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes public: 4573887c468d731420e929e6ad3acf190d5431e94fcRoland Levillain ConditionVariable(const char* name, Mutex& mutex); 4585f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes ~ConditionVariable(); 4595f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes 460c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers void Broadcast(Thread* self); 461c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers void Signal(Thread* self); 462c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // TODO: No thread safety analysis on Wait and TimedWait as they call mutex operations via their 463c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // pointer copy, thereby defeating annotalysis. 464c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers void Wait(Thread* self) NO_THREAD_SAFETY_ANALYSIS; 4657b078e8c04f3e1451dbdd18543c8b9692b5b067eIan Rogers bool TimedWait(Thread* self, int64_t ms, int32_t ns) NO_THREAD_SAFETY_ANALYSIS; 4661d54e73444e017d3a65234e0f193846f3e27472bIan Rogers // Variant of Wait that should be used with caution. Doesn't validate that no mutexes are held 4671d54e73444e017d3a65234e0f193846f3e27472bIan Rogers // when waiting. 4681d54e73444e017d3a65234e0f193846f3e27472bIan Rogers // TODO: remove this. 4691d54e73444e017d3a65234e0f193846f3e27472bIan Rogers void WaitHoldingLocks(Thread* self) NO_THREAD_SAFETY_ANALYSIS; 4705f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes 4715f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes private: 47223055dc5d7a90c4a12e259fd0ed7cd4d04d89182Ian Rogers const char* const name_; 473c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // The Mutex being used by waiters. It is an error to mix condition variables between different 474c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // Mutexes. 475c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers Mutex& guard_; 476c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#if ART_USE_FUTEXES 477c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // A counter that is modified by signals and broadcasts. This ensures that when a waiter gives up 478d45f201e9bd43490e30a35710865789b8d70e249Ian Rogers // their Mutex and another thread takes it and signals, the waiting thread observes that sequence_ 479d45f201e9bd43490e30a35710865789b8d70e249Ian Rogers // changed and doesn't enter the wait. Modified while holding guard_, but is read by futex wait 480d45f201e9bd43490e30a35710865789b8d70e249Ian Rogers // without guard_ held. 481b122a4bbed34ab22b4c1541ee25e5cf22f12a926Ian Rogers AtomicInteger sequence_; 482c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // Number of threads that have come into to wait, not the length of the waiters on the futex as 4835bd97c483c1de1eb97afe76123b1b9ab53095edfIan Rogers // waiters may have been requeued onto guard_. Guarded by guard_. 484c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers volatile int32_t num_waiters_; 485c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#else 486c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers pthread_cond_t cond_; 487c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#endif 4885f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes DISALLOW_COPY_AND_ASSIGN(ConditionVariable); 4895f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes}; 4905f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes 49100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Scoped locker/unlocker for a regular Mutex that acquires mu upon construction and releases it 49200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// upon destruction. 49390443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SCOPED_CAPABILITY MutexLock { 49400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 4953887c468d731420e929e6ad3acf190d5431e94fcRoland Levillain MutexLock(Thread* self, Mutex& mu) ACQUIRE(mu) : self_(self), mu_(mu) { 49681d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.ExclusiveLock(self_); 49781d425b0b232962441616f8b14f73620bffef5e5Ian Rogers } 49881d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 4994e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier ~MutexLock() RELEASE() { 50081d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.ExclusiveUnlock(self_); 50100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 50200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 50300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers private: 50481d425b0b232962441616f8b14f73620bffef5e5Ian Rogers Thread* const self_; 50500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers Mutex& mu_; 50600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers DISALLOW_COPY_AND_ASSIGN(MutexLock); 50700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers}; 50800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Catch bug where variable name is omitted. "MutexLock (lock);" instead of "MutexLock mu(lock)". 509575e78c41ece0dec969d31f46be563d4eb7ae43bAndreas Gampe#define MutexLock(x) static_assert(0, "MutexLock declaration missing variable name") 51000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 51100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Scoped locker/unlocker for a ReaderWriterMutex that acquires read access to mu upon 51200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// construction and releases it upon destruction. 51390443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SCOPED_CAPABILITY ReaderMutexLock { 51400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 515b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE ReaderMutexLock(Thread* self, ReaderWriterMutex& mu) ACQUIRE(mu); 51681d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 517b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE ~ReaderMutexLock() RELEASE(); 51800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 51900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers private: 52081d425b0b232962441616f8b14f73620bffef5e5Ian Rogers Thread* const self_; 52100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ReaderWriterMutex& mu_; 52200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers DISALLOW_COPY_AND_ASSIGN(ReaderMutexLock); 52300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers}; 52400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 52500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Scoped locker/unlocker for a ReaderWriterMutex that acquires write access to mu upon 52600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// construction and releases it upon destruction. 52790443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SCOPED_CAPABILITY WriterMutexLock { 52800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 5293887c468d731420e929e6ad3acf190d5431e94fcRoland Levillain WriterMutexLock(Thread* self, ReaderWriterMutex& mu) EXCLUSIVE_LOCK_FUNCTION(mu) : 53081d425b0b232962441616f8b14f73620bffef5e5Ian Rogers self_(self), mu_(mu) { 53181d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.ExclusiveLock(self_); 53281d425b0b232962441616f8b14f73620bffef5e5Ian Rogers } 53381d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 53400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ~WriterMutexLock() UNLOCK_FUNCTION() { 53581d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.ExclusiveUnlock(self_); 53600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 53700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 53800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers private: 53950b35e2fd1a68cd1240e4a9d9f363e11764957d1Ian Rogers Thread* const self_; 54000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ReaderWriterMutex& mu_; 54100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers DISALLOW_COPY_AND_ASSIGN(WriterMutexLock); 54200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers}; 54300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Catch bug where variable name is omitted. "WriterMutexLock (lock);" instead of 54400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// "WriterMutexLock mu(lock)". 545575e78c41ece0dec969d31f46be563d4eb7ae43bAndreas Gampe#define WriterMutexLock(x) static_assert(0, "WriterMutexLock declaration missing variable name") 54600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 5474e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier// For StartNoThreadSuspension and EndNoThreadSuspension. 5484e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartierclass CAPABILITY("role") Role { 5494e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier public: 5504e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier void Acquire() ACQUIRE() {} 5514e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier void Release() RELEASE() {} 5524e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier const Role& operator!() const { return *this; } 5534e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier}; 5544e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier 5554e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartierclass Uninterruptible : public Role { 5564e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier}; 5574e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier 558719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers// Global mutexes corresponding to the levels above. 559719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogersclass Locks { 560719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers public: 561719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static void Init(); 56291e56692c6bd9fa1d41951ee7dc311f19461f4beMathieu Chartier static void InitConditions() NO_THREAD_SAFETY_ANALYSIS; // Condition variables. 563f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr 564f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // Destroying various lock types can emit errors that vary depending upon 565f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // whether the client (art::Runtime) is currently active. Allow the client 566f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // to set a callback that is used to check when it is acceptable to call 567f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // Abort. The default behavior is that the client *is not* able to call 568f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // Abort if no callback is established. 569f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr using ClientCallback = bool(); 570f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr static void SetClientCallback(ClientCallback* is_safe_to_call_abort_cb) NO_THREAD_SAFETY_ANALYSIS; 571f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // Checks for whether it is safe to call Abort() without using locks. 572f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr static bool IsSafeToCallAbortRacy() NO_THREAD_SAFETY_ANALYSIS; 573f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr 5748a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi // Add a mutex to expected_mutexes_on_weak_ref_access_. 5758a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi static void AddToExpectedMutexesOnWeakRefAccess(BaseMutex* mutex, bool need_lock = true); 5768a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi // Remove a mutex from expected_mutexes_on_weak_ref_access_. 5778a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi static void RemoveFromExpectedMutexesOnWeakRefAccess(BaseMutex* mutex, bool need_lock = true); 5788a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi // Check if the given mutex is in expected_mutexes_on_weak_ref_access_. 5798a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi static bool IsExpectedOnWeakRefAccess(BaseMutex* mutex); 580f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr 5819ef78b59da51080882e47505896b420977fd79aeMathieu Chartier // Guards allocation entrypoint instrumenting. 5824ad5cd3e7d519484559ef778d96fb3f0be8919faIan Rogers static Mutex* instrument_entrypoints_lock_; 5839ef78b59da51080882e47505896b420977fd79aeMathieu Chartier 58488fd720b6799184c8ad61e766a6d37af33ed30efAlex Light // Guards code that deals with user-code suspension. This mutex must be held when suspending or 58588fd720b6799184c8ad61e766a6d37af33ed30efAlex Light // resuming threads with SuspendReason::kForUserCode. It may be held by a suspended thread, but 58688fd720b6799184c8ad61e766a6d37af33ed30efAlex Light // only if the suspension is not due to SuspendReason::kForUserCode. 58788fd720b6799184c8ad61e766a6d37af33ed30efAlex Light static Mutex* user_code_suspension_lock_ ACQUIRED_AFTER(instrument_entrypoints_lock_); 58888fd720b6799184c8ad61e766a6d37af33ed30efAlex Light 589eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // A barrier is used to synchronize the GC/Debugger thread with mutator threads. When GC/Debugger 590eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // thread wants to suspend all mutator threads, it needs to wait for all mutator threads to pass 591eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // a barrier. Threads that are already suspended will get their barrier passed by the GC/Debugger 592eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // thread; threads in the runnable state will pass the barrier when they transit to the suspended 593eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // state. GC/Debugger thread will be woken up when all mutator threads are suspended. 594719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // 595719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Thread suspension: 596eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // mutator thread | GC/Debugger 597eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // .. running .. | .. running .. 598719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | Request thread suspension by: 599719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | - acquiring thread_suspend_count_lock_ 600719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | - incrementing Thread::suspend_count_ on 601719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | all mutator threads 602719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | - releasing thread_suspend_count_lock_ 603eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // .. running .. | Block wait for all threads to pass a barrier 604719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Poll Thread::suspend_count_ and enter full | .. blocked .. 605719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // suspend code. | .. blocked .. 606eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // Change state to kSuspended (pass the barrier) | Wake up when all threads pass the barrier 607eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // x: Acquire thread_suspend_count_lock_ | .. running .. 608eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // while Thread::suspend_count_ > 0 | .. running .. 609eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // - wait on Thread::resume_cond_ | .. running .. 610eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // (releases thread_suspend_count_lock_) | .. running .. 611719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | Request thread resumption by: 612719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | - acquiring thread_suspend_count_lock_ 613719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | - decrementing Thread::suspend_count_ on 614719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | all mutator threads 615719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | - notifying on Thread::resume_cond_ 616719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // - re-acquire thread_suspend_count_lock_ | - releasing thread_suspend_count_lock_ 617719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Release thread_suspend_count_lock_ | .. running .. 618eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // Change to kRunnable | .. running .. 619eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // - this uses a CAS operation to ensure the | .. running .. 620eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // suspend request flag isn't raised as the | .. running .. 621eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // state is changed | .. running .. 622eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // - if the CAS operation fails then goto x | .. running .. 623719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | .. running .. 62488fd720b6799184c8ad61e766a6d37af33ed30efAlex Light static MutatorMutex* mutator_lock_ ACQUIRED_AFTER(user_code_suspension_lock_); 625719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 626719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Allow reader-writer mutual exclusion on the mark and live bitmaps of the heap. 627719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static ReaderWriterMutex* heap_bitmap_lock_ ACQUIRED_AFTER(mutator_lock_); 628719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 629719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Guards shutdown of the runtime. 630719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static Mutex* runtime_shutdown_lock_ ACQUIRED_AFTER(heap_bitmap_lock_); 631719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 6329e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu // Guards background profiler global state. 633b139b6d3833cd6a90f345204202ec57ff277c088Hiroshi Yamauchi static Mutex* profiler_lock_ ACQUIRED_AFTER(runtime_shutdown_lock_); 6349e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu 6359e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu // Guards trace (ie traceview) requests. 6369e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu static Mutex* trace_lock_ ACQUIRED_AFTER(profiler_lock_); 6379e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu 638306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom // Guards debugger recent allocation records. 639306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom static Mutex* alloc_tracker_lock_ ACQUIRED_AFTER(trace_lock_); 640306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom 641306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom // Guards updates to instrumentation to ensure mutual exclusion of 642306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom // events like deoptimization requests. 643306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom // TODO: improve name, perhaps instrumentation_update_lock_. 644306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom static Mutex* deoptimization_lock_ ACQUIRED_AFTER(alloc_tracker_lock_); 645306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom 646063fc772b5b8aed7d769cd7cccb6ddc7619326eeMingyao Yang // Guards Class Hierarchy Analysis (CHA). 647063fc772b5b8aed7d769cd7cccb6ddc7619326eeMingyao Yang static Mutex* cha_lock_ ACQUIRED_AFTER(deoptimization_lock_); 648063fc772b5b8aed7d769cd7cccb6ddc7619326eeMingyao Yang 649719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // The thread_list_lock_ guards ThreadList::list_. It is also commonly held to stop threads 650719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // attaching and detaching. 651063fc772b5b8aed7d769cd7cccb6ddc7619326eeMingyao Yang static Mutex* thread_list_lock_ ACQUIRED_AFTER(cha_lock_); 652719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 65391e56692c6bd9fa1d41951ee7dc311f19461f4beMathieu Chartier // Signaled when threads terminate. Used to determine when all non-daemons have terminated. 65491e56692c6bd9fa1d41951ee7dc311f19461f4beMathieu Chartier static ConditionVariable* thread_exit_cond_ GUARDED_BY(Locks::thread_list_lock_); 65591e56692c6bd9fa1d41951ee7dc311f19461f4beMathieu Chartier 65668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // Guards maintaining loading library data structures. 65768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers static Mutex* jni_libraries_lock_ ACQUIRED_AFTER(thread_list_lock_); 65868d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 659719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Guards breakpoints. 660ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz static ReaderWriterMutex* breakpoint_lock_ ACQUIRED_AFTER(jni_libraries_lock_); 661719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 662719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Guards lists of classes within the class linker. 6639e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu static ReaderWriterMutex* classlinker_classes_lock_ ACQUIRED_AFTER(breakpoint_lock_); 664719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 665719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // When declaring any Mutex add DEFAULT_MUTEX_ACQUIRED_AFTER to use annotalysis to check the code 666719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // doesn't try to hold a higher level Mutex. 6670fa1786bdcc333873ed65a1f77a4669d5701ac5eAlex Light #define DEFAULT_MUTEX_ACQUIRED_AFTER ACQUIRED_AFTER(art::Locks::classlinker_classes_lock_) 668719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 66974240819ae09e29b2753ef38f4eb4be1c2762e2eAndreas Gampe static Mutex* allocated_monitor_ids_lock_ ACQUIRED_AFTER(classlinker_classes_lock_); 67074240819ae09e29b2753ef38f4eb4be1c2762e2eAndreas Gampe 6719e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu // Guard the allocation/deallocation of thread ids. 67274240819ae09e29b2753ef38f4eb4be1c2762e2eAndreas Gampe static Mutex* allocated_thread_ids_lock_ ACQUIRED_AFTER(allocated_monitor_ids_lock_); 6739e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu 6749e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu // Guards modification of the LDT on x86. 6759e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu static Mutex* modify_ldt_lock_ ACQUIRED_AFTER(allocated_thread_ids_lock_); 6769e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu 677cc1b5357f83f0b787d51fbfde3fe870c8a2fa050Andreas Gampe static ReaderWriterMutex* dex_lock_ ACQUIRED_AFTER(modify_ldt_lock_); 678cc1b5357f83f0b787d51fbfde3fe870c8a2fa050Andreas Gampe 679f9c6fc610b27887f832e453a0da1789187293408Mathieu Chartier // Guards opened oat files in OatFileManager. 680cc1b5357f83f0b787d51fbfde3fe870c8a2fa050Andreas Gampe static ReaderWriterMutex* oat_file_manager_lock_ ACQUIRED_AFTER(dex_lock_); 681f9c6fc610b27887f832e453a0da1789187293408Mathieu Chartier 682340dafabc8e88378e395cda9027cf17726910e91Nicolas Geoffray // Guards extra string entries for VerifierDeps. 683340dafabc8e88378e395cda9027cf17726910e91Nicolas Geoffray static ReaderWriterMutex* verifier_deps_lock_ ACQUIRED_AFTER(oat_file_manager_lock_); 684ca3c8c33501bf199d6fd0a5db30a27d8e010cb23David Brazdil 685a206c745dbb64b14f05c87891d425475c2f6d63aRichard Uhler // Guards dlopen_handles_ in DlOpenOatFile. 686ca3c8c33501bf199d6fd0a5db30a27d8e010cb23David Brazdil static Mutex* host_dlopen_handles_lock_ ACQUIRED_AFTER(verifier_deps_lock_); 687e58991b3b2282b5761f1a6023a16c803e1c4eb45Mathieu Chartier 688719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Guards intern table. 689a206c745dbb64b14f05c87891d425475c2f6d63aRichard Uhler static Mutex* intern_table_lock_ ACQUIRED_AFTER(host_dlopen_handles_lock_); 690719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 691a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards reference processor. 692a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_processor_lock_ ACQUIRED_AFTER(intern_table_lock_); 693a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 694a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards cleared references queue. 695a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_cleared_references_lock_ ACQUIRED_AFTER(reference_processor_lock_); 696a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 697a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards weak references queue. 698a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_weak_references_lock_ ACQUIRED_AFTER(reference_queue_cleared_references_lock_); 699a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 700a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards finalizer references queue. 701a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_finalizer_references_lock_ ACQUIRED_AFTER(reference_queue_weak_references_lock_); 702a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 703a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards phantom references queue. 704a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_phantom_references_lock_ ACQUIRED_AFTER(reference_queue_finalizer_references_lock_); 705a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 706a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards soft references queue. 707a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_soft_references_lock_ ACQUIRED_AFTER(reference_queue_phantom_references_lock_); 708a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 70905a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe // Guard accesses to the JNI Global Reference table. 71005a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe static ReaderWriterMutex* jni_globals_lock_ ACQUIRED_AFTER(reference_queue_soft_references_lock_); 71105a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe 71205a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe // Guard accesses to the JNI Weak Global Reference table. 71305a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe static Mutex* jni_weak_globals_lock_ ACQUIRED_AFTER(jni_globals_lock_); 71405a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe 715c8089540ccf0f1c43d8db3828f21d489b28a4013Andreas Gampe // Guard accesses to the JNI function table override. 716c8089540ccf0f1c43d8db3828f21d489b28a4013Andreas Gampe static Mutex* jni_function_table_lock_ ACQUIRED_AFTER(jni_weak_globals_lock_); 717c8089540ccf0f1c43d8db3828f21d489b28a4013Andreas Gampe 718719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Have an exclusive aborting thread. 719c8089540ccf0f1c43d8db3828f21d489b28a4013Andreas Gampe static Mutex* abort_lock_ ACQUIRED_AFTER(jni_function_table_lock_); 720719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 721719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Allow mutual exclusion when manipulating Thread::suspend_count_. 722719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // TODO: Does the trade-off of a per-thread lock make sense? 723719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static Mutex* thread_suspend_count_lock_ ACQUIRED_AFTER(abort_lock_); 724719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 725719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // One unexpected signal at a time lock. 726719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static Mutex* unexpected_signal_lock_ ACQUIRED_AFTER(thread_suspend_count_lock_); 727719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 728719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Have an exclusive logging thread. 729719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static Mutex* logging_lock_ ACQUIRED_AFTER(unexpected_signal_lock_); 730a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi 731a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi // List of mutexes that we expect a thread may hold when accessing weak refs. This is used to 732a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi // avoid a deadlock in the empty checkpoint while weak ref access is disabled (b/34964016). If we 733a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi // encounter an unexpected mutex on accessing weak refs, 734a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi // Thread::CheckEmptyCheckpointFromWeakRefAccess will detect it. 735a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi static std::vector<BaseMutex*> expected_mutexes_on_weak_ref_access_; 7368a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi static Atomic<const BaseMutex*> expected_mutexes_on_weak_ref_access_guard_; 7378a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi class ScopedExpectedMutexesOnWeakRefAccessLock; 738719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers}; 739719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 7404e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartierclass Roles { 7414e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier public: 74290ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier // Uninterruptible means that the thread may not become suspended. 7434e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier static Uninterruptible uninterruptible_; 7444e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier}; 7454e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier 7468daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes} // namespace art 7478daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 748fc0e3219edc9a5bf81b166e82fd5db2796eb6a0dBrian Carlstrom#endif // ART_RUNTIME_BASE_MUTEX_H_ 749