blob: d72ff73d4fe59f3a2888463787374bbd57af2fd6 [file] [log] [blame]
Elliott Hughes5f791332011-09-15 17:45:30 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Elliott Hughes54e7df12011-09-16 11:47:04 -070017#ifndef ART_SRC_MONITOR_H_
18#define ART_SRC_MONITOR_H_
Elliott Hughes5f791332011-09-15 17:45:30 -070019
20#include <pthread.h>
21#include <stdint.h>
22
Elliott Hughes8e4aac52011-09-26 17:03:36 -070023#include <iosfwd>
Elliott Hughesc33a32b2011-10-11 18:18:07 -070024#include <list>
Elliott Hughes8e4aac52011-09-26 17:03:36 -070025
Elliott Hughesc33a32b2011-10-11 18:18:07 -070026#include "heap.h"
Elliott Hughes5f791332011-09-15 17:45:30 -070027#include "mutex.h"
28
29namespace art {
30
31/*
32 * Monitor shape field. Used to distinguish thin locks from fat locks.
33 */
34#define LW_SHAPE_THIN 0
35#define LW_SHAPE_FAT 1
36#define LW_SHAPE_MASK 0x1
37#define LW_SHAPE(x) ((x) & LW_SHAPE_MASK)
38
39/*
40 * Hash state field. Used to signify that an object has had its
41 * identity hash code exposed or relocated.
42 */
43#define LW_HASH_STATE_UNHASHED 0
44#define LW_HASH_STATE_HASHED 1
45#define LW_HASH_STATE_HASHED_AND_MOVED 3
46#define LW_HASH_STATE_MASK 0x3
47#define LW_HASH_STATE_SHIFT 1
48#define LW_HASH_STATE(x) (((x) >> LW_HASH_STATE_SHIFT) & LW_HASH_STATE_MASK)
49
50/*
Elliott Hughes5f791332011-09-15 17:45:30 -070051 * Lock owner field. Contains the thread id of the thread currently
52 * holding the lock.
53 */
54#define LW_LOCK_OWNER_MASK 0xffff
55#define LW_LOCK_OWNER_SHIFT 3
56#define LW_LOCK_OWNER(x) (((x) >> LW_LOCK_OWNER_SHIFT) & LW_LOCK_OWNER_MASK)
57
jeffhao33dc7712011-11-09 17:54:24 -080058class Method;
Elliott Hughes54e7df12011-09-16 11:47:04 -070059class Object;
60class Thread;
Elliott Hughes08fc03a2012-06-26 17:34:00 -070061class StackVisitor;
Elliott Hughes5f791332011-09-15 17:45:30 -070062
63class Monitor {
64 public:
65 ~Monitor();
66
Elliott Hughesfc861622011-10-17 17:57:47 -070067 static bool IsSensitiveThread();
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -080068 static void Init(uint32_t lock_profiling_threshold, bool (*is_sensitive_thread_hook)());
Elliott Hughes32d6e1e2011-10-11 14:47:44 -070069
Brian Carlstrom24a3c2e2011-10-17 18:07:52 -070070 static uint32_t GetThinLockId(uint32_t raw_lock_word);
Elliott Hughes5f791332011-09-15 17:45:30 -070071
72 static void MonitorEnter(Thread* thread, Object* obj);
73 static bool MonitorExit(Thread* thread, Object* obj);
74
75 static void Notify(Thread* self, Object* obj);
76 static void NotifyAll(Thread* self, Object* obj);
77 static void Wait(Thread* self, Object* obj, int64_t ms, int32_t ns, bool interruptShouldThrow);
78
Elliott Hughes8e4aac52011-09-26 17:03:36 -070079 static void DescribeWait(std::ostream& os, const Thread* thread);
Elliott Hughes08fc03a2012-06-26 17:34:00 -070080 static void DescribeLocks(std::ostream& os, StackVisitor* stack_visitor);
Elliott Hughes8e4aac52011-09-26 17:03:36 -070081
Elliott Hughesc33a32b2011-10-11 18:18:07 -070082 Object* GetObject();
83
Elliott Hughes5f791332011-09-15 17:45:30 -070084 private:
Elliott Hughesa51a3dd2011-10-17 15:19:26 -070085 explicit Monitor(Object* obj);
Elliott Hughes5f791332011-09-15 17:45:30 -070086
87 void AppendToWaitSet(Thread* thread);
88 void RemoveFromWaitSet(Thread* thread);
89
90 static void Inflate(Thread* self, Object* obj);
91
Elliott Hughesfc861622011-10-17 17:57:47 -070092 void LogContentionEvent(Thread* self, uint32_t wait_ms, uint32_t sample_percent, const char* owner_filename, uint32_t owner_line_number);
93
Ian Rogers6d0b13e2012-02-07 09:25:29 -080094 static void FailedUnlock(Object* obj, Thread* expected_owner, Thread* found_owner, Monitor* mon);
95
Elliott Hughesf8349362012-06-18 15:00:06 -070096 void Lock(Thread* self) NO_THREAD_SAFETY_ANALYSIS; // TODO: mark Object LOCKABLE.
97 bool Unlock(Thread* thread) NO_THREAD_SAFETY_ANALYSIS; // TODO: mark Object LOCKABLE.
Elliott Hughes5f791332011-09-15 17:45:30 -070098
99 void Notify(Thread* self);
100 void NotifyAll(Thread* self);
101
Elliott Hughesf8349362012-06-18 15:00:06 -0700102 void Wait(Thread* self, int64_t msec, int32_t nsec, bool interruptShouldThrow) NO_THREAD_SAFETY_ANALYSIS; // TODO: mark Object LOCKABLE.
Elliott Hughes5f791332011-09-15 17:45:30 -0700103
jeffhao33dc7712011-11-09 17:54:24 -0800104 // Translates the provided method and pc into its declaring class' source file and line number.
105 void TranslateLocation(const Method* method, uint32_t pc,
106 const char*& source_file, uint32_t& line_number) const;
107
Elliott Hughesfc861622011-10-17 17:57:47 -0700108 static bool (*is_sensitive_thread_hook_)();
Elliott Hughesfc861622011-10-17 17:57:47 -0700109 static uint32_t lock_profiling_threshold_;
Elliott Hughes32d6e1e2011-10-11 14:47:44 -0700110
Brian Carlstrom4514d3c2011-10-21 17:01:31 -0700111 // Which thread currently owns the lock?
Ian Rogers6d0b13e2012-02-07 09:25:29 -0800112 Thread* volatile owner_;
Elliott Hughes5f791332011-09-15 17:45:30 -0700113
Brian Carlstrom4514d3c2011-10-21 17:01:31 -0700114 // Owner's recursive lock depth.
Elliott Hughes5f791332011-09-15 17:45:30 -0700115 int lock_count_;
116
Brian Carlstrom4514d3c2011-10-21 17:01:31 -0700117 // What object are we part of (for debugging).
Ian Rogers6d0b13e2012-02-07 09:25:29 -0800118 Object* const obj_;
Elliott Hughes5f791332011-09-15 17:45:30 -0700119
Brian Carlstrom4514d3c2011-10-21 17:01:31 -0700120 // Threads currently waiting on this monitor.
Elliott Hughes5f791332011-09-15 17:45:30 -0700121 Thread* wait_set_;
122
123 Mutex lock_;
124
Ian Rogers0399dde2012-06-06 17:09:28 -0700125 // Method and dex pc where the lock owner acquired the lock, used when lock
jeffhao33dc7712011-11-09 17:54:24 -0800126 // sampling is enabled. locking_method_ may be null if the lock is currently
127 // unlocked, or if the lock is acquired by the system when the stack is empty.
128 const Method* locking_method_;
Ian Rogers0399dde2012-06-06 17:09:28 -0700129 uint32_t locking_dex_pc_;
Elliott Hughes5f791332011-09-15 17:45:30 -0700130
Brian Carlstrom4514d3c2011-10-21 17:01:31 -0700131 friend class MonitorList;
Elliott Hughes5f791332011-09-15 17:45:30 -0700132 friend class Object;
Elliott Hughesc33a32b2011-10-11 18:18:07 -0700133 DISALLOW_COPY_AND_ASSIGN(Monitor);
134};
135
136class MonitorList {
137 public:
138 MonitorList();
139 ~MonitorList();
140
141 void Add(Monitor* m);
142
143 void SweepMonitorList(Heap::IsMarkedTester is_marked, void* arg);
144
145 private:
146 Mutex lock_;
147 std::list<Monitor*> list_;
148
149 DISALLOW_COPY_AND_ASSIGN(MonitorList);
Elliott Hughes5f791332011-09-15 17:45:30 -0700150};
151
Elliott Hughes5f791332011-09-15 17:45:30 -0700152} // namespace art
153
Elliott Hughes54e7df12011-09-16 11:47:04 -0700154#endif // ART_SRC_MONITOR_H_