instrumentation.h revision 14691c5e786e8c2c5734f687e4c96217340771be
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 {
333f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  class ArtField;
34ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom  class ArtMethod;
35ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom  class Class;
36ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom  class Object;
37ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom  class Throwable;
3862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers}  // namespace mirror
3962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogersunion JValue;
40725a957985171d712d5c048cc3d00ff14968784bjeffhaoclass Thread;
4162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogersclass ThrowLocation;
42725a957985171d712d5c048cc3d00ff14968784bjeffhao
4362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogersnamespace instrumentation {
44725a957985171d712d5c048cc3d00ff14968784bjeffhao
45ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz// Interpreter handler tables.
46ee1997a3b83334985e757f369c09e111b121661bSebastien Hertzenum InterpreterHandlerTable {
47ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz  kMainHandlerTable = 0,          // Main handler table: no suspend check, no instrumentation.
48ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz  kAlternativeHandlerTable = 1,   // Alternative handler table: suspend check and/or instrumentation
49ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz                                  // enabled.
50ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz  kNumHandlerTables
51ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz};
52ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz
5362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// Instrumentation event listener API. Registered listeners will get the appropriate call back for
5462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// the events they are listening for. The call backs supply the thread, method and dex_pc the event
5562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// occurred upon. The thread may or may not be Thread::Current().
5662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogersstruct InstrumentationListener {
5762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  InstrumentationListener() {}
5862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  virtual ~InstrumentationListener() {}
5962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
6062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Call-back for when a method is entered.
6162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  virtual void MethodEntered(Thread* thread, mirror::Object* this_object,
62ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                             mirror::ArtMethod* method,
6362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers                             uint32_t dex_pc) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0;
6462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
6562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Call-back for when a method is exited.
6662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // TODO: its likely passing the return value would be useful, however, we may need to get and
6762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  //       parse the shorty to determine what kind of register holds the result.
6862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  virtual void MethodExited(Thread* thread, mirror::Object* this_object,
69ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                            mirror::ArtMethod* method, uint32_t dex_pc,
7062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers                            const JValue& return_value)
7162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0;
7262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
7362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Call-back for when a method is popped due to an exception throw. A method will either cause a
7462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // MethodExited call-back or a MethodUnwind call-back when its activation is removed.
7551db44a194bafc3810a41164a8b39614f10e79dfSebastien Hertz  virtual void MethodUnwind(Thread* thread, mirror::Object* this_object,
76ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                            mirror::ArtMethod* method, uint32_t dex_pc)
7751db44a194bafc3810a41164a8b39614f10e79dfSebastien Hertz      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0;
7862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
7962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Call-back for when the dex pc moves in a method.
8062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  virtual void DexPcMoved(Thread* thread, mirror::Object* this_object,
81ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                          mirror::ArtMethod* method, uint32_t new_dex_pc)
8262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0;
8362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
843f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  // Call-back for when we read from a field.
853f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  virtual void FieldRead(Thread* thread, mirror::Object* this_object, mirror::ArtMethod* method,
863f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz                         uint32_t dex_pc, mirror::ArtField* field) = 0;
873f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz
883f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  // Call-back for when we write into a field.
893f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  virtual void FieldWritten(Thread* thread, mirror::Object* this_object, mirror::ArtMethod* method,
903f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz                            uint32_t dex_pc, mirror::ArtField* field, const JValue& field_value) = 0;
913f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz
9262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Call-back when an exception is caught.
9314691c5e786e8c2c5734f687e4c96217340771beNicolas Geoffray  virtual void ExceptionCaught(Thread* thread, mirror::Throwable* exception_object)
9462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0;
95e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier
96e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  // Call-back for when we get a backward branch.
97e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  virtual void BackwardBranch(Thread* thread, mirror::ArtMethod* method, int32_t dex_pc_offset)
98e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) = 0;
99725a957985171d712d5c048cc3d00ff14968784bjeffhao};
100725a957985171d712d5c048cc3d00ff14968784bjeffhao
10162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// Instrumentation is a catch-all for when extra information is required from the runtime. The
10262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// typical use for instrumentation is for profiling and debugging. Instrumentation may add stubs
10362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// to method entry and exit, it may also force execution to be switched to the interpreter and
10462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// trigger deoptimization.
105725a957985171d712d5c048cc3d00ff14968784bjeffhaoclass Instrumentation {
106725a957985171d712d5c048cc3d00ff14968784bjeffhao public:
10762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  enum InstrumentationEvent {
108e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    kMethodEntered = 0x1,
109e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    kMethodExited = 0x2,
110e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    kMethodUnwind = 0x4,
111e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    kDexPcMoved = 0x8,
112e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    kFieldRead = 0x10,
113e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    kFieldWritten = 0x20,
114e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    kExceptionCaught = 0x40,
115e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    kBackwardBranch = 0x80,
11662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  };
11762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
1183b05e9ba874449dbff65b01b8781001f7d93eea6Mathieu Chartier  Instrumentation();
11962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
12062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Add a listener to be notified of the masked together sent of instrumentation events. This
12162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // suspend the runtime to install stubs. You are expected to hold the mutator lock as a proxy
12262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // for saying you should have suspended all threads (installing stubs while threads are running
12362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // will break).
12462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void AddListener(InstrumentationListener* listener, uint32_t events)
12562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_)
12662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_);
12762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
12862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Removes a listener possibly removing instrumentation stubs.
12962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void RemoveListener(InstrumentationListener* listener, uint32_t events)
13062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_)
13162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_);
13262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
133138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // Deoptimization.
134a76a6d4cb3dedec909bd927f20bc0ab23198a337Sebastien Hertz  void EnableDeoptimization()
135a76a6d4cb3dedec909bd927f20bc0ab23198a337Sebastien Hertz      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_)
1363b05e9ba874449dbff65b01b8781001f7d93eea6Mathieu Chartier      LOCKS_EXCLUDED(deoptimized_methods_lock_);
137a76a6d4cb3dedec909bd927f20bc0ab23198a337Sebastien Hertz  void DisableDeoptimization()
138a76a6d4cb3dedec909bd927f20bc0ab23198a337Sebastien Hertz      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_)
1394d25df3f76f864b7629ac8c0046d46997f293d8dSebastien Hertz      LOCKS_EXCLUDED(deoptimized_methods_lock_);
140a76a6d4cb3dedec909bd927f20bc0ab23198a337Sebastien Hertz  bool AreAllMethodsDeoptimized() const {
141a76a6d4cb3dedec909bd927f20bc0ab23198a337Sebastien Hertz    return interpreter_stubs_installed_;
142a76a6d4cb3dedec909bd927f20bc0ab23198a337Sebastien Hertz  }
14311d40c250ec86c784cf76b8c31e1cf9285d555dcSebastien Hertz  bool ShouldNotifyMethodEnterExitEvents() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
144138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz
145138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // Executes everything with interpreter.
146138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  void DeoptimizeEverything()
147138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_)
148138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_);
149138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz
150138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // Executes everything with compiled code (or interpreter if there is no code).
151138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  void UndeoptimizeEverything()
152138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_)
153138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_);
154138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz
155138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // Deoptimize a method by forcing its execution with the interpreter. Nevertheless, a static
156138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // method (except a class initializer) set to the resolution trampoline will be deoptimized only
157138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // once its declaring class is initialized.
158138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  void Deoptimize(mirror::ArtMethod* method)
1593b05e9ba874449dbff65b01b8781001f7d93eea6Mathieu Chartier      LOCKS_EXCLUDED(Locks::thread_list_lock_, deoptimized_methods_lock_)
160138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_);
161138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz
162138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // Undeoptimze the method by restoring its entrypoints. Nevertheless, a static method
163138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // (except a class initializer) set to the resolution trampoline will be updated only once its
164138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // declaring class is initialized.
165138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  void Undeoptimize(mirror::ArtMethod* method)
1664d25df3f76f864b7629ac8c0046d46997f293d8dSebastien Hertz      LOCKS_EXCLUDED(Locks::thread_list_lock_, deoptimized_methods_lock_)
167138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_);
168138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz
169799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi  bool IsDeoptimized(mirror::ArtMethod* method)
170799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      LOCKS_EXCLUDED(deoptimized_methods_lock_)
171799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
172138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz
173138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // Enable method tracing by installing instrumentation entry/exit stubs.
174138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  void EnableMethodTracing()
175138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_)
176138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_);
177138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz
178138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // Disable method tracing by uninstalling instrumentation entry/exit stubs.
179138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  void DisableMethodTracing()
180138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_)
181138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_);
182138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz
183ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  InterpreterHandlerTable GetInterpreterHandlerTable() const
184ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
185ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz    return interpreter_handler_table_;
186ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz  }
187ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz
1889ef78b59da51080882e47505896b420977fd79aeMathieu Chartier  void InstrumentQuickAllocEntryPoints() LOCKS_EXCLUDED(Locks::instrument_entrypoints_lock_);
1899ef78b59da51080882e47505896b420977fd79aeMathieu Chartier  void UninstrumentQuickAllocEntryPoints() LOCKS_EXCLUDED(Locks::instrument_entrypoints_lock_);
1909ef78b59da51080882e47505896b420977fd79aeMathieu Chartier  void InstrumentQuickAllocEntryPointsLocked()
1919ef78b59da51080882e47505896b420977fd79aeMathieu Chartier      EXCLUSIVE_LOCKS_REQUIRED(Locks::instrument_entrypoints_lock_)
19269dbec6d9d55eeb2867949c2791d01dc9aa916c8Jeff Hao      LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::runtime_shutdown_lock_);
1939ef78b59da51080882e47505896b420977fd79aeMathieu Chartier  void UninstrumentQuickAllocEntryPointsLocked()
1949ef78b59da51080882e47505896b420977fd79aeMathieu Chartier      EXCLUSIVE_LOCKS_REQUIRED(Locks::instrument_entrypoints_lock_)
19569dbec6d9d55eeb2867949c2791d01dc9aa916c8Jeff Hao      LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::runtime_shutdown_lock_);
196d889178ec78930538d9d6a66c3df9ee9afaffbb4Mathieu Chartier  void ResetQuickAllocEntryPoints() EXCLUSIVE_LOCKS_REQUIRED(Locks::runtime_shutdown_lock_);
197fa82427c68b09f4aedbee319dc71579afbfc66f5Ian Rogers
19862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Update the code of a method respecting any installed stubs.
199956af0f0cb05422e38c1d22cbef309d16b8a1a12Elliott Hughes  void UpdateMethodsCode(mirror::ArtMethod* method, const void* quick_code)
200138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
20162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
20262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Get the quick code for the given method. More efficient than asking the class linker as it
20362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // will short-cut to GetCode if instrumentation and static method resolution stubs aren't
20462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // installed.
205a7dd0386f35c0ba4aef3f5b16bc84c6f4e2fc702Mathieu Chartier  const void* GetQuickCodeFor(mirror::ArtMethod* method, size_t pointer_size) const
20662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
20762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
20862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void ForceInterpretOnly() {
20962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers    interpret_only_ = true;
21062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers    forced_interpret_only_ = true;
21162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  }
21262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
213ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom  // Called by ArtMethod::Invoke to determine dispatch mechanism.
21462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  bool InterpretOnly() const {
21562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers    return interpret_only_;
21662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  }
21762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
218563b47cc142e477da244539b1d63070425e7fd78Hiroshi Yamauchi  bool IsForcedInterpretOnly() const {
219563b47cc142e477da244539b1d63070425e7fd78Hiroshi Yamauchi    return forced_interpret_only_;
220563b47cc142e477da244539b1d63070425e7fd78Hiroshi Yamauchi  }
221563b47cc142e477da244539b1d63070425e7fd78Hiroshi Yamauchi
22262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  bool AreExitStubsInstalled() const {
22362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers    return instrumentation_stubs_installed_;
22462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  }
22562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
226ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool HasMethodEntryListeners() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
22774109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz    return have_method_entry_listeners_;
22874109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz  }
22974109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz
230ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool HasMethodExitListeners() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
23174109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz    return have_method_exit_listeners_;
23274109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz  }
23374109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz
234ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool HasDexPcListeners() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
23574109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz    return have_dex_pc_listeners_;
23674109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz  }
23774109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz
238ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool HasFieldReadListeners() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2393f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz    return have_field_read_listeners_;
2403f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  }
2413f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz
242ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool HasFieldWriteListeners() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2433f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz    return have_field_write_listeners_;
2443f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  }
2453f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz
246ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool HasExceptionCaughtListeners() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2479f1020305292a21fd14a402b189c765a125226abSebastien Hertz    return have_exception_caught_listeners_;
2489f1020305292a21fd14a402b189c765a125226abSebastien Hertz  }
2499f1020305292a21fd14a402b189c765a125226abSebastien Hertz
250e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  bool HasBackwardBranchListeners() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
251e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    return have_backward_branch_listeners_;
252e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  }
253e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier
254ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool IsActive() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
255ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz    return have_dex_pc_listeners_ || have_method_entry_listeners_ || have_method_exit_listeners_ ||
25642cd43fa593e8f0427eb0ec158bef08814a6180bSebastien Hertz        have_field_read_listeners_ || have_field_write_listeners_ ||
257ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz        have_exception_caught_listeners_ || have_method_unwind_listeners_;
258ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz  }
259ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz
26062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Inform listeners that a method has been entered. A dex PC is provided as we may install
26162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // listeners into executing code and get method enter events for methods already on the stack.
26262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void MethodEnterEvent(Thread* thread, mirror::Object* this_object,
263ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                        mirror::ArtMethod* method, uint32_t dex_pc) const
26462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
26574109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz    if (UNLIKELY(HasMethodEntryListeners())) {
26662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      MethodEnterEventImpl(thread, this_object, method, dex_pc);
26762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers    }
26862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  }
26962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
27062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Inform listeners that a method has been exited.
27162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void MethodExitEvent(Thread* thread, mirror::Object* this_object,
272ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                       mirror::ArtMethod* method, uint32_t dex_pc,
27362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers                       const JValue& return_value) const
27462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
27574109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz    if (UNLIKELY(HasMethodExitListeners())) {
27662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      MethodExitEventImpl(thread, this_object, method, dex_pc, return_value);
27762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers    }
27862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  }
27962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
28062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Inform listeners that a method has been exited due to an exception.
28162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void MethodUnwindEvent(Thread* thread, mirror::Object* this_object,
282ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                         mirror::ArtMethod* method, uint32_t dex_pc) const
28362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
28462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
28562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Inform listeners that the dex pc has moved (only supported by the interpreter).
28662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void DexPcMovedEvent(Thread* thread, mirror::Object* this_object,
287ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                       mirror::ArtMethod* method, uint32_t dex_pc) const
28862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
28974109f6683096de494b1457fa6d5b0ac33b4c98cSebastien Hertz    if (UNLIKELY(HasDexPcListeners())) {
29062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      DexPcMovedEventImpl(thread, this_object, method, dex_pc);
29162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers    }
29262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  }
293725a957985171d712d5c048cc3d00ff14968784bjeffhao
294e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  // Inform listeners that a backward branch has been taken (only supported by the interpreter).
295e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  void BackwardBranch(Thread* thread, mirror::ArtMethod* method, int32_t offset) const
296e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
297e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    if (UNLIKELY(HasBackwardBranchListeners())) {
298e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier      BackwardBranchImpl(thread, method, offset);
299e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier    }
300e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  }
301e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier
3023f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  // Inform listeners that we read a field (only supported by the interpreter).
3033f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  void FieldReadEvent(Thread* thread, mirror::Object* this_object,
3043f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz                      mirror::ArtMethod* method, uint32_t dex_pc,
3053f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz                      mirror::ArtField* field) const
3063f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
3073f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz    if (UNLIKELY(HasFieldReadListeners())) {
3083f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz      FieldReadEventImpl(thread, this_object, method, dex_pc, field);
3093f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz    }
3103f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  }
3113f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz
3123f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  // Inform listeners that we write a field (only supported by the interpreter).
3133f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  void FieldWriteEvent(Thread* thread, mirror::Object* this_object,
3143f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz                       mirror::ArtMethod* method, uint32_t dex_pc,
3153f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz                       mirror::ArtField* field, const JValue& field_value) const
3163f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
3173f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz    if (UNLIKELY(HasFieldWriteListeners())) {
3183f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz      FieldWriteEventImpl(thread, this_object, method, dex_pc, field, field_value);
3193f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz    }
3203f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  }
3213f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz
32262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Inform listeners that an exception was caught.
32314691c5e786e8c2c5734f687e4c96217340771beNicolas Geoffray  void ExceptionCaughtEvent(Thread* thread, mirror::Throwable* exception_object) const
32462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
325725a957985171d712d5c048cc3d00ff14968784bjeffhao
32662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Called when an instrumented method is entered. The intended link register (lr) is saved so
32762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // that returning causes a branch to the method exit stub. Generates method enter events.
32862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void PushInstrumentationStackFrame(Thread* self, mirror::Object* this_object,
329ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom                                     mirror::ArtMethod* method, uintptr_t lr,
3309a916d3c0d0574d106c764e737c67b52988d6139Jeff Hao                                     bool interpreter_entry)
33162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
332725a957985171d712d5c048cc3d00ff14968784bjeffhao
33362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Called when an instrumented method is exited. Removes the pushed instrumentation frame
33462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // returning the intended link register. Generates method exit events.
335d58342caa97108ba413bad467c285c0377f138f5Andreas Gampe  TwoWordReturn PopInstrumentationStackFrame(Thread* self, uintptr_t* return_pc,
336d58342caa97108ba413bad467c285c0377f138f5Andreas Gampe                                             uint64_t gpr_result, uint64_t fpr_result)
33762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
338725a957985171d712d5c048cc3d00ff14968784bjeffhao
33962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Pops an instrumentation frame from the current thread and generate an unwind event.
34062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void PopMethodForUnwind(Thread* self, bool is_deoptimization) const
34162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
34262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
34362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Call back for configure stubs.
344a10aa3789544cf62a2d362c032ea8d9532b47b39Sebastien Hertz  void InstallStubsForClass(mirror::Class* klass) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
345725a957985171d712d5c048cc3d00ff14968784bjeffhao
346138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  void InstallStubsForMethod(mirror::ArtMethod* method)
347138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
348138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz
3493b05e9ba874449dbff65b01b8781001f7d93eea6Mathieu Chartier  void VisitRoots(RootCallback* callback, void* arg) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
3503b05e9ba874449dbff65b01b8781001f7d93eea6Mathieu Chartier      LOCKS_EXCLUDED(deoptimized_methods_lock_);
3513b05e9ba874449dbff65b01b8781001f7d93eea6Mathieu Chartier
352725a957985171d712d5c048cc3d00ff14968784bjeffhao private:
35362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Does the job of installing or removing instrumentation code within methods.
35462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void ConfigureStubs(bool require_entry_exit_stubs, bool require_interpreter)
35562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_)
3563b05e9ba874449dbff65b01b8781001f7d93eea6Mathieu Chartier      LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::classlinker_classes_lock_,
3573b05e9ba874449dbff65b01b8781001f7d93eea6Mathieu Chartier                     deoptimized_methods_lock_);
35862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
359ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  void UpdateInterpreterHandlerTable() EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_) {
360ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz    interpreter_handler_table_ = IsActive() ? kAlternativeHandlerTable : kMainHandlerTable;
361ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz  }
362ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz
363661974a5561e5ccdfbac8cb5d8df8b7e6f3483b8Mathieu Chartier  // No thread safety analysis to get around SetQuickAllocEntryPointsInstrumented requiring
364661974a5561e5ccdfbac8cb5d8df8b7e6f3483b8Mathieu Chartier  // exclusive access to mutator lock which you can't get if the runtime isn't started.
3659ef78b59da51080882e47505896b420977fd79aeMathieu Chartier  void SetEntrypointsInstrumented(bool instrumented) NO_THREAD_SAFETY_ANALYSIS;
366661974a5561e5ccdfbac8cb5d8df8b7e6f3483b8Mathieu Chartier
36762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void MethodEnterEventImpl(Thread* thread, mirror::Object* this_object,
368ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                            mirror::ArtMethod* method, uint32_t dex_pc) const
36962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
37062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void MethodExitEventImpl(Thread* thread, mirror::Object* this_object,
371ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                           mirror::ArtMethod* method,
37262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers                           uint32_t dex_pc, const JValue& return_value) const
37362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
37462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  void DexPcMovedEventImpl(Thread* thread, mirror::Object* this_object,
375ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers                           mirror::ArtMethod* method, uint32_t dex_pc) const
37662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
377e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  void BackwardBranchImpl(Thread* thread, mirror::ArtMethod* method, int32_t offset) const
378e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
3793f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  void FieldReadEventImpl(Thread* thread, mirror::Object* this_object,
3803f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz                           mirror::ArtMethod* method, uint32_t dex_pc,
3813f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz                           mirror::ArtField* field) const
3823f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
3833f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  void FieldWriteEventImpl(Thread* thread, mirror::Object* this_object,
3843f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz                           mirror::ArtMethod* method, uint32_t dex_pc,
3853f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz                           mirror::ArtField* field, const JValue& field_value) const
3863f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
38762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
388799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi  // Read barrier-aware utility functions for accessing deoptimized_methods_
389799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi  bool AddDeoptimizedMethod(mirror::ArtMethod* method)
390799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
391799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      EXCLUSIVE_LOCKS_REQUIRED(deoptimized_methods_lock_);
392799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi  bool FindDeoptimizedMethod(mirror::ArtMethod* method)
393799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
394799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      SHARED_LOCKS_REQUIRED(deoptimized_methods_lock_);
395799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi  bool RemoveDeoptimizedMethod(mirror::ArtMethod* method)
396799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
397799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      EXCLUSIVE_LOCKS_REQUIRED(deoptimized_methods_lock_);
398799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi  mirror::ArtMethod* BeginDeoptimizedMethod()
399799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
400799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      SHARED_LOCKS_REQUIRED(deoptimized_methods_lock_);
401799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi  bool IsDeoptimizedMethodsEmpty() const
402799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
403799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi      SHARED_LOCKS_REQUIRED(deoptimized_methods_lock_);
404799eb3a5555254427db269921042419bc30d4d86Hiroshi Yamauchi
405ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom  // Have we hijacked ArtMethod::code_ so that it calls instrumentation/interpreter code?
40662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  bool instrumentation_stubs_installed_;
40762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
408ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom  // Have we hijacked ArtMethod::code_ to reference the enter/exit stubs?
40962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  bool entry_exit_stubs_installed_;
41062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
411ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom  // Have we hijacked ArtMethod::code_ to reference the enter interpreter stub?
41262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  bool interpreter_stubs_installed_;
41362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
41462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Do we need the fidelity of events that we only get from running within the interpreter?
41562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  bool interpret_only_;
416725a957985171d712d5c048cc3d00ff14968784bjeffhao
41762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Did the runtime request we only run in the interpreter? ie -Xint mode.
41862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  bool forced_interpret_only_;
419725a957985171d712d5c048cc3d00ff14968784bjeffhao
42062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Do we have any listeners for method entry events? Short-cut to avoid taking the
42162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // instrumentation_lock_.
422ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool have_method_entry_listeners_ GUARDED_BY(Locks::mutator_lock_);
42362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
42462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Do we have any listeners for method exit events? Short-cut to avoid taking the
42562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // instrumentation_lock_.
426ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool have_method_exit_listeners_ GUARDED_BY(Locks::mutator_lock_);
42762d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
42862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Do we have any listeners for method unwind events? Short-cut to avoid taking the
42962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // instrumentation_lock_.
430ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool have_method_unwind_listeners_ GUARDED_BY(Locks::mutator_lock_);
43162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
43262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Do we have any listeners for dex move events? Short-cut to avoid taking the
43362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // instrumentation_lock_.
434ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool have_dex_pc_listeners_ GUARDED_BY(Locks::mutator_lock_);
43562d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
4363f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  // Do we have any listeners for field read events? Short-cut to avoid taking the
4373f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  // instrumentation_lock_.
438ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool have_field_read_listeners_ GUARDED_BY(Locks::mutator_lock_);
4393f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz
4403f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  // Do we have any listeners for field write events? Short-cut to avoid taking the
4413f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz  // instrumentation_lock_.
442ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool have_field_write_listeners_ GUARDED_BY(Locks::mutator_lock_);
4433f52eafe5577b8489f90dc8ed5981b3455206147Sebastien Hertz
44462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // Do we have any exception caught listeners? Short-cut to avoid taking the instrumentation_lock_.
445ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  bool have_exception_caught_listeners_ GUARDED_BY(Locks::mutator_lock_);
44662d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
447e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  // Do we have any backward branch listeners? Short-cut to avoid taking the instrumentation_lock_.
448e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  bool have_backward_branch_listeners_ GUARDED_BY(Locks::mutator_lock_);
449e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier
45062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  // The event listeners, written to with the mutator_lock_ exclusively held.
45162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  std::list<InstrumentationListener*> method_entry_listeners_ GUARDED_BY(Locks::mutator_lock_);
45262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  std::list<InstrumentationListener*> method_exit_listeners_ GUARDED_BY(Locks::mutator_lock_);
45362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  std::list<InstrumentationListener*> method_unwind_listeners_ GUARDED_BY(Locks::mutator_lock_);
454e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier  std::list<InstrumentationListener*> backward_branch_listeners_ GUARDED_BY(Locks::mutator_lock_);
455ca1d06cfa2f2b8d2be4390644e126cb68cdbb5baDaniel Mihalyi  std::shared_ptr<std::list<InstrumentationListener*>> dex_pc_listeners_
456ca1d06cfa2f2b8d2be4390644e126cb68cdbb5baDaniel Mihalyi      GUARDED_BY(Locks::mutator_lock_);
457ca1d06cfa2f2b8d2be4390644e126cb68cdbb5baDaniel Mihalyi  std::shared_ptr<std::list<InstrumentationListener*>> field_read_listeners_
458ca1d06cfa2f2b8d2be4390644e126cb68cdbb5baDaniel Mihalyi      GUARDED_BY(Locks::mutator_lock_);
459ca1d06cfa2f2b8d2be4390644e126cb68cdbb5baDaniel Mihalyi  std::shared_ptr<std::list<InstrumentationListener*>> field_write_listeners_
460ca1d06cfa2f2b8d2be4390644e126cb68cdbb5baDaniel Mihalyi      GUARDED_BY(Locks::mutator_lock_);
461ca1d06cfa2f2b8d2be4390644e126cb68cdbb5baDaniel Mihalyi  std::shared_ptr<std::list<InstrumentationListener*>> exception_caught_listeners_
462ca1d06cfa2f2b8d2be4390644e126cb68cdbb5baDaniel Mihalyi      GUARDED_BY(Locks::mutator_lock_);
463725a957985171d712d5c048cc3d00ff14968784bjeffhao
464138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // The set of methods being deoptimized (by the debugger) which must be executed with interpreter
465138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  // only.
4663b05e9ba874449dbff65b01b8781001f7d93eea6Mathieu Chartier  mutable ReaderWriterMutex deoptimized_methods_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
46794f7b49578b6aaa80de8ffed230648d601393905Hiroshi Yamauchi  std::multimap<int32_t, GcRoot<mirror::ArtMethod>> deoptimized_methods_
46894f7b49578b6aaa80de8ffed230648d601393905Hiroshi Yamauchi      GUARDED_BY(deoptimized_methods_lock_);
46911d40c250ec86c784cf76b8c31e1cf9285d555dcSebastien Hertz  bool deoptimization_enabled_;
470138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz
471fa82427c68b09f4aedbee319dc71579afbfc66f5Ian Rogers  // Current interpreter handler table. This is updated each time the thread state flags are
472fa82427c68b09f4aedbee319dc71579afbfc66f5Ian Rogers  // modified.
473ed2be1725fb79075892b1a9103487c9d9a95b350Sebastien Hertz  InterpreterHandlerTable interpreter_handler_table_ GUARDED_BY(Locks::mutator_lock_);
474ee1997a3b83334985e757f369c09e111b121661bSebastien Hertz
475fa82427c68b09f4aedbee319dc71579afbfc66f5Ian Rogers  // Greater than 0 if quick alloc entry points instrumented.
4769ef78b59da51080882e47505896b420977fd79aeMathieu Chartier  size_t quick_alloc_entry_points_instrumentation_counter_
4779ef78b59da51080882e47505896b420977fd79aeMathieu Chartier      GUARDED_BY(Locks::instrument_entrypoints_lock_);
478fa82427c68b09f4aedbee319dc71579afbfc66f5Ian Rogers
479725a957985171d712d5c048cc3d00ff14968784bjeffhao  DISALLOW_COPY_AND_ASSIGN(Instrumentation);
480725a957985171d712d5c048cc3d00ff14968784bjeffhao};
4816a3c1fcb4ba42ad4d5d142c17a3712a6ddd3866fIan Rogersstd::ostream& operator<<(std::ostream& os, const Instrumentation::InstrumentationEvent& rhs);
482725a957985171d712d5c048cc3d00ff14968784bjeffhao
48362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers// An element in the instrumentation side stack maintained in art::Thread.
48462d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogersstruct InstrumentationStackFrame {
485ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom  InstrumentationStackFrame(mirror::Object* this_object, mirror::ArtMethod* method,
4869a916d3c0d0574d106c764e737c67b52988d6139Jeff Hao                            uintptr_t return_pc, size_t frame_id, bool interpreter_entry)
4879a916d3c0d0574d106c764e737c67b52988d6139Jeff Hao      : this_object_(this_object), method_(method), return_pc_(return_pc), frame_id_(frame_id),
4889a916d3c0d0574d106c764e737c67b52988d6139Jeff Hao        interpreter_entry_(interpreter_entry) {
48962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  }
49062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
49162d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  std::string Dump() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
49262d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
49362d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers  mirror::Object* this_object_;
494ea46f950e7a51585db293cd7f047de190a482414Brian Carlstrom  mirror::ArtMethod* method_;
495138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  uintptr_t return_pc_;
496138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  size_t frame_id_;
497138dbfc3336e379d74d157086f69a0fbe830089bSebastien Hertz  bool interpreter_entry_;
49862d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers};
49962d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers
50062d6c772205b8859f0ebf7ad105402ec4c3e2e01Ian Rogers}  // namespace instrumentation
501725a957985171d712d5c048cc3d00ff14968784bjeffhao}  // namespace art
502725a957985171d712d5c048cc3d00ff14968784bjeffhao
503fc0e3219edc9a5bf81b166e82fd5db2796eb6a0dBrian Carlstrom#endif  // ART_RUNTIME_INSTRUMENTATION_H_
504