vmservice: Add /coverage collection to scripts, classes and libraries.

runtime/vm/coverage.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/coverage.h"
 
 #include "include/dart_api.h"
 
 #include "vm/compiler.h"
 #include "vm/isolate.h"
@@ skipping 23 matching lines @@
   while (tkit.CurrentTokenKind() != Token::kEOS) {
     (*map)[tkit.CurrentPosition()] = cur_line;
     if (tkit.CurrentTokenKind() == Token::kNEWLINE) {
       cur_line++;
     }
     tkit.Advance();
   }
 }
 
 
+static inline void PrintJSONPreamble(JSONObject* jsobj) {
+  jsobj->AddProperty("type", "CodeCoverage");
+  jsobj->AddProperty("id", "coverage");
+}
+
+
 void CodeCoverage::CompileAndAdd(const Function& function,
                                  const JSONArray& hits_arr,
                                  const GrowableArray<intptr_t>& pos_to_line) {
   Isolate* isolate = Isolate::Current();
   if (!function.HasCode()) {
     // If the function should not be compiled or if the compilation failed,
     // then just skip this method.
     // TODO(iposva): Maybe we should skip synthesized methods in general too.
     if (function.is_abstract() || function.IsRedirectingFactory()) {
       return;
@@ skipping 41 matching lines @@
         ASSERT(test_line == line);
 #endif
         hits_arr.AddValue(line);
         hits_arr.AddValue(ic_data->AggregateCount());
       }
     }
   }
 }
 
 
