jeffhao | 725a957 | 2012-11-13 18:20:12 -0800 | [diff] [blame] | 1 | /* |
| 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 Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 17 | #ifndef ART_RUNTIME_INSTRUMENTATION_H_ |
| 18 | #define ART_RUNTIME_INSTRUMENTATION_H_ |
jeffhao | 725a957 | 2012-11-13 18:20:12 -0800 | [diff] [blame] | 19 | |
Ian Rogers | 576ca0c | 2014-06-06 15:58:22 -0700 | [diff] [blame] | 20 | #include <stdint.h> |
Ian Rogers | 576ca0c | 2014-06-06 15:58:22 -0700 | [diff] [blame] | 21 | #include <list> |
Hiroshi Yamauchi | 799eb3a | 2014-07-18 15:38:17 -0700 | [diff] [blame] | 22 | #include <map> |
Ian Rogers | 576ca0c | 2014-06-06 15:58:22 -0700 | [diff] [blame] | 23 | |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 24 | #include "atomic.h" |
Andreas Gampe | d58342c | 2014-06-05 14:18:08 -0700 | [diff] [blame] | 25 | #include "instruction_set.h" |
Elliott Hughes | 7616005 | 2012-12-12 16:31:20 -0800 | [diff] [blame] | 26 | #include "base/macros.h" |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 27 | #include "base/mutex.h" |
Hiroshi Yamauchi | 94f7b49 | 2014-07-22 18:08:23 -0700 | [diff] [blame] | 28 | #include "gc_root.h" |
Mathieu Chartier | 3b05e9b | 2014-03-25 09:29:43 -0700 | [diff] [blame] | 29 | #include "object_callbacks.h" |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 30 | |
jeffhao | 725a957 | 2012-11-13 18:20:12 -0800 | [diff] [blame] | 31 | namespace art { |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 32 | namespace mirror { |
Sebastien Hertz | 3f52eaf | 2014-04-04 17:50:18 +0200 | [diff] [blame] | 33 | class ArtField; |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 34 | class ArtMethod; |
| 35 | class Class; |
| 36 | class Object; |
| 37 | class Throwable; |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 38 | } // namespace mirror |
| 39 | union JValue; |
jeffhao | 725a957 | 2012-11-13 18:20:12 -0800 | [diff] [blame] | 40 | class Thread; |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 41 | class ThrowLocation; |
jeffhao | 725a957 | 2012-11-13 18:20:12 -0800 | [diff] [blame] | 42 | |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 43 | namespace instrumentation { |
jeffhao | 725a957 | 2012-11-13 18:20:12 -0800 | [diff] [blame] | 44 | |
Sebastien Hertz | ee1997a | 2013-09-19 14:47:09 +0200 | [diff] [blame] | 45 | // Interpreter handler tables. |
| 46 | enum InterpreterHandlerTable { |
| 47 | kMainHandlerTable = 0, // Main handler table: no suspend check, no instrumentation. |
| 48 | kAlternativeHandlerTable = 1, // Alternative handler table: suspend check and/or instrumentation |
| 49 | // enabled. |
| 50 | kNumHandlerTables |
| 51 | }; |
| 52 | |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 53 | // Instrumentation event listener API. Registered listeners will get the appropriate call back for |
| 54 | // the events they are listening for. The call backs supply the thread, method and dex_pc the event |
| 55 | // occurred upon. The thread may or may not be Thread::Current(). |
| 56 | struct InstrumentationListener { |
| 57 | InstrumentationListener() {} |
| 58 | virtual ~InstrumentationListener() {} |
| 59 | |
| 60 | // Call-back for when a method is entered. |
| 61 | virtual void MethodEntered(Thread* thread, mirror::Object* this_object, |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 62 | mirror::ArtMethod* method, |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 63 | uint32_t dex_pc) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0; |
| 64 | |
| 65 | // Call-back for when a method is exited. |
| 66 | // TODO: its likely passing the return value would be useful, however, we may need to get and |
| 67 | // parse the shorty to determine what kind of register holds the result. |
| 68 | virtual void MethodExited(Thread* thread, mirror::Object* this_object, |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 69 | mirror::ArtMethod* method, uint32_t dex_pc, |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 70 | const JValue& return_value) |
| 71 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0; |
| 72 | |
| 73 | // Call-back for when a method is popped due to an exception throw. A method will either cause a |
| 74 | // MethodExited call-back or a MethodUnwind call-back when its activation is removed. |
Sebastien Hertz | 51db44a | 2013-11-19 10:00:29 +0100 | [diff] [blame] | 75 | virtual void MethodUnwind(Thread* thread, mirror::Object* this_object, |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 76 | mirror::ArtMethod* method, uint32_t dex_pc) |
Sebastien Hertz | 51db44a | 2013-11-19 10:00:29 +0100 | [diff] [blame] | 77 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0; |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 78 | |
| 79 | // Call-back for when the dex pc moves in a method. |
| 80 | virtual void DexPcMoved(Thread* thread, mirror::Object* this_object, |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 81 | mirror::ArtMethod* method, uint32_t new_dex_pc) |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 82 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0; |
| 83 | |
Sebastien Hertz | 3f52eaf | 2014-04-04 17:50:18 +0200 | [diff] [blame] | 84 | // Call-back for when we read from a field. |
| 85 | virtual void FieldRead(Thread* thread, mirror::Object* this_object, mirror::ArtMethod* method, |
| 86 | uint32_t dex_pc, mirror::ArtField* field) = 0; |
| 87 | |
| 88 | // Call-back for when we write into a field. |
| 89 | virtual void FieldWritten(Thread* thread, mirror::Object* this_object, mirror::ArtMethod* method, |
| 90 | uint32_t dex_pc, mirror::ArtField* field, const JValue& field_value) = 0; |
| 91 | |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 92 | // Call-back when an exception is caught. |
| 93 | virtual void ExceptionCaught(Thread* thread, const ThrowLocation& throw_location, |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 94 | mirror::ArtMethod* catch_method, uint32_t catch_dex_pc, |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 95 | mirror::Throwable* exception_object) |
| 96 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0; |
jeffhao | 725a957 | 2012-11-13 18:20:12 -0800 | [diff] [blame] | 97 | }; |
| 98 | |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 99 | // Instrumentation is a catch-all for when extra information is required from the runtime. The |
| 100 | // typical use for instrumentation is for profiling and debugging. Instrumentation may add stubs |
| 101 | // to method entry and exit, it may also force execution to be switched to the interpreter and |
| 102 | // trigger deoptimization. |
jeffhao | 725a957 | 2012-11-13 18:20:12 -0800 | [diff] [blame] | 103 | class Instrumentation { |
| 104 | public: |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 105 | enum InstrumentationEvent { |
Sebastien Hertz | 3f52eaf | 2014-04-04 17:50:18 +0200 | [diff] [blame] | 106 | kMethodEntered = 1 << 0, |
| 107 | kMethodExited = 1 << 1, |
| 108 | kMethodUnwind = 1 << 2, |
| 109 | kDexPcMoved = 1 << 3, |
| 110 | kFieldRead = 1 << 4, |
| 111 | kFieldWritten = 1 << 5, |
| 112 | kExceptionCaught = 1 << 6, |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 113 | }; |
jeffhao | 725a957 | 2012-11-13 18:20:12 -0800 | [diff] [blame] | 114 | |
Mathieu Chartier | 3b05e9b | 2014-03-25 09:29:43 -0700 | [diff] [blame] | 115 | Instrumentation(); |
jeffhao | 725a957 | 2012-11-13 18:20:12 -0800 | [diff] [blame] | 116 | |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 117 | // Add a listener to be notified of the masked together sent of instrumentation events. This |
| 118 | // suspend the runtime to install stubs. You are expected to hold the mutator lock as a proxy |
| 119 | // for saying you should have suspended all threads (installing stubs while threads are running |
| 120 | // will break). |
| 121 | void AddListener(InstrumentationListener* listener, uint32_t events) |
| 122 | EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 123 | LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_); |
jeffhao | 725a957 | 2012-11-13 18:20:12 -0800 | [diff] [blame] | 124 | |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 125 | // Removes a listener possibly removing instrumentation stubs. |
| 126 | void RemoveListener(InstrumentationListener* listener, uint32_t events) |
| 127 | EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 128 | LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_); |
jeffhao | 725a957 | 2012-11-13 18:20:12 -0800 | [diff] [blame] | 129 | |
Sebastien Hertz | 138dbfc | 2013-12-04 18:15:25 +0100 | [diff] [blame] | 130 | // Deoptimization. |
Sebastien Hertz | a76a6d4 | 2014-03-20 16:40:17 +0100 | [diff] [blame] | 131 | void EnableDeoptimization() |
| 132 | EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_) |
Mathieu Chartier | 3b05e9b | 2014-03-25 09:29:43 -0700 | [diff] [blame] | 133 | LOCKS_EXCLUDED(deoptimized_methods_lock_); |
Sebastien Hertz | a76a6d4 | 2014-03-20 16:40:17 +0100 | [diff] [blame] | 134 | void DisableDeoptimization() |
| 135 | EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_) |
Sebastien Hertz | 4d25df3 | 2014-03-21 17:44:46 +0100 | [diff] [blame] | 136 | LOCKS_EXCLUDED(deoptimized_methods_lock_); |
Sebastien Hertz | a76a6d4 | 2014-03-20 16:40:17 +0100 | [diff] [blame] | 137 | bool AreAllMethodsDeoptimized() const { |
| 138 | return interpreter_stubs_installed_; |
| 139 | } |
Sebastien Hertz | 11d40c2 | 2014-02-19 18:00:17 +0100 | [diff] [blame] | 140 | bool ShouldNotifyMethodEnterExitEvents() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Sebastien Hertz | 138dbfc | 2013-12-04 18:15:25 +0100 | [diff] [blame] | 141 | |
| 142 | // Executes everything with interpreter. |
| 143 | void DeoptimizeEverything() |
| 144 | EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 145 | LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_); |
| 146 | |
| 147 | // Executes everything with compiled code (or interpreter if there is no code). |
| 148 | void UndeoptimizeEverything() |
| 149 | EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 150 | LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_); |
| 151 | |
| 152 | // Deoptimize a method by forcing its execution with the interpreter. Nevertheless, a static |
| 153 | // method (except a class initializer) set to the resolution trampoline will be deoptimized only |
| 154 | // once its declaring class is initialized. |
| 155 | void Deoptimize(mirror::ArtMethod* method) |
Mathieu Chartier | 3b05e9b | 2014-03-25 09:29:43 -0700 | [diff] [blame] | 156 | LOCKS_EXCLUDED(Locks::thread_list_lock_, deoptimized_methods_lock_) |
Sebastien Hertz | 138dbfc | 2013-12-04 18:15:25 +0100 | [diff] [blame] | 157 | EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 158 | |
| 159 | // Undeoptimze the method by restoring its entrypoints. Nevertheless, a static method |
| 160 | // (except a class initializer) set to the resolution trampoline will be updated only once its |
| 161 | // declaring class is initialized. |
| 162 | void Undeoptimize(mirror::ArtMethod* method) |
Sebastien Hertz | 4d25df3 | 2014-03-21 17:44:46 +0100 | [diff] [blame] | 163 | LOCKS_EXCLUDED(Locks::thread_list_lock_, deoptimized_methods_lock_) |
Sebastien Hertz | 138dbfc | 2013-12-04 18:15:25 +0100 | [diff] [blame] | 164 | EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 165 | |
Hiroshi Yamauchi | 799eb3a | 2014-07-18 15:38:17 -0700 | [diff] [blame] | 166 | bool IsDeoptimized(mirror::ArtMethod* method) |
| 167 | LOCKS_EXCLUDED(deoptimized_methods_lock_) |
| 168 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Sebastien Hertz | 138dbfc | 2013-12-04 18:15:25 +0100 | [diff] [blame] | 169 | |
| 170 | // Enable method tracing by installing instrumentation entry/exit stubs. |
| 171 | void EnableMethodTracing() |
| 172 | EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 173 | LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_); |
| 174 | |
| 175 | // Disable method tracing by uninstalling instrumentation entry/exit stubs. |
| 176 | void DisableMethodTracing() |
| 177 | EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 178 | LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_); |
| 179 | |
Sebastien Hertz | ed2be17 | 2014-08-19 15:33:43 +0200 | [diff] [blame^] | 180 | InterpreterHandlerTable GetInterpreterHandlerTable() const |
| 181 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { |
Sebastien Hertz | ee1997a | 2013-09-19 14:47:09 +0200 | [diff] [blame] | 182 | return interpreter_handler_table_; |
| 183 | } |
| 184 | |
Mathieu Chartier | d889178 | 2014-03-02 13:28:37 -0800 | [diff] [blame] | 185 | void InstrumentQuickAllocEntryPoints() LOCKS_EXCLUDED(Locks::thread_list_lock_, |
| 186 | Locks::runtime_shutdown_lock_); |
| 187 | void UninstrumentQuickAllocEntryPoints() LOCKS_EXCLUDED(Locks::thread_list_lock_, |
| 188 | Locks::runtime_shutdown_lock_); |
| 189 | void ResetQuickAllocEntryPoints() EXCLUSIVE_LOCKS_REQUIRED(Locks::runtime_shutdown_lock_); |
Ian Rogers | fa82427 | 2013-11-05 16:12:57 -0800 | [diff] [blame] | 190 | |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 191 | // Update the code of a method respecting any installed stubs. |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 192 | void UpdateMethodsCode(mirror::ArtMethod* method, const void* quick_code, |
Hiroshi Yamauchi | 799eb3a | 2014-07-18 15:38:17 -0700 | [diff] [blame] | 193 | const void* portable_code, bool have_portable_code) |
Sebastien Hertz | 138dbfc | 2013-12-04 18:15:25 +0100 | [diff] [blame] | 194 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 195 | |
| 196 | // Get the quick code for the given method. More efficient than asking the class linker as it |
| 197 | // will short-cut to GetCode if instrumentation and static method resolution stubs aren't |
| 198 | // installed. |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 199 | const void* GetQuickCodeFor(mirror::ArtMethod* method) const |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 200 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 201 | |
| 202 | void ForceInterpretOnly() { |
| 203 | interpret_only_ = true; |
| 204 | forced_interpret_only_ = true; |
| 205 | } |
| 206 | |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 207 | // Called by ArtMethod::Invoke to determine dispatch mechanism. |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 208 | bool InterpretOnly() const { |
| 209 | return interpret_only_; |
| 210 | } |
| 211 | |
Hiroshi Yamauchi | 563b47c | 2014-02-28 17:18:37 -0800 | [diff] [blame] | 212 | bool IsForcedInterpretOnly() const { |
| 213 | return forced_interpret_only_; |
| 214 | } |
| 215 | |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 216 | bool ShouldPortableCodeDeoptimize() const { |
| 217 | return instrumentation_stubs_installed_; |
| 218 | } |
| 219 | |
| 220 | bool AreExitStubsInstalled() const { |
| 221 | return instrumentation_stubs_installed_; |
| 222 | } |
| 223 | |
Sebastien Hertz | ed2be17 | 2014-08-19 15:33:43 +0200 | [diff] [blame^] | 224 | bool HasMethodEntryListeners() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { |
Sebastien Hertz | 74109f6 | 2013-06-07 17:40:09 +0200 | [diff] [blame] | 225 | return have_method_entry_listeners_; |
| 226 | } |
| 227 | |
Sebastien Hertz | ed2be17 | 2014-08-19 15:33:43 +0200 | [diff] [blame^] | 228 | bool HasMethodExitListeners() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { |
Sebastien Hertz | 74109f6 | 2013-06-07 17:40:09 +0200 | [diff] [blame] | 229 | return have_method_exit_listeners_; |
| 230 | } |
| 231 | |
Sebastien Hertz | ed2be17 | 2014-08-19 15:33:43 +0200 | [diff] [blame^] | 232 | bool HasDexPcListeners() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { |
Sebastien Hertz | 74109f6 | 2013-06-07 17:40:09 +0200 | [diff] [blame] | 233 | return have_dex_pc_listeners_; |
| 234 | } |
| 235 | |
Sebastien Hertz | ed2be17 | 2014-08-19 15:33:43 +0200 | [diff] [blame^] | 236 | bool HasFieldReadListeners() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { |
Sebastien Hertz | 3f52eaf | 2014-04-04 17:50:18 +0200 | [diff] [blame] | 237 | return have_field_read_listeners_; |
| 238 | } |
| 239 | |
Sebastien Hertz | ed2be17 | 2014-08-19 15:33:43 +0200 | [diff] [blame^] | 240 | bool HasFieldWriteListeners() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { |
Sebastien Hertz | 3f52eaf | 2014-04-04 17:50:18 +0200 | [diff] [blame] | 241 | return have_field_write_listeners_; |
| 242 | } |
| 243 | |
Sebastien Hertz | ed2be17 | 2014-08-19 15:33:43 +0200 | [diff] [blame^] | 244 | bool HasExceptionCaughtListeners() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { |
Sebastien Hertz | 9f10203 | 2014-05-23 08:59:42 +0200 | [diff] [blame] | 245 | return have_exception_caught_listeners_; |
| 246 | } |
| 247 | |
Sebastien Hertz | ed2be17 | 2014-08-19 15:33:43 +0200 | [diff] [blame^] | 248 | bool IsActive() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { |
Sebastien Hertz | ee1997a | 2013-09-19 14:47:09 +0200 | [diff] [blame] | 249 | return have_dex_pc_listeners_ || have_method_entry_listeners_ || have_method_exit_listeners_ || |
Sebastien Hertz | 42cd43f | 2014-05-13 14:15:41 +0200 | [diff] [blame] | 250 | have_field_read_listeners_ || have_field_write_listeners_ || |
Sebastien Hertz | ee1997a | 2013-09-19 14:47:09 +0200 | [diff] [blame] | 251 | have_exception_caught_listeners_ || have_method_unwind_listeners_; |
| 252 | } |
| 253 | |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 254 | // Inform listeners that a method has been entered. A dex PC is provided as we may install |
| 255 | // listeners into executing code and get method enter events for methods already on the stack. |
| 256 | void MethodEnterEvent(Thread* thread, mirror::Object* this_object, |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 257 | mirror::ArtMethod* method, uint32_t dex_pc) const |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 258 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { |
Sebastien Hertz | 74109f6 | 2013-06-07 17:40:09 +0200 | [diff] [blame] | 259 | if (UNLIKELY(HasMethodEntryListeners())) { |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 260 | MethodEnterEventImpl(thread, this_object, method, dex_pc); |
| 261 | } |
| 262 | } |
| 263 | |
| 264 | // Inform listeners that a method has been exited. |
| 265 | void MethodExitEvent(Thread* thread, mirror::Object* this_object, |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 266 | mirror::ArtMethod* method, uint32_t dex_pc, |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 267 | const JValue& return_value) const |
| 268 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { |
Sebastien Hertz | 74109f6 | 2013-06-07 17:40:09 +0200 | [diff] [blame] | 269 | if (UNLIKELY(HasMethodExitListeners())) { |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 270 | MethodExitEventImpl(thread, this_object, method, dex_pc, return_value); |
| 271 | } |
| 272 | } |
| 273 | |
| 274 | // Inform listeners that a method has been exited due to an exception. |
| 275 | void MethodUnwindEvent(Thread* thread, mirror::Object* this_object, |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 276 | mirror::ArtMethod* method, uint32_t dex_pc) const |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 277 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 278 | |
| 279 | // Inform listeners that the dex pc has moved (only supported by the interpreter). |
| 280 | void DexPcMovedEvent(Thread* thread, mirror::Object* this_object, |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 281 | mirror::ArtMethod* method, uint32_t dex_pc) const |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 282 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { |
Sebastien Hertz | 74109f6 | 2013-06-07 17:40:09 +0200 | [diff] [blame] | 283 | if (UNLIKELY(HasDexPcListeners())) { |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 284 | DexPcMovedEventImpl(thread, this_object, method, dex_pc); |
| 285 | } |
| 286 | } |
| 287 | |
Sebastien Hertz | 3f52eaf | 2014-04-04 17:50:18 +0200 | [diff] [blame] | 288 | // Inform listeners that we read a field (only supported by the interpreter). |
| 289 | void FieldReadEvent(Thread* thread, mirror::Object* this_object, |
| 290 | mirror::ArtMethod* method, uint32_t dex_pc, |
| 291 | mirror::ArtField* field) const |
| 292 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { |
| 293 | if (UNLIKELY(HasFieldReadListeners())) { |
| 294 | FieldReadEventImpl(thread, this_object, method, dex_pc, field); |
| 295 | } |
| 296 | } |
| 297 | |
| 298 | // Inform listeners that we write a field (only supported by the interpreter). |
| 299 | void FieldWriteEvent(Thread* thread, mirror::Object* this_object, |
| 300 | mirror::ArtMethod* method, uint32_t dex_pc, |
| 301 | mirror::ArtField* field, const JValue& field_value) const |
| 302 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { |
| 303 | if (UNLIKELY(HasFieldWriteListeners())) { |
| 304 | FieldWriteEventImpl(thread, this_object, method, dex_pc, field, field_value); |
| 305 | } |
| 306 | } |
| 307 | |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 308 | // Inform listeners that an exception was caught. |
| 309 | void ExceptionCaughtEvent(Thread* thread, const ThrowLocation& throw_location, |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 310 | mirror::ArtMethod* catch_method, uint32_t catch_dex_pc, |
Sebastien Hertz | 947ff08 | 2013-09-17 14:10:13 +0200 | [diff] [blame] | 311 | mirror::Throwable* exception_object) const |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 312 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 313 | |
| 314 | // Called when an instrumented method is entered. The intended link register (lr) is saved so |
| 315 | // that returning causes a branch to the method exit stub. Generates method enter events. |
| 316 | void PushInstrumentationStackFrame(Thread* self, mirror::Object* this_object, |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 317 | mirror::ArtMethod* method, uintptr_t lr, |
Jeff Hao | 9a916d3 | 2013-06-27 18:45:37 -0700 | [diff] [blame] | 318 | bool interpreter_entry) |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 319 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 320 | |
| 321 | // Called when an instrumented method is exited. Removes the pushed instrumentation frame |
| 322 | // returning the intended link register. Generates method exit events. |
Andreas Gampe | d58342c | 2014-06-05 14:18:08 -0700 | [diff] [blame] | 323 | TwoWordReturn PopInstrumentationStackFrame(Thread* self, uintptr_t* return_pc, |
| 324 | uint64_t gpr_result, uint64_t fpr_result) |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 325 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 326 | |
| 327 | // Pops an instrumentation frame from the current thread and generate an unwind event. |
| 328 | void PopMethodForUnwind(Thread* self, bool is_deoptimization) const |
| 329 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 330 | |
| 331 | // Call back for configure stubs. |
| 332 | bool InstallStubsForClass(mirror::Class* klass) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
jeffhao | 725a957 | 2012-11-13 18:20:12 -0800 | [diff] [blame] | 333 | |
Sebastien Hertz | 138dbfc | 2013-12-04 18:15:25 +0100 | [diff] [blame] | 334 | void InstallStubsForMethod(mirror::ArtMethod* method) |
| 335 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 336 | |
Mathieu Chartier | 3b05e9b | 2014-03-25 09:29:43 -0700 | [diff] [blame] | 337 | void VisitRoots(RootCallback* callback, void* arg) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 338 | LOCKS_EXCLUDED(deoptimized_methods_lock_); |
| 339 | |
jeffhao | 725a957 | 2012-11-13 18:20:12 -0800 | [diff] [blame] | 340 | private: |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 341 | // Does the job of installing or removing instrumentation code within methods. |
| 342 | void ConfigureStubs(bool require_entry_exit_stubs, bool require_interpreter) |
| 343 | EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_) |
Mathieu Chartier | 3b05e9b | 2014-03-25 09:29:43 -0700 | [diff] [blame] | 344 | LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_, |
| 345 | deoptimized_methods_lock_); |
jeffhao | 725a957 | 2012-11-13 18:20:12 -0800 | [diff] [blame] | 346 | |
Sebastien Hertz | ed2be17 | 2014-08-19 15:33:43 +0200 | [diff] [blame^] | 347 | void UpdateInterpreterHandlerTable() EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_) { |
Sebastien Hertz | ee1997a | 2013-09-19 14:47:09 +0200 | [diff] [blame] | 348 | interpreter_handler_table_ = IsActive() ? kAlternativeHandlerTable : kMainHandlerTable; |
| 349 | } |
| 350 | |
Mathieu Chartier | 661974a | 2014-01-09 11:23:53 -0800 | [diff] [blame] | 351 | // No thread safety analysis to get around SetQuickAllocEntryPointsInstrumented requiring |
| 352 | // exclusive access to mutator lock which you can't get if the runtime isn't started. |
| 353 | void SetEntrypointsInstrumented(bool instrumented) NO_THREAD_SAFETY_ANALYSIS; |
| 354 | |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 355 | void MethodEnterEventImpl(Thread* thread, mirror::Object* this_object, |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 356 | mirror::ArtMethod* method, uint32_t dex_pc) const |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 357 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 358 | void MethodExitEventImpl(Thread* thread, mirror::Object* this_object, |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 359 | mirror::ArtMethod* method, |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 360 | uint32_t dex_pc, const JValue& return_value) const |
| 361 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 362 | void DexPcMovedEventImpl(Thread* thread, mirror::Object* this_object, |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 363 | mirror::ArtMethod* method, uint32_t dex_pc) const |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 364 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Sebastien Hertz | 3f52eaf | 2014-04-04 17:50:18 +0200 | [diff] [blame] | 365 | void FieldReadEventImpl(Thread* thread, mirror::Object* this_object, |
| 366 | mirror::ArtMethod* method, uint32_t dex_pc, |
| 367 | mirror::ArtField* field) const |
| 368 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 369 | void FieldWriteEventImpl(Thread* thread, mirror::Object* this_object, |
| 370 | mirror::ArtMethod* method, uint32_t dex_pc, |
| 371 | mirror::ArtField* field, const JValue& field_value) const |
| 372 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
jeffhao | 725a957 | 2012-11-13 18:20:12 -0800 | [diff] [blame] | 373 | |
Hiroshi Yamauchi | 799eb3a | 2014-07-18 15:38:17 -0700 | [diff] [blame] | 374 | // Read barrier-aware utility functions for accessing deoptimized_methods_ |
| 375 | bool AddDeoptimizedMethod(mirror::ArtMethod* method) |
| 376 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 377 | EXCLUSIVE_LOCKS_REQUIRED(deoptimized_methods_lock_); |
| 378 | bool FindDeoptimizedMethod(mirror::ArtMethod* method) |
| 379 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 380 | SHARED_LOCKS_REQUIRED(deoptimized_methods_lock_); |
| 381 | bool RemoveDeoptimizedMethod(mirror::ArtMethod* method) |
| 382 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 383 | EXCLUSIVE_LOCKS_REQUIRED(deoptimized_methods_lock_); |
| 384 | mirror::ArtMethod* BeginDeoptimizedMethod() |
| 385 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 386 | SHARED_LOCKS_REQUIRED(deoptimized_methods_lock_); |
| 387 | bool IsDeoptimizedMethodsEmpty() const |
| 388 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 389 | SHARED_LOCKS_REQUIRED(deoptimized_methods_lock_); |
| 390 | |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 391 | // Have we hijacked ArtMethod::code_ so that it calls instrumentation/interpreter code? |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 392 | bool instrumentation_stubs_installed_; |
| 393 | |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 394 | // Have we hijacked ArtMethod::code_ to reference the enter/exit stubs? |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 395 | bool entry_exit_stubs_installed_; |
| 396 | |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 397 | // Have we hijacked ArtMethod::code_ to reference the enter interpreter stub? |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 398 | bool interpreter_stubs_installed_; |
| 399 | |
| 400 | // Do we need the fidelity of events that we only get from running within the interpreter? |
| 401 | bool interpret_only_; |
| 402 | |
| 403 | // Did the runtime request we only run in the interpreter? ie -Xint mode. |
| 404 | bool forced_interpret_only_; |
| 405 | |
| 406 | // Do we have any listeners for method entry events? Short-cut to avoid taking the |
| 407 | // instrumentation_lock_. |
Sebastien Hertz | ed2be17 | 2014-08-19 15:33:43 +0200 | [diff] [blame^] | 408 | bool have_method_entry_listeners_ GUARDED_BY(Locks::mutator_lock_); |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 409 | |
| 410 | // Do we have any listeners for method exit events? Short-cut to avoid taking the |
| 411 | // instrumentation_lock_. |
Sebastien Hertz | ed2be17 | 2014-08-19 15:33:43 +0200 | [diff] [blame^] | 412 | bool have_method_exit_listeners_ GUARDED_BY(Locks::mutator_lock_); |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 413 | |
| 414 | // Do we have any listeners for method unwind events? Short-cut to avoid taking the |
| 415 | // instrumentation_lock_. |
Sebastien Hertz | ed2be17 | 2014-08-19 15:33:43 +0200 | [diff] [blame^] | 416 | bool have_method_unwind_listeners_ GUARDED_BY(Locks::mutator_lock_); |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 417 | |
| 418 | // Do we have any listeners for dex move events? Short-cut to avoid taking the |
| 419 | // instrumentation_lock_. |
Sebastien Hertz | ed2be17 | 2014-08-19 15:33:43 +0200 | [diff] [blame^] | 420 | bool have_dex_pc_listeners_ GUARDED_BY(Locks::mutator_lock_); |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 421 | |
Sebastien Hertz | 3f52eaf | 2014-04-04 17:50:18 +0200 | [diff] [blame] | 422 | // Do we have any listeners for field read events? Short-cut to avoid taking the |
| 423 | // instrumentation_lock_. |
Sebastien Hertz | ed2be17 | 2014-08-19 15:33:43 +0200 | [diff] [blame^] | 424 | bool have_field_read_listeners_ GUARDED_BY(Locks::mutator_lock_); |
Sebastien Hertz | 3f52eaf | 2014-04-04 17:50:18 +0200 | [diff] [blame] | 425 | |
| 426 | // Do we have any listeners for field write events? Short-cut to avoid taking the |
| 427 | // instrumentation_lock_. |
Sebastien Hertz | ed2be17 | 2014-08-19 15:33:43 +0200 | [diff] [blame^] | 428 | bool have_field_write_listeners_ GUARDED_BY(Locks::mutator_lock_); |
Sebastien Hertz | 3f52eaf | 2014-04-04 17:50:18 +0200 | [diff] [blame] | 429 | |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 430 | // Do we have any exception caught listeners? Short-cut to avoid taking the instrumentation_lock_. |
Sebastien Hertz | ed2be17 | 2014-08-19 15:33:43 +0200 | [diff] [blame^] | 431 | bool have_exception_caught_listeners_ GUARDED_BY(Locks::mutator_lock_); |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 432 | |
| 433 | // The event listeners, written to with the mutator_lock_ exclusively held. |
| 434 | std::list<InstrumentationListener*> method_entry_listeners_ GUARDED_BY(Locks::mutator_lock_); |
| 435 | std::list<InstrumentationListener*> method_exit_listeners_ GUARDED_BY(Locks::mutator_lock_); |
| 436 | std::list<InstrumentationListener*> method_unwind_listeners_ GUARDED_BY(Locks::mutator_lock_); |
Daniel Mihalyi | ca1d06c | 2014-08-18 18:45:31 +0200 | [diff] [blame] | 437 | std::shared_ptr<std::list<InstrumentationListener*>> dex_pc_listeners_ |
| 438 | GUARDED_BY(Locks::mutator_lock_); |
| 439 | std::shared_ptr<std::list<InstrumentationListener*>> field_read_listeners_ |
| 440 | GUARDED_BY(Locks::mutator_lock_); |
| 441 | std::shared_ptr<std::list<InstrumentationListener*>> field_write_listeners_ |
| 442 | GUARDED_BY(Locks::mutator_lock_); |
| 443 | std::shared_ptr<std::list<InstrumentationListener*>> exception_caught_listeners_ |
| 444 | GUARDED_BY(Locks::mutator_lock_); |
jeffhao | 725a957 | 2012-11-13 18:20:12 -0800 | [diff] [blame] | 445 | |
Sebastien Hertz | 138dbfc | 2013-12-04 18:15:25 +0100 | [diff] [blame] | 446 | // The set of methods being deoptimized (by the debugger) which must be executed with interpreter |
| 447 | // only. |
Mathieu Chartier | 3b05e9b | 2014-03-25 09:29:43 -0700 | [diff] [blame] | 448 | mutable ReaderWriterMutex deoptimized_methods_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER; |
Hiroshi Yamauchi | 94f7b49 | 2014-07-22 18:08:23 -0700 | [diff] [blame] | 449 | std::multimap<int32_t, GcRoot<mirror::ArtMethod>> deoptimized_methods_ |
| 450 | GUARDED_BY(deoptimized_methods_lock_); |
Sebastien Hertz | 11d40c2 | 2014-02-19 18:00:17 +0100 | [diff] [blame] | 451 | bool deoptimization_enabled_; |
Sebastien Hertz | 138dbfc | 2013-12-04 18:15:25 +0100 | [diff] [blame] | 452 | |
Ian Rogers | fa82427 | 2013-11-05 16:12:57 -0800 | [diff] [blame] | 453 | // Current interpreter handler table. This is updated each time the thread state flags are |
| 454 | // modified. |
Sebastien Hertz | ed2be17 | 2014-08-19 15:33:43 +0200 | [diff] [blame^] | 455 | InterpreterHandlerTable interpreter_handler_table_ GUARDED_BY(Locks::mutator_lock_); |
Sebastien Hertz | ee1997a | 2013-09-19 14:47:09 +0200 | [diff] [blame] | 456 | |
Ian Rogers | fa82427 | 2013-11-05 16:12:57 -0800 | [diff] [blame] | 457 | // Greater than 0 if quick alloc entry points instrumented. |
| 458 | // TODO: The access and changes to this is racy and should be guarded by a lock. |
Mathieu Chartier | cbb2d20 | 2013-11-14 17:45:16 -0800 | [diff] [blame] | 459 | AtomicInteger quick_alloc_entry_points_instrumentation_counter_; |
Ian Rogers | fa82427 | 2013-11-05 16:12:57 -0800 | [diff] [blame] | 460 | |
jeffhao | 725a957 | 2012-11-13 18:20:12 -0800 | [diff] [blame] | 461 | DISALLOW_COPY_AND_ASSIGN(Instrumentation); |
| 462 | }; |
| 463 | |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 464 | // An element in the instrumentation side stack maintained in art::Thread. |
| 465 | struct InstrumentationStackFrame { |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 466 | InstrumentationStackFrame(mirror::Object* this_object, mirror::ArtMethod* method, |
Jeff Hao | 9a916d3 | 2013-06-27 18:45:37 -0700 | [diff] [blame] | 467 | uintptr_t return_pc, size_t frame_id, bool interpreter_entry) |
| 468 | : this_object_(this_object), method_(method), return_pc_(return_pc), frame_id_(frame_id), |
| 469 | interpreter_entry_(interpreter_entry) { |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 470 | } |
| 471 | |
| 472 | std::string Dump() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 473 | |
| 474 | mirror::Object* this_object_; |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 475 | mirror::ArtMethod* method_; |
Sebastien Hertz | 138dbfc | 2013-12-04 18:15:25 +0100 | [diff] [blame] | 476 | uintptr_t return_pc_; |
| 477 | size_t frame_id_; |
| 478 | bool interpreter_entry_; |
Ian Rogers | 62d6c77 | 2013-02-27 08:32:07 -0800 | [diff] [blame] | 479 | }; |
| 480 | |
| 481 | } // namespace instrumentation |
jeffhao | 725a957 | 2012-11-13 18:20:12 -0800 | [diff] [blame] | 482 | } // namespace art |
| 483 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 484 | #endif // ART_RUNTIME_INSTRUMENTATION_H_ |