mirror of
https://github.com/dart-lang/sdk
synced 2024-09-05 00:13:50 +00:00
![Ryan Macnak](/assets/img/avatar_default.png)
Assume the embedder provides static strings for event labels. TEST=Instruments Bug: https://github.com/dart-lang/sdk/issues/49178 Change-Id: I40aa4996fed2b1230da64d182e6f172f60480fdf Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/251145 Reviewed-by: Siva Annamalai <asiva@google.com> Commit-Queue: Ryan Macnak <rmacnak@google.com>
1096 lines
32 KiB
C++
1096 lines
32 KiB
C++
// Copyright (c) 2015, the Dart project authors. Please see the AUTHORS file
|
|
// for details. All rights reserved. Use of this source code is governed by a
|
|
// BSD-style license that can be found in the LICENSE file.
|
|
|
|
#ifndef RUNTIME_VM_TIMELINE_H_
|
|
#define RUNTIME_VM_TIMELINE_H_
|
|
|
|
#include "include/dart_tools_api.h"
|
|
|
|
#include "platform/atomic.h"
|
|
#include "vm/allocation.h"
|
|
#include "vm/bitfield.h"
|
|
#include "vm/globals.h"
|
|
#include "vm/growable_array.h"
|
|
#include "vm/os.h"
|
|
#include "vm/os_thread.h"
|
|
|
|
#if defined(FUCHSIA_SDK) || defined(DART_HOST_OS_FUCHSIA)
|
|
#include <lib/trace-engine/context.h>
|
|
#include <lib/trace-engine/instrumentation.h>
|
|
#elif defined(DART_HOST_OS_MACOS)
|
|
#include <os/availability.h>
|
|
#if defined(__MAC_10_14) || defined (__IPHONE_12_0)
|
|
#define DART_HOST_OS_SUPPORTS_SIGNPOST 1
|
|
#endif
|
|
// signpost.h exists in macOS 10.14, iOS 12 or above
|
|
#if defined(DART_HOST_OS_SUPPORTS_SIGNPOST)
|
|
#include <os/signpost.h>
|
|
#else
|
|
#include <os/log.h>
|
|
#endif
|
|
#endif
|
|
|
|
namespace dart {
|
|
|
|
class JSONArray;
|
|
class JSONObject;
|
|
class JSONStream;
|
|
class JSONWriter;
|
|
class Object;
|
|
class ObjectPointerVisitor;
|
|
class Isolate;
|
|
class Thread;
|
|
class TimelineEvent;
|
|
class TimelineEventBlock;
|
|
class TimelineEventRecorder;
|
|
class TimelineStream;
|
|
class VirtualMemory;
|
|
class Zone;
|
|
|
|
#define CALLBACK_RECORDER_NAME "Callback"
|
|
#define ENDLESS_RECORDER_NAME "Endless"
|
|
#define FILE_RECORDER_NAME "File"
|
|
#define FUCHSIA_RECORDER_NAME "Fuchsia"
|
|
#define MACOS_RECORDER_NAME "Macos"
|
|
#define RING_RECORDER_NAME "Ring"
|
|
#define STARTUP_RECORDER_NAME "Startup"
|
|
#define SYSTRACE_RECORDER_NAME "Systrace"
|
|
|
|
// (name, fuchsia_name, has_static_labels).
|
|
#define TIMELINE_STREAM_LIST(V) \
|
|
V(API, "dart:api", true) \
|
|
V(Compiler, "dart:compiler", true) \
|
|
V(CompilerVerbose, "dart:compiler.verbose", true) \
|
|
V(Dart, "dart:dart", false) \
|
|
V(Debugger, "dart:debugger", true) \
|
|
V(Embedder, "dart:embedder", true) \
|
|
V(GC, "dart:gc", true) \
|
|
V(Isolate, "dart:isolate", true) \
|
|
V(VM, "dart:vm", true)
|
|
|
|
// A stream of timeline events. A stream has a name and can be enabled or
|
|
// disabled (globally and per isolate).
|
|
class TimelineStream {
|
|
public:
|
|
TimelineStream(const char* name,
|
|
const char* fuchsia_name,
|
|
bool static_labels,
|
|
bool enabled);
|
|
|
|
const char* name() const { return name_; }
|
|
const char* fuchsia_name() const { return fuchsia_name_; }
|
|
|
|
bool enabled() {
|
|
#if defined(DART_HOST_OS_FUCHSIA)
|
|
#ifdef PRODUCT
|
|
return trace_is_category_enabled(fuchsia_name_);
|
|
#else
|
|
return trace_is_category_enabled(fuchsia_name_) || enabled_ != 0;
|
|
#endif // PRODUCT
|
|
#else
|
|
return enabled_ != 0;
|
|
#endif // defined(DART_HOST_OS_FUCHSIA)
|
|
}
|
|
|
|
void set_enabled(bool enabled) { enabled_ = enabled ? 1 : 0; }
|
|
|
|
// Records an event. Will return |NULL| if not enabled. The returned
|
|
// |TimelineEvent| is in an undefined state and must be initialized.
|
|
// NOTE: It is not allowed to call StartEvent again without completing
|
|
// the first event.
|
|
TimelineEvent* StartEvent();
|
|
|
|
static intptr_t enabled_offset() {
|
|
return OFFSET_OF(TimelineStream, enabled_);
|
|
}
|
|
|
|
#if defined(DART_HOST_OS_FUCHSIA)
|
|
trace_site_t* trace_site() { return &trace_site_; }
|
|
#elif defined(DART_HOST_OS_MACOS)
|
|
os_log_t macos_log() const { return macos_log_; }
|
|
bool has_static_labels() const { return has_static_labels_; }
|
|
#endif
|
|
|
|
private:
|
|
const char* const name_;
|
|
const char* const fuchsia_name_;
|
|
|
|
// This field is accessed by generated code (intrinsic) and expects to see
|
|
// 0 or 1. If this becomes a BitField, the generated code must be updated.
|
|
uintptr_t enabled_;
|
|
|
|
#if defined(DART_HOST_OS_FUCHSIA)
|
|
trace_site_t trace_site_ = {};
|
|
#elif defined(DART_HOST_OS_MACOS)
|
|
os_log_t macos_log_ = {};
|
|
bool has_static_labels_ = false;
|
|
#endif
|
|
};
|
|
|
|
class RecorderLock : public AllStatic {
|
|
public:
|
|
static void EnterLock() {
|
|
outstanding_event_writes_.fetch_add(1, std::memory_order_acquire);
|
|
}
|
|
|
|
static void ExitLock() {
|
|
intptr_t count =
|
|
outstanding_event_writes_.fetch_sub(1, std::memory_order_release);
|
|
ASSERT(count >= 0);
|
|
}
|
|
|
|
static bool IsShuttingDown() {
|
|
return shutdown_lock_.load(std::memory_order_relaxed);
|
|
}
|
|
|
|
static void WaitForShutdown() {
|
|
shutdown_lock_.exchange(true);
|
|
// Spin waiting for outstanding events to be completed.
|
|
while (outstanding_event_writes_.load(std::memory_order_relaxed) > 0) {
|
|
}
|
|
}
|
|
|
|
private:
|
|
static std::atomic<bool> shutdown_lock_;
|
|
static std::atomic<intptr_t> outstanding_event_writes_;
|
|
|
|
DISALLOW_COPY_AND_ASSIGN(RecorderLock);
|
|
};
|
|
|
|
class RecorderLockScope {
|
|
public:
|
|
RecorderLockScope() { RecorderLock::EnterLock(); }
|
|
|
|
~RecorderLockScope() { RecorderLock::ExitLock(); }
|
|
|
|
bool IsShuttingDown() { return RecorderLock::IsShuttingDown(); }
|
|
|
|
private:
|
|
DISALLOW_COPY_AND_ASSIGN(RecorderLockScope);
|
|
};
|
|
|
|
class Timeline : public AllStatic {
|
|
public:
|
|
// Initialize timeline system. Not thread safe.
|
|
static void Init();
|
|
|
|
// Cleanup timeline system. Not thread safe.
|
|
static void Cleanup();
|
|
|
|
// Access the global recorder. Not thread safe.
|
|
static TimelineEventRecorder* recorder() { return recorder_; }
|
|
|
|
static bool recorder_discards_clock_values() {
|
|
return recorder_discards_clock_values_;
|
|
}
|
|
static void set_recorder_discards_clock_values(bool value) {
|
|
recorder_discards_clock_values_ = value;
|
|
}
|
|
|
|
// Reclaim all |TimelineEventBlocks|s that are cached by threads.
|
|
static void ReclaimCachedBlocksFromThreads();
|
|
|
|
static void Clear();
|
|
|
|
#ifndef PRODUCT
|
|
// Print information about streams to JSON.
|
|
static void PrintFlagsToJSON(JSONStream* json);
|
|
|
|
// Output the recorded streams to a JSONS array.
|
|
static void PrintFlagsToJSONArray(JSONArray* arr);
|
|
#endif
|
|
|
|
#define TIMELINE_STREAM_ACCESSOR(name, ...) \
|
|
static TimelineStream* Get##name##Stream() { return &stream_##name##_; }
|
|
TIMELINE_STREAM_LIST(TIMELINE_STREAM_ACCESSOR)
|
|
#undef TIMELINE_STREAM_ACCESSOR
|
|
|
|
#define TIMELINE_STREAM_FLAGS(name, ...) \
|
|
static void SetStream##name##Enabled(bool enabled) { \
|
|
stream_##name##_.set_enabled(enabled); \
|
|
}
|
|
TIMELINE_STREAM_LIST(TIMELINE_STREAM_FLAGS)
|
|
#undef TIMELINE_STREAM_FLAGS
|
|
|
|
private:
|
|
static void ClearUnsafe();
|
|
static void ReclaimCachedBlocksFromThreadsUnsafe();
|
|
|
|
static TimelineEventRecorder* recorder_;
|
|
static MallocGrowableArray<char*>* enabled_streams_;
|
|
static bool recorder_discards_clock_values_;
|
|
|
|
#define TIMELINE_STREAM_DECLARE(name, ...) \
|
|
static TimelineStream stream_##name##_;
|
|
TIMELINE_STREAM_LIST(TIMELINE_STREAM_DECLARE)
|
|
#undef TIMELINE_STREAM_DECLARE
|
|
|
|
static RecorderLock recorder_lock_;
|
|
|
|
template <class>
|
|
friend class TimelineRecorderOverride;
|
|
friend class ReclaimBlocksIsolateVisitor;
|
|
};
|
|
|
|
struct TimelineEventArgument {
|
|
const char* name;
|
|
char* value;
|
|
};
|
|
|
|
class TimelineEventArguments {
|
|
public:
|
|
TimelineEventArguments() : buffer_(NULL), length_(0) {}
|
|
~TimelineEventArguments() { Free(); }
|
|
// Get/Set the number of arguments in the event.
|
|
void SetNumArguments(intptr_t length);
|
|
// |name| must be a compile time constant. Takes ownership of |argument|.
|
|
void SetArgument(intptr_t i, const char* name, char* argument);
|
|
// |name| must be a compile time constant. Copies |argument|.
|
|
void CopyArgument(intptr_t i, const char* name, const char* argument);
|
|
// |name| must be a compile time constant. Takes ownership of |args|
|
|
void FormatArgument(intptr_t i,
|
|
const char* name,
|
|
const char* fmt,
|
|
va_list args);
|
|
|
|
void StealArguments(TimelineEventArguments* arguments);
|
|
|
|
TimelineEventArgument* buffer() const { return buffer_; }
|
|
|
|
intptr_t length() const { return length_; }
|
|
|
|
void Free();
|
|
|
|
TimelineEventArgument& operator[](intptr_t index) const {
|
|
return buffer_[index];
|
|
}
|
|
|
|
bool IsEmpty() { return length_ == 0; }
|
|
|
|
bool IsNotEmpty() { return length_ != 0; }
|
|
|
|
private:
|
|
TimelineEventArgument* buffer_;
|
|
intptr_t length_;
|
|
DISALLOW_COPY_AND_ASSIGN(TimelineEventArguments);
|
|
};
|
|
|
|
// You should get a |TimelineEvent| from a |TimelineStream|.
|
|
class TimelineEvent {
|
|
public:
|
|
// Keep in sync with StateBits below.
|
|
enum EventType {
|
|
kNone,
|
|
kBegin,
|
|
kEnd,
|
|
kDuration,
|
|
kInstant,
|
|
kAsyncBegin,
|
|
kAsyncInstant,
|
|
kAsyncEnd,
|
|
kCounter,
|
|
kFlowBegin,
|
|
kFlowStep,
|
|
kFlowEnd,
|
|
kMetadata,
|
|
kNumEventTypes,
|
|
};
|
|
|
|
TimelineEvent();
|
|
~TimelineEvent();
|
|
|
|
void Reset();
|
|
|
|
bool IsValid() const {
|
|
return (event_type() > kNone) && (event_type() < kNumEventTypes);
|
|
}
|
|
|
|
// Marks the beginning of an asynchronous operation with |async_id|.
|
|
void AsyncBegin(const char* label,
|
|
int64_t async_id,
|
|
int64_t micros = OS::GetCurrentMonotonicMicrosForTimeline());
|
|
// Marks an instantaneous event associated with |async_id|.
|
|
void AsyncInstant(
|
|
const char* label,
|
|
int64_t async_id,
|
|
int64_t micros = OS::GetCurrentMonotonicMicrosForTimeline());
|
|
// Marks the end of an asynchronous operation associated with |async_id|.
|
|
void AsyncEnd(const char* label,
|
|
int64_t async_id,
|
|
int64_t micros = OS::GetCurrentMonotonicMicrosForTimeline());
|
|
|
|
void DurationBegin(
|
|
const char* label,
|
|
int64_t micros = OS::GetCurrentMonotonicMicrosForTimeline(),
|
|
int64_t thread_micros = OS::GetCurrentThreadCPUMicrosForTimeline());
|
|
void DurationEnd(
|
|
int64_t micros = OS::GetCurrentMonotonicMicrosForTimeline(),
|
|
int64_t thread_micros = OS::GetCurrentThreadCPUMicrosForTimeline());
|
|
|
|
void Instant(const char* label,
|
|
int64_t micros = OS::GetCurrentMonotonicMicrosForTimeline());
|
|
|
|
void Duration(const char* label,
|
|
int64_t start_micros,
|
|
int64_t end_micros,
|
|
int64_t thread_start_micros = -1,
|
|
int64_t thread_end_micros = -1);
|
|
|
|
void Begin(
|
|
const char* label,
|
|
int64_t id,
|
|
int64_t micros = OS::GetCurrentMonotonicMicrosForTimeline(),
|
|
int64_t thread_micros = OS::GetCurrentThreadCPUMicrosForTimeline());
|
|
|
|
void End(const char* label,
|
|
int64_t id,
|
|
int64_t micros = OS::GetCurrentMonotonicMicrosForTimeline(),
|
|
int64_t thread_micros = OS::GetCurrentThreadCPUMicrosForTimeline());
|
|
|
|
void Counter(const char* label,
|
|
int64_t micros = OS::GetCurrentMonotonicMicrosForTimeline());
|
|
|
|
void FlowBegin(const char* label,
|
|
int64_t async_id,
|
|
int64_t micros = OS::GetCurrentMonotonicMicrosForTimeline());
|
|
void FlowStep(const char* label,
|
|
int64_t async_id,
|
|
int64_t micros = OS::GetCurrentMonotonicMicrosForTimeline());
|
|
void FlowEnd(const char* label,
|
|
int64_t async_id,
|
|
int64_t micros = OS::GetCurrentMonotonicMicrosForTimeline());
|
|
|
|
void Metadata(const char* label,
|
|
int64_t micros = OS::GetCurrentMonotonicMicrosForTimeline());
|
|
|
|
void CompleteWithPreSerializedArgs(char* args_json);
|
|
|
|
// Get/Set the number of arguments in the event.
|
|
intptr_t GetNumArguments() { return arguments_.length(); }
|
|
void SetNumArguments(intptr_t length) { arguments_.SetNumArguments(length); }
|
|
// |name| must be a compile time constant. Takes ownership of |argument|.
|
|
void SetArgument(intptr_t i, const char* name, char* argument) {
|
|
arguments_.SetArgument(i, name, argument);
|
|
}
|
|
// |name| must be a compile time constant. Copies |argument|.
|
|
void CopyArgument(intptr_t i, const char* name, const char* argument) {
|
|
arguments_.CopyArgument(i, name, argument);
|
|
}
|
|
// |name| must be a compile time constant.
|
|
void FormatArgument(intptr_t i, const char* name, const char* fmt, ...)
|
|
PRINTF_ATTRIBUTE(4, 5);
|
|
|
|
void StealArguments(TimelineEventArguments* arguments) {
|
|
arguments_.StealArguments(arguments);
|
|
}
|
|
// Mandatory to call when this event is completely filled out.
|
|
void Complete();
|
|
|
|
EventType event_type() const { return EventTypeField::decode(state_); }
|
|
|
|
bool IsFinishedDuration() const {
|
|
return (event_type() == kDuration) && (timestamp1_ > timestamp0_);
|
|
}
|
|
|
|
bool HasThreadCPUTime() const;
|
|
int64_t ThreadCPUTimeDuration() const;
|
|
int64_t ThreadCPUTimeOrigin() const;
|
|
|
|
int64_t TimeOrigin() const { return timestamp0_; }
|
|
int64_t Id() const {
|
|
ASSERT(event_type() != kDuration);
|
|
return timestamp1_;
|
|
}
|
|
int64_t TimeDuration() const;
|
|
int64_t TimeEnd() const {
|
|
ASSERT(IsFinishedDuration());
|
|
return timestamp1_;
|
|
}
|
|
|
|
// The lowest time value stored in this event.
|
|
int64_t LowTime() const;
|
|
// The highest time value stored in this event.
|
|
int64_t HighTime() const;
|
|
|
|
#ifndef PRODUCT
|
|
void PrintJSON(JSONStream* stream) const;
|
|
#endif
|
|
void PrintJSON(JSONWriter* writer) const;
|
|
|
|
ThreadId thread() const { return thread_; }
|
|
|
|
void set_thread(ThreadId tid) { thread_ = tid; }
|
|
|
|
Dart_Port isolate_id() const { return isolate_id_; }
|
|
|
|
uint64_t isolate_group_id() const { return isolate_group_id_; }
|
|
|
|
const char* label() const { return label_; }
|
|
|
|
// Does this duration end before |micros| ?
|
|
bool DurationFinishedBefore(int64_t micros) const {
|
|
return TimeEnd() <= micros;
|
|
}
|
|
|
|
bool IsDuration() const { return (event_type() == kDuration); }
|
|
|
|
bool IsBegin() const { return (event_type() == kBegin); }
|
|
|
|
bool IsEnd() const { return (event_type() == kEnd); }
|
|
|
|
// Is this event a synchronous begin or end event?
|
|
bool IsBeginOrEnd() const { return IsBegin() || IsEnd(); }
|
|
|
|
// Does this duration fully contain |other| ?
|
|
bool DurationContains(TimelineEvent* other) const {
|
|
ASSERT(IsFinishedDuration());
|
|
if (other->IsBegin()) {
|
|
if (other->TimeOrigin() < TimeOrigin()) {
|
|
return false;
|
|
}
|
|
if (other->TimeOrigin() > TimeEnd()) {
|
|
return false;
|
|
}
|
|
return true;
|
|
} else {
|
|
ASSERT(other->IsFinishedDuration());
|
|
if (other->TimeOrigin() < TimeOrigin()) {
|
|
return false;
|
|
}
|
|
if (other->TimeEnd() < TimeOrigin()) {
|
|
return false;
|
|
}
|
|
if (other->TimeOrigin() > TimeEnd()) {
|
|
return false;
|
|
}
|
|
if (other->TimeEnd() > TimeEnd()) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
}
|
|
|
|
bool Within(int64_t time_origin_micros, int64_t time_extent_micros);
|
|
|
|
void set_owns_label(bool owns_label) {
|
|
state_ = OwnsLabelBit::update(owns_label, state_);
|
|
}
|
|
|
|
TimelineEventArgument* arguments() const { return arguments_.buffer(); }
|
|
|
|
intptr_t arguments_length() const { return arguments_.length(); }
|
|
|
|
TimelineEvent* next() const {
|
|
return next_;
|
|
}
|
|
void set_next(TimelineEvent* next) {
|
|
next_ = next;
|
|
}
|
|
|
|
private:
|
|
void StreamInit(TimelineStream* stream) { stream_ = stream; }
|
|
void Init(EventType event_type, const char* label);
|
|
|
|
void set_event_type(EventType event_type) {
|
|
// We only reserve 4 bits to hold the event type.
|
|
COMPILE_ASSERT(kNumEventTypes < 16);
|
|
state_ = EventTypeField::update(event_type, state_);
|
|
}
|
|
|
|
void set_timestamp0(int64_t value) {
|
|
ASSERT(timestamp0_ == 0);
|
|
timestamp0_ = value;
|
|
}
|
|
void set_timestamp1(int64_t value) {
|
|
ASSERT(timestamp1_ == 0);
|
|
timestamp1_ = value;
|
|
}
|
|
|
|
void set_thread_timestamp0(int64_t value) {
|
|
ASSERT(thread_timestamp0_ == -1);
|
|
thread_timestamp0_ = value;
|
|
}
|
|
|
|
void set_thread_timestamp1(int64_t value) {
|
|
ASSERT(thread_timestamp1_ == -1);
|
|
thread_timestamp1_ = value;
|
|
}
|
|
|
|
bool pre_serialized_args() const {
|
|
return PreSerializedArgsBit::decode(state_);
|
|
}
|
|
|
|
void set_pre_serialized_args(bool pre_serialized_args) {
|
|
state_ = PreSerializedArgsBit::update(pre_serialized_args, state_);
|
|
}
|
|
|
|
bool owns_label() const { return OwnsLabelBit::decode(state_); }
|
|
|
|
enum StateBits {
|
|
kEventTypeBit = 0, // reserve 4 bits for type.
|
|
kPreSerializedArgsBit = 4,
|
|
kOwnsLabelBit = 5,
|
|
kNextBit = 6,
|
|
};
|
|
|
|
class EventTypeField : public BitField<uword, EventType, kEventTypeBit, 4> {};
|
|
class PreSerializedArgsBit
|
|
: public BitField<uword, bool, kPreSerializedArgsBit, 1> {};
|
|
class OwnsLabelBit : public BitField<uword, bool, kOwnsLabelBit, 1> {};
|
|
|
|
int64_t timestamp0_;
|
|
int64_t timestamp1_;
|
|
int64_t thread_timestamp0_;
|
|
int64_t thread_timestamp1_;
|
|
TimelineEventArguments arguments_;
|
|
uword state_;
|
|
const char* label_;
|
|
TimelineStream* stream_;
|
|
ThreadId thread_;
|
|
Dart_Port isolate_id_;
|
|
uint64_t isolate_group_id_;
|
|
TimelineEvent* next_;
|
|
|
|
friend class TimelineEventRecorder;
|
|
friend class TimelineEventEndlessRecorder;
|
|
friend class TimelineEventRingRecorder;
|
|
friend class TimelineEventStartupRecorder;
|
|
friend class TimelineEventPlatformRecorder;
|
|
friend class TimelineEventFuchsiaRecorder;
|
|
friend class TimelineEventMacosRecorder;
|
|
friend class TimelineStream;
|
|
friend class TimelineTestHelper;
|
|
DISALLOW_COPY_AND_ASSIGN(TimelineEvent);
|
|
};
|
|
|
|
#ifdef SUPPORT_TIMELINE
|
|
#define TIMELINE_DURATION(thread, stream, name) \
|
|
TimelineBeginEndScope tbes(thread, Timeline::Get##stream##Stream(), name);
|
|
#define TIMELINE_FUNCTION_COMPILATION_DURATION(thread, name, function) \
|
|
TimelineBeginEndScope tbes(thread, Timeline::GetCompilerStream(), name); \
|
|
if (tbes.enabled()) { \
|
|
tbes.SetNumArguments(1); \
|
|
tbes.CopyArgument(0, "function", function.ToQualifiedCString()); \
|
|
}
|
|
|
|
#define TIMELINE_FUNCTION_GC_DURATION(thread, name) \
|
|
TimelineBeginEndScope tbes(thread, Timeline::GetGCStream(), name);
|
|
#else
|
|
#define TIMELINE_DURATION(thread, stream, name)
|
|
#define TIMELINE_FUNCTION_COMPILATION_DURATION(thread, name, function)
|
|
#define TIMELINE_FUNCTION_GC_DURATION(thread, name)
|
|
#endif // SUPPORT_TIMELINE
|
|
|
|
// See |TimelineBeginEndScope|.
|
|
class TimelineEventScope : public StackResource {
|
|
public:
|
|
bool enabled() const { return enabled_; }
|
|
|
|
intptr_t GetNumArguments() { return arguments_.length(); }
|
|
void SetNumArguments(intptr_t length);
|
|
|
|
void SetArgument(intptr_t i, const char* name, char* argument);
|
|
|
|
void CopyArgument(intptr_t i, const char* name, const char* argument);
|
|
|
|
void FormatArgument(intptr_t i, const char* name, const char* fmt, ...)
|
|
PRINTF_ATTRIBUTE(4, 5);
|
|
|
|
protected:
|
|
TimelineEventScope(TimelineStream* stream, const char* label);
|
|
|
|
TimelineEventScope(Thread* thread, TimelineStream* stream, const char* label);
|
|
|
|
bool ShouldEmitEvent() const { return enabled_; }
|
|
|
|
void set_enabled(bool enabled) { enabled_ = enabled; }
|
|
|
|
const char* label() const { return label_; }
|
|
|
|
int64_t id() const { return id_; }
|
|
|
|
TimelineEventArgument* arguments() const { return arguments_.buffer(); }
|
|
|
|
intptr_t arguments_length() const { return arguments_.length(); }
|
|
|
|
TimelineStream* stream() const { return stream_; }
|
|
|
|
virtual ~TimelineEventScope();
|
|
|
|
void StealArguments(TimelineEvent* event);
|
|
|
|
private:
|
|
void Init();
|
|
|
|
TimelineStream* stream_;
|
|
const char* label_;
|
|
int64_t id_;
|
|
TimelineEventArguments arguments_;
|
|
bool enabled_;
|
|
|
|
DISALLOW_COPY_AND_ASSIGN(TimelineEventScope);
|
|
};
|
|
|
|
class TimelineBeginEndScope : public TimelineEventScope {
|
|
public:
|
|
TimelineBeginEndScope(TimelineStream* stream, const char* label);
|
|
|
|
TimelineBeginEndScope(Thread* thread,
|
|
TimelineStream* stream,
|
|
const char* label);
|
|
|
|
virtual ~TimelineBeginEndScope();
|
|
|
|
private:
|
|
void EmitBegin();
|
|
void EmitEnd();
|
|
|
|
DISALLOW_COPY_AND_ASSIGN(TimelineBeginEndScope);
|
|
};
|
|
|
|
// A block of |TimelineEvent|s. Not thread safe.
|
|
class TimelineEventBlock : public MallocAllocated {
|
|
public:
|
|
static const intptr_t kBlockSize = 64;
|
|
|
|
explicit TimelineEventBlock(intptr_t index);
|
|
~TimelineEventBlock();
|
|
|
|
TimelineEventBlock* next() const { return next_; }
|
|
void set_next(TimelineEventBlock* next) { next_ = next; }
|
|
|
|
intptr_t length() const { return length_; }
|
|
|
|
intptr_t block_index() const { return block_index_; }
|
|
|
|
bool IsEmpty() const { return length_ == 0; }
|
|
|
|
bool IsFull() const { return length_ == kBlockSize; }
|
|
|
|
TimelineEvent* At(intptr_t index) {
|
|
ASSERT(index >= 0);
|
|
ASSERT(index < kBlockSize);
|
|
return &events_[index];
|
|
}
|
|
|
|
const TimelineEvent* At(intptr_t index) const {
|
|
ASSERT(index >= 0);
|
|
ASSERT(index < kBlockSize);
|
|
return &events_[index];
|
|
}
|
|
|
|
// Attempt to sniff the timestamp from the first event.
|
|
int64_t LowerTimeBound() const;
|
|
|
|
// Returns false if |this| violates any of the following invariants:
|
|
// - events in the block come from one thread.
|
|
// - events have monotonically increasing timestamps.
|
|
bool CheckBlock();
|
|
|
|
// Call Reset on all events and set length to 0.
|
|
void Reset();
|
|
|
|
// Only safe to access under the recorder's lock.
|
|
bool in_use() const { return in_use_; }
|
|
|
|
// Only safe to access under the recorder's lock.
|
|
ThreadId thread_id() const { return thread_id_; }
|
|
|
|
protected:
|
|
#ifndef PRODUCT
|
|
void PrintJSON(JSONStream* stream) const;
|
|
#endif
|
|
|
|
TimelineEvent* StartEvent();
|
|
|
|
TimelineEvent events_[kBlockSize];
|
|
TimelineEventBlock* next_;
|
|
intptr_t length_;
|
|
intptr_t block_index_;
|
|
|
|
// Only accessed under the recorder's lock.
|
|
ThreadId thread_id_;
|
|
bool in_use_;
|
|
|
|
void Open();
|
|
void Finish();
|
|
|
|
friend class Thread;
|
|
friend class TimelineEventRecorder;
|
|
friend class TimelineEventEndlessRecorder;
|
|
friend class TimelineEventRingRecorder;
|
|
friend class TimelineEventStartupRecorder;
|
|
friend class TimelineEventPlatformRecorder;
|
|
friend class TimelineTestHelper;
|
|
friend class JSONStream;
|
|
|
|
private:
|
|
DISALLOW_COPY_AND_ASSIGN(TimelineEventBlock);
|
|
};
|
|
|
|
class TimelineEventFilter : public ValueObject {
|
|
public:
|
|
TimelineEventFilter(int64_t time_origin_micros = -1,
|
|
int64_t time_extent_micros = -1);
|
|
|
|
virtual ~TimelineEventFilter();
|
|
|
|
virtual bool IncludeBlock(TimelineEventBlock* block) {
|
|
if (block == NULL) {
|
|
return false;
|
|
}
|
|
// Not empty and not in use.
|
|
return !block->IsEmpty() && !block->in_use();
|
|
}
|
|
|
|
virtual bool IncludeEvent(TimelineEvent* event) {
|
|
if (event == NULL) {
|
|
return false;
|
|
}
|
|
return event->IsValid();
|
|
}
|
|
|
|
int64_t time_origin_micros() const { return time_origin_micros_; }
|
|
|
|
int64_t time_extent_micros() const { return time_extent_micros_; }
|
|
|
|
private:
|
|
int64_t time_origin_micros_;
|
|
int64_t time_extent_micros_;
|
|
};
|
|
|
|
class IsolateTimelineEventFilter : public TimelineEventFilter {
|
|
public:
|
|
explicit IsolateTimelineEventFilter(Dart_Port isolate_id,
|
|
int64_t time_origin_micros = -1,
|
|
int64_t time_extent_micros = -1);
|
|
|
|
bool IncludeBlock(TimelineEventBlock* block) {
|
|
if (block == NULL) {
|
|
return false;
|
|
}
|
|
// Not empty, not in use, and isolate match.
|
|
return !block->IsEmpty() && !block->in_use();
|
|
}
|
|
|
|
bool IncludeEvent(TimelineEvent* event) {
|
|
return event->IsValid() && (event->isolate_id() == isolate_id_);
|
|
}
|
|
|
|
private:
|
|
Dart_Port isolate_id_;
|
|
};
|
|
|
|
// Recorder of |TimelineEvent|s.
|
|
class TimelineEventRecorder : public MallocAllocated {
|
|
public:
|
|
TimelineEventRecorder();
|
|
virtual ~TimelineEventRecorder() {}
|
|
|
|
TimelineEventBlock* GetNewBlock();
|
|
|
|
// Interface method(s) which must be implemented.
|
|
#ifndef PRODUCT
|
|
virtual void PrintJSON(JSONStream* js, TimelineEventFilter* filter) = 0;
|
|
virtual void PrintTraceEvent(JSONStream* js, TimelineEventFilter* filter) = 0;
|
|
#endif
|
|
virtual const char* name() const = 0;
|
|
|
|
void FinishBlock(TimelineEventBlock* block);
|
|
|
|
virtual intptr_t Size() = 0;
|
|
|
|
protected:
|
|
#ifndef PRODUCT
|
|
void WriteTo(const char* directory);
|
|
#endif
|
|
|
|
// Interface method(s) which must be implemented.
|
|
virtual TimelineEvent* StartEvent() = 0;
|
|
virtual void CompleteEvent(TimelineEvent* event) = 0;
|
|
virtual TimelineEventBlock* GetHeadBlockLocked() = 0;
|
|
virtual TimelineEventBlock* GetNewBlockLocked() = 0;
|
|
virtual void Clear() = 0;
|
|
|
|
// Utility method(s).
|
|
#ifndef PRODUCT
|
|
void PrintJSONMeta(JSONArray* array) const;
|
|
#endif
|
|
TimelineEvent* ThreadBlockStartEvent();
|
|
void ThreadBlockCompleteEvent(TimelineEvent* event);
|
|
|
|
void ResetTimeTracking();
|
|
void ReportTime(int64_t micros);
|
|
int64_t TimeOriginMicros() const;
|
|
int64_t TimeExtentMicros() const;
|
|
|
|
Mutex lock_;
|
|
int64_t time_low_micros_;
|
|
int64_t time_high_micros_;
|
|
|
|
friend class TimelineEvent;
|
|
friend class TimelineStream;
|
|
friend class TimelineTestHelper;
|
|
friend class Timeline;
|
|
|
|
private:
|
|
DISALLOW_COPY_AND_ASSIGN(TimelineEventRecorder);
|
|
};
|
|
|
|
// An abstract recorder that stores events in a buffer of fixed capacity.
|
|
class TimelineEventFixedBufferRecorder : public TimelineEventRecorder {
|
|
public:
|
|
static const intptr_t kDefaultCapacity = 32 * KB; // Number of events.
|
|
|
|
explicit TimelineEventFixedBufferRecorder(intptr_t capacity);
|
|
virtual ~TimelineEventFixedBufferRecorder();
|
|
|
|
#ifndef PRODUCT
|
|
void PrintJSON(JSONStream* js, TimelineEventFilter* filter);
|
|
void PrintTraceEvent(JSONStream* js, TimelineEventFilter* filter);
|
|
#endif
|
|
|
|
intptr_t Size();
|
|
|
|
protected:
|
|
TimelineEvent* StartEvent();
|
|
void CompleteEvent(TimelineEvent* event);
|
|
TimelineEventBlock* GetHeadBlockLocked();
|
|
intptr_t FindOldestBlockIndex() const;
|
|
void Clear();
|
|
|
|
#ifndef PRODUCT
|
|
void PrintJSONEvents(JSONArray* array, TimelineEventFilter* filter);
|
|
#endif
|
|
|
|
VirtualMemory* memory_;
|
|
TimelineEventBlock* blocks_;
|
|
intptr_t capacity_;
|
|
intptr_t num_blocks_;
|
|
intptr_t block_cursor_;
|
|
};
|
|
|
|
// A recorder that stores events in a buffer of fixed capacity. When the buffer
|
|
// is full, new events overwrite old events.
|
|
class TimelineEventRingRecorder : public TimelineEventFixedBufferRecorder {
|
|
public:
|
|
explicit TimelineEventRingRecorder(intptr_t capacity = kDefaultCapacity)
|
|
: TimelineEventFixedBufferRecorder(capacity) {}
|
|
virtual ~TimelineEventRingRecorder() {}
|
|
|
|
const char* name() const { return RING_RECORDER_NAME; }
|
|
|
|
protected:
|
|
TimelineEventBlock* GetNewBlockLocked();
|
|
};
|
|
|
|
// A recorder that stores events in a buffer of fixed capacity. When the buffer
|
|
// is full, new events are dropped.
|
|
class TimelineEventStartupRecorder : public TimelineEventFixedBufferRecorder {
|
|
public:
|
|
explicit TimelineEventStartupRecorder(intptr_t capacity = kDefaultCapacity)
|
|
: TimelineEventFixedBufferRecorder(capacity) {}
|
|
virtual ~TimelineEventStartupRecorder() {}
|
|
|
|
const char* name() const { return STARTUP_RECORDER_NAME; }
|
|
|
|
protected:
|
|
TimelineEventBlock* GetNewBlockLocked();
|
|
};
|
|
|
|
// An abstract recorder that calls |OnEvent| whenever an event is complete.
|
|
// This should only be used for testing.
|
|
class TimelineEventCallbackRecorder : public TimelineEventRecorder {
|
|
public:
|
|
TimelineEventCallbackRecorder();
|
|
virtual ~TimelineEventCallbackRecorder();
|
|
|
|
#ifndef PRODUCT
|
|
void PrintJSON(JSONStream* js, TimelineEventFilter* filter);
|
|
void PrintTraceEvent(JSONStream* js, TimelineEventFilter* filter);
|
|
#endif
|
|
|
|
// Called when |event| is completed. It is unsafe to keep a reference to
|
|
// |event| as it may be freed as soon as this function returns.
|
|
virtual void OnEvent(TimelineEvent* event) = 0;
|
|
|
|
const char* name() const { return CALLBACK_RECORDER_NAME; }
|
|
|
|
protected:
|
|
TimelineEventBlock* GetNewBlockLocked() { return NULL; }
|
|
TimelineEventBlock* GetHeadBlockLocked() { return NULL; }
|
|
void Clear() {}
|
|
TimelineEvent* StartEvent();
|
|
void CompleteEvent(TimelineEvent* event);
|
|
};
|
|
|
|
// A recorder that stores events in chains of blocks of events.
|
|
// NOTE: This recorder will continue to allocate blocks until it exhausts
|
|
// memory.
|
|
class TimelineEventEndlessRecorder : public TimelineEventRecorder {
|
|
public:
|
|
TimelineEventEndlessRecorder();
|
|
virtual ~TimelineEventEndlessRecorder();
|
|
|
|
#ifndef PRODUCT
|
|
void PrintJSON(JSONStream* js, TimelineEventFilter* filter);
|
|
void PrintTraceEvent(JSONStream* js, TimelineEventFilter* filter);
|
|
#endif
|
|
|
|
const char* name() const { return ENDLESS_RECORDER_NAME; }
|
|
intptr_t Size() { return block_index_ * sizeof(TimelineEventBlock); }
|
|
|
|
protected:
|
|
TimelineEvent* StartEvent();
|
|
void CompleteEvent(TimelineEvent* event);
|
|
TimelineEventBlock* GetNewBlockLocked();
|
|
TimelineEventBlock* GetHeadBlockLocked();
|
|
void Clear();
|
|
|
|
#ifndef PRODUCT
|
|
void PrintJSONEvents(JSONArray* array, TimelineEventFilter* filter);
|
|
#endif
|
|
|
|
TimelineEventBlock* head_;
|
|
TimelineEventBlock* tail_;
|
|
intptr_t block_index_;
|
|
|
|
friend class TimelineTestHelper;
|
|
};
|
|
|
|
// The TimelineEventPlatformRecorder records timeline events to a platform
|
|
// specific destination. It's implementation is in the timeline_{linux,...}.cc
|
|
// files.
|
|
class TimelineEventPlatformRecorder : public TimelineEventRecorder {
|
|
public:
|
|
TimelineEventPlatformRecorder();
|
|
virtual ~TimelineEventPlatformRecorder();
|
|
|
|
#ifndef PRODUCT
|
|
void PrintJSON(JSONStream* js, TimelineEventFilter* filter);
|
|
void PrintTraceEvent(JSONStream* js, TimelineEventFilter* filter);
|
|
#endif
|
|
|
|
// Called when |event| is completed. It is unsafe to keep a reference to
|
|
// |event| as it may be freed as soon as this function returns.
|
|
virtual void OnEvent(TimelineEvent* event) = 0;
|
|
|
|
virtual const char* name() const = 0;
|
|
|
|
protected:
|
|
TimelineEventBlock* GetNewBlockLocked() { return NULL; }
|
|
TimelineEventBlock* GetHeadBlockLocked() { return NULL; }
|
|
void Clear() {}
|
|
TimelineEvent* StartEvent();
|
|
void CompleteEvent(TimelineEvent* event);
|
|
};
|
|
|
|
#if defined(DART_HOST_OS_FUCHSIA)
|
|
// A recorder that sends events to Fuchsia's tracing app.
|
|
class TimelineEventFuchsiaRecorder : public TimelineEventPlatformRecorder {
|
|
public:
|
|
TimelineEventFuchsiaRecorder() {}
|
|
virtual ~TimelineEventFuchsiaRecorder() {}
|
|
|
|
const char* name() const { return FUCHSIA_RECORDER_NAME; }
|
|
intptr_t Size() { return 0; }
|
|
|
|
private:
|
|
void OnEvent(TimelineEvent* event);
|
|
};
|
|
#endif // defined(DART_HOST_OS_FUCHSIA)
|
|
|
|
#if defined(DART_HOST_OS_ANDROID) || defined(DART_HOST_OS_LINUX)
|
|
// A recorder that writes events to Android Systrace. This class is exposed in
|
|
// this header file only so that PrintSystrace can be visible to
|
|
// timeline_test.cc.
|
|
class TimelineEventSystraceRecorder : public TimelineEventPlatformRecorder {
|
|
public:
|
|
TimelineEventSystraceRecorder();
|
|
virtual ~TimelineEventSystraceRecorder();
|
|
|
|
static intptr_t PrintSystrace(TimelineEvent* event,
|
|
char* buffer,
|
|
intptr_t buffer_size);
|
|
|
|
const char* name() const { return SYSTRACE_RECORDER_NAME; }
|
|
intptr_t Size() { return 0; }
|
|
|
|
private:
|
|
void OnEvent(TimelineEvent* event);
|
|
|
|
int systrace_fd_;
|
|
};
|
|
#endif // defined(DART_HOST_OS_ANDROID) || defined(DART_HOST_OS_LINUX)
|
|
|
|
#if defined(DART_HOST_OS_MACOS)
|
|
// A recorder that sends events to Macos's tracing app. See:
|
|
// https://developer.apple.com/documentation/os/logging?language=objc
|
|
class TimelineEventMacosRecorder : public TimelineEventPlatformRecorder {
|
|
public:
|
|
TimelineEventMacosRecorder() API_AVAILABLE(ios(12.0), macos(10.14));
|
|
virtual ~TimelineEventMacosRecorder() API_AVAILABLE(ios(12.0), macos(10.14));
|
|
|
|
const char* name() const { return MACOS_RECORDER_NAME; }
|
|
intptr_t Size() { return 0; }
|
|
|
|
private:
|
|
void OnEvent(TimelineEvent* event) API_AVAILABLE(ios(12.0), macos(10.14));
|
|
};
|
|
#endif // defined(DART_HOST_OS_MACOS)
|
|
|
|
class TimelineEventFileRecorder : public TimelineEventPlatformRecorder {
|
|
public:
|
|
explicit TimelineEventFileRecorder(const char* path);
|
|
virtual ~TimelineEventFileRecorder();
|
|
|
|
const char* name() const { return FILE_RECORDER_NAME; }
|
|
intptr_t Size() { return 0; }
|
|
|
|
void Drain();
|
|
|
|
private:
|
|
void CompleteEvent(TimelineEvent* event);
|
|
void OnEvent(TimelineEvent* event) { UNREACHABLE(); }
|
|
void Write(const char* buffer) { Write(buffer, strlen(buffer)); }
|
|
void Write(const char* buffer, intptr_t len);
|
|
|
|
Monitor monitor_;
|
|
TimelineEvent* head_;
|
|
TimelineEvent* tail_;
|
|
void* file_;
|
|
bool first_;
|
|
bool shutting_down_;
|
|
ThreadJoinId thread_id_;
|
|
};
|
|
|
|
class DartTimelineEventHelpers : public AllStatic {
|
|
public:
|
|
static void ReportTaskEvent(Thread* thread,
|
|
TimelineEvent* event,
|
|
int64_t id,
|
|
const char* phase,
|
|
const char* category,
|
|
char* name,
|
|
char* args);
|
|
|
|
static void ReportFlowEvent(Thread* thread,
|
|
TimelineEvent* event,
|
|
const char* category,
|
|
char* name,
|
|
int64_t type,
|
|
int64_t flow_id,
|
|
char* args);
|
|
|
|
static void ReportInstantEvent(Thread* thread,
|
|
TimelineEvent* event,
|
|
const char* category,
|
|
char* name,
|
|
char* args);
|
|
};
|
|
|
|
} // namespace dart
|
|
|
|
#endif // RUNTIME_VM_TIMELINE_H_
|