Timeline API fixes for Flutter

runtime/vm/dart_api_impl_test.cc

 // Copyright (c) 2012, 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.
 
 #include "bin/builtin.h"
 #include "include/dart_api.h"
 #include "include/dart_mirrors_api.h"
 #include "include/dart_native_api.h"
 #include "include/dart_tools_api.h"
 #include "platform/assert.h"
 #include "platform/text_buffer.h"
 #include "platform/utils.h"
 #include "vm/class_finalizer.h"
 #include "vm/dart_api_impl.h"
 #include "vm/dart_api_state.h"
 #include "vm/lockers.h"
+#include "vm/timeline.h"
 #include "vm/unit_test.h"
 #include "vm/verifier.h"
 
 namespace dart {
 
 DECLARE_FLAG(bool, verify_acquired_data);
 DECLARE_FLAG(bool, ignore_patch_signature_mismatch);
 
 #ifndef PRODUCT
 
@@ skipping 9156 matching lines @@
   }
 }
 
 
 #ifndef PRODUCT
 
 
 TEST_CASE(Timeline_Dart_TimelineDuration) {
   Isolate* isolate = Isolate::Current();
   // Grab embedder stream.
-  TimelineStream* stream = isolate->GetEmbedderStream();
+  TimelineStream* stream = Timeline::GetEmbedderStream();
   // Make sure it is enabled.
   stream->set_enabled(true);
   // Add a duration event.
   Dart_TimelineDuration("testDurationEvent", 0, 1);
   // Check that it is in the output.
   TimelineEventRecorder* recorder = Timeline::recorder();
   Timeline::ReclaimCachedBlocksFromThreads();
   JSONStream js;
   IsolateTimelineEventFilter filter(isolate->main_port());
   recorder->PrintJSON(&js, &filter);
   EXPECT_SUBSTRING("testDurationEvent", js.ToCString());
 }
 
 
 TEST_CASE(Timeline_Dart_TimelineInstant) {
   Isolate* isolate = Isolate::Current();
   // Grab embedder stream.
-  TimelineStream* stream = isolate->GetEmbedderStream();
+  TimelineStream* stream = Timeline::GetEmbedderStream();
   // Make sure it is enabled.
   stream->set_enabled(true);
   Dart_TimelineInstant("testInstantEvent");
   // Check that it is in the output.
   TimelineEventRecorder* recorder = Timeline::recorder();
   Timeline::ReclaimCachedBlocksFromThreads();
   JSONStream js;
   IsolateTimelineEventFilter filter(isolate->main_port());
   recorder->PrintJSON(&js, &filter);
   EXPECT_SUBSTRING("testInstantEvent", js.ToCString());
 }
 
 
 TEST_CASE(Timeline_Dart_TimelineAsyncDisabled) {
-  Isolate* isolate = Isolate::Current();
   // Grab embedder stream.
-  TimelineStream* stream = isolate->GetEmbedderStream();
+  TimelineStream* stream = Timeline::GetEmbedderStream();
   // Make sure it is disabled.
   stream->set_enabled(false);
   int64_t async_id = -1;
   Dart_TimelineAsyncBegin("testAsyncEvent", &async_id);
   // Expect that the |async_id| is negative because the stream is disabled.
   EXPECT(async_id < 0);
   // Call Dart_TimelineAsyncEnd with a negative async_id.
   Dart_TimelineAsyncEnd("testAsyncEvent", async_id);
   // Check that testAsync is not in the output.
   TimelineEventRecorder* recorder = Timeline::recorder();
   Timeline::ReclaimCachedBlocksFromThreads();
   JSONStream js;
   TimelineEventFilter filter;
   recorder->PrintJSON(&js, &filter);
   EXPECT_NOTSUBSTRING("testAsyncEvent", js.ToCString());
 }
 
 
 TEST_CASE(Timeline_Dart_TimelineAsync) {
   Isolate* isolate = Isolate::Current();
   // Grab embedder stream.
-  TimelineStream* stream = isolate->GetEmbedderStream();
+  TimelineStream* stream = Timeline::GetEmbedderStream();
   // Make sure it is enabled.
   stream->set_enabled(true);
   int64_t async_id = -1;
   Dart_TimelineAsyncBegin("testAsyncEvent", &async_id);
   // Expect that the |async_id| is >= 0.
   EXPECT(async_id >= 0);
 
   Dart_TimelineAsyncEnd("testAsyncEvent", async_id);
 
   // Check that it is in the output.
@@ skipping 47 matching lines @@
     "main() => foo();\n";
 
   Dart_Handle lib =
       TestCase::LoadTestScript(kScriptChars, NULL);
 
   const char* buffer = NULL;
   intptr_t buffer_length = 0;
   bool success = false;
 
   // Enable recording of all streams.
-  Dart_TimelineSetRecordedStreams(DART_TIMELINE_STREAM_ALL);
+  Dart_GlobalTimelineSetRecordedStreams(DART_TIMELINE_STREAM_ALL);
 
   // Invoke main, which will be compiled resulting in a compiler event in
   // the timeline.
   Dart_Handle result = Dart_Invoke(lib,
                                    NewString("main"),
                                    0,
                                    NULL);
   EXPECT_VALID(result);
 
   // Grab the trace.
   AppendData data;
-  success = Dart_TimelineGetTrace(AppendStreamConsumer, &data);
+  success = Dart_GlobalTimelineGetTrace(AppendStreamConsumer, &data);
   EXPECT(success);
   buffer = reinterpret_cast<char*>(data.buffer);
   buffer_length = data.buffer_length;
   EXPECT(buffer_length > 0);
   EXPECT(buffer != NULL);
 
   // Response starts with a '{' character and not a '['.
   EXPECT(buffer[0] == '{');
   // Response ends with a '}' character and not a ']'.
   EXPECT(buffer[buffer_length - 1] == '\0');
@@ skipping 19 matching lines @@
     "}\n";
 
   Dart_Handle lib =
       TestCase::LoadTestScript(kScriptChars, NULL);
 
   const char* buffer = NULL;
   intptr_t buffer_length = 0;
   bool success = false;
 
   // Enable recording of the Dart stream.
-  Dart_TimelineSetRecordedStreams(DART_TIMELINE_STREAM_DART);
+  Dart_GlobalTimelineSetRecordedStreams(DART_TIMELINE_STREAM_DART);
 
   // Invoke main, which will add a new timeline event from Dart.
   Dart_Handle result = Dart_Invoke(lib,
                                    NewString("main"),
                                    0,
                                    NULL);
   EXPECT_VALID(result);
 
   // Grab the trace.
   AppendData data;
   data.buffer = NULL;
   data.buffer_length = 0;
-  success = Dart_TimelineGetTrace(AppendStreamConsumer, &data);
+  success = Dart_GlobalTimelineGetTrace(AppendStreamConsumer, &data);
   EXPECT(success);
   buffer = reinterpret_cast<char*>(data.buffer);
   buffer_length = data.buffer_length;
   EXPECT(buffer_length > 0);
   EXPECT(buffer != NULL);
 
   // Response starts with a '{' character and not a '['.
   EXPECT(buffer[0] == '{');
   // Response ends with a '}' character and not a ']'.
   EXPECT(buffer[buffer_length - 1] == '\0');
@@ skipping 18 matching lines @@
     "}\n";
 
   Dart_Handle lib =
       TestCase::LoadTestScript(kScriptChars, NULL);
 
   const char* buffer = NULL;
   intptr_t buffer_length = 0;
   bool success = false;
 
   // Enable recording of all streams.
-  Dart_TimelineSetRecordedStreams(DART_TIMELINE_STREAM_ALL);
+  Dart_GlobalTimelineSetRecordedStreams(DART_TIMELINE_STREAM_ALL);
 
   // Invoke main, which will be compiled resulting in a compiler event in
   // the timeline.
   Dart_Handle result = Dart_Invoke(lib,
                                    NewString("main"),
                                    0,
                                    NULL);
   EXPECT_VALID(result);
 
   // Grab the trace.
   AppendData data;
-  success = Dart_TimelineGetTrace(AppendStreamConsumer, &data);
+  success = Dart_GlobalTimelineGetTrace(AppendStreamConsumer, &data);
   EXPECT(success);
   buffer = reinterpret_cast<char*>(data.buffer);
   buffer_length = data.buffer_length;
   EXPECT(buffer_length > 0);
   EXPECT(buffer != NULL);
 
   // Response starts with a '{' character and not a '['.
   EXPECT(buffer[0] == '{');
   // Response ends with a '}' character and not a ']'.
   EXPECT(buffer[buffer_length - 1] == '\0');
@@ skipping 28 matching lines @@
   // Invoke main, which will be compiled resulting in a compiler event in
   // the timeline.
   Dart_Handle result = Dart_Invoke(lib,
                                    NewString("main"),
                                    0,
                                    NULL);
   EXPECT_VALID(result);
 
   // Grab the trace.
   AppendData data;
-  success = Dart_TimelineGetTrace(AppendStreamConsumer, &data);
+  success = Dart_GlobalTimelineGetTrace(AppendStreamConsumer, &data);
   EXPECT(success);
   buffer = reinterpret_cast<char*>(data.buffer);
   buffer_length = data.buffer_length;
   EXPECT(buffer_length > 0);
   EXPECT(buffer != NULL);
 
   // Response starts with a '{' character and not a '['.
   EXPECT(buffer[0] == '{');
   // Response ends with a '}' character and not a ']'.
   EXPECT(buffer[buffer_length - 1] == '\0');
   EXPECT(buffer[buffer_length - 2] == '}');
 
   // Heartbeat test.
   EXPECT_SUBSTRING("\"cat\":\"Compiler\"", buffer);
   EXPECT_SUBSTRING("\"name\":\"CompileFunction\"", buffer);
   EXPECT_SUBSTRING("\"function\":\"::_main\"", buffer);
 
   // Free buffer allocated by AppendStreamConsumer
   free(data.buffer);
 }
 
 
