1 /*
2  * Copyright (C) 2013 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 
17 #ifndef ART_RUNTIME_THREAD_STATE_H_
18 #define ART_RUNTIME_THREAD_STATE_H_
19 
20 #include <iosfwd>
21 
22 namespace art {
23 
24 // State stored in our C++ class Thread.
25 // When we refer to "a suspended state", or when function names mention "ToSuspended" or
26 // "FromSuspended", we mean any state other than kRunnable, i.e. any state in which the thread is
27 // guaranteed not to access the Java heap. The kSuspended state is merely one of these.
28 enum ThreadState {
29   //                                   Java
30   //                                   Thread.State   JDWP state
31   kTerminated = 66,                 // TERMINATED     TS_ZOMBIE    Thread.run has returned, but Thread* still around
32   kRunnable,                        // RUNNABLE       TS_RUNNING   runnable
33   kTimedWaiting,                    // TIMED_WAITING  TS_WAIT      in Object.wait() with a timeout
34   kSleeping,                        // TIMED_WAITING  TS_SLEEPING  in Thread.sleep()
35   kBlocked,                         // BLOCKED        TS_MONITOR   blocked on a monitor
36   kWaiting,                         // WAITING        TS_WAIT      in Object.wait()
37   kWaitingForLockInflation,         // WAITING        TS_WAIT      blocked inflating a thin-lock
38   kWaitingForTaskProcessor,         // WAITING        TS_WAIT      blocked waiting for taskProcessor
39   kWaitingForGcToComplete,          // WAITING        TS_WAIT      blocked waiting for GC
40   kWaitingForCheckPointsToRun,      // WAITING        TS_WAIT      GC waiting for checkpoints to run
41   kWaitingPerformingGc,             // WAITING        TS_WAIT      performing GC
42   kWaitingForDebuggerSend,          // WAITING        TS_WAIT      blocked waiting for events to be sent
43   kWaitingForDebuggerToAttach,      // WAITING        TS_WAIT      blocked waiting for debugger to attach
44   kWaitingInMainDebuggerLoop,       // WAITING        TS_WAIT      blocking/reading/processing debugger events
45   kWaitingForDebuggerSuspension,    // WAITING        TS_WAIT      waiting for debugger suspend all
46   kWaitingForJniOnLoad,             // WAITING        TS_WAIT      waiting for execution of dlopen and JNI on load code
47   kWaitingForSignalCatcherOutput,   // WAITING        TS_WAIT      waiting for signal catcher IO to complete
48   kWaitingInMainSignalCatcherLoop,  // WAITING        TS_WAIT      blocking/reading/processing signals
49   kWaitingForDeoptimization,        // WAITING        TS_WAIT      waiting for deoptimization suspend all
50   kWaitingForMethodTracingStart,    // WAITING        TS_WAIT      waiting for method tracing to start
51   kWaitingForVisitObjects,          // WAITING        TS_WAIT      waiting for visiting objects
52   kWaitingForGetObjectsAllocated,   // WAITING        TS_WAIT      waiting for getting the number of allocated objects
53   kWaitingWeakGcRootRead,           // WAITING        TS_WAIT      waiting on the GC to read a weak root
54   kWaitingForGcThreadFlip,          // WAITING        TS_WAIT      waiting on the GC thread flip (CC collector) to finish
55   kNativeForAbort,                  // WAITING        TS_WAIT      checking other threads are not run on abort.
56   kStarting,                        // NEW            TS_WAIT      native thread started, not yet ready to run managed code
57   kNative,                          // RUNNABLE       TS_RUNNING   running in a JNI native method
58   kSuspended,                       // RUNNABLE       TS_RUNNING   suspended by GC or debugger
59 };
60 std::ostream& operator<<(std::ostream& os, ThreadState rhs);
61 
62 }  // namespace art
63 
64 #endif  // ART_RUNTIME_THREAD_STATE_H_
65