blob: bf4995a459fa9286c35ab78c634d1230caf4cccf [file] [log] [blame]
Elliott Hughes2faa5f12012-01-30 14:42:07 -08001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
jeffhaoe343b762011-12-05 16:36:44 -080016
Brian Carlstromfc0e3212013-07-17 14:40:12 -070017#ifndef ART_RUNTIME_TRACE_H_
18#define ART_RUNTIME_TRACE_H_
jeffhaoe343b762011-12-05 16:36:44 -080019
jeffhaoa9ef3fd2011-12-13 18:33:43 -080020#include <ostream>
21#include <set>
22#include <string>
Jeff Hao0abc72e2013-08-13 13:45:14 -070023#include <vector>
jeffhaoe343b762011-12-05 16:36:44 -080024
Elliott Hughes76160052012-12-12 16:31:20 -080025#include "base/macros.h"
jeffhaoe343b762011-12-05 16:36:44 -080026#include "globals.h"
Ian Rogers62d6c772013-02-27 08:32:07 -080027#include "instrumentation.h"
Elliott Hughes76160052012-12-12 16:31:20 -080028#include "os.h"
Elliott Hughesa0e18062012-04-13 15:59:59 -070029#include "safe_map.h"
jeffhao2692b572011-12-16 15:42:28 -080030#include "UniquePtr.h"
jeffhaoe343b762011-12-05 16:36:44 -080031
32namespace art {
33
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080034namespace mirror {
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +020035 class ArtField;
Brian Carlstromea46f952013-07-30 01:26:50 -070036 class ArtMethod;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080037} // namespace mirror
jeffhaoa9ef3fd2011-12-13 18:33:43 -080038class Thread;
jeffhaoe343b762011-12-05 16:36:44 -080039
Elliott Hughescfbe73d2012-05-22 17:37:06 -070040enum ProfilerClockSource {
41 kProfilerClockSourceThreadCpu,
42 kProfilerClockSourceWall,
Ian Rogers62d6c772013-02-27 08:32:07 -080043 kProfilerClockSourceDual, // Both wall and thread CPU clocks.
Elliott Hughescfbe73d2012-05-22 17:37:06 -070044};
45
Brian Carlstrom491ca9e2014-03-02 18:24:38 -080046#if defined(HAVE_POSIX_CLOCKS)
47const ProfilerClockSource kDefaultProfilerClockSource = kProfilerClockSourceDual;
48#else
49const ProfilerClockSource kDefaultProfilerClockSource = kProfilerClockSourceWall;
50#endif
51
Jeff Hao64caa7d2013-08-29 11:18:01 -070052enum TracingMode {
53 kTracingInactive,
54 kMethodTracingActive,
55 kSampleProfilingActive,
56};
57
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +020058class Trace FINAL : public instrumentation::InstrumentationListener {
jeffhaoe343b762011-12-05 16:36:44 -080059 public:
jeffhao0791adc2012-04-04 11:14:32 -070060 enum TraceFlag {
61 kTraceCountAllocs = 1,
62 };
63
Elliott Hughescfbe73d2012-05-22 17:37:06 -070064 static void SetDefaultClockSource(ProfilerClockSource clock_source);
65
Ian Rogers62d6c772013-02-27 08:32:07 -080066 static void Start(const char* trace_filename, int trace_fd, int buffer_size, int flags,
Jeff Hao23009dc2013-08-22 15:36:42 -070067 bool direct_to_ddms, bool sampling_enabled, int interval_us)
Ian Rogers62d6c772013-02-27 08:32:07 -080068 LOCKS_EXCLUDED(Locks::mutator_lock_,
69 Locks::thread_list_lock_,
70 Locks::thread_suspend_count_lock_,
71 Locks::trace_lock_);
72 static void Stop() LOCKS_EXCLUDED(Locks::trace_lock_);
73 static void Shutdown() LOCKS_EXCLUDED(Locks::trace_lock_);
Jeff Hao64caa7d2013-08-29 11:18:01 -070074 static TracingMode GetMethodTracingMode() LOCKS_EXCLUDED(Locks::trace_lock_);
jeffhaoe343b762011-12-05 16:36:44 -080075
Elliott Hughescfbe73d2012-05-22 17:37:06 -070076 bool UseWallClock();
77 bool UseThreadCpuClock();
78
Ian Rogerse2f77e72013-08-13 19:19:40 -070079 void CompareAndUpdateStackTrace(Thread* thread, std::vector<mirror::ArtMethod*>* stack_trace)
Jeff Hao0abc72e2013-08-13 13:45:14 -070080 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
81
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +020082 // InstrumentationListener implementation.
83 void MethodEntered(Thread* thread, mirror::Object* this_object,
84 mirror::ArtMethod* method, uint32_t dex_pc)
85 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) OVERRIDE;
86 void MethodExited(Thread* thread, mirror::Object* this_object,
87 mirror::ArtMethod* method, uint32_t dex_pc,
88 const JValue& return_value)
89 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) OVERRIDE;
90 void MethodUnwind(Thread* thread, mirror::Object* this_object,
91 mirror::ArtMethod* method, uint32_t dex_pc)
92 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) OVERRIDE;
93 void DexPcMoved(Thread* thread, mirror::Object* this_object,
94 mirror::ArtMethod* method, uint32_t new_dex_pc)
95 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) OVERRIDE;
96 void FieldRead(Thread* thread, mirror::Object* this_object,
97 mirror::ArtMethod* method, uint32_t dex_pc, mirror::ArtField* field)
98 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) OVERRIDE;
99 void FieldWritten(Thread* thread, mirror::Object* this_object,
100 mirror::ArtMethod* method, uint32_t dex_pc, mirror::ArtField* field,
101 const JValue& field_value)
102 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) OVERRIDE;
103 void ExceptionCaught(Thread* thread, const ThrowLocation& throw_location,
104 mirror::ArtMethod* catch_method, uint32_t catch_dex_pc,
105 mirror::Throwable* exception_object)
106 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) OVERRIDE;
Brian Carlstrom0cd7ec22013-07-17 23:40:20 -0700107
Jeff Hao5ce4b172013-08-16 16:27:18 -0700108 // Reuse an old stack trace if it exists, otherwise allocate a new one.
109 static std::vector<mirror::ArtMethod*>* AllocStackTrace();
110 // Clear and store an old stack trace for later use.
111 static void FreeStackTrace(std::vector<mirror::ArtMethod*>* stack_trace);
112
jeffhaoe343b762011-12-05 16:36:44 -0800113 private:
Jeff Hao23009dc2013-08-22 15:36:42 -0700114 explicit Trace(File* trace_file, int buffer_size, int flags, bool sampling_enabled);
jeffhao2692b572011-12-16 15:42:28 -0800115
Jeff Hao23009dc2013-08-22 15:36:42 -0700116 // The sampling interval in microseconds is passed as an argument.
Jeff Hao0abc72e2013-08-13 13:45:14 -0700117 static void* RunSamplingThread(void* arg) LOCKS_EXCLUDED(Locks::trace_lock_);
118
Ian Rogersb726dcb2012-09-05 08:57:23 -0700119 void FinishTracing() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
jeffhao2692b572011-12-16 15:42:28 -0800120
Jeff Haoc1ff4b72013-08-19 11:33:10 -0700121 void ReadClocks(Thread* thread, uint32_t* thread_clock_diff, uint32_t* wall_clock_diff);
122
Ian Rogersef7d42f2014-01-06 12:55:46 -0800123 void LogMethodTraceEvent(Thread* thread, mirror::ArtMethod* method,
Jeff Haoc1ff4b72013-08-19 11:33:10 -0700124 instrumentation::Instrumentation::InstrumentationEvent event,
125 uint32_t thread_clock_diff, uint32_t wall_clock_diff);
Ian Rogers62d6c772013-02-27 08:32:07 -0800126
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800127 // Methods to output traced methods and threads.
Brian Carlstromea46f952013-07-30 01:26:50 -0700128 void GetVisitedMethods(size_t end_offset, std::set<mirror::ArtMethod*>* visited_methods);
129 void DumpMethodList(std::ostream& os, const std::set<mirror::ArtMethod*>& visited_methods)
Ian Rogers62d6c772013-02-27 08:32:07 -0800130 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogersb726dcb2012-09-05 08:57:23 -0700131 void DumpThreadList(std::ostream& os) LOCKS_EXCLUDED(Locks::thread_list_lock_);
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800132
Ian Rogers62d6c772013-02-27 08:32:07 -0800133 // Singleton instance of the Trace or NULL when no method tracing is active.
Jeff Hao0abc72e2013-08-13 13:45:14 -0700134 static Trace* volatile the_trace_ GUARDED_BY(Locks::trace_lock_);
Ian Rogers62d6c772013-02-27 08:32:07 -0800135
136 // The default profiler clock source.
137 static ProfilerClockSource default_clock_source_;
jeffhaoe343b762011-12-05 16:36:44 -0800138
Jeff Hao0abc72e2013-08-13 13:45:14 -0700139 // Sampling thread, non-zero when sampling.
140 static pthread_t sampling_pthread_;
141
Jeff Hao5ce4b172013-08-16 16:27:18 -0700142 // Used to remember an unused stack trace to avoid re-allocation during sampling.
143 static UniquePtr<std::vector<mirror::ArtMethod*> > temp_stack_trace_;
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800144
jeffhao2692b572011-12-16 15:42:28 -0800145 // File to write trace data out to, NULL if direct to ddms.
146 UniquePtr<File> trace_file_;
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800147
jeffhao2692b572011-12-16 15:42:28 -0800148 // Buffer to store trace data.
149 UniquePtr<uint8_t> buf_;
150
jeffhao0791adc2012-04-04 11:14:32 -0700151 // Flags enabling extra tracing of things such as alloc counts.
Ian Rogers62d6c772013-02-27 08:32:07 -0800152 const int flags_;
jeffhao0791adc2012-04-04 11:14:32 -0700153
Jeff Hao23009dc2013-08-22 15:36:42 -0700154 // True if traceview should sample instead of instrumenting method entry/exit.
155 const bool sampling_enabled_;
156
Ian Rogers62d6c772013-02-27 08:32:07 -0800157 const ProfilerClockSource clock_source_;
Elliott Hughescfbe73d2012-05-22 17:37:06 -0700158
Ian Rogers62d6c772013-02-27 08:32:07 -0800159 // Size of buf_.
160 const int buffer_size_;
jeffhao2692b572011-12-16 15:42:28 -0800161
Ian Rogers62d6c772013-02-27 08:32:07 -0800162 // Time trace was created.
163 const uint64_t start_time_;
164
165 // Offset into buf_.
jeffhao2692b572011-12-16 15:42:28 -0800166 volatile int32_t cur_offset_;
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800167
Ian Rogers62d6c772013-02-27 08:32:07 -0800168 // Did we overflow the buffer recording traces?
169 bool overflow_;
170
jeffhaoe343b762011-12-05 16:36:44 -0800171 DISALLOW_COPY_AND_ASSIGN(Trace);
172};
173
174} // namespace art
175
Brian Carlstromfc0e3212013-07-17 14:40:12 -0700176#endif // ART_RUNTIME_TRACE_H_