+static const char* arg_names[] = {
+  "arg0"
+};
+
+
+static const char* arg_values[] = {
+  "value0"
+};
+
+
 TEST_CASE(Timeline_Dart_GlobalTimelineGetTrace) {
   const char* kScriptChars =
     "bar() => 'z';\n"
     "foo() => 'a';\n"
     "main() => foo();\n";
 
   // Enable all streams.
   Dart_GlobalTimelineSetRecordedStreams(DART_TIMELINE_STREAM_ALL |
                                         DART_TIMELINE_STREAM_VM);
   Dart_Handle lib;
   {
     // Add something to the VM stream.
     TimelineDurationScope tds(Timeline::GetVMStream(),
                               "TestVMDuration");
     lib = TestCase::LoadTestScript(kScriptChars, NULL);
   }
 
+  {
+    // Add something to the embedder stream.
+    Dart_TimelineEvent("TRACE_EVENT",
+                       Dart_TimelineGetMicros(),
+                       0,
+                       Dart_Timeline_Event_Begin,
+                       1,
+                       &arg_names[0],
+                       &arg_values[0]);
+  }
+
   // Invoke main, which will be compiled resulting in a compiler event in
   // the timeline.
   Dart_Handle result = Dart_Invoke(lib,
                                    NewString("main"),
                                    0,
                                    NULL);
   EXPECT_VALID(result);
 
   const char* buffer = NULL;
   intptr_t buffer_length = 0;
@@ skipping 19 matching lines @@
   // Response ends with a '}' character and not a ']'.
   EXPECT(buffer[buffer_length - 1] == '\0');
   EXPECT(buffer[buffer_length - 2] == '}');
 
   // Heartbeat test.
   EXPECT_SUBSTRING("\"name\":\"TestVMDuration\"", buffer);
   EXPECT_SUBSTRING("\"cat\":\"Compiler\"", buffer);
   EXPECT_SUBSTRING("\"name\":\"CompileFunction\"", buffer);
   EXPECT_SUBSTRING("\"function\":\"::_main\"", buffer);
   EXPECT_NOTSUBSTRING("\"function\":\"::_bar\"", buffer);
+  EXPECT_SUBSTRING("TRACE_EVENT", buffer);
+  EXPECT_SUBSTRING("arg0", buffer);
+  EXPECT_SUBSTRING("value0", buffer);
 
   // Free buffer allocated by AppendStreamConsumer
   free(data.buffer);
   data.buffer = NULL;
   data.buffer_length = 0;
 
   // Retrieving the global trace resulted in all open blocks being reclaimed.
   // Add some new events and verify that both sets of events are present
   // in the resulting trace.
   {
@@ skipping 207 matching lines @@
 static void StartRecording() {
   start_called = true;
 }
 
 static void StopRecording() {
   stop_called = true;
 }
 
 
 TEST_CASE(Timeline_Dart_EmbedderTimelineStartStopRecording) {
-  Dart_SetEmbedderTimelineCallbacks(StartRecording, StopRecording, NULL);
+  Dart_SetEmbedderTimelineCallbacks(StartRecording, StopRecording);
 
   EXPECT(!start_called);
   EXPECT(!stop_called);
   Timeline::SetStreamEmbedderEnabled(true);
   EXPECT(start_called);
   EXPECT(!stop_called);
 
   start_called = false;
   stop_called = false;
   EXPECT(!start_called);
   EXPECT(!stop_called);
   Timeline::SetStreamEmbedderEnabled(false);
   EXPECT(!start_called);
   EXPECT(stop_called);
 }
 
-static bool GetTimeline(Dart_StreamConsumer stream_consumer,
-                        void* user_data) {
-  ASSERT(stream_consumer != NULL);
-  ASSERT(user_data != NULL);
-
-  const char* test_string = "HELLO FROM EMBEDDER";
-  stream_consumer(Dart_StreamConsumer_kData,
-                  "embedder.timeline",
-                  reinterpret_cast<const uint8_t*>(test_string),
-                  strlen(test_string),
-                  user_data);
-  return true;
-}
-
-TEST_CASE(Timeline_Dart_EmbedderTimelineGetTimeline) {
-  Dart_SetEmbedderTimelineCallbacks(NULL, NULL, GetTimeline);
-
-  Dart_GlobalTimelineSetRecordedStreams(DART_TIMELINE_STREAM_EMBEDDER);
-  Dart_TimelineDuration("testDurationEvent", 0, 1);
-
-  AppendData data;
-  bool success = Dart_GlobalTimelineGetTrace(AppendStreamConsumer, &data);
-  EXPECT(success);
-
-  EXPECT_SUBSTRING("}},HELLO FROM EMBEDDER",
-                   data.buffer);
-
-  // Free buffer allocated by AppendStreamConsumer
-  free(data.buffer);
-}
-
 #endif  // !PRODUCT
 
 }  // namespace dart