1 /*
2 * Copyright (C) 2012 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_SCOPED_THREAD_STATE_CHANGE_INL_H_
18 #define ART_RUNTIME_SCOPED_THREAD_STATE_CHANGE_INL_H_
19
20 #include "scoped_thread_state_change.h"
21
22 #include <android-base/logging.h>
23
24 #include "base/casts.h"
25 #include "jni_env_ext-inl.h"
26 #include "obj_ptr-inl.h"
27 #include "runtime.h"
28 #include "thread-inl.h"
29
30 namespace art {
31
ScopedThreadStateChange(Thread * self,ThreadState new_thread_state)32 inline ScopedThreadStateChange::ScopedThreadStateChange(Thread* self, ThreadState new_thread_state)
33 : self_(self), thread_state_(new_thread_state), expected_has_no_thread_(false) {
34 if (UNLIKELY(self_ == nullptr)) {
35 // Value chosen arbitrarily and won't be used in the destructor since thread_ == null.
36 old_thread_state_ = kTerminated;
37 Runtime* runtime = Runtime::Current();
38 CHECK(runtime == nullptr || !runtime->IsStarted() || runtime->IsShuttingDown(self_));
39 } else {
40 DCHECK_EQ(self, Thread::Current());
41 // Read state without locks, ok as state is effectively thread local and we're not interested
42 // in the suspend count (this will be handled in the runnable transitions).
43 old_thread_state_ = self->GetState();
44 if (old_thread_state_ != new_thread_state) {
45 if (new_thread_state == kRunnable) {
46 self_->TransitionFromSuspendedToRunnable();
47 } else if (old_thread_state_ == kRunnable) {
48 self_->TransitionFromRunnableToSuspended(new_thread_state);
49 } else {
50 // A suspended transition to another effectively suspended transition, ok to use Unsafe.
51 self_->SetState(new_thread_state);
52 }
53 }
54 }
55 }
56
~ScopedThreadStateChange()57 inline ScopedThreadStateChange::~ScopedThreadStateChange() {
58 if (UNLIKELY(self_ == nullptr)) {
59 if (!expected_has_no_thread_) {
60 Runtime* runtime = Runtime::Current();
61 bool shutting_down = (runtime == nullptr) || runtime->IsShuttingDown(nullptr);
62 CHECK(shutting_down);
63 }
64 } else {
65 if (old_thread_state_ != thread_state_) {
66 if (old_thread_state_ == kRunnable) {
67 self_->TransitionFromSuspendedToRunnable();
68 } else if (thread_state_ == kRunnable) {
69 self_->TransitionFromRunnableToSuspended(old_thread_state_);
70 } else {
71 // A suspended transition to another effectively suspended transition, ok to use Unsafe.
72 self_->SetState(old_thread_state_);
73 }
74 }
75 }
76 }
77
78 template<typename T>
AddLocalReference(ObjPtr<mirror::Object> obj)79 inline T ScopedObjectAccessAlreadyRunnable::AddLocalReference(ObjPtr<mirror::Object> obj) const {
80 Locks::mutator_lock_->AssertSharedHeld(Self());
81 if (kIsDebugBuild) {
82 CHECK(IsRunnable()); // Don't work with raw objects in non-runnable states.
83 DCheckObjIsNotClearedJniWeakGlobal(obj);
84 }
85 return obj == nullptr ? nullptr : Env()->AddLocalReference<T>(obj);
86 }
87
88 template<typename T>
Decode(jobject obj)89 inline ObjPtr<T> ScopedObjectAccessAlreadyRunnable::Decode(jobject obj) const {
90 Locks::mutator_lock_->AssertSharedHeld(Self());
91 DCHECK(IsRunnable()); // Don't work with raw objects in non-runnable states.
92 return ObjPtr<T>::DownCast(Self()->DecodeJObject(obj));
93 }
94
IsRunnable()95 inline bool ScopedObjectAccessAlreadyRunnable::IsRunnable() const {
96 return self_->GetState() == kRunnable;
97 }
98
ScopedObjectAccessAlreadyRunnable(JNIEnv * env)99 inline ScopedObjectAccessAlreadyRunnable::ScopedObjectAccessAlreadyRunnable(JNIEnv* env)
100 : self_(ThreadForEnv(env)), env_(down_cast<JNIEnvExt*>(env)), vm_(env_->GetVm()) {}
101
ScopedObjectAccessAlreadyRunnable(Thread * self)102 inline ScopedObjectAccessAlreadyRunnable::ScopedObjectAccessAlreadyRunnable(Thread* self)
103 : self_(self),
104 env_(down_cast<JNIEnvExt*>(self->GetJniEnv())),
105 vm_(env_ != nullptr ? env_->GetVm() : nullptr) {}
106
ScopedObjectAccessUnchecked(JNIEnv * env)107 inline ScopedObjectAccessUnchecked::ScopedObjectAccessUnchecked(JNIEnv* env)
108 : ScopedObjectAccessAlreadyRunnable(env), tsc_(Self(), kRunnable) {
109 Self()->VerifyStack();
110 Locks::mutator_lock_->AssertSharedHeld(Self());
111 }
112
ScopedObjectAccessUnchecked(Thread * self)113 inline ScopedObjectAccessUnchecked::ScopedObjectAccessUnchecked(Thread* self)
114 : ScopedObjectAccessAlreadyRunnable(self), tsc_(self, kRunnable) {
115 Self()->VerifyStack();
116 Locks::mutator_lock_->AssertSharedHeld(Self());
117 }
118
ScopedObjectAccess(JNIEnv * env)119 inline ScopedObjectAccess::ScopedObjectAccess(JNIEnv* env) : ScopedObjectAccessUnchecked(env) {}
ScopedObjectAccess(Thread * self)120 inline ScopedObjectAccess::ScopedObjectAccess(Thread* self) : ScopedObjectAccessUnchecked(self) {}
~ScopedObjectAccess()121 inline ScopedObjectAccess::~ScopedObjectAccess() {}
122
ScopedThreadSuspension(Thread * self,ThreadState suspended_state)123 inline ScopedThreadSuspension::ScopedThreadSuspension(Thread* self, ThreadState suspended_state)
124 : self_(self), suspended_state_(suspended_state) {
125 DCHECK(self_ != nullptr);
126 self_->TransitionFromRunnableToSuspended(suspended_state);
127 }
128
~ScopedThreadSuspension()129 inline ScopedThreadSuspension::~ScopedThreadSuspension() {
130 DCHECK_EQ(self_->GetState(), suspended_state_);
131 self_->TransitionFromSuspendedToRunnable();
132 }
133
134 } // namespace art
135
136 #endif // ART_RUNTIME_SCOPED_THREAD_STATE_CHANGE_INL_H_
137