instrumentation.h revision c785344b87221f5e4e6473e5b762e4e61fe65dcf
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
20576ca0cd692c0b6ae70e776de91015b8ff000a08Ian Rogers#include <stdint.h>
21576ca0cd692c0b6ae70e776de91015b8ff000a08Ian Rogers#include <list>
22799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi#include <map>
23576ca0cd692c0b6ae70e776de91015b8ff000a08Ian Rogers
24d582fa4ea62083a7598dded5b82dc2198b3daac7Ian Rogers#include "arch/instruction_set.h"
25ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers#include "atomic.h"
26761600567d73b23324ae0251e871c15d6849ffd8Elliott Hughes#include "base/macros.h"
27719d1a33f6569864f529e5a3fff59e7bca97aad0Ian Rogers#include "base/mutex.h"
2894f7b49578b6aaa80de8ffed230648d601393905Hiroshi Yamauchi#include "gc_root.h"
293b05e9ba874449dbff65b01b8781001f7d93eea6Mathieu Chartier#include "object_callbacks.h"
302dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers
31725a957985171d712d5c048cc3d00ff14968784bjeffhaonamespace art {
322dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogersnamespace mirror {
33ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom  class ArtMethod;
34ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom  class Class;
35ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom  class Object;
36ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom  class Throwable;
3762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers}  // namespace mirror
38c785344b87221f5e4e6473e5b762e4e61fe65dcfMathieu Chartierclass ArtField;
3962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogersunion JValue;
40725a957985171d712d5c048cc3d00ff14968784bjeffhaoclass Thread;
41725a957985171d712d5c048cc3d00ff14968784bjeffhao
4262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogersnamespace instrumentation {
43725a957985171d712d5c048cc3d00ff14968784bjeffhao
44ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz// Interpreter handler tables.
45ee1997a3b83334985e757f369c09e111b121661bSebastien Hertzenum InterpreterHandlerTable {
46ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz  kMainHandlerTable = 0,          // Main handler table: no suspend check, no instrumentation.
47ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz  kAlternativeHandlerTable = 1,   // Alternative handler table: suspend check and/or instrumentation
48ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz                                  // enabled.
49ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz  kNumHandlerTables
50ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz};
51ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz
5262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// Instrumentation event listener API. Registered listeners will get the appropriate call back for
5362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// the events they are listening for. The call backs supply the thread, method and dex_pc the event
5462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// occurred upon. The thread may or may not be Thread::Current().
5562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogersstruct InstrumentationListener {
5662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  InstrumentationListener() {}
5762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  virtual ~InstrumentationListener() {}
5862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
5962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Call-back for when a method is entered.
6062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  virtual void MethodEntered(Thread* thread, mirror::Object* this_object,
61ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                             mirror::ArtMethod* method,
6262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers                             uint32_t dex_pc) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0;
6362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
6462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Call-back for when a method is exited.
6562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // TODO: its likely passing the return value would be useful, however, we may need to get and
6662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  //       parse the shorty to determine what kind of register holds the result.
6762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  virtual void MethodExited(Thread* thread, mirror::Object* this_object,
68ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                            mirror::ArtMethod* method, uint32_t dex_pc,
6962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers                            const JValue& return_value)
7062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0;
7162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
7262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Call-back for when a method is popped due to an exception throw. A method will either cause a
7362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // MethodExited call-back or a MethodUnwind call-back when its activation is removed.
7451db44a194bafc3810a41164a8b39614f10e79dfSebastien Hertz  virtual void MethodUnwind(Thread* thread, mirror::Object* this_object,
75ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                            mirror::ArtMethod* method, uint32_t dex_pc)
7651db44a194bafc3810a41164a8b39614f10e79dfSebastien Hertz      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0;
7762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
7862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Call-back for when the dex pc moves in a method.
7962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  virtual void DexPcMoved(Thread* thread, mirror::Object* this_object,
80ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                          mirror::ArtMethod* method, uint32_t new_dex_pc)
8162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0;
8262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
833f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  // Call-back for when we read from a field.
843f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  virtual void FieldRead(Thread* thread, mirror::Object* this_object, mirror::ArtMethod* method,
85c785344b87221f5e4e6473e5b762e4e61fe65dcfMathieu Chartier                         uint32_t dex_pc, ArtField* field) = 0;
863f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz
873f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  // Call-back for when we write into a field.
883f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  virtual void FieldWritten(Thread* thread, mirror::Object* this_object, mirror::ArtMethod* method,
89c785344b87221f5e4e6473e5b762e4e61fe65dcfMathieu Chartier                            uint32_t dex_pc, ArtField* field, const JValue& field_value) = 0;
903f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz
9162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Call-back when an exception is caught.
9214691c5e786e8c2c5734f687e4c96217340771beNicolas Geoffray  virtual void ExceptionCaught(Thread* thread, mirror::Throwable* exception_object)
9362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0;
94e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier
95e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  // Call-back for when we get a backward branch.
96e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  virtual void BackwardBranch(Thread* thread, mirror::ArtMethod* method, int32_t dex_pc_offset)
97e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0;
98725a957985171d712d5c048cc3d00ff14968784bjeffhao};
99725a957985171d712d5c048cc3d00ff14968784bjeffhao
10062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// Instrumentation is a catch-all for when extra information is required from the runtime. The
10162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// typical use for instrumentation is for profiling and debugging. Instrumentation may add stubs
10262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// to method entry and exit, it may also force execution to be switched to the interpreter and
10362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// trigger deoptimization.
104725a957985171d712d5c048cc3d00ff14968784bjeffhaoclass Instrumentation {
105725a957985171d712d5c048cc3d00ff14968784bjeffhao public:
10662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  enum InstrumentationEvent {
107e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    kMethodEntered = 0x1,
108e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    kMethodExited = 0x2,
109e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    kMethodUnwind = 0x4,
110e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    kDexPcMoved = 0x8,
111e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    kFieldRead = 0x10,
112e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    kFieldWritten = 0x20,
113e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    kExceptionCaught = 0x40,
114e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    kBackwardBranch = 0x80,
11562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  };
11662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
1173b05e9ba874449dbff65b01b8781001f7d93eea6Mathieu Chartier  Instrumentation();
11862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
11962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Add a listener to be notified of the masked together sent of instrumentation events. This
12062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // suspend the runtime to install stubs. You are expected to hold the mutator lock as a proxy
12162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // for saying you should have suspended all threads (installing stubs while threads are running
12262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // will break).
12362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void AddListener(InstrumentationListener* listener, uint32_t events)
12462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_)
12562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_);
12662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
12762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Removes a listener possibly removing instrumentation stubs.
12862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void RemoveListener(InstrumentationListener* listener, uint32_t events)
12962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_)
13062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_);
13162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
132138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // Deoptimization.
133a76a6d4cb3dedec909bd927f20bc0ab23198a337Sebastien Hertz  void EnableDeoptimization()
134a76a6d4cb3dedec909bd927f20bc0ab23198a337Sebastien Hertz      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_)
1353b05e9ba874449dbff65b01b8781001f7d93eea6Mathieu Chartier      LOCKS_EXCLUDED(deoptimized_methods_lock_);
136a76a6d4cb3dedec909bd927f20bc0ab23198a337Sebastien Hertz  void DisableDeoptimization()
137a76a6d4cb3dedec909bd927f20bc0ab23198a337Sebastien Hertz      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_)
1384d25df3f76f864b7629ac8c0046d46997f293d8dSebastien Hertz      LOCKS_EXCLUDED(deoptimized_methods_lock_);
139a76a6d4cb3dedec909bd927f20bc0ab23198a337Sebastien Hertz  bool AreAllMethodsDeoptimized() const {
140a76a6d4cb3dedec909bd927f20bc0ab23198a337Sebastien Hertz    return interpreter_stubs_installed_;
141a76a6d4cb3dedec909bd927f20bc0ab23198a337Sebastien Hertz  }
14211d40c250ec86c784cf76b8c31e1cf9285d555dcSebastien Hertz  bool ShouldNotifyMethodEnterExitEvents() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
143138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz
144138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // Executes everything with interpreter.
145138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  void DeoptimizeEverything()
146138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_)
147138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_);
148138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz
149138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // Executes everything with compiled code (or interpreter if there is no code).
150138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  void UndeoptimizeEverything()
151138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_)
152138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_);
153138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz
154138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // Deoptimize a method by forcing its execution with the interpreter. Nevertheless, a static
155138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // method (except a class initializer) set to the resolution trampoline will be deoptimized only
156138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // once its declaring class is initialized.
157138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  void Deoptimize(mirror::ArtMethod* method)
1583b05e9ba874449dbff65b01b8781001f7d93eea6Mathieu Chartier      LOCKS_EXCLUDED(Locks::thread_list_lock_, deoptimized_methods_lock_)
159138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_);
160138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz
161138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // Undeoptimze the method by restoring its entrypoints. Nevertheless, a static method
162138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // (except a class initializer) set to the resolution trampoline will be updated only once its
163138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // declaring class is initialized.
164138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  void Undeoptimize(mirror::ArtMethod* method)
1654d25df3f76f864b7629ac8c0046d46997f293d8dSebastien Hertz      LOCKS_EXCLUDED(Locks::thread_list_lock_, deoptimized_methods_lock_)
166138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_);
167138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz
168799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi  bool IsDeoptimized(mirror::ArtMethod* method)
169799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      LOCKS_EXCLUDED(deoptimized_methods_lock_)
170799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
171138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz
172138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // Enable method tracing by installing instrumentation entry/exit stubs.
173138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  void EnableMethodTracing()
174138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_)
175138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_);
176138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz
177138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // Disable method tracing by uninstalling instrumentation entry/exit stubs.
178138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  void DisableMethodTracing()
179138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_)
180138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_);
181138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz
182ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  InterpreterHandlerTable GetInterpreterHandlerTable() const
183ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
184ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz    return interpreter_handler_table_;
185ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz  }
186ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz
1879ef78b59da51080882e47505896b420977fd79aeMathieu Chartier  void InstrumentQuickAllocEntryPoints() LOCKS_EXCLUDED(Locks::instrument_entrypoints_lock_);
1889ef78b59da51080882e47505896b420977fd79aeMathieu Chartier  void UninstrumentQuickAllocEntryPoints() LOCKS_EXCLUDED(Locks::instrument_entrypoints_lock_);
1899ef78b59da51080882e47505896b420977fd79aeMathieu Chartier  void InstrumentQuickAllocEntryPointsLocked()
1909ef78b59da51080882e47505896b420977fd79aeMathieu Chartier      EXCLUSIVE_LOCKS_REQUIRED(Locks::instrument_entrypoints_lock_)
19169dbec6d9d55eeb2867949c2791d01dc9aa916c8Jeff Hao      LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::runtime_shutdown_lock_);
1929ef78b59da51080882e47505896b420977fd79aeMathieu Chartier  void UninstrumentQuickAllocEntryPointsLocked()
1939ef78b59da51080882e47505896b420977fd79aeMathieu Chartier      EXCLUSIVE_LOCKS_REQUIRED(Locks::instrument_entrypoints_lock_)
19469dbec6d9d55eeb2867949c2791d01dc9aa916c8Jeff Hao      LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::runtime_shutdown_lock_);
195d889178ec78930538d9d6a66c3df9ee9afaffbb4Mathieu Chartier  void ResetQuickAllocEntryPoints() EXCLUSIVE_LOCKS_REQUIRED(Locks::runtime_shutdown_lock_);
196fa82427c68b09f4aedbee319dc71579afbfc66f5Ian Rogers
19762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Update the code of a method respecting any installed stubs.
198956af0f0cb05422e38c1d22cbef309d16b8a1a12Elliott Hughes  void UpdateMethodsCode(mirror::ArtMethod* method, const void* quick_code)
199138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
20062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
20162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Get the quick code for the given method. More efficient than asking the class linker as it
20262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // will short-cut to GetCode if instrumentation and static method resolution stubs aren't
20362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // installed.
204a7dd0386f35c0ba4aef3f5b16bc84c6f4e2fc702Mathieu Chartier  const void* GetQuickCodeFor(mirror::ArtMethod* method, size_t pointer_size) const
20562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
20662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
20762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void ForceInterpretOnly() {
20862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers    interpret_only_ = true;
20962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers    forced_interpret_only_ = true;
21062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  }
21162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
212ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom  // Called by ArtMethod::Invoke to determine dispatch mechanism.
21362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  bool InterpretOnly() const {
21462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers    return interpret_only_;
21562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  }
21662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
217563b47cc142e477da244539b1d63070425e7fd78Hiroshi Yamauchi  bool IsForcedInterpretOnly() const {
218563b47cc142e477da244539b1d63070425e7fd78Hiroshi Yamauchi    return forced_interpret_only_;
219563b47cc142e477da244539b1d63070425e7fd78Hiroshi Yamauchi  }
220563b47cc142e477da244539b1d63070425e7fd78Hiroshi Yamauchi
22162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  bool AreExitStubsInstalled() const {
22262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers    return instrumentation_stubs_installed_;
22362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  }
22462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
225ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool HasMethodEntryListeners() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
22674109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz    return have_method_entry_listeners_;
22774109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz  }
22874109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz
229ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool HasMethodExitListeners() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
23074109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz    return have_method_exit_listeners_;
23174109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz  }
23274109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz
233ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool HasDexPcListeners() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
23474109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz    return have_dex_pc_listeners_;
23574109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz  }
23674109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz
237ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool HasFieldReadListeners() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2383f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz    return have_field_read_listeners_;
2393f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  }
2403f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz
241ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool HasFieldWriteListeners() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2423f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz    return have_field_write_listeners_;
2433f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  }
2443f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz
245ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool HasExceptionCaughtListeners() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2469f1020305292a21fd14a402b189c765a125226abSebastien Hertz    return have_exception_caught_listeners_;
2479f1020305292a21fd14a402b189c765a125226abSebastien Hertz  }
2489f1020305292a21fd14a402b189c765a125226abSebastien Hertz
249e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  bool HasBackwardBranchListeners() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
250e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    return have_backward_branch_listeners_;
251e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  }
252e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier
253ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool IsActive() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
254ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz    return have_dex_pc_listeners_ || have_method_entry_listeners_ || have_method_exit_listeners_ ||
25542cd43fa593e8f0427eb0ec158bef08814a6180bSebastien Hertz        have_field_read_listeners_ || have_field_write_listeners_ ||
256ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz        have_exception_caught_listeners_ || have_method_unwind_listeners_;
257ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz  }
258ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz
25962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Inform listeners that a method has been entered. A dex PC is provided as we may install
26062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // listeners into executing code and get method enter events for methods already on the stack.
26162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void MethodEnterEvent(Thread* thread, mirror::Object* this_object,
262ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                        mirror::ArtMethod* method, uint32_t dex_pc) const
26362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
26474109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz    if (UNLIKELY(HasMethodEntryListeners())) {
26562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      MethodEnterEventImpl(thread, this_object, method, dex_pc);
26662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers    }
26762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  }
26862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
26962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Inform listeners that a method has been exited.
27062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void MethodExitEvent(Thread* thread, mirror::Object* this_object,
271ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                       mirror::ArtMethod* method, uint32_t dex_pc,
27262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers                       const JValue& return_value) const
27362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
27474109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz    if (UNLIKELY(HasMethodExitListeners())) {
27562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      MethodExitEventImpl(thread, this_object, method, dex_pc, return_value);
27662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers    }
27762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  }
27862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
27962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Inform listeners that a method has been exited due to an exception.
28062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void MethodUnwindEvent(Thread* thread, mirror::Object* this_object,
281ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                         mirror::ArtMethod* method, uint32_t dex_pc) const
28262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
28362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
28462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Inform listeners that the dex pc has moved (only supported by the interpreter).
28562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void DexPcMovedEvent(Thread* thread, mirror::Object* this_object,
286ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                       mirror::ArtMethod* method, uint32_t dex_pc) const
28762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
28874109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz    if (UNLIKELY(HasDexPcListeners())) {
28962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      DexPcMovedEventImpl(thread, this_object, method, dex_pc);
29062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers    }
29162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  }
292725a957985171d712d5c048cc3d00ff14968784bjeffhao
293e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  // Inform listeners that a backward branch has been taken (only supported by the interpreter).
294e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  void BackwardBranch(Thread* thread, mirror::ArtMethod* method, int32_t offset) const
295e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
296e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    if (UNLIKELY(HasBackwardBranchListeners())) {
297e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier      BackwardBranchImpl(thread, method, offset);
298e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    }
299e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  }
300e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier
3013f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  // Inform listeners that we read a field (only supported by the interpreter).
3023f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  void FieldReadEvent(Thread* thread, mirror::Object* this_object,
3033f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz                      mirror::ArtMethod* method, uint32_t dex_pc,
304c785344b87221f5e4e6473e5b762e4e61fe65dcfMathieu Chartier                      ArtField* field) const
3053f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
3063f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz    if (UNLIKELY(HasFieldReadListeners())) {
3073f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz      FieldReadEventImpl(thread, this_object, method, dex_pc, field);
3083f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz    }
3093f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  }
3103f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz
3113f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  // Inform listeners that we write a field (only supported by the interpreter).
3123f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  void FieldWriteEvent(Thread* thread, mirror::Object* this_object,
3133f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz                       mirror::ArtMethod* method, uint32_t dex_pc,
314c785344b87221f5e4e6473e5b762e4e61fe65dcfMathieu Chartier                       ArtField* field, const JValue& field_value) const
3153f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
3163f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz    if (UNLIKELY(HasFieldWriteListeners())) {
3173f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz      FieldWriteEventImpl(thread, this_object, method, dex_pc, field, field_value);
3183f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz    }
3193f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  }
3203f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz
32162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Inform listeners that an exception was caught.
32214691c5e786e8c2c5734f687e4c96217340771beNicolas Geoffray  void ExceptionCaughtEvent(Thread* thread, mirror::Throwable* exception_object) const
32362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
324725a957985171d712d5c048cc3d00ff14968784bjeffhao
32562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Called when an instrumented method is entered. The intended link register (lr) is saved so
32662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // that returning causes a branch to the method exit stub. Generates method enter events.
32762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void PushInstrumentationStackFrame(Thread* self, mirror::Object* this_object,
328ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom                                     mirror::ArtMethod* method, uintptr_t lr,
3299a916d3c0d0574d106c764e737c67b52988d6139Jeff Hao                                     bool interpreter_entry)
33062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
331725a957985171d712d5c048cc3d00ff14968784bjeffhao
33262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Called when an instrumented method is exited. Removes the pushed instrumentation frame
33362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // returning the intended link register. Generates method exit events.
334d58342caa97108ba413bad467c285c0377f138f5Andreas Gampe  TwoWordReturn PopInstrumentationStackFrame(Thread* self, uintptr_t* return_pc,
335d58342caa97108ba413bad467c285c0377f138f5Andreas Gampe                                             uint64_t gpr_result, uint64_t fpr_result)
33662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
337725a957985171d712d5c048cc3d00ff14968784bjeffhao
33862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Pops an instrumentation frame from the current thread and generate an unwind event.
33962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void PopMethodForUnwind(Thread* self, bool is_deoptimization) const
34062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
34162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
34262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Call back for configure stubs.
343a10aa3789544cf62a2d362c032ea8d9532b47b39Sebastien Hertz  void InstallStubsForClass(mirror::Class* klass) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
344725a957985171d712d5c048cc3d00ff14968784bjeffhao
345138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  void InstallStubsForMethod(mirror::ArtMethod* method)
346138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
347138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz
348bb87e0f1a52de656bc77cb01cb887e51a0e5198bMathieu Chartier  void VisitRoots(RootVisitor* visitor) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
3493b05e9ba874449dbff65b01b8781001f7d93eea6Mathieu Chartier      LOCKS_EXCLUDED(deoptimized_methods_lock_);
3503b05e9ba874449dbff65b01b8781001f7d93eea6Mathieu Chartier
351725a957985171d712d5c048cc3d00ff14968784bjeffhao private:
35262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Does the job of installing or removing instrumentation code within methods.
35362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void ConfigureStubs(bool require_entry_exit_stubs, bool require_interpreter)
35462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_)
3553b05e9ba874449dbff65b01b8781001f7d93eea6Mathieu Chartier      LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_,
3563b05e9ba874449dbff65b01b8781001f7d93eea6Mathieu Chartier                     deoptimized_methods_lock_);
35762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
358ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  void UpdateInterpreterHandlerTable() EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_) {
359ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz    interpreter_handler_table_ = IsActive() ? kAlternativeHandlerTable : kMainHandlerTable;
360ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz  }
361ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz
362661974a5561e5ccdfbac8cb5d8df8b7e6f3483b8Mathieu Chartier  // No thread safety analysis to get around SetQuickAllocEntryPointsInstrumented requiring
363661974a5561e5ccdfbac8cb5d8df8b7e6f3483b8Mathieu Chartier  // exclusive access to mutator lock which you can't get if the runtime isn't started.
3649ef78b59da51080882e47505896b420977fd79aeMathieu Chartier  void SetEntrypointsInstrumented(bool instrumented) NO_THREAD_SAFETY_ANALYSIS;
365661974a5561e5ccdfbac8cb5d8df8b7e6f3483b8Mathieu Chartier
36662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void MethodEnterEventImpl(Thread* thread, mirror::Object* this_object,
367ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                            mirror::ArtMethod* method, uint32_t dex_pc) const
36862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
36962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void MethodExitEventImpl(Thread* thread, mirror::Object* this_object,
370ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                           mirror::ArtMethod* method,
37162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers                           uint32_t dex_pc, const JValue& return_value) const
37262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
37362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void DexPcMovedEventImpl(Thread* thread, mirror::Object* this_object,
374ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                           mirror::ArtMethod* method, uint32_t dex_pc) const
37562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
376e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  void BackwardBranchImpl(Thread* thread, mirror::ArtMethod* method, int32_t offset) const
377e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
3783f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  void FieldReadEventImpl(Thread* thread, mirror::Object* this_object,
3793f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz                           mirror::ArtMethod* method, uint32_t dex_pc,
380c785344b87221f5e4e6473e5b762e4e61fe65dcfMathieu Chartier                           ArtField* field) const
3813f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
3823f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  void FieldWriteEventImpl(Thread* thread, mirror::Object* this_object,
3833f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz                           mirror::ArtMethod* method, uint32_t dex_pc,
384c785344b87221f5e4e6473e5b762e4e61fe65dcfMathieu Chartier                           ArtField* field, const JValue& field_value) const
3853f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
38662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
387799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi  // Read barrier-aware utility functions for accessing deoptimized_methods_
388799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi  bool AddDeoptimizedMethod(mirror::ArtMethod* method)
389799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
390799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      EXCLUSIVE_LOCKS_REQUIRED(deoptimized_methods_lock_);
391799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi  bool FindDeoptimizedMethod(mirror::ArtMethod* method)
392799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
393799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      SHARED_LOCKS_REQUIRED(deoptimized_methods_lock_);
394799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi  bool RemoveDeoptimizedMethod(mirror::ArtMethod* method)
395799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
396799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      EXCLUSIVE_LOCKS_REQUIRED(deoptimized_methods_lock_);
397799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi  mirror::ArtMethod* BeginDeoptimizedMethod()
398799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
399799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      SHARED_LOCKS_REQUIRED(deoptimized_methods_lock_);
400799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi  bool IsDeoptimizedMethodsEmpty() const
401799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
402799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      SHARED_LOCKS_REQUIRED(deoptimized_methods_lock_);
403799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi
404ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom  // Have we hijacked ArtMethod::code_ so that it calls instrumentation/interpreter code?
40562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  bool instrumentation_stubs_installed_;
40662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
407ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom  // Have we hijacked ArtMethod::code_ to reference the enter/exit stubs?
40862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  bool entry_exit_stubs_installed_;
40962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
410ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom  // Have we hijacked ArtMethod::code_ to reference the enter interpreter stub?
41162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  bool interpreter_stubs_installed_;
41262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
41362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Do we need the fidelity of events that we only get from running within the interpreter?
41462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  bool interpret_only_;
415725a957985171d712d5c048cc3d00ff14968784bjeffhao
41662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Did the runtime request we only run in the interpreter? ie -Xint mode.
41762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  bool forced_interpret_only_;
418725a957985171d712d5c048cc3d00ff14968784bjeffhao
41962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Do we have any listeners for method entry events? Short-cut to avoid taking the
42062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // instrumentation_lock_.
421ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool have_method_entry_listeners_ GUARDED_BY(Locks::mutator_lock_);
42262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
42362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Do we have any listeners for method exit events? Short-cut to avoid taking the
42462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // instrumentation_lock_.
425ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool have_method_exit_listeners_ GUARDED_BY(Locks::mutator_lock_);
42662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
42762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Do we have any listeners for method unwind events? Short-cut to avoid taking the
42862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // instrumentation_lock_.
429ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool have_method_unwind_listeners_ GUARDED_BY(Locks::mutator_lock_);
43062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
43162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Do we have any listeners for dex move events? Short-cut to avoid taking the
43262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // instrumentation_lock_.
433ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool have_dex_pc_listeners_ GUARDED_BY(Locks::mutator_lock_);
43462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
4353f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  // Do we have any listeners for field read events? Short-cut to avoid taking the
4363f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  // instrumentation_lock_.
437ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool have_field_read_listeners_ GUARDED_BY(Locks::mutator_lock_);
4383f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz
4393f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  // Do we have any listeners for field write events? Short-cut to avoid taking the
4403f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  // instrumentation_lock_.
441ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool have_field_write_listeners_ GUARDED_BY(Locks::mutator_lock_);
4423f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz
44362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Do we have any exception caught listeners? Short-cut to avoid taking the instrumentation_lock_.
444ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool have_exception_caught_listeners_ GUARDED_BY(Locks::mutator_lock_);
44562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
446e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  // Do we have any backward branch listeners? Short-cut to avoid taking the instrumentation_lock_.
447e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  bool have_backward_branch_listeners_ GUARDED_BY(Locks::mutator_lock_);
448e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier
44962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // The event listeners, written to with the mutator_lock_ exclusively held.
45062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  std::list<InstrumentationListener*> method_entry_listeners_ GUARDED_BY(Locks::mutator_lock_);
45162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  std::list<InstrumentationListener*> method_exit_listeners_ GUARDED_BY(Locks::mutator_lock_);
45262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  std::list<InstrumentationListener*> method_unwind_listeners_ GUARDED_BY(Locks::mutator_lock_);
453e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  std::list<InstrumentationListener*> backward_branch_listeners_ GUARDED_BY(Locks::mutator_lock_);
454ca1d06cfa2f2b8d2be4390644e126cb68cdbb5baDaniel Mihalyi  std::shared_ptr<std::list<InstrumentationListener*>> dex_pc_listeners_
455ca1d06cfa2f2b8d2be4390644e126cb68cdbb5baDaniel Mihalyi      GUARDED_BY(Locks::mutator_lock_);
456ca1d06cfa2f2b8d2be4390644e126cb68cdbb5baDaniel Mihalyi  std::shared_ptr<std::list<InstrumentationListener*>> field_read_listeners_
457ca1d06cfa2f2b8d2be4390644e126cb68cdbb5baDaniel Mihalyi      GUARDED_BY(Locks::mutator_lock_);
458ca1d06cfa2f2b8d2be4390644e126cb68cdbb5baDaniel Mihalyi  std::shared_ptr<std::list<InstrumentationListener*>> field_write_listeners_
459ca1d06cfa2f2b8d2be4390644e126cb68cdbb5baDaniel Mihalyi      GUARDED_BY(Locks::mutator_lock_);
460ca1d06cfa2f2b8d2be4390644e126cb68cdbb5baDaniel Mihalyi  std::shared_ptr<std::list<InstrumentationListener*>> exception_caught_listeners_
461ca1d06cfa2f2b8d2be4390644e126cb68cdbb5baDaniel Mihalyi      GUARDED_BY(Locks::mutator_lock_);
462725a957985171d712d5c048cc3d00ff14968784bjeffhao
463138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // The set of methods being deoptimized (by the debugger) which must be executed with interpreter
464138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // only.
4653b05e9ba874449dbff65b01b8781001f7d93eea6Mathieu Chartier  mutable ReaderWriterMutex deoptimized_methods_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
46694f7b49578b6aaa80de8ffed230648d601393905Hiroshi Yamauchi  std::multimap<int32_t, GcRoot<mirror::ArtMethod>> deoptimized_methods_
46794f7b49578b6aaa80de8ffed230648d601393905Hiroshi Yamauchi      GUARDED_BY(deoptimized_methods_lock_);
46811d40c250ec86c784cf76b8c31e1cf9285d555dcSebastien Hertz  bool deoptimization_enabled_;
469138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz
470fa82427c68b09f4aedbee319dc71579afbfc66f5Ian Rogers  // Current interpreter handler table. This is updated each time the thread state flags are
471fa82427c68b09f4aedbee319dc71579afbfc66f5Ian Rogers  // modified.
472ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  InterpreterHandlerTable interpreter_handler_table_ GUARDED_BY(Locks::mutator_lock_);
473ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz
474fa82427c68b09f4aedbee319dc71579afbfc66f5Ian Rogers  // Greater than 0 if quick alloc entry points instrumented.
4759ef78b59da51080882e47505896b420977fd79aeMathieu Chartier  size_t quick_alloc_entry_points_instrumentation_counter_
4769ef78b59da51080882e47505896b420977fd79aeMathieu Chartier      GUARDED_BY(Locks::instrument_entrypoints_lock_);
477fa82427c68b09f4aedbee319dc71579afbfc66f5Ian Rogers
478725a957985171d712d5c048cc3d00ff14968784bjeffhao  DISALLOW_COPY_AND_ASSIGN(Instrumentation);
479725a957985171d712d5c048cc3d00ff14968784bjeffhao};
4806a3c1fcb4ba42ad4d5d142c17a3712a6ddd3866fIan Rogersstd::ostream& operator<<(std::ostream& os, const Instrumentation::InstrumentationEvent& rhs);
481725a957985171d712d5c048cc3d00ff14968784bjeffhao
48262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// An element in the instrumentation side stack maintained in art::Thread.
48362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogersstruct InstrumentationStackFrame {
484ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom  InstrumentationStackFrame(mirror::Object* this_object, mirror::ArtMethod* method,
4859a916d3c0d0574d106c764e737c67b52988d6139Jeff Hao                            uintptr_t return_pc, size_t frame_id, bool interpreter_entry)
4869a916d3c0d0574d106c764e737c67b52988d6139Jeff Hao      : this_object_(this_object), method_(method), return_pc_(return_pc), frame_id_(frame_id),
4879a916d3c0d0574d106c764e737c67b52988d6139Jeff Hao        interpreter_entry_(interpreter_entry) {
48862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  }
48962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
49062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  std::string Dump() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
49162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
49262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  mirror::Object* this_object_;
493ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom  mirror::ArtMethod* method_;
494138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  uintptr_t return_pc_;
495138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  size_t frame_id_;
496138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  bool interpreter_entry_;
49762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers};
49862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
49962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers}  // namespace instrumentation
500725a957985171d712d5c048cc3d00ff14968784bjeffhao}  // namespace art
501725a957985171d712d5c048cc3d00ff14968784bjeffhao
502fc0e3219edc9a5bf81b166e82fd5db2796eb6a0dBrian Carlstrom#endif  // ART_RUNTIME_INSTRUMENTATION_H_
503