instrumentation.h revision 138dbfc3336e379d74d157086f69a0fbe830089b
1725a957985171d712d5c048cc3d00ff14968784bjeffhao/* 2725a957985171d712d5c048cc3d00ff14968784bjeffhao * Copyright (C) 2011 The Android Open Source Project 3725a957985171d712d5c048cc3d00ff14968784bjeffhao * 4725a957985171d712d5c048cc3d00ff14968784bjeffhao * Licensed under the Apache License, Version 2.0 (the "License"); 5725a957985171d712d5c048cc3d00ff14968784bjeffhao * you may not use this file except in compliance with the License. 6725a957985171d712d5c048cc3d00ff14968784bjeffhao * You may obtain a copy of the License at 7725a957985171d712d5c048cc3d00ff14968784bjeffhao * 8725a957985171d712d5c048cc3d00ff14968784bjeffhao * http://www.apache.org/licenses/LICENSE-2.0 9725a957985171d712d5c048cc3d00ff14968784bjeffhao * 10725a957985171d712d5c048cc3d00ff14968784bjeffhao * Unless required by applicable law or agreed to in writing, software 11725a957985171d712d5c048cc3d00ff14968784bjeffhao * distributed under the License is distributed on an "AS IS" BASIS, 12725a957985171d712d5c048cc3d00ff14968784bjeffhao * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13725a957985171d712d5c048cc3d00ff14968784bjeffhao * See the License for the specific language governing permissions and 14725a957985171d712d5c048cc3d00ff14968784bjeffhao * limitations under the License. 15725a957985171d712d5c048cc3d00ff14968784bjeffhao */ 16725a957985171d712d5c048cc3d00ff14968784bjeffhao 17fc0e3219edc9a5bf81b166e82fd5db2796eb6a0dBrian Carlstrom#ifndef ART_RUNTIME_INSTRUMENTATION_H_ 18fc0e3219edc9a5bf81b166e82fd5db2796eb6a0dBrian Carlstrom#define ART_RUNTIME_INSTRUMENTATION_H_ 19725a957985171d712d5c048cc3d00ff14968784bjeffhao 20cbb2d20bea2861f244da2e2318d8c088300a3710Mathieu Chartier#include "atomic_integer.h" 21761600567d73b23324ae0251e871c15d6849ffd8Elliott Hughes#include "base/macros.h" 2262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers#include "locks.h" 232dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers 242dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers#include <stdint.h> 25138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz#include <set> 2662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers#include <list> 27725a957985171d712d5c048cc3d00ff14968784bjeffhao 28725a957985171d712d5c048cc3d00ff14968784bjeffhaonamespace art { 292dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogersnamespace mirror { 30ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom class ArtMethod; 31ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom class Class; 32ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom class Object; 33ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom class Throwable; 3462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers} // namespace mirror 3562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogersunion JValue; 36725a957985171d712d5c048cc3d00ff14968784bjeffhaoclass Thread; 3762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogersclass ThrowLocation; 38725a957985171d712d5c048cc3d00ff14968784bjeffhao 3962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogersnamespace instrumentation { 40725a957985171d712d5c048cc3d00ff14968784bjeffhao 41ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz// Interpreter handler tables. 42ee1997a3b83334985e757f369c09e111b121661bSebastien Hertzenum InterpreterHandlerTable { 43ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz kMainHandlerTable = 0, // Main handler table: no suspend check, no instrumentation. 44ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz kAlternativeHandlerTable = 1, // Alternative handler table: suspend check and/or instrumentation 45ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz // enabled. 46ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz kNumHandlerTables 47ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz}; 48ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz 4962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// Instrumentation event listener API. Registered listeners will get the appropriate call back for 5062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// the events they are listening for. The call backs supply the thread, method and dex_pc the event 5162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// occurred upon. The thread may or may not be Thread::Current(). 5262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogersstruct InstrumentationListener { 5362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers InstrumentationListener() {} 5462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers virtual ~InstrumentationListener() {} 5562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 5662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Call-back for when a method is entered. 5762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers virtual void MethodEntered(Thread* thread, mirror::Object* this_object, 58ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom const mirror::ArtMethod* method, 5962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers uint32_t dex_pc) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0; 6062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 6162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Call-back for when a method is exited. 6262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // TODO: its likely passing the return value would be useful, however, we may need to get and 6362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // parse the shorty to determine what kind of register holds the result. 6462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers virtual void MethodExited(Thread* thread, mirror::Object* this_object, 65ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom const mirror::ArtMethod* method, uint32_t dex_pc, 6662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers const JValue& return_value) 6762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0; 6862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 6962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Call-back for when a method is popped due to an exception throw. A method will either cause a 7062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // MethodExited call-back or a MethodUnwind call-back when its activation is removed. 7151db44a194bafc3810a41164a8b39614f10e79dfSebastien Hertz virtual void MethodUnwind(Thread* thread, mirror::Object* this_object, 7251db44a194bafc3810a41164a8b39614f10e79dfSebastien Hertz const mirror::ArtMethod* method, uint32_t dex_pc) 7351db44a194bafc3810a41164a8b39614f10e79dfSebastien Hertz SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0; 7462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 7562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Call-back for when the dex pc moves in a method. 7662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers virtual void DexPcMoved(Thread* thread, mirror::Object* this_object, 77ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom const mirror::ArtMethod* method, uint32_t new_dex_pc) 7862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0; 7962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 8062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Call-back when an exception is caught. 8162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers virtual void ExceptionCaught(Thread* thread, const ThrowLocation& throw_location, 82ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom mirror::ArtMethod* catch_method, uint32_t catch_dex_pc, 8362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers mirror::Throwable* exception_object) 8462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0; 85725a957985171d712d5c048cc3d00ff14968784bjeffhao}; 86725a957985171d712d5c048cc3d00ff14968784bjeffhao 8762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// Instrumentation is a catch-all for when extra information is required from the runtime. The 8862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// typical use for instrumentation is for profiling and debugging. Instrumentation may add stubs 8962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// to method entry and exit, it may also force execution to be switched to the interpreter and 9062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// trigger deoptimization. 91725a957985171d712d5c048cc3d00ff14968784bjeffhaoclass Instrumentation { 92725a957985171d712d5c048cc3d00ff14968784bjeffhao public: 9362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers enum InstrumentationEvent { 9462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers kMethodEntered = 1, 9562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers kMethodExited = 2, 9662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers kMethodUnwind = 4, 9762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers kDexPcMoved = 8, 9862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers kExceptionCaught = 16 9962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers }; 10062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 10162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers Instrumentation() : 10262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers instrumentation_stubs_installed_(false), entry_exit_stubs_installed_(false), 10362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers interpreter_stubs_installed_(false), 10462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers interpret_only_(false), forced_interpret_only_(false), 10562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers have_method_entry_listeners_(false), have_method_exit_listeners_(false), 10662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers have_method_unwind_listeners_(false), have_dex_pc_listeners_(false), 107ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz have_exception_caught_listeners_(false), 108fa82427c68b09f4aedbee319dc71579afbfc66f5Ian Rogers interpreter_handler_table_(kMainHandlerTable), 109fa82427c68b09f4aedbee319dc71579afbfc66f5Ian Rogers quick_alloc_entry_points_instrumentation_counter_(0) {} 11062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 11162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Add a listener to be notified of the masked together sent of instrumentation events. This 11262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // suspend the runtime to install stubs. You are expected to hold the mutator lock as a proxy 11362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // for saying you should have suspended all threads (installing stubs while threads are running 11462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // will break). 11562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers void AddListener(InstrumentationListener* listener, uint32_t events) 11662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_) 11762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_); 11862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 11962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Removes a listener possibly removing instrumentation stubs. 12062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers void RemoveListener(InstrumentationListener* listener, uint32_t events) 12162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_) 12262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_); 12362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 124138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz // Deoptimization. 125138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz void EnableDeoptimization() EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_); 126138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz void DisableDeoptimization() EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_); 127138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz bool IsDeoptimizationEnabled() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 128138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz 129138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz // Executes everything with interpreter. 130138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz void DeoptimizeEverything() 131138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_) 132138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_); 133138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz 134138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz // Executes everything with compiled code (or interpreter if there is no code). 135138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz void UndeoptimizeEverything() 136138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_) 137138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_); 138138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz 139138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz // Deoptimize a method by forcing its execution with the interpreter. Nevertheless, a static 140138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz // method (except a class initializer) set to the resolution trampoline will be deoptimized only 141138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz // once its declaring class is initialized. 142138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz void Deoptimize(mirror::ArtMethod* method) 143138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz LOCKS_EXCLUDED(Locks::thread_list_lock_) 144138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_); 145138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz 146138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz // Undeoptimze the method by restoring its entrypoints. Nevertheless, a static method 147138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz // (except a class initializer) set to the resolution trampoline will be updated only once its 148138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz // declaring class is initialized. 149138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz void Undeoptimize(mirror::ArtMethod* method) 150138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz LOCKS_EXCLUDED(Locks::thread_list_lock_) 151138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_); 152138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz 153138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz bool IsDeoptimized(mirror::ArtMethod* method) const; 154138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz 155138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz // Enable method tracing by installing instrumentation entry/exit stubs. 156138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz void EnableMethodTracing() 157138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_) 158138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_); 159138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz 160138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz // Disable method tracing by uninstalling instrumentation entry/exit stubs. 161138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz void DisableMethodTracing() 162138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_) 163138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_); 164138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz 165ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz InterpreterHandlerTable GetInterpreterHandlerTable() const { 166ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz return interpreter_handler_table_; 167ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz } 168ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz 169fa82427c68b09f4aedbee319dc71579afbfc66f5Ian Rogers void InstrumentQuickAllocEntryPoints() LOCKS_EXCLUDED(Locks::thread_list_lock_); 170fa82427c68b09f4aedbee319dc71579afbfc66f5Ian Rogers void UninstrumentQuickAllocEntryPoints() LOCKS_EXCLUDED(Locks::thread_list_lock_); 171cbb2d20bea2861f244da2e2318d8c088300a3710Mathieu Chartier void ResetQuickAllocEntryPoints(); 172fa82427c68b09f4aedbee319dc71579afbfc66f5Ian Rogers 17362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Update the code of a method respecting any installed stubs. 174138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz void UpdateMethodsCode(mirror::ArtMethod* method, const void* code) const 175138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 17662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 17762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Get the quick code for the given method. More efficient than asking the class linker as it 17862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // will short-cut to GetCode if instrumentation and static method resolution stubs aren't 17962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // installed. 180ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom const void* GetQuickCodeFor(const mirror::ArtMethod* method) const 18162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 18262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 18362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers void ForceInterpretOnly() { 18462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers interpret_only_ = true; 18562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers forced_interpret_only_ = true; 18662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers } 18762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 188ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom // Called by ArtMethod::Invoke to determine dispatch mechanism. 18962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers bool InterpretOnly() const { 19062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers return interpret_only_; 19162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers } 19262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 19362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers bool ShouldPortableCodeDeoptimize() const { 19462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers return instrumentation_stubs_installed_; 19562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers } 19662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 19762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers bool AreExitStubsInstalled() const { 19862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers return instrumentation_stubs_installed_; 19962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers } 20062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 20174109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz bool HasMethodEntryListeners() const { 20274109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz return have_method_entry_listeners_; 20374109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz } 20474109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz 20574109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz bool HasMethodExitListeners() const { 20674109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz return have_method_exit_listeners_; 20774109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz } 20874109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz 20974109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz bool HasDexPcListeners() const { 21074109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz return have_dex_pc_listeners_; 21174109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz } 21274109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz 213ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz bool IsActive() const { 214ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz return have_dex_pc_listeners_ || have_method_entry_listeners_ || have_method_exit_listeners_ || 215ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz have_exception_caught_listeners_ || have_method_unwind_listeners_; 216ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz } 217ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz 21862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Inform listeners that a method has been entered. A dex PC is provided as we may install 21962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // listeners into executing code and get method enter events for methods already on the stack. 22062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers void MethodEnterEvent(Thread* thread, mirror::Object* this_object, 221ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom const mirror::ArtMethod* method, uint32_t dex_pc) const 22262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 22374109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz if (UNLIKELY(HasMethodEntryListeners())) { 22462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers MethodEnterEventImpl(thread, this_object, method, dex_pc); 22562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers } 22662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers } 22762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 22862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Inform listeners that a method has been exited. 22962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers void MethodExitEvent(Thread* thread, mirror::Object* this_object, 230ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom const mirror::ArtMethod* method, uint32_t dex_pc, 23162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers const JValue& return_value) const 23262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 23374109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz if (UNLIKELY(HasMethodExitListeners())) { 23462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers MethodExitEventImpl(thread, this_object, method, dex_pc, return_value); 23562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers } 23662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers } 23762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 23862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Inform listeners that a method has been exited due to an exception. 23962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers void MethodUnwindEvent(Thread* thread, mirror::Object* this_object, 240ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom const mirror::ArtMethod* method, uint32_t dex_pc) const 24162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 24262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 24362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Inform listeners that the dex pc has moved (only supported by the interpreter). 24462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers void DexPcMovedEvent(Thread* thread, mirror::Object* this_object, 245ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom const mirror::ArtMethod* method, uint32_t dex_pc) const 24662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 24774109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz if (UNLIKELY(HasDexPcListeners())) { 24862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers DexPcMovedEventImpl(thread, this_object, method, dex_pc); 24962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers } 25062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers } 251725a957985171d712d5c048cc3d00ff14968784bjeffhao 25262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Inform listeners that an exception was caught. 25362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers void ExceptionCaughtEvent(Thread* thread, const ThrowLocation& throw_location, 254ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom mirror::ArtMethod* catch_method, uint32_t catch_dex_pc, 255947ff080753c786a74f1cd7aeb09f717bb7074bdSebastien Hertz mirror::Throwable* exception_object) const 25662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 257725a957985171d712d5c048cc3d00ff14968784bjeffhao 25862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Called when an instrumented method is entered. The intended link register (lr) is saved so 25962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // that returning causes a branch to the method exit stub. Generates method enter events. 26062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers void PushInstrumentationStackFrame(Thread* self, mirror::Object* this_object, 261ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom mirror::ArtMethod* method, uintptr_t lr, 2629a916d3c0d0574d106c764e737c67b52988d6139Jeff Hao bool interpreter_entry) 26362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 264725a957985171d712d5c048cc3d00ff14968784bjeffhao 26562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Called when an instrumented method is exited. Removes the pushed instrumentation frame 26662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // returning the intended link register. Generates method exit events. 26762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers uint64_t PopInstrumentationStackFrame(Thread* self, uintptr_t* return_pc, uint64_t gpr_result, 26862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers uint64_t fpr_result) 26962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 270725a957985171d712d5c048cc3d00ff14968784bjeffhao 27162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Pops an instrumentation frame from the current thread and generate an unwind event. 27262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers void PopMethodForUnwind(Thread* self, bool is_deoptimization) const 27362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 27462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 27562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Call back for configure stubs. 27662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers bool InstallStubsForClass(mirror::Class* klass) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 277725a957985171d712d5c048cc3d00ff14968784bjeffhao 278138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz void InstallStubsForMethod(mirror::ArtMethod* method) 279138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 280138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz 281725a957985171d712d5c048cc3d00ff14968784bjeffhao private: 28262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Does the job of installing or removing instrumentation code within methods. 28362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers void ConfigureStubs(bool require_entry_exit_stubs, bool require_interpreter) 28462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_) 28562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_); 28662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 287ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz void UpdateInterpreterHandlerTable() { 288ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz interpreter_handler_table_ = IsActive() ? kAlternativeHandlerTable : kMainHandlerTable; 289ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz } 290ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz 29162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers void MethodEnterEventImpl(Thread* thread, mirror::Object* this_object, 292ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom const mirror::ArtMethod* method, uint32_t dex_pc) const 29362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 29462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers void MethodExitEventImpl(Thread* thread, mirror::Object* this_object, 295ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom const mirror::ArtMethod* method, 29662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers uint32_t dex_pc, const JValue& return_value) const 29762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 29862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers void DexPcMovedEventImpl(Thread* thread, mirror::Object* this_object, 299ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom const mirror::ArtMethod* method, uint32_t dex_pc) const 30062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 30162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 302ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom // Have we hijacked ArtMethod::code_ so that it calls instrumentation/interpreter code? 30362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers bool instrumentation_stubs_installed_; 30462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 305ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom // Have we hijacked ArtMethod::code_ to reference the enter/exit stubs? 30662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers bool entry_exit_stubs_installed_; 30762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 308ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom // Have we hijacked ArtMethod::code_ to reference the enter interpreter stub? 30962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers bool interpreter_stubs_installed_; 31062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 31162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Do we need the fidelity of events that we only get from running within the interpreter? 31262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers bool interpret_only_; 313725a957985171d712d5c048cc3d00ff14968784bjeffhao 31462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Did the runtime request we only run in the interpreter? ie -Xint mode. 31562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers bool forced_interpret_only_; 316725a957985171d712d5c048cc3d00ff14968784bjeffhao 31762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Do we have any listeners for method entry events? Short-cut to avoid taking the 31862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // instrumentation_lock_. 31962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers bool have_method_entry_listeners_; 32062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 32162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Do we have any listeners for method exit events? Short-cut to avoid taking the 32262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // instrumentation_lock_. 32362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers bool have_method_exit_listeners_; 32462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 32562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Do we have any listeners for method unwind events? Short-cut to avoid taking the 32662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // instrumentation_lock_. 32762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers bool have_method_unwind_listeners_; 32862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 32962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Do we have any listeners for dex move events? Short-cut to avoid taking the 33062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // instrumentation_lock_. 33162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers bool have_dex_pc_listeners_; 33262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 33362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // Do we have any exception caught listeners? Short-cut to avoid taking the instrumentation_lock_. 33462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers bool have_exception_caught_listeners_; 33562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 33662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers // The event listeners, written to with the mutator_lock_ exclusively held. 33762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers std::list<InstrumentationListener*> method_entry_listeners_ GUARDED_BY(Locks::mutator_lock_); 33862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers std::list<InstrumentationListener*> method_exit_listeners_ GUARDED_BY(Locks::mutator_lock_); 33962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers std::list<InstrumentationListener*> method_unwind_listeners_ GUARDED_BY(Locks::mutator_lock_); 34062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers std::list<InstrumentationListener*> dex_pc_listeners_ GUARDED_BY(Locks::mutator_lock_); 34162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers std::list<InstrumentationListener*> exception_caught_listeners_ GUARDED_BY(Locks::mutator_lock_); 342725a957985171d712d5c048cc3d00ff14968784bjeffhao 343138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz // The set of methods being deoptimized (by the debugger) which must be executed with interpreter 344138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz // only. 345138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz // TODO we need to visit these methods as roots. 346138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz std::set<mirror::ArtMethod*> deoptimized_methods_; 347138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz 348fa82427c68b09f4aedbee319dc71579afbfc66f5Ian Rogers // Current interpreter handler table. This is updated each time the thread state flags are 349fa82427c68b09f4aedbee319dc71579afbfc66f5Ian Rogers // modified. 350ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz InterpreterHandlerTable interpreter_handler_table_; 351ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz 352fa82427c68b09f4aedbee319dc71579afbfc66f5Ian Rogers // Greater than 0 if quick alloc entry points instrumented. 353fa82427c68b09f4aedbee319dc71579afbfc66f5Ian Rogers // TODO: The access and changes to this is racy and should be guarded by a lock. 354cbb2d20bea2861f244da2e2318d8c088300a3710Mathieu Chartier AtomicInteger quick_alloc_entry_points_instrumentation_counter_; 355fa82427c68b09f4aedbee319dc71579afbfc66f5Ian Rogers 356725a957985171d712d5c048cc3d00ff14968784bjeffhao DISALLOW_COPY_AND_ASSIGN(Instrumentation); 357725a957985171d712d5c048cc3d00ff14968784bjeffhao}; 358725a957985171d712d5c048cc3d00ff14968784bjeffhao 35962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// An element in the instrumentation side stack maintained in art::Thread. 36062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogersstruct InstrumentationStackFrame { 361ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom InstrumentationStackFrame(mirror::Object* this_object, mirror::ArtMethod* method, 3629a916d3c0d0574d106c764e737c67b52988d6139Jeff Hao uintptr_t return_pc, size_t frame_id, bool interpreter_entry) 3639a916d3c0d0574d106c764e737c67b52988d6139Jeff Hao : this_object_(this_object), method_(method), return_pc_(return_pc), frame_id_(frame_id), 3649a916d3c0d0574d106c764e737c67b52988d6139Jeff Hao interpreter_entry_(interpreter_entry) { 36562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers } 36662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 36762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers std::string Dump() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 36862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 36962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers mirror::Object* this_object_; 370ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom mirror::ArtMethod* method_; 371138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz uintptr_t return_pc_; 372138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz size_t frame_id_; 373138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz bool interpreter_entry_; 37462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers}; 37562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers 37662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers} // namespace instrumentation 377725a957985171d712d5c048cc3d00ff14968784bjeffhao} // namespace art 378725a957985171d712d5c048cc3d00ff14968784bjeffhao 379fc0e3219edc9a5bf81b166e82fd5db2796eb6a0dBrian Carlstrom#endif // ART_RUNTIME_INSTRUMENTATION_H_ 380