mutex.h revision a79efdb69350fa66e1beabed4499ef4d0e809785
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 2757943810cfc789da890d73621741729da5feaaf8Andreas Gampe#include <android-base/logging.h> 2857943810cfc789da890d73621741729da5feaaf8Andreas Gampe 29ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers#include "atomic.h" 3039b378ca3b4b6dc6da1651b84ee4289cd9bff0f8Andreas Gampe#include "base/aborting.h" 31761600567d73b23324ae0251e871c15d6849ffd8Elliott Hughes#include "base/macros.h" 3200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers#include "globals.h" 3381d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 34ab47016374d340011680e9cd970ee7d6225d6704Ian Rogers#if defined(__APPLE__) 3581d425b0b232962441616f8b14f73620bffef5e5Ian Rogers#define ART_USE_FUTEXES 0 36ab47016374d340011680e9cd970ee7d6225d6704Ian Rogers#else 37c01417898a6e4f8a5663d6c0556982488c133cdfChris Dearman#define ART_USE_FUTEXES 1 38ab47016374d340011680e9cd970ee7d6225d6704Ian Rogers#endif 398daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 4066aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers// Currently Darwin doesn't support locks with timeouts. 4166aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#if !defined(__APPLE__) 4266aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#define HAVE_TIMED_RWLOCK 1 4366aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#else 4466aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#define HAVE_TIMED_RWLOCK 0 4566aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#endif 4666aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers 478daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughesnamespace art { 488daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 4990443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SHARED_LOCKABLE ReaderWriterMutex; 5090443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SHARED_LOCKABLE MutatorMutex; 5156edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogersclass ScopedContentionRecorder; 5250b35e2fd1a68cd1240e4a9d9f363e11764957d1Ian Rogersclass Thread; 5350b35e2fd1a68cd1240e4a9d9f363e11764957d1Ian Rogers 54719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers// LockLevel is used to impose a lock hierarchy [1] where acquisition of a Mutex at a higher or 55719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers// equal level to a lock a thread holds is invalid. The lock hierarchy achieves a cycle free 56719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers// partial ordering and thereby cause deadlock situations to fail checks. 57719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers// 58719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers// [1] http://www.drdobbs.com/parallel/use-lock-hierarchies-to-avoid-deadlock/204801163 59719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogersenum LockLevel { 60719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kLoggingLock = 0, 617de77dd4f2d3cbb0615ee001589eb99ae82c3dccRaghu Gandham kSwapMutexesLock, 62719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kUnexpectedSignalLock, 63719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kThreadSuspendCountLock, 64719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kAbortLock, 65d0a160d722e696b1a3ffb91dcfde61ee11bfb3e0Tao Wu kJdwpAdbStateLock, 66719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpSocketLock, 672cd334ae2d4287216523882f0d298cf3901b7ab1Hiroshi Yamauchi kRegionSpaceRegionLock, 68f169e27100acbec024f699de9ef842a27c0b2036Mathieu Chartier kMarkSweepMarkStackLock, 692994605707219f67af8340ddd9379ce9bd86d74cMathieu Chartier kRosAllocGlobalLock, 702994605707219f67af8340ddd9379ce9bd86d74cMathieu Chartier kRosAllocBracketLock, 712994605707219f67af8340ddd9379ce9bd86d74cMathieu Chartier kRosAllocBulkFreeLock, 72f169e27100acbec024f699de9ef842a27c0b2036Mathieu Chartier kTaggingLockLevel, 73bc4d218ce2ceef0c4f308d4ff42f7ec1ec43c40eAndreas Gampe kTransactionLogLock, 74c8089540ccf0f1c43d8db3828f21d489b28a4013Andreas Gampe kJniFunctionTableLock, 75673ed3d8aedc5462a47ded827c99f35d46525457Mathieu Chartier kJniWeakGlobalsLock, 7605a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe kJniGlobalsLock, 77a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceQueueSoftReferencesLock, 78a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceQueuePhantomReferencesLock, 79a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceQueueFinalizerReferencesLock, 80a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceQueueWeakReferencesLock, 81a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceQueueClearedReferencesLock, 82a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier kReferenceProcessorLock, 835cc349f3dd578e974f78314c50b6a0267c23e591David Srbecky kJitDebugInterfaceLock, 84719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kAllocSpaceLock, 852cd334ae2d4287216523882f0d298cf3901b7ab1Hiroshi Yamauchi kBumpPointerSpaceBlockLock, 86c785344b87221f5e4e6473e5b762e4e61fe65dcfMathieu Chartier kArenaPoolLock, 87719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kInternTableLock, 883f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko kOatFileSecondaryLookupLock, 89a206c745dbb64b14f05c87891d425475c2f6d63aRichard Uhler kHostDlOpenHandlesLock, 90ca3c8c33501bf199d6fd0a5db30a27d8e010cb23David Brazdil kVerifierDepsLock, 91f9c6fc610b27887f832e453a0da1789187293408Mathieu Chartier kOatFileManagerLock, 927526d783ab68ed1dd53c763c75895cb432532b0fAndreas Gampe kTracingUniqueMethodsLock, 937526d783ab68ed1dd53c763c75895cb432532b0fAndreas Gampe kTracingStreamingLock, 94b8aa1e4c10dcdc7fef96634f87e259dfee83a1cfMathieu Chartier kDeoptimizedMethodsLock, 95b8aa1e4c10dcdc7fef96634f87e259dfee83a1cfMathieu Chartier kClassLoaderClassesLock, 96719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kDefaultMutexLevel, 976c60d8420e51fda65ad247ae04b5a823c88c26b6Mathieu Chartier kDexLock, 98719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kMarkSweepLargeObjectLock, 99719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpObjectRegistryLock, 1009e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu kModifyLdtLock, 1019e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu kAllocatedThreadIdsLock, 10274240819ae09e29b2753ef38f4eb4be1c2762e2eAndreas Gampe kMonitorPoolLock, 103b8aa1e4c10dcdc7fef96634f87e259dfee83a1cfMathieu Chartier kClassLinkerClassesLock, // TODO rename. 104a79efdb69350fa66e1beabed4499ef4d0e809785Mathieu Chartier kDexToDexCompilerLock, 10565975776f807d55c83af6cca1e447f8daa794413Mathieu Chartier kJitCodeCacheLock, 106063fc772b5b8aed7d769cd7cccb6ddc7619326eeMingyao Yang kCHALock, 107495e783c9180c3fc033ce459ee0a783e633f7754Igor Murashkin kSubtypeCheckLock, 108719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kBreakpointLock, 109719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kMonitorLock, 110440e4ceb310349ee8eb569495bc04d3d7fbe71cbMathieu Chartier kMonitorListLock, 11168d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers kJniLoadLibraryLock, 112719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kThreadListLock, 113306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom kAllocTrackerLock, 114719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kDeoptimizationLock, 115719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kProfilerLock, 1164e5b20863898006ec6c9d120cda167d38dda6e60Sebastien Hertz kJdwpShutdownLock, 117719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpEventListLock, 118719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpAttachLock, 119719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kJdwpStartLock, 120719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kRuntimeShutdownLock, 12169dbec6d9d55eeb2867949c2791d01dc9aa916c8Jeff Hao kTraceLock, 122719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kHeapBitmapLock, 123719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kMutatorLock, 12488fd720b6799184c8ad61e766a6d37af33ed30efAlex Light kUserCodeSuspensionLock, 1259ef78b59da51080882e47505896b420977fd79aeMathieu Chartier kInstrumentEntrypointsLock, 126719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kZygoteCreationLock, 127719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 128b284f8d775ac32d8109744d94b99da451570beefAlex Light // The highest valid lock level. Use this if there is code that should only be called with no 129b284f8d775ac32d8109744d94b99da451570beefAlex Light // other locks held. Since this is the highest lock level we also allow it to be held even if the 130b284f8d775ac32d8109744d94b99da451570beefAlex Light // runtime or current thread is not fully set-up yet (for example during thread attach). Note that 131b284f8d775ac32d8109744d94b99da451570beefAlex Light // this lock also has special behavior around the mutator_lock_. Since the mutator_lock_ is not 132b284f8d775ac32d8109744d94b99da451570beefAlex Light // really a 'real' lock we allow this to be locked when the mutator_lock_ is held exclusive. 133b284f8d775ac32d8109744d94b99da451570beefAlex Light // Furthermore, the mutator_lock_ may not be acquired in any form when a lock of this level is 134b284f8d775ac32d8109744d94b99da451570beefAlex Light // held. Since the mutator_lock_ being held strong means that all other threads are suspended this 135b284f8d775ac32d8109744d94b99da451570beefAlex Light // will prevent deadlocks while still allowing this lock level to function as a "highest" level. 136b284f8d775ac32d8109744d94b99da451570beefAlex Light kTopLockLevel, 137b284f8d775ac32d8109744d94b99da451570beefAlex Light 138719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers kLockLevelCount // Must come last. 139719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers}; 140719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogersstd::ostream& operator<<(std::ostream& os, const LockLevel& rhs); 141719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 1422e250c826b3c405d675017efe79e5db3651c9ee6Brian Carlstromconst bool kDebugLocking = kIsDebugBuild; 14325fd14b87cced64a179dee885573113be5e11944Ian Rogers 1441afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi// Record Log contention information, dumpable via SIGQUIT. 1451afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi#ifdef ART_USE_FUTEXES 14608f2e7b59fab9df108d3d91e6eeb4bbccbb325d1Jeff Hao// To enable lock contention logging, set this to true. 14708f2e7b59fab9df108d3d91e6eeb4bbccbb325d1Jeff Haoconst bool kLogLockContentions = false; 1481afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi#else 1491afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi// Keep this false as lock contention logging is supported only with 1501afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi// futex. 1511afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchiconst bool kLogLockContentions = false; 1521afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi#endif 153d9c4fc94fa618617f94e1de9af5f034549100753Ian Rogersconst size_t kContentionLogSize = 4; 1541afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchiconst size_t kContentionLogDataSize = kLogLockContentions ? 1 : 0; 1551afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchiconst size_t kAllMutexDataSize = kLogLockContentions ? 1 : 0; 1561afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi 15700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Base class for all Mutex implementations 15800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogersclass BaseMutex { 15900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 160bab74963db2484ea5f10a82ea26e8a99722bfefeIan Rogers const char* GetName() const { 16100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers return name_; 16200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 16300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 16400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers virtual bool IsMutex() const { return false; } 16500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers virtual bool IsReaderWriterMutex() const { return false; } 166eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li virtual bool IsMutatorMutex() const { return false; } 16700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 16856edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers virtual void Dump(std::ostream& os) const = 0; 16956edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers 17056edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers static void DumpAll(std::ostream& os); 17156edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers 172a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi bool ShouldRespondToEmptyCheckpointRequest() const { 173a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi return should_respond_to_empty_checkpoint_request_; 174a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi } 175a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi 176a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi void SetShouldRespondToEmptyCheckpointRequest(bool value) { 177a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi should_respond_to_empty_checkpoint_request_ = value; 178a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi } 179a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi 180a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi virtual void WakeupToRespondToEmptyCheckpoint() = 0; 181a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi 18200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers protected: 18300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers friend class ConditionVariable; 18400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 18581d425b0b232962441616f8b14f73620bffef5e5Ian Rogers BaseMutex(const char* name, LockLevel level); 18656edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers virtual ~BaseMutex(); 18781d425b0b232962441616f8b14f73620bffef5e5Ian Rogers void RegisterAsLocked(Thread* self); 18881d425b0b232962441616f8b14f73620bffef5e5Ian Rogers void RegisterAsUnlocked(Thread* self); 18981d425b0b232962441616f8b14f73620bffef5e5Ian Rogers void CheckSafeToWait(Thread* self); 19000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 19156edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers friend class ScopedContentionRecorder; 19256edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers 1931afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi void RecordContention(uint64_t blocked_tid, uint64_t owner_tid, uint64_t nano_time_blocked); 19456edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers void DumpContention(std::ostream& os) const; 19556edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers 19681d425b0b232962441616f8b14f73620bffef5e5Ian Rogers const LockLevel level_; // Support for lock hierarchy. 197bab74963db2484ea5f10a82ea26e8a99722bfefeIan Rogers const char* const name_; 198a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi bool should_respond_to_empty_checkpoint_request_; 1991afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi 20056edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers // A log entry that records contention but makes no guarantee that either tid will be held live. 20156edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers struct ContentionLogEntry { 20256edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers ContentionLogEntry() : blocked_tid(0), owner_tid(0) {} 20356edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers uint64_t blocked_tid; 20456edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers uint64_t owner_tid; 20556edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers AtomicInteger count; 20656edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers }; 2071afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi struct ContentionLogData { 2081afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi ContentionLogEntry contention_log[kContentionLogSize]; 2091afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi // The next entry in the contention log to be updated. Value ranges from 0 to 2101afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi // kContentionLogSize - 1. 2111afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi AtomicInteger cur_content_log_entry; 2121afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi // Number of times the Mutex has been contended. 2131afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi AtomicInteger contention_count; 2141afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi // Sum of time waited by all contenders in ns. 21537f3c968ecd04e77802fe17bb82dabc07de21ca1Ian Rogers Atomic<uint64_t> wait_time; 2161afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi void AddToWaitTime(uint64_t value); 2171afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi ContentionLogData() : wait_time(0) {} 2181afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi }; 2193e5cf305db800b2989ad57b7cde8fb3cc9fa1b9eIan Rogers ContentionLogData contention_log_data_[kContentionLogDataSize]; 2201afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi 2211afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi public: 2221afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi bool HasEverContended() const { 2231afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi if (kLogLockContentions) { 2243e5cf305db800b2989ad57b7cde8fb3cc9fa1b9eIan Rogers return contention_log_data_->contention_count.LoadSequentiallyConsistent() > 0; 2251afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi } 2261afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi return false; 2271afde13b36cc1d67528104c2b1395495f669cd3fHiroshi Yamauchi } 22800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers}; 22900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 23000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// A Mutex is used to achieve mutual exclusion between threads. A Mutex can be used to gain 23100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// exclusive access to what it guards. A Mutex can be in one of two states: 23200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Free - not owned by any thread, 23300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Exclusive - owned by a single thread. 23400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// 23500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// The effect of locking and unlocking operations on the state is: 23600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// State | ExclusiveLock | ExclusiveUnlock 23700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// ------------------------------------------- 23800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Free | Exclusive | error 23900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Exclusive | Block* | Free 24000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// * Mutex is not reentrant and so an attempt to ExclusiveLock on the same thread will result in 24100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// an error. Being non-reentrant simplifies Waiting on ConditionVariables. 24201ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogersstd::ostream& operator<<(std::ostream& os, const Mutex& mu); 24300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogersclass LOCKABLE Mutex : public BaseMutex { 24400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 24581d425b0b232962441616f8b14f73620bffef5e5Ian Rogers explicit Mutex(const char* name, LockLevel level = kDefaultMutexLevel, bool recursive = false); 24600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ~Mutex(); 24700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 24800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers virtual bool IsMutex() const { return true; } 24900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 25000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Block until mutex is free then acquire exclusive access. 25190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ExclusiveLock(Thread* self) ACQUIRE(); 25290443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void Lock(Thread* self) ACQUIRE() { ExclusiveLock(self); } 25300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 25400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Returns true if acquires exclusive access, false otherwise. 25590443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier bool ExclusiveTryLock(Thread* self) TRY_ACQUIRE(true); 25690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier bool TryLock(Thread* self) TRY_ACQUIRE(true) { return ExclusiveTryLock(self); } 25700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 25800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Release exclusive access. 25990443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ExclusiveUnlock(Thread* self) RELEASE(); 26090443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void Unlock(Thread* self) RELEASE() { ExclusiveUnlock(self); } 26100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 26200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Is the current thread the exclusive holder of the Mutex. 263b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE bool IsExclusiveHeld(const Thread* self) const; 2648daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 26500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert that the Mutex is exclusively held by the current thread. 266b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE void AssertExclusiveHeld(const Thread* self) const ASSERT_CAPABILITY(this); 267b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE void AssertHeld(const Thread* self) const ASSERT_CAPABILITY(this); 26800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 26900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert that the Mutex is not held by the current thread. 27090443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void AssertNotHeldExclusive(const Thread* self) ASSERT_CAPABILITY(!*this) { 271db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 27201ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers CHECK(!IsExclusiveHeld(self)) << *this; 27300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 27400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 27590443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void AssertNotHeld(const Thread* self) ASSERT_CAPABILITY(!*this) { 27690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier AssertNotHeldExclusive(self); 27790443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier } 27800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 279c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Id associated with exclusive owner. No memory ordering semantics if called from a thread other 280c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // than the owner. 2810882af2e3ca253184b6ab56a8966a2f37407144eHans Boehm pid_t GetExclusiveOwnerTid() const; 28200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 28300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Returns how many times this Mutex has been locked, it is better to use AssertHeld/NotHeld. 28400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers unsigned int GetDepth() const { 28500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers return recursion_count_; 28600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 28700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 28856edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers virtual void Dump(std::ostream& os) const; 28901ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers 29090443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier // For negative capabilities in clang annotations. 29190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier const Mutex& operator!() const { return *this; } 29290443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier 293a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi void WakeupToRespondToEmptyCheckpoint() OVERRIDE; 294a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi 29500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers private: 296c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#if ART_USE_FUTEXES 297c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // 0 is unheld, 1 is held. 298c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers AtomicInteger state_; 299c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // Exclusive owner. 3000882af2e3ca253184b6ab56a8966a2f37407144eHans Boehm Atomic<pid_t> exclusive_owner_; 301c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // Number of waiting contenders. 302b122a4bbed34ab22b4c1541ee25e5cf22f12a926Ian Rogers AtomicInteger num_contenders_; 303c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#else 30400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers pthread_mutex_t mutex_; 3050882af2e3ca253184b6ab56a8966a2f37407144eHans Boehm Atomic<pid_t> exclusive_owner_; // Guarded by mutex_. Asynchronous reads are OK. 306c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#endif 30700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers const bool recursive_; // Can the lock be recursively held? 30800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers unsigned int recursion_count_; 309f1498437b0d6beb9f4f91980b98cbeb0b5c773ceElliott Hughes friend class ConditionVariable; 3108daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes DISALLOW_COPY_AND_ASSIGN(Mutex); 3118daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes}; 3128daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 31300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// A ReaderWriterMutex is used to achieve mutual exclusion between threads, similar to a Mutex. 31400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Unlike a Mutex a ReaderWriterMutex can be used to gain exclusive (writer) or shared (reader) 31500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// access to what it guards. A flaw in relation to a Mutex is that it cannot be used with a 31600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// condition variable. A ReaderWriterMutex can be in one of three states: 31700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Free - not owned by any thread, 31800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Exclusive - owned by a single thread, 31900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// - Shared(n) - shared amongst n threads. 32000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// 32100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// The effect of locking and unlocking operations on the state is: 32200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// 32300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// State | ExclusiveLock | ExclusiveUnlock | SharedLock | SharedUnlock 32400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// ---------------------------------------------------------------------------- 32500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Free | Exclusive | error | SharedLock(1) | error 32600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Exclusive | Block | Free | Block | error 32700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Shared(n) | Block | error | SharedLock(n+1)* | Shared(n-1) or Free 32800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// * for large values of n the SharedLock may block. 32901ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogersstd::ostream& operator<<(std::ostream& os, const ReaderWriterMutex& mu); 33090443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SHARED_LOCKABLE ReaderWriterMutex : public BaseMutex { 3318daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes public: 33281d425b0b232962441616f8b14f73620bffef5e5Ian Rogers explicit ReaderWriterMutex(const char* name, LockLevel level = kDefaultMutexLevel); 33300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ~ReaderWriterMutex(); 33400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 33500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers virtual bool IsReaderWriterMutex() const { return true; } 33600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 33700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Block until ReaderWriterMutex is free then acquire exclusive access. 33890443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ExclusiveLock(Thread* self) ACQUIRE(); 33990443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void WriterLock(Thread* self) ACQUIRE() { ExclusiveLock(self); } 34000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 34100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Release exclusive access. 34290443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ExclusiveUnlock(Thread* self) RELEASE(); 34390443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void WriterUnlock(Thread* self) RELEASE() { ExclusiveUnlock(self); } 34400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 34500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Block until ReaderWriterMutex is free and acquire exclusive access. Returns true on success 34600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // or false if timeout is reached. 34766aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#if HAVE_TIMED_RWLOCK 348c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers bool ExclusiveLockWithTimeout(Thread* self, int64_t ms, int32_t ns) 34981d425b0b232962441616f8b14f73620bffef5e5Ian Rogers EXCLUSIVE_TRYLOCK_FUNCTION(true); 35066aee5cd571cf4739d2735769304202ea5051fb8Ian Rogers#endif 35100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 35200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Block until ReaderWriterMutex is shared or free then acquire a share on the access. 35390443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void SharedLock(Thread* self) ACQUIRE_SHARED() ALWAYS_INLINE; 35490443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ReaderLock(Thread* self) ACQUIRE_SHARED() { SharedLock(self); } 35500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 35600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Try to acquire share of ReaderWriterMutex. 35790443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier bool SharedTryLock(Thread* self) SHARED_TRYLOCK_FUNCTION(true); 35800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 35900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Release a share of the access. 36090443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void SharedUnlock(Thread* self) RELEASE_SHARED() ALWAYS_INLINE; 36190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier void ReaderUnlock(Thread* self) RELEASE_SHARED() { SharedUnlock(self); } 36200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 36300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Is the current thread the exclusive holder of the ReaderWriterMutex. 364b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE bool IsExclusiveHeld(const Thread* self) const; 36500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 36600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert the current thread has exclusive access to the ReaderWriterMutex. 367b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE void AssertExclusiveHeld(const Thread* self) const ASSERT_CAPABILITY(this); 368b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE void AssertWriterHeld(const Thread* self) const ASSERT_CAPABILITY(this); 3698daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 37000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert the current thread doesn't have exclusive access to the ReaderWriterMutex. 37190ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier void AssertNotExclusiveHeld(const Thread* self) ASSERT_CAPABILITY(!this) { 372db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 373e3359f7ad7671c5816f17145ca3a01516512e8d6Ian Rogers CHECK(!IsExclusiveHeld(self)) << *this; 37400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 37500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 37690ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier void AssertNotWriterHeld(const Thread* self) ASSERT_CAPABILITY(!this) { 37790ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier AssertNotExclusiveHeld(self); 37890ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier } 37900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 38000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Is the current thread a shared holder of the ReaderWriterMutex. 38181d425b0b232962441616f8b14f73620bffef5e5Ian Rogers bool IsSharedHeld(const Thread* self) const; 38200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 38300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert the current thread has shared access to the ReaderWriterMutex. 3843768adec2f819cb506577618fdde158ba659ddd4Mathieu Chartier ALWAYS_INLINE void AssertSharedHeld(const Thread* self) ASSERT_SHARED_CAPABILITY(this) { 385db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 3862cebb24bfc3247d3e9be138a3350106737455918Mathieu Chartier // TODO: we can only assert this well when self != null. 3872cebb24bfc3247d3e9be138a3350106737455918Mathieu Chartier CHECK(IsSharedHeld(self) || self == nullptr) << *this; 38800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 3898daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes } 3903768adec2f819cb506577618fdde158ba659ddd4Mathieu Chartier ALWAYS_INLINE void AssertReaderHeld(const Thread* self) ASSERT_SHARED_CAPABILITY(this) { 39190ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier AssertSharedHeld(self); 39290ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier } 3938daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 39400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // Assert the current thread doesn't hold this ReaderWriterMutex either in shared or exclusive 39500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers // mode. 3963768adec2f819cb506577618fdde158ba659ddd4Mathieu Chartier ALWAYS_INLINE void AssertNotHeld(const Thread* self) ASSERT_SHARED_CAPABILITY(!this) { 397db978719dbcb73fc6acfd193561445c4462786b8Nicolas Geoffray if (kDebugLocking && (gAborting == 0)) { 39801ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers CHECK(!IsSharedHeld(self)) << *this; 39900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 40000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 40100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 402c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Id associated with exclusive owner. No memory ordering semantics if called from a thread other 4030882af2e3ca253184b6ab56a8966a2f37407144eHans Boehm // than the owner. Returns 0 if the lock is not held. Returns either 0 or -1 if it is held by 4040882af2e3ca253184b6ab56a8966a2f37407144eHans Boehm // one or more readers. 4050882af2e3ca253184b6ab56a8966a2f37407144eHans Boehm pid_t GetExclusiveOwnerTid() const; 40681d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 40756edc432fa914f7ccfa87ce443e64f5ef475666dIan Rogers virtual void Dump(std::ostream& os) const; 40801ae5808367e641a983e3f8bb82b3e0d364cd03eIan Rogers 40990443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier // For negative capabilities in clang annotations. 41090443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier const ReaderWriterMutex& operator!() const { return *this; } 41190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier 412a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi void WakeupToRespondToEmptyCheckpoint() OVERRIDE; 413a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi 4148daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes private: 41551d212ef31945743abe8a469707aaa25bab95357Ian Rogers#if ART_USE_FUTEXES 416cf7f19135f0e273f7b0136315633c2abfc715343Ian Rogers // Out-of-inline path for handling contention for a SharedLock. 417cf7f19135f0e273f7b0136315633c2abfc715343Ian Rogers void HandleSharedLockContention(Thread* self, int32_t cur_state); 418cf7f19135f0e273f7b0136315633c2abfc715343Ian Rogers 41981d425b0b232962441616f8b14f73620bffef5e5Ian Rogers // -1 implies held exclusive, +ve shared held by state_ many owners. 420c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers AtomicInteger state_; 421c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Exclusive owner. Modification guarded by this mutex. 4220882af2e3ca253184b6ab56a8966a2f37407144eHans Boehm Atomic<pid_t> exclusive_owner_; 423c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Number of contenders waiting for a reader share. 424c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers AtomicInteger num_pending_readers_; 425c7190697f8665e706f6ebb4ae36fa63c46a32cd5Ian Rogers // Number of contenders waiting to be the writer. 426b122a4bbed34ab22b4c1541ee25e5cf22f12a926Ian Rogers AtomicInteger num_pending_writers_; 42781d425b0b232962441616f8b14f73620bffef5e5Ian Rogers#else 42800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers pthread_rwlock_t rwlock_; 4290882af2e3ca253184b6ab56a8966a2f37407144eHans Boehm Atomic<pid_t> exclusive_owner_; // Writes guarded by rwlock_. Asynchronous reads are OK. 43081d425b0b232962441616f8b14f73620bffef5e5Ian Rogers#endif 43100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers DISALLOW_COPY_AND_ASSIGN(ReaderWriterMutex); 4328daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes}; 4338daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 434eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// MutatorMutex is a special kind of ReaderWriterMutex created specifically for the 435eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// Locks::mutator_lock_ mutex. The behaviour is identical to the ReaderWriterMutex except that 436eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// thread state changes also play a part in lock ownership. The mutator_lock_ will not be truly 437eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// held by any mutator threads. However, a thread in the kRunnable state is considered to have 438eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// shared ownership of the mutator lock and therefore transitions in and out of the kRunnable 439eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// state have associated implications on lock ownership. Extra methods to handle the state 440eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// transitions have been added to the interface but are only accessible to the methods dealing 441eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// with state transitions. The thread state and flags attributes are used to ensure thread state 442eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// transitions are consistent with the permitted behaviour of the mutex. 443eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// 444eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// *) The most important consequence of this behaviour is that all threads must be in one of the 445eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// suspended states before exclusive ownership of the mutator mutex is sought. 446eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li// 447eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Listd::ostream& operator<<(std::ostream& os, const MutatorMutex& mu); 44890443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SHARED_LOCKABLE MutatorMutex : public ReaderWriterMutex { 449eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li public: 450eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li explicit MutatorMutex(const char* name, LockLevel level = kDefaultMutexLevel) 451eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li : ReaderWriterMutex(name, level) {} 452eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li ~MutatorMutex() {} 453eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li 454eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li virtual bool IsMutatorMutex() const { return true; } 455eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li 45690443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier // For negative capabilities in clang annotations. 45790443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier const MutatorMutex& operator!() const { return *this; } 45890443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier 459eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li private: 460eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li friend class Thread; 461eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li void TransitionFromRunnableToSuspended(Thread* self) UNLOCK_FUNCTION() ALWAYS_INLINE; 462eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li void TransitionFromSuspendedToRunnable(Thread* self) SHARED_LOCK_FUNCTION() ALWAYS_INLINE; 463eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li 464eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li DISALLOW_COPY_AND_ASSIGN(MutatorMutex); 465eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li}; 466eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li 46700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// ConditionVariables allow threads to queue and sleep. Threads may then be resumed individually 46800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// (Signal) or all at once (Broadcast). 4695f79133a435ebcb20000370d56046fe01201dd80Elliott Hughesclass ConditionVariable { 4705f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes public: 4713887c468d731420e929e6ad3acf190d5431e94fcRoland Levillain ConditionVariable(const char* name, Mutex& mutex); 4725f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes ~ConditionVariable(); 4735f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes 474c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers void Broadcast(Thread* self); 475c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers void Signal(Thread* self); 476c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // TODO: No thread safety analysis on Wait and TimedWait as they call mutex operations via their 477c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // pointer copy, thereby defeating annotalysis. 478c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers void Wait(Thread* self) NO_THREAD_SAFETY_ANALYSIS; 4797b078e8c04f3e1451dbdd18543c8b9692b5b067eIan Rogers bool TimedWait(Thread* self, int64_t ms, int32_t ns) NO_THREAD_SAFETY_ANALYSIS; 4801d54e73444e017d3a65234e0f193846f3e27472bIan Rogers // Variant of Wait that should be used with caution. Doesn't validate that no mutexes are held 4811d54e73444e017d3a65234e0f193846f3e27472bIan Rogers // when waiting. 4821d54e73444e017d3a65234e0f193846f3e27472bIan Rogers // TODO: remove this. 4831d54e73444e017d3a65234e0f193846f3e27472bIan Rogers void WaitHoldingLocks(Thread* self) NO_THREAD_SAFETY_ANALYSIS; 4845f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes 4855f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes private: 48623055dc5d7a90c4a12e259fd0ed7cd4d04d89182Ian Rogers const char* const name_; 487c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // The Mutex being used by waiters. It is an error to mix condition variables between different 488c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // Mutexes. 489c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers Mutex& guard_; 490c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#if ART_USE_FUTEXES 491c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // A counter that is modified by signals and broadcasts. This ensures that when a waiter gives up 492d45f201e9bd43490e30a35710865789b8d70e249Ian Rogers // their Mutex and another thread takes it and signals, the waiting thread observes that sequence_ 493d45f201e9bd43490e30a35710865789b8d70e249Ian Rogers // changed and doesn't enter the wait. Modified while holding guard_, but is read by futex wait 494d45f201e9bd43490e30a35710865789b8d70e249Ian Rogers // without guard_ held. 495b122a4bbed34ab22b4c1541ee25e5cf22f12a926Ian Rogers AtomicInteger sequence_; 496c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers // Number of threads that have come into to wait, not the length of the waiters on the futex as 4975bd97c483c1de1eb97afe76123b1b9ab53095edfIan Rogers // waiters may have been requeued onto guard_. Guarded by guard_. 498c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers volatile int32_t num_waiters_; 499c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#else 500c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers pthread_cond_t cond_; 501c604d731730b43231f63040c8db1d58304da0cf3Ian Rogers#endif 5025f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes DISALLOW_COPY_AND_ASSIGN(ConditionVariable); 5035f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes}; 5045f79133a435ebcb20000370d56046fe01201dd80Elliott Hughes 50500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Scoped locker/unlocker for a regular Mutex that acquires mu upon construction and releases it 50600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// upon destruction. 50790443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SCOPED_CAPABILITY MutexLock { 50800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 5093887c468d731420e929e6ad3acf190d5431e94fcRoland Levillain MutexLock(Thread* self, Mutex& mu) ACQUIRE(mu) : self_(self), mu_(mu) { 51081d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.ExclusiveLock(self_); 51181d425b0b232962441616f8b14f73620bffef5e5Ian Rogers } 51281d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 5134e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier ~MutexLock() RELEASE() { 51481d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.ExclusiveUnlock(self_); 51500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 51600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 51700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers private: 51881d425b0b232962441616f8b14f73620bffef5e5Ian Rogers Thread* const self_; 51900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers Mutex& mu_; 52000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers DISALLOW_COPY_AND_ASSIGN(MutexLock); 52100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers}; 52200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Catch bug where variable name is omitted. "MutexLock (lock);" instead of "MutexLock mu(lock)". 523575e78c41ece0dec969d31f46be563d4eb7ae43bAndreas Gampe#define MutexLock(x) static_assert(0, "MutexLock declaration missing variable name") 52400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 52500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Scoped locker/unlocker for a ReaderWriterMutex that acquires read access to mu upon 52600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// construction and releases it upon destruction. 52790443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SCOPED_CAPABILITY ReaderMutexLock { 52800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 529b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE ReaderMutexLock(Thread* self, ReaderWriterMutex& mu) ACQUIRE(mu); 53081d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 531b486a98aadc95d80548953410cf23edba62259faAndreas Gampe ALWAYS_INLINE ~ReaderMutexLock() RELEASE(); 53200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 53300f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers private: 53481d425b0b232962441616f8b14f73620bffef5e5Ian Rogers Thread* const self_; 53500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ReaderWriterMutex& mu_; 53600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers DISALLOW_COPY_AND_ASSIGN(ReaderMutexLock); 53700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers}; 53800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 53900f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Scoped locker/unlocker for a ReaderWriterMutex that acquires write access to mu upon 54000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// construction and releases it upon destruction. 54190443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartierclass SCOPED_CAPABILITY WriterMutexLock { 54200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers public: 5433887c468d731420e929e6ad3acf190d5431e94fcRoland Levillain WriterMutexLock(Thread* self, ReaderWriterMutex& mu) EXCLUSIVE_LOCK_FUNCTION(mu) : 54481d425b0b232962441616f8b14f73620bffef5e5Ian Rogers self_(self), mu_(mu) { 54581d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.ExclusiveLock(self_); 54681d425b0b232962441616f8b14f73620bffef5e5Ian Rogers } 54781d425b0b232962441616f8b14f73620bffef5e5Ian Rogers 54800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ~WriterMutexLock() UNLOCK_FUNCTION() { 54981d425b0b232962441616f8b14f73620bffef5e5Ian Rogers mu_.ExclusiveUnlock(self_); 55000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers } 55100f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 55200f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers private: 55350b35e2fd1a68cd1240e4a9d9f363e11764957d1Ian Rogers Thread* const self_; 55400f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers ReaderWriterMutex& mu_; 55500f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers DISALLOW_COPY_AND_ASSIGN(WriterMutexLock); 55600f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers}; 55700f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// Catch bug where variable name is omitted. "WriterMutexLock (lock);" instead of 55800f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers// "WriterMutexLock mu(lock)". 559575e78c41ece0dec969d31f46be563d4eb7ae43bAndreas Gampe#define WriterMutexLock(x) static_assert(0, "WriterMutexLock declaration missing variable name") 56000f7d0eaa6bd93d33bf0c1429bf4ba0b3f28abacIan Rogers 5614e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier// For StartNoThreadSuspension and EndNoThreadSuspension. 5624e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartierclass CAPABILITY("role") Role { 5634e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier public: 5644e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier void Acquire() ACQUIRE() {} 5654e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier void Release() RELEASE() {} 5664e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier const Role& operator!() const { return *this; } 5674e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier}; 5684e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier 5694e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartierclass Uninterruptible : public Role { 5704e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier}; 5714e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier 572719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers// Global mutexes corresponding to the levels above. 573719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogersclass Locks { 574719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers public: 575719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static void Init(); 57691e56692c6bd9fa1d41951ee7dc311f19461f4beMathieu Chartier static void InitConditions() NO_THREAD_SAFETY_ANALYSIS; // Condition variables. 577f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr 578f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // Destroying various lock types can emit errors that vary depending upon 579f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // whether the client (art::Runtime) is currently active. Allow the client 580f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // to set a callback that is used to check when it is acceptable to call 581f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // Abort. The default behavior is that the client *is not* able to call 582f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // Abort if no callback is established. 583f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr using ClientCallback = bool(); 584f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr static void SetClientCallback(ClientCallback* is_safe_to_call_abort_cb) NO_THREAD_SAFETY_ANALYSIS; 585f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr // Checks for whether it is safe to call Abort() without using locks. 586f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr static bool IsSafeToCallAbortRacy() NO_THREAD_SAFETY_ANALYSIS; 587f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr 5888a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi // Add a mutex to expected_mutexes_on_weak_ref_access_. 5898a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi static void AddToExpectedMutexesOnWeakRefAccess(BaseMutex* mutex, bool need_lock = true); 5908a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi // Remove a mutex from expected_mutexes_on_weak_ref_access_. 5918a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi static void RemoveFromExpectedMutexesOnWeakRefAccess(BaseMutex* mutex, bool need_lock = true); 5928a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi // Check if the given mutex is in expected_mutexes_on_weak_ref_access_. 5938a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi static bool IsExpectedOnWeakRefAccess(BaseMutex* mutex); 594f42eb2c7801dbb45a6ba20a372d5ba4712ebefbaDavid Sehr 5959ef78b59da51080882e47505896b420977fd79aeMathieu Chartier // Guards allocation entrypoint instrumenting. 5964ad5cd3e7d519484559ef778d96fb3f0be8919faIan Rogers static Mutex* instrument_entrypoints_lock_; 5979ef78b59da51080882e47505896b420977fd79aeMathieu Chartier 59888fd720b6799184c8ad61e766a6d37af33ed30efAlex Light // Guards code that deals with user-code suspension. This mutex must be held when suspending or 59988fd720b6799184c8ad61e766a6d37af33ed30efAlex Light // resuming threads with SuspendReason::kForUserCode. It may be held by a suspended thread, but 60088fd720b6799184c8ad61e766a6d37af33ed30efAlex Light // only if the suspension is not due to SuspendReason::kForUserCode. 60188fd720b6799184c8ad61e766a6d37af33ed30efAlex Light static Mutex* user_code_suspension_lock_ ACQUIRED_AFTER(instrument_entrypoints_lock_); 60288fd720b6799184c8ad61e766a6d37af33ed30efAlex Light 603eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // A barrier is used to synchronize the GC/Debugger thread with mutator threads. When GC/Debugger 604eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // thread wants to suspend all mutator threads, it needs to wait for all mutator threads to pass 605eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // a barrier. Threads that are already suspended will get their barrier passed by the GC/Debugger 606eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // thread; threads in the runnable state will pass the barrier when they transit to the suspended 607eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // state. GC/Debugger thread will be woken up when all mutator threads are suspended. 608719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // 609719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Thread suspension: 610eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // mutator thread | GC/Debugger 611eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // .. running .. | .. running .. 612719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | Request thread suspension by: 613719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | - acquiring thread_suspend_count_lock_ 614719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | - incrementing Thread::suspend_count_ on 615719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | all mutator threads 616719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | - releasing thread_suspend_count_lock_ 617eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // .. running .. | Block wait for all threads to pass a barrier 618719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Poll Thread::suspend_count_ and enter full | .. blocked .. 619719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // suspend code. | .. blocked .. 620eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // Change state to kSuspended (pass the barrier) | Wake up when all threads pass the barrier 621eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // x: Acquire thread_suspend_count_lock_ | .. running .. 622eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // while Thread::suspend_count_ > 0 | .. running .. 623eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // - wait on Thread::resume_cond_ | .. running .. 624eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // (releases thread_suspend_count_lock_) | .. running .. 625719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | Request thread resumption by: 626719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | - acquiring thread_suspend_count_lock_ 627719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | - decrementing Thread::suspend_count_ on 628719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | all mutator threads 629719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. waiting .. | - notifying on Thread::resume_cond_ 630719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // - re-acquire thread_suspend_count_lock_ | - releasing thread_suspend_count_lock_ 631719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Release thread_suspend_count_lock_ | .. running .. 632eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // Change to kRunnable | .. running .. 633eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // - this uses a CAS operation to ensure the | .. running .. 634eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // suspend request flag isn't raised as the | .. running .. 635eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // state is changed | .. running .. 636eac4424b3420c280f97ff2f815b5dedd8dac9801Yu Li // - if the CAS operation fails then goto x | .. running .. 637719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // .. running .. | .. running .. 63888fd720b6799184c8ad61e766a6d37af33ed30efAlex Light static MutatorMutex* mutator_lock_ ACQUIRED_AFTER(user_code_suspension_lock_); 639719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 640719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Allow reader-writer mutual exclusion on the mark and live bitmaps of the heap. 641719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static ReaderWriterMutex* heap_bitmap_lock_ ACQUIRED_AFTER(mutator_lock_); 642719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 643719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Guards shutdown of the runtime. 644719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static Mutex* runtime_shutdown_lock_ ACQUIRED_AFTER(heap_bitmap_lock_); 645719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 6469e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu // Guards background profiler global state. 647b139b6d3833cd6a90f345204202ec57ff277c088Hiroshi Yamauchi static Mutex* profiler_lock_ ACQUIRED_AFTER(runtime_shutdown_lock_); 6489e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu 6499e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu // Guards trace (ie traceview) requests. 6509e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu static Mutex* trace_lock_ ACQUIRED_AFTER(profiler_lock_); 6519e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu 652306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom // Guards debugger recent allocation records. 653306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom static Mutex* alloc_tracker_lock_ ACQUIRED_AFTER(trace_lock_); 654306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom 655306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom // Guards updates to instrumentation to ensure mutual exclusion of 656306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom // events like deoptimization requests. 657306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom // TODO: improve name, perhaps instrumentation_update_lock_. 658306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom static Mutex* deoptimization_lock_ ACQUIRED_AFTER(alloc_tracker_lock_); 659306db81aba41eb244a4e8299cf58ac18ae9999c7Brian Carlstrom 660063fc772b5b8aed7d769cd7cccb6ddc7619326eeMingyao Yang // Guards Class Hierarchy Analysis (CHA). 661063fc772b5b8aed7d769cd7cccb6ddc7619326eeMingyao Yang static Mutex* cha_lock_ ACQUIRED_AFTER(deoptimization_lock_); 662063fc772b5b8aed7d769cd7cccb6ddc7619326eeMingyao Yang 663495e783c9180c3fc033ce459ee0a783e633f7754Igor Murashkin // Guard the update of the SubtypeCheck data stores in each Class::status_ field. 664495e783c9180c3fc033ce459ee0a783e633f7754Igor Murashkin // This lock is used in SubtypeCheck methods which are the interface for 665495e783c9180c3fc033ce459ee0a783e633f7754Igor Murashkin // any SubtypeCheck-mutating methods. 666495e783c9180c3fc033ce459ee0a783e633f7754Igor Murashkin // In Class::IsSubClass, the lock is not required since it does not update the SubtypeCheck data. 667495e783c9180c3fc033ce459ee0a783e633f7754Igor Murashkin static Mutex* subtype_check_lock_ ACQUIRED_AFTER(cha_lock_); 668495e783c9180c3fc033ce459ee0a783e633f7754Igor Murashkin 669719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // The thread_list_lock_ guards ThreadList::list_. It is also commonly held to stop threads 670719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // attaching and detaching. 671495e783c9180c3fc033ce459ee0a783e633f7754Igor Murashkin static Mutex* thread_list_lock_ ACQUIRED_AFTER(subtype_check_lock_); 672719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 67391e56692c6bd9fa1d41951ee7dc311f19461f4beMathieu Chartier // Signaled when threads terminate. Used to determine when all non-daemons have terminated. 67491e56692c6bd9fa1d41951ee7dc311f19461f4beMathieu Chartier static ConditionVariable* thread_exit_cond_ GUARDED_BY(Locks::thread_list_lock_); 67591e56692c6bd9fa1d41951ee7dc311f19461f4beMathieu Chartier 67668d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers // Guards maintaining loading library data structures. 67768d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers static Mutex* jni_libraries_lock_ ACQUIRED_AFTER(thread_list_lock_); 67868d8b42ddec39ec0174162d90d4abaa004d1983eIan Rogers 679719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Guards breakpoints. 680ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz static ReaderWriterMutex* breakpoint_lock_ ACQUIRED_AFTER(jni_libraries_lock_); 681719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 682719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Guards lists of classes within the class linker. 6839e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu static ReaderWriterMutex* classlinker_classes_lock_ ACQUIRED_AFTER(breakpoint_lock_); 684719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 685719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // When declaring any Mutex add DEFAULT_MUTEX_ACQUIRED_AFTER to use annotalysis to check the code 686719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // doesn't try to hold a higher level Mutex. 6870fa1786bdcc333873ed65a1f77a4669d5701ac5eAlex Light #define DEFAULT_MUTEX_ACQUIRED_AFTER ACQUIRED_AFTER(art::Locks::classlinker_classes_lock_) 688719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 68974240819ae09e29b2753ef38f4eb4be1c2762e2eAndreas Gampe static Mutex* allocated_monitor_ids_lock_ ACQUIRED_AFTER(classlinker_classes_lock_); 69074240819ae09e29b2753ef38f4eb4be1c2762e2eAndreas Gampe 6919e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu // Guard the allocation/deallocation of thread ids. 69274240819ae09e29b2753ef38f4eb4be1c2762e2eAndreas Gampe static Mutex* allocated_thread_ids_lock_ ACQUIRED_AFTER(allocated_monitor_ids_lock_); 6939e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu 6949e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu // Guards modification of the LDT on x86. 6959e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu static Mutex* modify_ldt_lock_ ACQUIRED_AFTER(allocated_thread_ids_lock_); 6969e36931cc79ca665908db9575126881d1cfdea5aChao-ying Fu 697cc1b5357f83f0b787d51fbfde3fe870c8a2fa050Andreas Gampe static ReaderWriterMutex* dex_lock_ ACQUIRED_AFTER(modify_ldt_lock_); 698cc1b5357f83f0b787d51fbfde3fe870c8a2fa050Andreas Gampe 699f9c6fc610b27887f832e453a0da1789187293408Mathieu Chartier // Guards opened oat files in OatFileManager. 700cc1b5357f83f0b787d51fbfde3fe870c8a2fa050Andreas Gampe static ReaderWriterMutex* oat_file_manager_lock_ ACQUIRED_AFTER(dex_lock_); 701f9c6fc610b27887f832e453a0da1789187293408Mathieu Chartier 702340dafabc8e88378e395cda9027cf17726910e91Nicolas Geoffray // Guards extra string entries for VerifierDeps. 703340dafabc8e88378e395cda9027cf17726910e91Nicolas Geoffray static ReaderWriterMutex* verifier_deps_lock_ ACQUIRED_AFTER(oat_file_manager_lock_); 704ca3c8c33501bf199d6fd0a5db30a27d8e010cb23David Brazdil 705a206c745dbb64b14f05c87891d425475c2f6d63aRichard Uhler // Guards dlopen_handles_ in DlOpenOatFile. 706ca3c8c33501bf199d6fd0a5db30a27d8e010cb23David Brazdil static Mutex* host_dlopen_handles_lock_ ACQUIRED_AFTER(verifier_deps_lock_); 707e58991b3b2282b5761f1a6023a16c803e1c4eb45Mathieu Chartier 708719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Guards intern table. 709a206c745dbb64b14f05c87891d425475c2f6d63aRichard Uhler static Mutex* intern_table_lock_ ACQUIRED_AFTER(host_dlopen_handles_lock_); 710719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 711a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards reference processor. 712a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_processor_lock_ ACQUIRED_AFTER(intern_table_lock_); 713a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 714a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards cleared references queue. 715a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_cleared_references_lock_ ACQUIRED_AFTER(reference_processor_lock_); 716a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 717a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards weak references queue. 718a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_weak_references_lock_ ACQUIRED_AFTER(reference_queue_cleared_references_lock_); 719a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 720a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards finalizer references queue. 721a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_finalizer_references_lock_ ACQUIRED_AFTER(reference_queue_weak_references_lock_); 722a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 723a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards phantom references queue. 724a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_phantom_references_lock_ ACQUIRED_AFTER(reference_queue_finalizer_references_lock_); 725a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 726a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier // Guards soft references queue. 727a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier static Mutex* reference_queue_soft_references_lock_ ACQUIRED_AFTER(reference_queue_phantom_references_lock_); 728a5a53efea976af505f4f849b5925d5e14c4f8e5cMathieu Chartier 72905a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe // Guard accesses to the JNI Global Reference table. 73005a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe static ReaderWriterMutex* jni_globals_lock_ ACQUIRED_AFTER(reference_queue_soft_references_lock_); 73105a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe 73205a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe // Guard accesses to the JNI Weak Global Reference table. 73305a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe static Mutex* jni_weak_globals_lock_ ACQUIRED_AFTER(jni_globals_lock_); 73405a364c8d8271ceeca307d04736f53e92d03de9dAndreas Gampe 735c8089540ccf0f1c43d8db3828f21d489b28a4013Andreas Gampe // Guard accesses to the JNI function table override. 736c8089540ccf0f1c43d8db3828f21d489b28a4013Andreas Gampe static Mutex* jni_function_table_lock_ ACQUIRED_AFTER(jni_weak_globals_lock_); 737c8089540ccf0f1c43d8db3828f21d489b28a4013Andreas Gampe 738719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Have an exclusive aborting thread. 739c8089540ccf0f1c43d8db3828f21d489b28a4013Andreas Gampe static Mutex* abort_lock_ ACQUIRED_AFTER(jni_function_table_lock_); 740719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 741719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Allow mutual exclusion when manipulating Thread::suspend_count_. 742719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // TODO: Does the trade-off of a per-thread lock make sense? 743719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static Mutex* thread_suspend_count_lock_ ACQUIRED_AFTER(abort_lock_); 744719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 745719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // One unexpected signal at a time lock. 746719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static Mutex* unexpected_signal_lock_ ACQUIRED_AFTER(thread_suspend_count_lock_); 747719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 748719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers // Have an exclusive logging thread. 749719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers static Mutex* logging_lock_ ACQUIRED_AFTER(unexpected_signal_lock_); 750a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi 751a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi // List of mutexes that we expect a thread may hold when accessing weak refs. This is used to 752a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi // avoid a deadlock in the empty checkpoint while weak ref access is disabled (b/34964016). If we 753a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi // encounter an unexpected mutex on accessing weak refs, 754a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi // Thread::CheckEmptyCheckpointFromWeakRefAccess will detect it. 755a222404a5832ab16786931576d52825d08eed3caHiroshi Yamauchi static std::vector<BaseMutex*> expected_mutexes_on_weak_ref_access_; 7568a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi static Atomic<const BaseMutex*> expected_mutexes_on_weak_ref_access_guard_; 7578a433246d0f26f1f8519925ee6fc5cee8fbd0788Hiroshi Yamauchi class ScopedExpectedMutexesOnWeakRefAccessLock; 758719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers}; 759719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers 7604e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartierclass Roles { 7614e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier public: 76290ef3db4bd1d4865f5f9cb95c8e7d9afb46994f9Mathieu Chartier // Uninterruptible means that the thread may not become suspended. 7634e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier static Uninterruptible uninterruptible_; 7644e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier}; 7654e2cb098017bf073335ebb02b1bc0a36828cd720Mathieu Chartier 7668daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes} // namespace art 7678daa0929f08a3080ea64dbd4e997e72f411e6fc9Elliott Hughes 768fc0e3219edc9a5bf81b166e82fd5db2796eb6a0dBrian Carlstrom#endif // ART_RUNTIME_BASE_MUTEX_H_ 769