-void CodeCoverage::PrintClass(const Class& cls, const JSONArray& jsarr) {
+void CodeCoverage::PrintClass(const Class& cls,
+                              const JSONArray& jsarr,
+                              const Script& script_filter) {
   Isolate* isolate = Isolate::Current();
   Array& functions = Array::Handle(cls.functions());
   ASSERT(!functions.IsNull());
   Function& function = Function::Handle();
   Script& script = Script::Handle();
   String& saved_url = String::Handle();
   String& url = String::Handle();
   GrowableArray<intptr_t> pos_to_line;
   int i = 0;
   while (i < functions.Length()) {
     HANDLESCOPE(isolate);
     function ^= functions.At(i);
+    script = function.script();
+    if (!script_filter.IsNull() && script_filter.raw() != script.raw()) {
+      i++;
+      continue;
+    }
+    saved_url = script.url();
+    ComputeTokenPosToLineNumberMap(script, &pos_to_line);
     JSONObject jsobj(&jsarr);
-    script = function.script();
-    ComputeTokenPosToLineNumberMap(script, &pos_to_line);
-    saved_url = script.url();
     jsobj.AddProperty("source", saved_url.ToCString());
     jsobj.AddProperty("script", script);
     JSONArray hits_arr(&jsobj, "hits");
 
     // We stay within this loop while we are seeing functions from the same
     // source URI.
     while (i < functions.Length()) {
       function ^= functions.At(i);
       script = function.script();
       url = script.url();
@@ skipping 13 matching lines @@
   GrowableObjectArray& closures =
       GrowableObjectArray::Handle(cls.closures());
   if (!closures.IsNull()) {
     i = 0;
     pos_to_line.Clear();
     // We need to keep rechecking the length of the closures array, as handling
     // a closure potentially adds new entries to the end.
     while (i < closures.Length()) {
       HANDLESCOPE(isolate);
       function ^= closures.At(i);
+      script = function.script();
+      if (!script_filter.IsNull() && script_filter.raw() != script.raw()) {
+        i++;
+        continue;
+      }
+      saved_url = script.url();
+      ComputeTokenPosToLineNumberMap(script, &pos_to_line);
       JSONObject jsobj(&jsarr);
-      script = function.script();
-      ComputeTokenPosToLineNumberMap(script, &pos_to_line);
-      saved_url = script.url();
       jsobj.AddProperty("source", saved_url.ToCString());
       jsobj.AddProperty("script", script);
       JSONArray hits_arr(&jsobj, "hits");
 
       // We stay within this loop while we are seeing functions from the same
       // source URI.
       while (i < closures.Length()) {
         function ^= closures.At(i);
         script = function.script();
         url = script.url();
         if (!url.Equals(saved_url)) {
           pos_to_line.Clear();
           break;
         }
         CompileAndAdd(function, hits_arr, pos_to_line);
         i++;
       }
     }
   }
 }
 
 
+void CodeCoverage::PrintJSONForClass(const Class& cls,
+                                     JSONStream* stream) {
+  Isolate* isolate = Isolate::Current();
+  JSONObject coverage(stream);
+  PrintJSONPreamble(&coverage);
+  {
+    JSONArray jsarr(&coverage, "coverage");
+    if (cls.EnsureIsFinalized(isolate) == Error::null()) {
+      // Only classes that have been finalized do have a meaningful list of
+      // functions.
+      PrintClass(cls, jsarr, Script::Handle());
+    }
+  }
+}
+
+
+void CodeCoverage::PrintJSONForLibrary(const Library& lib,
+                                       JSONStream* stream) {
+  Isolate* isolate = Isolate::Current();
+  Class& cls = Class::Handle();
+  JSONObject coverage(stream);
+  PrintJSONPreamble(&coverage);
+  {
+    JSONArray jsarr(&coverage, "coverage");
+    ClassDictionaryIterator it(lib, ClassDictionaryIterator::kIteratePrivate);
+    while (it.HasNext()) {
+      cls = it.GetNextClass();
+      if (cls.EnsureIsFinalized(isolate) == Error::null()) {
+        // Only classes that have been finalized do have a meaningful list of
+        // functions.
+        PrintClass(cls, jsarr, Script::Handle());
+      }
+    }
+  }
+}
+
+
+void CodeCoverage::PrintJSONForScript(const String& script_name,
+                                      JSONStream* stream) {
+  // Unless there's a backref to the script's library we need to search through
+  // all libraries.
+  Isolate* isolate = Isolate::Current();
+  const GrowableObjectArray& libs = GrowableObjectArray::Handle(
+      isolate, isolate->object_store()->libraries());
+  Library& lib = Library::Handle();
+  Class& cls = Class::Handle();
+  JSONObject coverage(stream);
+  PrintJSONPreamble(&coverage);
+  {
+    JSONArray jsarr(&coverage, "coverage");
+    Script& script = Script::Handle();
+    for (int i = 0; i < libs.Length(); i++) {
+      lib ^= libs.At(i);
+      const Array& loaded_scripts = Array::Handle(lib.LoadedScripts());
+      intptr_t num_scripts = loaded_scripts.Length();
+      bool found = false;
+      for (intptr_t i = 0; i < num_scripts; i++) {

[Cutch, 2014/06/23 16:23:11]

Factor this code into a utility method?

FindLibraryWithScriptName(...).

[Michael Lippautz (Google), 2014/06/24 17:51:07]

Done.

Added
  static RawScript* Script::FindByUrl(...)
  RawLibrary* Script::FindLibrary()

+        script ^= loaded_scripts.At(i);
+        if (script_name.CompareTo(String::Handle(script.url())) == 0) {
+          found = true;
+          break;
+        }
+      }
+      if (!found) {
+        continue;
+      }
+      ClassDictionaryIterator it(lib, ClassDictionaryIterator::kIteratePrivate);

[Cutch, 2014/06/23 16:23:11]

Just call PrintJSONForLibrary instead of duplicating the code?

[Michael Lippautz (Google), 2014/06/24 17:51:07]

Done.

+      while (it.HasNext()) {
+        cls = it.GetNextClass();
+        if (cls.EnsureIsFinalized(isolate) == Error::null()) {
+          // Only classes that have been finalized do have a meaningful list of
+          // functions.
+          PrintClass(cls, jsarr, script);
+        }
+      }
+    }
+  }
+}
+
+
 void CodeCoverage::Write(Isolate* isolate) {
   if (FLAG_coverage_dir == NULL) {
     return;
   }
 
   Dart_FileOpenCallback file_open = Isolate::file_open_callback();
   Dart_FileWriteCallback file_write = Isolate::file_write_callback();
   Dart_FileCloseCallback file_close = Isolate::file_close_callback();
   if ((file_open == NULL) || (file_write == NULL) || (file_close == NULL)) {
     return;
@@ skipping 30 matching lines @@
   {
     JSONArray jsarr(&coverage, "coverage");
     for (int i = 0; i < libs.Length(); i++) {
       lib ^= libs.At(i);
       ClassDictionaryIterator it(lib, ClassDictionaryIterator::kIteratePrivate);
       while (it.HasNext()) {
         cls = it.GetNextClass();
         if (cls.EnsureIsFinalized(isolate) == Error::null()) {
           // Only classes that have been finalized do have a meaningful list of
           // functions.
-          PrintClass(cls, jsarr);
+          PrintClass(cls, jsarr, Script::Handle());
         }
       }
     }
   }
 }
 
 
 }  // namespace dart