Add fine grained command line and service protocol control over timeline streams recording

runtime/vm/service.cc

 // Copyright (c) 2013, 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 "vm/service.h"
 
 #include "include/dart_api.h"
 #include "include/dart_native_api.h"
 #include "platform/globals.h"
 
@@ skipping 629 matching lines @@
   // For now observatory enums are ascii letters plus underscore.
   static bool IsEnumChar(char c) {
     return (((c >= 'a') && (c <= 'z')) ||
             ((c >= 'A') && (c <= 'Z')) ||
             (c == '_'));
   }
 
   // Returns number of elements in the list.  -1 on parse error.
   intptr_t ElementCount(const char* value) const {
     const char* kJsonWhitespaceChars = " \t\r\n";
-
     if (value == NULL) {
       return -1;
     }
     const char* cp = value;
     cp += strspn(cp, kJsonWhitespaceChars);
     if (*cp++ != '[') {
       // Missing initial [.
       return -1;
     }
     bool closed = false;
@@ skipping 2192 matching lines @@
 
 
 static bool GetVMMetric(Thread* thread, JSONStream* js) {
   const char* metric_id = js->LookupParam("metricId");
   if (metric_id == NULL) {
     PrintMissingParamError(js, "metricId");
   }
   return false;
 }
 
+static const char* const timeline_streams_enum_names[] = {
+  "all",
+#define DEFINE_NAME(name, unused)                                              \
+  #name,
+ISOLATE_TIMELINE_STREAM_LIST(DEFINE_NAME)
+#undef DEFINE_NAME
+  "VM",
+  NULL
+};
+
+static const EnumListParameter* recorded_streams_param =
+    new EnumListParameter("recordedStreams",

[zra, 2016/02/12 18:57:56]

Where is this deleted?

[Cutch, 2016/02/12 20:13:57]

It's not and none of our parameter lists are.

[zra, 2016/02/12 20:23:55]

If there isn't one already, please file a bug to clean these up and add a TODO.

+                          false,
+                          timeline_streams_enum_names);
+
+static const MethodParameter* set_vm_timeline_flags_params[] = {
+  NO_ISOLATE_PARAMETER,
+  recorded_streams_param,

[zra, 2016/02/12 18:57:56]

Does this rely on the order that globals are initialized in? Is that
well-defined?

[Cutch, 2016/02/12 20:13:57]

Fixed here and elsewhere.

+  NULL,
+};
+
+
+static bool HasStream(const char** recorded_streams, const char* stream) {
+  while (*recorded_streams != NULL) {
+    if ((strcasestr(*recorded_streams, "all") != NULL) ||
+        (strcasestr(*recorded_streams, stream) != NULL)) {
+      return true;
+    }
+    recorded_streams++;
+  }
+  return false;
+}
+
 
-static const MethodParameter* set_vm_timeline_flag_params[] = {
-  NO_ISOLATE_PARAMETER,
-  new MethodParameter("_record", true),
-  NULL,
-};
-
-
-static bool SetVMTimelineFlag(Thread* thread, JSONStream* js) {
+static bool SetVMTimelineFlags(Thread* thread, JSONStream* js) {
   Isolate* isolate = thread->isolate();
   ASSERT(isolate != NULL);
   StackZone zone(thread);
 
-  bool recording = strcmp(js->LookupParam("_record"), "all") == 0;
-  Timeline::SetStreamAPIEnabled(recording);
-  Timeline::SetStreamCompilerEnabled(recording);
-  Timeline::SetStreamDartEnabled(recording);
-  Timeline::SetStreamDebuggerEnabled(recording);
-  Timeline::SetStreamEmbedderEnabled(recording);
-  Timeline::SetStreamGCEnabled(recording);
-  Timeline::SetStreamIsolateEnabled(recording);
+  const char* recorded_streams_str = js->LookupParam("recordedStreams");
+  const char** recorded_streams =
+      recorded_streams_param->Parse(thread->zone(), recorded_streams_str);
+
+  Timeline::SetStreamAPIEnabled(HasStream(recorded_streams, "API"));

[zra, 2016/02/12 18:57:56]

Is it possible to use ISOLATE_TIMELINE_STREAM_LIST here?

[Cutch, 2016/02/12 20:13:57]

Done.

+  Timeline::SetStreamCompilerEnabled(HasStream(recorded_streams, "Compiler"));
+  Timeline::SetStreamDartEnabled(HasStream(recorded_streams, "Dart"));
+  Timeline::SetStreamDebuggerEnabled(HasStream(recorded_streams, "Debugger"));
+  Timeline::SetStreamEmbedderEnabled(HasStream(recorded_streams, "Embedder"));
+  Timeline::SetStreamGCEnabled(HasStream(recorded_streams, "GC"));
+  Timeline::SetStreamIsolateEnabled(HasStream(recorded_streams, "Isolate"));
+  Timeline::SetVMStreamEnabled(HasStream(recorded_streams, "VM"));
 
   PrintSuccess(js);
 
   return true;
 }
 
 
-static const MethodParameter* get_vm_timeline_flag_params[] = {
+static const MethodParameter* get_vm_timeline_flags_params[] = {
   NO_ISOLATE_PARAMETER,
-  new MethodParameter("_record", false),
   NULL,
 };
 
 
-static bool GetVMTimelineFlag(Thread* thread, JSONStream* js) {
+static bool GetVMTimelineFlags(Thread* thread, JSONStream* js) {
   Isolate* isolate = thread->isolate();
   ASSERT(isolate != NULL);
   StackZone zone(thread);
-
-  js->PrintError(kFeatureDisabled, "TODO(johnmccutchan)");
+  Timeline::PrintFlagsToJSON(js);
   return true;
 }
 
 
 static const MethodParameter* clear_vm_timeline_params[] = {
   NO_ISOLATE_PARAMETER,
   NULL,
 };
 
 
@@ skipping 997 matching lines @@
   { "getVersion", GetVersion,
     get_version_params },
   { "getVM", GetVM,
     get_vm_params },
   { "_getVMMetric", GetVMMetric,
     get_vm_metric_params },
   { "_getVMMetricList", GetVMMetricList,
     get_vm_metric_list_params },
   { "_getVMTimeline", GetVMTimeline,
     get_vm_timeline_params },
-  { "_getVMTimelineFlag", GetVMTimelineFlag,
-    get_vm_timeline_flag_params },
+  { "_getVMTimelineFlags", GetVMTimelineFlags,
+    get_vm_timeline_flags_params },
   { "pause", Pause,
     pause_params },
   { "removeBreakpoint", RemoveBreakpoint,
     remove_breakpoint_params },
   { "_restartVM", RestartVM,
     restart_vm_params },
   { "resume", Resume,
     resume_params },
   { "_requestHeapSnapshot", RequestHeapSnapshot,
     request_heap_snapshot_params },
   { "setExceptionPauseMode", SetExceptionPauseMode,
     set_exception_pause_mode_params },
   { "_setFlag", SetFlag,
     set_flags_params },
   { "setLibraryDebuggable", SetLibraryDebuggable,
     set_library_debuggable_params },
   { "setName", SetName,
     set_name_params },
   { "_setTraceClassAllocation", SetTraceClassAllocation,
     set_trace_class_allocation_params },
   { "setVMName", SetVMName,
     set_vm_name_params },
-  { "_setVMTimelineFlag", SetVMTimelineFlag,
-    set_vm_timeline_flag_params },
+  { "_setVMTimelineFlags", SetVMTimelineFlags,
+    set_vm_timeline_flags_params },
 };
 
 
 const ServiceMethodDescriptor* FindMethod(const char* method_name) {
   intptr_t num_methods = sizeof(service_methods_) /
                          sizeof(service_methods_[0]);
   for (intptr_t i = 0; i < num_methods; i++) {
     const ServiceMethodDescriptor& method = service_methods_[i];
     if (strcmp(method_name, method.name) == 0) {
       return &method;
     }
   }
   return NULL;
 }
 
 #endif  // !PRODUCT
 
 }  // namespace dart