blob: d46987a8b813c154f07be3b8d8cc1d97f4403ebb [file] [log] [blame]
Elliott Hughes8daa0922011-09-11 13:46:25 -07001/*
2 * Copyright (C) 2011 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
Brian Carlstromfc0e3212013-07-17 14:40:12 -070017#ifndef ART_RUNTIME_THREAD_LIST_H_
18#define ART_RUNTIME_THREAD_LIST_H_
Elliott Hughes8daa0922011-09-11 13:46:25 -070019
Elliott Hughes76b61672012-12-12 17:47:30 -080020#include "base/mutex.h"
Ian Rogersd9c4fc92013-10-01 19:45:43 -070021#include "jni.h"
Mathieu Chartier83c8ee02014-01-28 14:50:23 -080022#include "object_callbacks.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080023
24#include <bitset>
25#include <list>
Elliott Hughes8daa0922011-09-11 13:46:25 -070026
27namespace art {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080028class Closure;
29class Thread;
Mathieu Chartier7664f5c2012-06-08 18:15:32 -070030class TimingLogger;
31
Elliott Hughes8daa0922011-09-11 13:46:25 -070032class ThreadList {
33 public:
34 static const uint32_t kMaxThreadId = 0xFFFF;
Ian Rogersd9c4fc92013-10-01 19:45:43 -070035 static const uint32_t kInvalidThreadId = 0;
36 static const uint32_t kMainThreadId = 1;
Elliott Hughes8daa0922011-09-11 13:46:25 -070037
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -080038 explicit ThreadList();
Elliott Hughes8daa0922011-09-11 13:46:25 -070039 ~ThreadList();
40
Ian Rogers00f7d0e2012-07-19 15:28:27 -070041 void DumpForSigQuit(std::ostream& os)
Ian Rogersb726dcb2012-09-05 08:57:23 -070042 LOCKS_EXCLUDED(Locks::thread_list_lock_)
43 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -070044 void DumpLocked(std::ostream& os) // For thread suspend timeout dumps.
Ian Rogersb726dcb2012-09-05 08:57:23 -070045 EXCLUSIVE_LOCKS_REQUIRED(Locks::thread_list_lock_)
46 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Brian Carlstrom7934ac22013-07-26 10:54:15 -070047 pid_t GetLockOwner(); // For SignalCatcher.
Elliott Hughes8daa0922011-09-11 13:46:25 -070048
Elliott Hughes8d768a92011-09-14 16:35:25 -070049 // Thread suspension support.
Ian Rogers00f7d0e2012-07-19 15:28:27 -070050 void ResumeAll()
Ian Rogersb726dcb2012-09-05 08:57:23 -070051 UNLOCK_FUNCTION(Locks::mutator_lock_)
52 LOCKS_EXCLUDED(Locks::thread_list_lock_,
53 Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -070054 void Resume(Thread* thread, bool for_debugger = false)
Ian Rogersb726dcb2012-09-05 08:57:23 -070055 LOCKS_EXCLUDED(Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -070056
57 // Suspends all threads and gets exclusive access to the mutator_lock_.
58 void SuspendAll()
Ian Rogersb726dcb2012-09-05 08:57:23 -070059 EXCLUSIVE_LOCK_FUNCTION(Locks::mutator_lock_)
60 LOCKS_EXCLUDED(Locks::thread_list_lock_,
61 Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -070062
Ian Rogersd9c4fc92013-10-01 19:45:43 -070063
64 // Suspend a thread using a peer, typically used by the debugger. Returns the thread on success,
65 // else NULL. The peer is used to identify the thread to avoid races with the thread terminating.
66 // If the thread should be suspended then value of request_suspension should be true otherwise
67 // the routine will wait for a previous suspend request. If the suspension times out then *timeout
68 // is set to true.
69 static Thread* SuspendThreadByPeer(jobject peer, bool request_suspension, bool debug_suspension,
70 bool* timed_out)
71 LOCKS_EXCLUDED(Locks::mutator_lock_,
72 Locks::thread_list_lock_,
73 Locks::thread_suspend_count_lock_);
74
75 // Suspend a thread using its thread id, typically used by lock/monitor inflation. Returns the
76 // thread on success else NULL. The thread id is used to identify the thread to avoid races with
77 // the thread terminating. Note that as thread ids are recycled this may not suspend the expected
78 // thread, that may be terminating. If the suspension times out then *timeout is set to true.
79 Thread* SuspendThreadByThreadId(uint32_t thread_id, bool debug_suspension, bool* timed_out)
80 LOCKS_EXCLUDED(Locks::mutator_lock_,
81 Locks::thread_list_lock_,
82 Locks::thread_suspend_count_lock_);
83
84 // Find an already suspended thread (or self) by its id.
85 Thread* FindThreadByThreadId(uint32_t thin_lock_id);
86
Mathieu Chartier858f1c52012-10-17 17:45:55 -070087 // Run a checkpoint on threads, running threads are not suspended but run the checkpoint inside
88 // of the suspend check. Returns how many checkpoints we should expect to run.
Ian Rogers719d1a32014-03-06 12:13:39 -080089 size_t RunCheckpoint(Closure* checkpoint_function)
Mathieu Chartier858f1c52012-10-17 17:45:55 -070090 LOCKS_EXCLUDED(Locks::thread_list_lock_,
91 Locks::thread_suspend_count_lock_);
92
Ian Rogersa03de6d2014-03-08 23:37:07 +000093 size_t RunCheckpointOnRunnableThreads(Closure* checkpoint_function)
94 LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::thread_suspend_count_lock_);
Dave Allison39c3bfb2014-01-28 18:33:52 -080095
Ian Rogers00f7d0e2012-07-19 15:28:27 -070096 // Suspends all threads
97 void SuspendAllForDebugger()
Ian Rogersb726dcb2012-09-05 08:57:23 -070098 LOCKS_EXCLUDED(Locks::mutator_lock_,
99 Locks::thread_list_lock_,
100 Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700101
102 void SuspendSelfForDebugger()
Ian Rogersb726dcb2012-09-05 08:57:23 -0700103 LOCKS_EXCLUDED(Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700104
105 void UndoDebuggerSuspensions()
Ian Rogersb726dcb2012-09-05 08:57:23 -0700106 LOCKS_EXCLUDED(Locks::thread_list_lock_,
107 Locks::thread_suspend_count_lock_);
Elliott Hughes8d768a92011-09-14 16:35:25 -0700108
Elliott Hughesf8349362012-06-18 15:00:06 -0700109 // Iterates over all the threads.
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700110 void ForEach(void (*callback)(Thread*, void*), void* context)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700111 EXCLUSIVE_LOCKS_REQUIRED(Locks::thread_list_lock_);
Elliott Hughes47fce012011-10-25 18:37:19 -0700112
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700113 // Add/remove current thread from list.
114 void Register(Thread* self)
Ian Rogers120f1c72012-09-28 17:17:10 -0700115 EXCLUSIVE_LOCKS_REQUIRED(Locks::runtime_shutdown_lock_)
116 LOCKS_EXCLUDED(Locks::mutator_lock_, Locks::thread_list_lock_);
117 void Unregister(Thread* self) LOCKS_EXCLUDED(Locks::mutator_lock_, Locks::thread_list_lock_);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700118
Mathieu Chartier83c8ee02014-01-28 14:50:23 -0800119 void VisitRoots(RootCallback* callback, void* arg) const
Ian Rogersb726dcb2012-09-05 08:57:23 -0700120 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700121
Mathieu Chartier83c8ee02014-01-28 14:50:23 -0800122 void VerifyRoots(VerifyRootCallback* callback, void* arg) const
Mathieu Chartier6f1c9492012-10-15 12:08:41 -0700123 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
124
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700125 // Return a copy of the thread list.
Ian Rogersb726dcb2012-09-05 08:57:23 -0700126 std::list<Thread*> GetList() EXCLUSIVE_LOCKS_REQUIRED(Locks::thread_list_lock_) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700127 return list_;
128 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700129
Mathieu Chartier590fee92013-09-13 13:46:47 -0700130 void DumpNativeStacks(std::ostream& os)
131 LOCKS_EXCLUDED(Locks::thread_list_lock_);
132
Elliott Hughes8daa0922011-09-11 13:46:25 -0700133 private:
Ian Rogerscfaa4552012-11-26 21:00:08 -0800134 uint32_t AllocThreadId(Thread* self);
Chao-ying Fu9e369312014-05-21 11:20:52 -0700135 void ReleaseThreadId(Thread* self, uint32_t id) LOCKS_EXCLUDED(Locks::allocated_thread_ids_lock_);
Elliott Hughese52e49b2012-04-02 16:05:44 -0700136
Ian Rogersb726dcb2012-09-05 08:57:23 -0700137 bool Contains(Thread* thread) EXCLUSIVE_LOCKS_REQUIRED(Locks::thread_list_lock_);
138 bool Contains(pid_t tid) EXCLUSIVE_LOCKS_REQUIRED(Locks::thread_list_lock_);
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700139
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700140 void DumpUnattachedThreads(std::ostream& os)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700141 LOCKS_EXCLUDED(Locks::thread_list_lock_);
Elliott Hughese52e49b2012-04-02 16:05:44 -0700142
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700143 void SuspendAllDaemonThreads()
Ian Rogersb726dcb2012-09-05 08:57:23 -0700144 LOCKS_EXCLUDED(Locks::thread_list_lock_,
145 Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700146 void WaitForOtherNonDaemonThreadsToExit()
Ian Rogersb726dcb2012-09-05 08:57:23 -0700147 LOCKS_EXCLUDED(Locks::thread_list_lock_,
148 Locks::thread_suspend_count_lock_);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700149
Ian Rogers50b35e22012-10-04 10:09:15 -0700150 void AssertThreadsAreSuspended(Thread* self, Thread* ignore1, Thread* ignore2 = NULL)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700151 LOCKS_EXCLUDED(Locks::thread_list_lock_,
152 Locks::thread_suspend_count_lock_);
Elliott Hughes234ab152011-10-26 14:02:26 -0700153
Chao-ying Fu9e369312014-05-21 11:20:52 -0700154 std::bitset<kMaxThreadId> allocated_ids_ GUARDED_BY(Locks::allocated_thread_ids_lock_);
Elliott Hughese52e49b2012-04-02 16:05:44 -0700155
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700156 // The actual list of all threads.
Ian Rogersb726dcb2012-09-05 08:57:23 -0700157 std::list<Thread*> list_ GUARDED_BY(Locks::thread_list_lock_);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700158
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700159 // Ongoing suspend all requests, used to ensure threads added to list_ respect SuspendAll.
Ian Rogersb726dcb2012-09-05 08:57:23 -0700160 int suspend_all_count_ GUARDED_BY(Locks::thread_suspend_count_lock_);
161 int debug_suspend_all_count_ GUARDED_BY(Locks::thread_suspend_count_lock_);
Elliott Hughes8d768a92011-09-14 16:35:25 -0700162
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700163 // Signaled when threads terminate. Used to determine when all non-daemons have terminated.
Ian Rogersb726dcb2012-09-05 08:57:23 -0700164 ConditionVariable thread_exit_cond_ GUARDED_BY(Locks::thread_list_lock_);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700165
Elliott Hughes8daa0922011-09-11 13:46:25 -0700166 friend class Thread;
Elliott Hughes8daa0922011-09-11 13:46:25 -0700167
168 DISALLOW_COPY_AND_ASSIGN(ThreadList);
169};
170
Elliott Hughes8daa0922011-09-11 13:46:25 -0700171} // namespace art
172
Brian Carlstromfc0e3212013-07-17 14:40:12 -0700173#endif // ART_RUNTIME_THREAD_LIST_H_