blob: 13e2bf6debd001053e74d4d4f3a8915ba70cef83 [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
17#include "trace.h"
18
jeffhaoa9ef3fd2011-12-13 18:33:43 -080019#include <sys/uio.h>
20
Jeff Hao0abc72e2013-08-13 13:45:14 -070021#include "base/stl_util.h"
Elliott Hughes76160052012-12-12 16:31:20 -080022#include "base/unix_file/fd_file.h"
jeffhaoe343b762011-12-05 16:36:44 -080023#include "class_linker.h"
Ian Rogers62d6c772013-02-27 08:32:07 -080024#include "common_throws.h"
jeffhaoa9ef3fd2011-12-13 18:33:43 -080025#include "debugger.h"
Ian Rogers4f6ad8a2013-03-18 15:27:28 -070026#include "dex_file-inl.h"
jeffhao725a9572012-11-13 18:20:12 -080027#include "instrumentation.h"
Brian Carlstromea46f952013-07-30 01:26:50 -070028#include "mirror/art_method-inl.h"
Ian Rogers4f6ad8a2013-03-18 15:27:28 -070029#include "mirror/class-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080030#include "mirror/dex_cache.h"
31#include "mirror/object_array-inl.h"
Ian Rogers4f6ad8a2013-03-18 15:27:28 -070032#include "mirror/object-inl.h"
jeffhaoa9ef3fd2011-12-13 18:33:43 -080033#include "object_utils.h"
34#include "os.h"
Ian Rogers00f7d0e2012-07-19 15:28:27 -070035#include "scoped_thread_state_change.h"
Jeff Hao0abc72e2013-08-13 13:45:14 -070036#include "ScopedLocalRef.h"
jeffhaoe343b762011-12-05 16:36:44 -080037#include "thread.h"
Ian Rogers57b86d42012-03-27 16:05:41 -070038#include "thread_list.h"
Ian Rogers166db042013-07-26 12:05:57 -070039#if !defined(ART_USE_PORTABLE_COMPILER)
40#include "entrypoints/quick/quick_entrypoints.h"
41#endif
jeffhao2692b572011-12-16 15:42:28 -080042
43namespace art {
44
Elliott Hughese119a362012-05-22 17:37:06 -070045// File format:
46// header
47// record 0
48// record 1
49// ...
50//
51// Header format:
52// u4 magic ('SLOW')
53// u2 version
54// u2 offset to data
55// u8 start date/time in usec
56// u2 record size in bytes (version >= 2 only)
57// ... padding to 32 bytes
58//
59// Record format v1:
60// u1 thread ID
61// u4 method ID | method action
62// u4 time delta since start, in usec
63//
64// Record format v2:
65// u2 thread ID
66// u4 method ID | method action
67// u4 time delta since start, in usec
68//
69// Record format v3:
70// u2 thread ID
71// u4 method ID | method action
72// u4 time delta since start, in usec
73// u4 wall time since start, in usec (when clock == "dual" only)
74//
75// 32 bits of microseconds is 70 minutes.
76//
77// All values are stored in little-endian order.
78
Ian Rogers62d6c772013-02-27 08:32:07 -080079enum TraceAction {
Brian Carlstrom7934ac22013-07-26 10:54:15 -070080 kTraceMethodEnter = 0x00, // method entry
81 kTraceMethodExit = 0x01, // method exit
82 kTraceUnroll = 0x02, // method exited by exception unrolling
Ian Rogers62d6c772013-02-27 08:32:07 -080083 // 0x03 currently unused
Brian Carlstrom7934ac22013-07-26 10:54:15 -070084 kTraceMethodActionMask = 0x03, // two bits
Ian Rogers62d6c772013-02-27 08:32:07 -080085};
86
Jeff Hao0abc72e2013-08-13 13:45:14 -070087class BuildStackTraceVisitor : public StackVisitor {
88 public:
89 explicit BuildStackTraceVisitor(Thread* thread) : StackVisitor(thread, NULL),
Ian Rogerse2f77e72013-08-13 19:19:40 -070090 method_trace_(new std::vector<mirror::ArtMethod*>) {}
Jeff Hao0abc72e2013-08-13 13:45:14 -070091
92 bool VisitFrame() {
Ian Rogerse2f77e72013-08-13 19:19:40 -070093 mirror::ArtMethod* m = GetMethod();
Jeff Hao0abc72e2013-08-13 13:45:14 -070094 // Ignore runtime frames (in particular callee save).
95 if (!m->IsRuntimeMethod()) {
96 method_trace_->push_back(m);
97 }
98 return true;
99 }
100
101 // Returns a stack trace where the topmost frame corresponds with the first element of the vector.
Ian Rogerse2f77e72013-08-13 19:19:40 -0700102 std::vector<mirror::ArtMethod*>* GetStackTrace() const {
Jeff Hao0abc72e2013-08-13 13:45:14 -0700103 return method_trace_;
104 }
105
106 private:
Ian Rogerse2f77e72013-08-13 19:19:40 -0700107 std::vector<mirror::ArtMethod*>* const method_trace_;
Jeff Hao0abc72e2013-08-13 13:45:14 -0700108};
109
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800110static const char kTraceTokenChar = '*';
111static const uint16_t kTraceHeaderLength = 32;
112static const uint32_t kTraceMagicValue = 0x574f4c53;
113static const uint16_t kTraceVersionSingleClock = 2;
114static const uint16_t kTraceVersionDualClock = 3;
Brian Carlstrom7934ac22013-07-26 10:54:15 -0700115static const uint16_t kTraceRecordSizeSingleClock = 10; // using v2
116static const uint16_t kTraceRecordSizeDualClock = 14; // using v3 with two timestamps
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800117
Ian Rogers62d6c772013-02-27 08:32:07 -0800118#if defined(HAVE_POSIX_CLOCKS)
119ProfilerClockSource Trace::default_clock_source_ = kProfilerClockSourceDual;
120#else
121ProfilerClockSource Trace::default_clock_source_ = kProfilerClockSourceWall;
122#endif
Elliott Hughese119a362012-05-22 17:37:06 -0700123
Jeff Hao0abc72e2013-08-13 13:45:14 -0700124Trace* volatile Trace::the_trace_ = NULL;
125// TODO: Add way to enable sampling and set interval through gui.
126bool Trace::sampling_enabled_ = true;
127uint32_t Trace::sampling_interval_us_ = 10000;
128pthread_t Trace::sampling_pthread_ = 0U;
Ian Rogers62d6c772013-02-27 08:32:07 -0800129
Brian Carlstromea46f952013-07-30 01:26:50 -0700130static mirror::ArtMethod* DecodeTraceMethodId(uint32_t tmid) {
131 return reinterpret_cast<mirror::ArtMethod*>(tmid & ~kTraceMethodActionMask);
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800132}
Elliott Hughese119a362012-05-22 17:37:06 -0700133
Ian Rogers62d6c772013-02-27 08:32:07 -0800134static TraceAction DecodeTraceAction(uint32_t tmid) {
135 return static_cast<TraceAction>(tmid & kTraceMethodActionMask);
136}
137
Brian Carlstromea46f952013-07-30 01:26:50 -0700138static uint32_t EncodeTraceMethodAndAction(const mirror::ArtMethod* method,
Ian Rogers62d6c772013-02-27 08:32:07 -0800139 TraceAction action) {
140 uint32_t tmid = reinterpret_cast<uint32_t>(method) | action;
141 DCHECK_EQ(method, DecodeTraceMethodId(tmid));
142 return tmid;
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800143}
144
Elliott Hughese119a362012-05-22 17:37:06 -0700145void Trace::SetDefaultClockSource(ProfilerClockSource clock_source) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800146#if defined(HAVE_POSIX_CLOCKS)
147 default_clock_source_ = clock_source;
148#else
149 if (clock_source != kProfilerClockSourceWall) {
150 LOG(WARNING) << "Ignoring tracing request to use ";
151 }
152#endif
153}
154
155static uint16_t GetTraceVersion(ProfilerClockSource clock_source) {
156 return (clock_source == kProfilerClockSourceDual) ? kTraceVersionDualClock
157 : kTraceVersionSingleClock;
158}
159
160static uint16_t GetRecordSize(ProfilerClockSource clock_source) {
161 return (clock_source == kProfilerClockSourceDual) ? kTraceRecordSizeDualClock
162 : kTraceRecordSizeSingleClock;
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800163}
164
Elliott Hughese119a362012-05-22 17:37:06 -0700165bool Trace::UseThreadCpuClock() {
Ian Rogers62d6c772013-02-27 08:32:07 -0800166 return (clock_source_ == kProfilerClockSourceThreadCpu) ||
167 (clock_source_ == kProfilerClockSourceDual);
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800168}
169
Elliott Hughese119a362012-05-22 17:37:06 -0700170bool Trace::UseWallClock() {
Ian Rogers62d6c772013-02-27 08:32:07 -0800171 return (clock_source_ == kProfilerClockSourceWall) ||
172 (clock_source_ == kProfilerClockSourceDual);
Elliott Hughese119a362012-05-22 17:37:06 -0700173}
174
175static void MeasureClockOverhead(Trace* trace) {
176 if (trace->UseThreadCpuClock()) {
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800177 ThreadCpuMicroTime();
178 }
Elliott Hughese119a362012-05-22 17:37:06 -0700179 if (trace->UseWallClock()) {
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800180 MicroTime();
181 }
182}
183
Elliott Hughese119a362012-05-22 17:37:06 -0700184static uint32_t GetClockOverhead(Trace* trace) {
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800185 uint64_t start = ThreadCpuMicroTime();
186
187 for (int i = 4000; i > 0; i--) {
Elliott Hughese119a362012-05-22 17:37:06 -0700188 MeasureClockOverhead(trace);
189 MeasureClockOverhead(trace);
190 MeasureClockOverhead(trace);
191 MeasureClockOverhead(trace);
192 MeasureClockOverhead(trace);
193 MeasureClockOverhead(trace);
194 MeasureClockOverhead(trace);
195 MeasureClockOverhead(trace);
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800196 }
197
198 uint64_t elapsed = ThreadCpuMicroTime() - start;
199 return uint32_t (elapsed / 32);
200}
201
Elliott Hughesffb465f2012-03-01 18:46:05 -0800202// TODO: put this somewhere with the big-endian equivalent used by JDWP.
203static void Append2LE(uint8_t* buf, uint16_t val) {
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800204 *buf++ = (uint8_t) val;
205 *buf++ = (uint8_t) (val >> 8);
206}
207
Elliott Hughesffb465f2012-03-01 18:46:05 -0800208// TODO: put this somewhere with the big-endian equivalent used by JDWP.
209static void Append4LE(uint8_t* buf, uint32_t val) {
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800210 *buf++ = (uint8_t) val;
211 *buf++ = (uint8_t) (val >> 8);
212 *buf++ = (uint8_t) (val >> 16);
213 *buf++ = (uint8_t) (val >> 24);
214}
215
Elliott Hughesffb465f2012-03-01 18:46:05 -0800216// TODO: put this somewhere with the big-endian equivalent used by JDWP.
217static void Append8LE(uint8_t* buf, uint64_t val) {
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800218 *buf++ = (uint8_t) val;
219 *buf++ = (uint8_t) (val >> 8);
220 *buf++ = (uint8_t) (val >> 16);
221 *buf++ = (uint8_t) (val >> 24);
222 *buf++ = (uint8_t) (val >> 32);
223 *buf++ = (uint8_t) (val >> 40);
224 *buf++ = (uint8_t) (val >> 48);
225 *buf++ = (uint8_t) (val >> 56);
226}
227
Jeff Hao0abc72e2013-08-13 13:45:14 -0700228static void GetSample(Thread* thread, void* arg) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
229 BuildStackTraceVisitor build_trace_visitor(thread);
230 build_trace_visitor.WalkStack();
Ian Rogerse2f77e72013-08-13 19:19:40 -0700231 std::vector<mirror::ArtMethod*>* stack_trace = build_trace_visitor.GetStackTrace();
Jeff Hao0abc72e2013-08-13 13:45:14 -0700232 Trace* the_trace = reinterpret_cast<Trace*>(arg);
233 the_trace->CompareAndUpdateStackTrace(thread, stack_trace);
234}
235
236void Trace::CompareAndUpdateStackTrace(Thread* thread,
Ian Rogerse2f77e72013-08-13 19:19:40 -0700237 std::vector<mirror::ArtMethod*>* stack_trace) {
Jeff Hao0abc72e2013-08-13 13:45:14 -0700238 CHECK_EQ(pthread_self(), sampling_pthread_);
Ian Rogerse2f77e72013-08-13 19:19:40 -0700239 SafeMap<Thread*, std::vector<mirror::ArtMethod*>*>::iterator map_it = thread_stack_trace_map_.find(thread);
Jeff Hao0abc72e2013-08-13 13:45:14 -0700240 if (map_it == thread_stack_trace_map_.end()) {
241 // If there's no existing stack trace in the map for this thread, log an entry event for all
242 // methods in the trace.
243 thread_stack_trace_map_.Put(thread, stack_trace);
Ian Rogerse2f77e72013-08-13 19:19:40 -0700244 for (std::vector<mirror::ArtMethod*>::reverse_iterator rit = stack_trace->rbegin();
Jeff Hao0abc72e2013-08-13 13:45:14 -0700245 rit != stack_trace->rend(); ++rit) {
246 LogMethodTraceEvent(thread, *rit, instrumentation::Instrumentation::kMethodEntered);
247 }
248 } else {
249 // If there's a previous stack trace for this thread, diff the traces and emit entry and exit
250 // events accordingly.
Ian Rogerse2f77e72013-08-13 19:19:40 -0700251 std::vector<mirror::ArtMethod*>* old_stack_trace = map_it->second;
Jeff Hao0abc72e2013-08-13 13:45:14 -0700252 thread_stack_trace_map_.Overwrite(thread, stack_trace);
Ian Rogerse2f77e72013-08-13 19:19:40 -0700253 std::vector<mirror::ArtMethod*>::reverse_iterator old_rit = old_stack_trace->rbegin();
254 std::vector<mirror::ArtMethod*>::reverse_iterator rit = stack_trace->rbegin();
Jeff Hao0abc72e2013-08-13 13:45:14 -0700255
256 // Iterate bottom-up over both traces until there's a difference between them.
257 while (old_rit != old_stack_trace->rend() && rit != stack_trace->rend() && *old_rit == *rit) {
258 old_rit++;
259 rit++;
260 }
261 // Iterate top-down over the old trace until the point where they differ, emitting exit events.
Ian Rogerse2f77e72013-08-13 19:19:40 -0700262 for (std::vector<mirror::ArtMethod*>::iterator old_it = old_stack_trace->begin();
Jeff Hao0abc72e2013-08-13 13:45:14 -0700263 old_it != old_rit.base(); ++old_it) {
264 LogMethodTraceEvent(thread, *old_it, instrumentation::Instrumentation::kMethodExited);
265 }
266 // Iterate bottom-up over the new trace from the point where they differ, emitting entry events.
267 for (; rit != stack_trace->rend(); ++rit) {
268 LogMethodTraceEvent(thread, *rit, instrumentation::Instrumentation::kMethodEntered);
269 }
270 delete old_stack_trace;
271 }
272}
273
274void* Trace::RunSamplingThread(void* arg) {
275 Runtime* runtime = Runtime::Current();
276 CHECK(runtime->AttachCurrentThread("Sampling Profiler", true, runtime->GetSystemThreadGroup(),
277 !runtime->IsCompiler()));
278
279 while (true) {
280 usleep(sampling_interval_us_);
281
282 Thread* self = Thread::Current();
283 Trace* the_trace;
284 {
285 MutexLock mu(self, *Locks::trace_lock_);
286 the_trace = the_trace_;
287 if (the_trace == NULL) {
288 break;
289 }
290 }
291
292 runtime->GetThreadList()->SuspendAll();
293 {
294 MutexLock mu(self, *Locks::thread_list_lock_);
295 runtime->GetThreadList()->ForEach(GetSample, the_trace);
296 }
297 runtime->GetThreadList()->ResumeAll();
298 }
299
300 runtime->DetachCurrentThread();
301 return NULL;
302}
303
Ian Rogers62d6c772013-02-27 08:32:07 -0800304void Trace::Start(const char* trace_filename, int trace_fd, int buffer_size, int flags,
305 bool direct_to_ddms) {
306 Thread* self = Thread::Current();
307 {
308 MutexLock mu(self, *Locks::trace_lock_);
309 if (the_trace_ != NULL) {
310 LOG(ERROR) << "Trace already in progress, ignoring this request";
311 return;
312 }
jeffhaoe343b762011-12-05 16:36:44 -0800313 }
Ian Rogers62d6c772013-02-27 08:32:07 -0800314 Runtime* runtime = Runtime::Current();
315 runtime->GetThreadList()->SuspendAll();
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800316
jeffhao2692b572011-12-16 15:42:28 -0800317 // Open trace file if not going directly to ddms.
Ian Rogers62d6c772013-02-27 08:32:07 -0800318 UniquePtr<File> trace_file;
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800319 if (!direct_to_ddms) {
320 if (trace_fd < 0) {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -0700321 trace_file.reset(OS::CreateEmptyFile(trace_filename));
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800322 } else {
Ian Rogers62d6c772013-02-27 08:32:07 -0800323 trace_file.reset(new File(trace_fd, "tracefile"));
Elliott Hughes76160052012-12-12 16:31:20 -0800324 trace_file->DisableAutoClose();
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800325 }
Ian Rogers62d6c772013-02-27 08:32:07 -0800326 if (trace_file.get() == NULL) {
jeffhaob5e81852012-03-12 11:15:45 -0700327 PLOG(ERROR) << "Unable to open trace file '" << trace_filename << "'";
Ian Rogers62d6c772013-02-27 08:32:07 -0800328 runtime->GetThreadList()->ResumeAll();
329 ScopedObjectAccess soa(self);
330 ThrowRuntimeException("Unable to open trace file '%s'", trace_filename);
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800331 return;
332 }
333 }
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800334
jeffhao2692b572011-12-16 15:42:28 -0800335 // Create Trace object.
Ian Rogers62d6c772013-02-27 08:32:07 -0800336 {
337 MutexLock mu(self, *Locks::trace_lock_);
Brian Carlstromdf629502013-07-17 22:39:56 -0700338 if (the_trace_ != NULL) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800339 LOG(ERROR) << "Trace already in progress, ignoring this request";
340 } else {
341 the_trace_ = new Trace(trace_file.release(), buffer_size, flags);
jeffhao0791adc2012-04-04 11:14:32 -0700342
Ian Rogers62d6c772013-02-27 08:32:07 -0800343 // Enable count of allocs if specified in the flags.
344 if ((flags && kTraceCountAllocs) != 0) {
345 runtime->SetStatsEnabled(true);
346 }
347
Jeff Hao0abc72e2013-08-13 13:45:14 -0700348 if (sampling_enabled_) {
349 CHECK_PTHREAD_CALL(pthread_create, (&sampling_pthread_, NULL, &RunSamplingThread, NULL),
350 "Sampling profiler thread");
351 } else {
352 runtime->GetInstrumentation()->AddListener(the_trace_,
353 instrumentation::Instrumentation::kMethodEntered |
354 instrumentation::Instrumentation::kMethodExited |
355 instrumentation::Instrumentation::kMethodUnwind);
356 }
Ian Rogers62d6c772013-02-27 08:32:07 -0800357 }
jeffhao0791adc2012-04-04 11:14:32 -0700358 }
Ian Rogers62d6c772013-02-27 08:32:07 -0800359 runtime->GetThreadList()->ResumeAll();
jeffhao2692b572011-12-16 15:42:28 -0800360}
361
362void Trace::Stop() {
Ian Rogers62d6c772013-02-27 08:32:07 -0800363 Runtime* runtime = Runtime::Current();
364 runtime->GetThreadList()->SuspendAll();
365 Trace* the_trace = NULL;
Jeff Hao0abc72e2013-08-13 13:45:14 -0700366 pthread_t sampling_pthread = 0U;
Ian Rogers62d6c772013-02-27 08:32:07 -0800367 {
368 MutexLock mu(Thread::Current(), *Locks::trace_lock_);
369 if (the_trace_ == NULL) {
370 LOG(ERROR) << "Trace stop requested, but no trace currently running";
371 } else {
372 the_trace = the_trace_;
373 the_trace_ = NULL;
Jeff Hao0abc72e2013-08-13 13:45:14 -0700374 sampling_pthread = sampling_pthread_;
375 sampling_pthread_ = 0U;
Ian Rogers62d6c772013-02-27 08:32:07 -0800376 }
jeffhao2692b572011-12-16 15:42:28 -0800377 }
Ian Rogers62d6c772013-02-27 08:32:07 -0800378 if (the_trace != NULL) {
379 the_trace->FinishTracing();
Jeff Hao0abc72e2013-08-13 13:45:14 -0700380
381 if (!sampling_enabled_) {
382 runtime->GetInstrumentation()->RemoveListener(the_trace,
383 instrumentation::Instrumentation::kMethodEntered |
384 instrumentation::Instrumentation::kMethodExited |
385 instrumentation::Instrumentation::kMethodUnwind);
386 }
Ian Rogers62d6c772013-02-27 08:32:07 -0800387 delete the_trace;
388 }
389 runtime->GetThreadList()->ResumeAll();
Jeff Hao0abc72e2013-08-13 13:45:14 -0700390
391 if (sampling_enabled_ && sampling_pthread != 0U) {
392 CHECK_PTHREAD_CALL(pthread_join, (sampling_pthread, NULL), "sampling thread shutdown");
393 }
jeffhao2692b572011-12-16 15:42:28 -0800394}
395
jeffhaob5e81852012-03-12 11:15:45 -0700396void Trace::Shutdown() {
Ian Rogers62d6c772013-02-27 08:32:07 -0800397 if (IsMethodTracingActive()) {
398 Stop();
jeffhaob5e81852012-03-12 11:15:45 -0700399 }
jeffhaob5e81852012-03-12 11:15:45 -0700400}
401
Ian Rogers62d6c772013-02-27 08:32:07 -0800402bool Trace::IsMethodTracingActive() {
403 MutexLock mu(Thread::Current(), *Locks::trace_lock_);
404 return the_trace_ != NULL;
405}
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800406
Ian Rogers62d6c772013-02-27 08:32:07 -0800407Trace::Trace(File* trace_file, int buffer_size, int flags)
408 : trace_file_(trace_file), buf_(new uint8_t[buffer_size]()), flags_(flags),
409 clock_source_(default_clock_source_), buffer_size_(buffer_size), start_time_(MicroTime()),
410 cur_offset_(0), overflow_(false) {
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800411 // Set up the beginning of the trace.
Ian Rogers62d6c772013-02-27 08:32:07 -0800412 uint16_t trace_version = GetTraceVersion(clock_source_);
jeffhao2692b572011-12-16 15:42:28 -0800413 memset(buf_.get(), 0, kTraceHeaderLength);
414 Append4LE(buf_.get(), kTraceMagicValue);
Ian Rogers62d6c772013-02-27 08:32:07 -0800415 Append2LE(buf_.get() + 4, trace_version);
jeffhao2692b572011-12-16 15:42:28 -0800416 Append2LE(buf_.get() + 6, kTraceHeaderLength);
417 Append8LE(buf_.get() + 8, start_time_);
Ian Rogers62d6c772013-02-27 08:32:07 -0800418 if (trace_version >= kTraceVersionDualClock) {
419 uint16_t record_size = GetRecordSize(clock_source_);
420 Append2LE(buf_.get() + 16, record_size);
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800421 }
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800422
jeffhao2692b572011-12-16 15:42:28 -0800423 // Update current offset.
424 cur_offset_ = kTraceHeaderLength;
Ian Rogers62d6c772013-02-27 08:32:07 -0800425}
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800426
Jeff Hao0abc72e2013-08-13 13:45:14 -0700427Trace::~Trace() {
428 CHECK_EQ(sampling_pthread_, static_cast<pthread_t>(0U));
429 STLDeleteValues(&thread_stack_trace_map_);
430}
431
Ian Rogers62d6c772013-02-27 08:32:07 -0800432static void DumpBuf(uint8_t* buf, size_t buf_size, ProfilerClockSource clock_source)
433 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
434 uint8_t* ptr = buf + kTraceHeaderLength;
435 uint8_t* end = buf + buf_size;
436
437 while (ptr < end) {
438 uint32_t tmid = ptr[2] | (ptr[3] << 8) | (ptr[4] << 16) | (ptr[5] << 24);
Brian Carlstromea46f952013-07-30 01:26:50 -0700439 mirror::ArtMethod* method = DecodeTraceMethodId(tmid);
Ian Rogers62d6c772013-02-27 08:32:07 -0800440 TraceAction action = DecodeTraceAction(tmid);
441 LOG(INFO) << PrettyMethod(method) << " " << static_cast<int>(action);
442 ptr += GetRecordSize(clock_source);
443 }
jeffhaoe343b762011-12-05 16:36:44 -0800444}
445
jeffhao2692b572011-12-16 15:42:28 -0800446void Trace::FinishTracing() {
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800447 // Compute elapsed time.
448 uint64_t elapsed = MicroTime() - start_time_;
449
450 size_t final_offset = cur_offset_;
Elliott Hughese119a362012-05-22 17:37:06 -0700451 uint32_t clock_overhead = GetClockOverhead(this);
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800452
jeffhao0791adc2012-04-04 11:14:32 -0700453 if ((flags_ & kTraceCountAllocs) != 0) {
454 Runtime::Current()->SetStatsEnabled(false);
455 }
456
Brian Carlstromea46f952013-07-30 01:26:50 -0700457 std::set<mirror::ArtMethod*> visited_methods;
Ian Rogers62d6c772013-02-27 08:32:07 -0800458 GetVisitedMethods(final_offset, &visited_methods);
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800459
460 std::ostringstream os;
461
462 os << StringPrintf("%cversion\n", kTraceTokenChar);
Ian Rogers62d6c772013-02-27 08:32:07 -0800463 os << StringPrintf("%d\n", GetTraceVersion(clock_source_));
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800464 os << StringPrintf("data-file-overflow=%s\n", overflow_ ? "true" : "false");
465 if (UseThreadCpuClock()) {
466 if (UseWallClock()) {
467 os << StringPrintf("clock=dual\n");
468 } else {
469 os << StringPrintf("clock=thread-cpu\n");
470 }
471 } else {
472 os << StringPrintf("clock=wall\n");
473 }
474 os << StringPrintf("elapsed-time-usec=%llu\n", elapsed);
Ian Rogers62d6c772013-02-27 08:32:07 -0800475 size_t num_records = (final_offset - kTraceHeaderLength) / GetRecordSize(clock_source_);
476 os << StringPrintf("num-method-calls=%zd\n", num_records);
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800477 os << StringPrintf("clock-call-overhead-nsec=%d\n", clock_overhead);
478 os << StringPrintf("vm=art\n");
jeffhao0791adc2012-04-04 11:14:32 -0700479 if ((flags_ & kTraceCountAllocs) != 0) {
480 os << StringPrintf("alloc-count=%d\n", Runtime::Current()->GetStat(KIND_ALLOCATED_OBJECTS));
481 os << StringPrintf("alloc-size=%d\n", Runtime::Current()->GetStat(KIND_ALLOCATED_BYTES));
482 os << StringPrintf("gc-count=%d\n", Runtime::Current()->GetStat(KIND_GC_INVOCATIONS));
483 }
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800484 os << StringPrintf("%cthreads\n", kTraceTokenChar);
485 DumpThreadList(os);
486 os << StringPrintf("%cmethods\n", kTraceTokenChar);
Ian Rogers62d6c772013-02-27 08:32:07 -0800487 DumpMethodList(os, visited_methods);
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800488 os << StringPrintf("%cend\n", kTraceTokenChar);
489
490 std::string header(os.str());
jeffhao2692b572011-12-16 15:42:28 -0800491 if (trace_file_.get() == NULL) {
Elliott Hughes7b9d9962012-04-20 18:48:18 -0700492 iovec iov[2];
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800493 iov[0].iov_base = reinterpret_cast<void*>(const_cast<char*>(header.c_str()));
494 iov[0].iov_len = header.length();
jeffhao2692b572011-12-16 15:42:28 -0800495 iov[1].iov_base = buf_.get();
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800496 iov[1].iov_len = final_offset;
497 Dbg::DdmSendChunkV(CHUNK_TYPE("MPSE"), iov, 2);
Ian Rogers62d6c772013-02-27 08:32:07 -0800498 const bool kDumpTraceInfo = false;
499 if (kDumpTraceInfo) {
500 LOG(INFO) << "Trace sent:\n" << header;
501 DumpBuf(buf_.get(), final_offset, clock_source_);
502 }
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800503 } else {
504 if (!trace_file_->WriteFully(header.c_str(), header.length()) ||
jeffhao2692b572011-12-16 15:42:28 -0800505 !trace_file_->WriteFully(buf_.get(), final_offset)) {
Elliott Hughes7b9d9962012-04-20 18:48:18 -0700506 std::string detail(StringPrintf("Trace data write failed: %s", strerror(errno)));
507 PLOG(ERROR) << detail;
Ian Rogers62d6c772013-02-27 08:32:07 -0800508 ThrowRuntimeException("%s", detail.c_str());
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800509 }
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800510 }
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800511}
512
Ian Rogers62d6c772013-02-27 08:32:07 -0800513void Trace::DexPcMoved(Thread* thread, mirror::Object* this_object,
Brian Carlstromea46f952013-07-30 01:26:50 -0700514 const mirror::ArtMethod* method, uint32_t new_dex_pc) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800515 // We're not recorded to listen to this kind of event, so complain.
516 LOG(ERROR) << "Unexpected dex PC event in tracing " << PrettyMethod(method) << " " << new_dex_pc;
517};
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800518
Ian Rogers62d6c772013-02-27 08:32:07 -0800519void Trace::MethodEntered(Thread* thread, mirror::Object* this_object,
Brian Carlstromea46f952013-07-30 01:26:50 -0700520 const mirror::ArtMethod* method, uint32_t dex_pc) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800521 LogMethodTraceEvent(thread, method, instrumentation::Instrumentation::kMethodEntered);
522}
523
524void Trace::MethodExited(Thread* thread, mirror::Object* this_object,
Brian Carlstromea46f952013-07-30 01:26:50 -0700525 const mirror::ArtMethod* method, uint32_t dex_pc,
Ian Rogers62d6c772013-02-27 08:32:07 -0800526 const JValue& return_value) {
527 UNUSED(return_value);
528 LogMethodTraceEvent(thread, method, instrumentation::Instrumentation::kMethodExited);
529}
530
Brian Carlstromea46f952013-07-30 01:26:50 -0700531void Trace::MethodUnwind(Thread* thread, const mirror::ArtMethod* method, uint32_t dex_pc) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800532 LogMethodTraceEvent(thread, method, instrumentation::Instrumentation::kMethodUnwind);
533}
534
535void Trace::ExceptionCaught(Thread* thread, const ThrowLocation& throw_location,
Brian Carlstromea46f952013-07-30 01:26:50 -0700536 mirror::ArtMethod* catch_method, uint32_t catch_dex_pc,
Ian Rogers62d6c772013-02-27 08:32:07 -0800537 mirror::Throwable* exception_object)
538 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
539 LOG(ERROR) << "Unexpected exception caught event in tracing";
540}
541
Brian Carlstromea46f952013-07-30 01:26:50 -0700542void Trace::LogMethodTraceEvent(Thread* thread, const mirror::ArtMethod* method,
Ian Rogers62d6c772013-02-27 08:32:07 -0800543 instrumentation::Instrumentation::InstrumentationEvent event) {
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800544 // Advance cur_offset_ atomically.
545 int32_t new_offset;
546 int32_t old_offset;
547 do {
548 old_offset = cur_offset_;
Ian Rogers62d6c772013-02-27 08:32:07 -0800549 new_offset = old_offset + GetRecordSize(clock_source_);
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800550 if (new_offset > buffer_size_) {
551 overflow_ = true;
552 return;
553 }
554 } while (android_atomic_release_cas(old_offset, new_offset, &cur_offset_) != 0);
555
Ian Rogers62d6c772013-02-27 08:32:07 -0800556 TraceAction action = kTraceMethodEnter;
557 switch (event) {
558 case instrumentation::Instrumentation::kMethodEntered:
559 action = kTraceMethodEnter;
560 break;
561 case instrumentation::Instrumentation::kMethodExited:
562 action = kTraceMethodExit;
563 break;
564 case instrumentation::Instrumentation::kMethodUnwind:
565 action = kTraceUnroll;
566 break;
567 default:
568 UNIMPLEMENTED(FATAL) << "Unexpected event: " << event;
569 }
570
571 uint32_t method_value = EncodeTraceMethodAndAction(method, action);
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800572
573 // Write data
jeffhao2692b572011-12-16 15:42:28 -0800574 uint8_t* ptr = buf_.get() + old_offset;
Ian Rogers62d6c772013-02-27 08:32:07 -0800575 Append2LE(ptr, thread->GetTid());
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800576 Append4LE(ptr + 2, method_value);
577 ptr += 6;
578
579 if (UseThreadCpuClock()) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800580 // TODO: this isn't vaguely thread safe.
581 SafeMap<Thread*, uint64_t>::iterator it = thread_clock_base_map_.find(thread);
582 uint32_t thread_clock_diff = 0;
583 if (UNLIKELY(it == thread_clock_base_map_.end())) {
584 // First event, the diff is 0, record the base time in the map.
585 uint64_t time = ThreadCpuMicroTime();
586 thread_clock_base_map_.Put(thread, time);
587 } else {
588 uint64_t thread_clock_base = it->second;
589 thread_clock_diff = ThreadCpuMicroTime() - thread_clock_base;
590 }
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800591 Append4LE(ptr, thread_clock_diff);
592 ptr += 4;
593 }
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800594 if (UseWallClock()) {
595 uint32_t wall_clock_diff = MicroTime() - start_time_;
596 Append4LE(ptr, wall_clock_diff);
597 }
598}
599
Ian Rogers62d6c772013-02-27 08:32:07 -0800600void Trace::GetVisitedMethods(size_t buf_size,
Brian Carlstromea46f952013-07-30 01:26:50 -0700601 std::set<mirror::ArtMethod*>* visited_methods) {
jeffhao2692b572011-12-16 15:42:28 -0800602 uint8_t* ptr = buf_.get() + kTraceHeaderLength;
Ian Rogers62d6c772013-02-27 08:32:07 -0800603 uint8_t* end = buf_.get() + buf_size;
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800604
605 while (ptr < end) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800606 uint32_t tmid = ptr[2] | (ptr[3] << 8) | (ptr[4] << 16) | (ptr[5] << 24);
Brian Carlstromea46f952013-07-30 01:26:50 -0700607 mirror::ArtMethod* method = DecodeTraceMethodId(tmid);
Ian Rogers62d6c772013-02-27 08:32:07 -0800608 visited_methods->insert(method);
609 ptr += GetRecordSize(clock_source_);
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800610 }
611}
612
Ian Rogers62d6c772013-02-27 08:32:07 -0800613void Trace::DumpMethodList(std::ostream& os,
Brian Carlstromea46f952013-07-30 01:26:50 -0700614 const std::set<mirror::ArtMethod*>& visited_methods) {
615 typedef std::set<mirror::ArtMethod*>::const_iterator It; // TODO: C++0x auto
Ian Rogers62d6c772013-02-27 08:32:07 -0800616 MethodHelper mh;
617 for (It it = visited_methods.begin(); it != visited_methods.end(); ++it) {
Brian Carlstromea46f952013-07-30 01:26:50 -0700618 mirror::ArtMethod* method = *it;
Ian Rogers62d6c772013-02-27 08:32:07 -0800619 mh.ChangeMethod(method);
Ian Rogers0399dde2012-06-06 17:09:28 -0700620 os << StringPrintf("%p\t%s\t%s\t%s\t%s\n", method,
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800621 PrettyDescriptor(mh.GetDeclaringClassDescriptor()).c_str(), mh.GetName(),
Ian Rogers0399dde2012-06-06 17:09:28 -0700622 mh.GetSignature().c_str(), mh.GetDeclaringClassSourceFile());
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800623 }
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800624}
625
626static void DumpThread(Thread* t, void* arg) {
Elliott Hughesffb465f2012-03-01 18:46:05 -0800627 std::ostream& os = *reinterpret_cast<std::ostream*>(arg);
628 std::string name;
629 t->GetThreadName(name);
630 os << t->GetTid() << "\t" << name << "\n";
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800631}
632
633void Trace::DumpThreadList(std::ostream& os) {
Ian Rogers81d425b2012-09-27 16:03:43 -0700634 Thread* self = Thread::Current();
635 Locks::thread_list_lock_->AssertNotHeld(self);
636 MutexLock mu(self, *Locks::thread_list_lock_);
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800637 Runtime::Current()->GetThreadList()->ForEach(DumpThread, &os);
jeffhaoe343b762011-12-05 16:36:44 -0800638}
639
jeffhaoe343b762011-12-05 16:36:44 -0800640} // namespace art