Improve code coverage generation.

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/isolate.h"
 #include "vm/json_stream.h"
 #include "vm/object.h"
 #include "vm/object_store.h"
 
 namespace dart {
 
 DEFINE_FLAG(charp, coverage_dir, NULL,
             "Enable writing coverage data into specified directory.");
 
-void CodeCoverage::PrintClass(const Class& cls, const JSONArray& jsarr) {
-  const Array& functions = Array::Handle(cls.functions());
-  ASSERT(!functions.IsNull());
+
+int CodeCoverage::PrintFunctionsInSource(const String& source,
+                                         const Array& functions,
+                                         int index,
+                                         const JSONArray& hits_arr) {
+  Isolate* isolate = Isolate::Current();
+  Code& code = Code::Handle();
   Function& function = Function::Handle();
-  Code& code = Code::Handle();
   Script& script = Script::Handle();
   String& url = String::Handle();
-  String& name = String::Handle();
   PcDescriptors& descriptors = PcDescriptors::Handle();
   Array& ic_array = Array::Handle();
   ICData& ic_data = ICData::Handle();
-  for (int i = 0; i < functions.Length(); i++) {
-    function ^= functions.At(i);
+  // 2^64-1: 20 digits. String format: "<line>-<line>\0".
+  const intptr_t kMaxLineRangeLen = 42;
+  char line_str[kMaxLineRangeLen];
 
-    JSONObject jsobj(&jsarr);
+  while (index < functions.Length()) {
+    HANDLESCOPE(isolate);
+    function ^= functions.At(index);
+
     script = function.script();
     url = script.url();
-    name = function.QualifiedUserVisibleName();
-    jsobj.AddProperty("source", url.ToCString());
-    jsobj.AddProperty("function", name.ToCString());
-
-    JSONArray jsarr(&jsobj, "hits");
+    if (!url.Equals(source)) {
+      // Abort adding hitcounts to this particular script file entry as soon as
+      // we find a function residing in a different script.
+      return index;
+    }
 
     if (function.HasCode()) {

[Ivan Posva, 2013/09/27 20:19:54]

As we discussed to get more complete coverage of functions it might be necessary
to compile all of the functions instead of just assigning them a zero hit count.

[Michael Lippautz (Google), 2013/09/27 21:46:50]

Done.

       // Print the hit counts for all IC datas.
       code = function.unoptimized_code();
       ic_array = code.ExtractTypeFeedbackArray();
       descriptors = code.pc_descriptors();
 
       for (int j = 0; j < descriptors.Length(); j++) {
+        HANDLESCOPE(isolate);
         PcDescriptors::Kind kind = descriptors.DescriptorKind(j);
         // Only IC based calls have counting.
         if ((kind == PcDescriptors::kIcCall) ||
             (kind == PcDescriptors::kUnoptStaticCall)) {
           intptr_t deopt_id = descriptors.DeoptId(j);
           ic_data ^= ic_array.At(deopt_id);
           if (!ic_data.IsNull()) {
             intptr_t token_pos = descriptors.TokenPos(j);
             intptr_t line = -1;
-            intptr_t col = -1;
-            script.GetTokenLocation(token_pos, &line, &col);
-            JSONObject ic_info(&jsarr);
-            ic_info.AddProperty("line", line);
-            ic_info.AddProperty("col", col);
-            ic_info.AddProperty("count", ic_data.AggregateCount());
+            script.GetTokenLocation(token_pos, &line, NULL);
+            hits_arr.AddValue(line);
+            hits_arr.AddValue(ic_data.AggregateCount());
           }
         }
       }
     } else {
-      // The function has no code so it was never executed and thus we add one
-      // zero count hit at the first token index.
-      intptr_t line = -1;
-      intptr_t col = -1;
-      script.GetTokenLocation(function.token_pos(), &line, &col);
-      JSONObject func_info(&jsarr);
-      func_info.AddProperty("line", line);
-      func_info.AddProperty("col", col);
-      func_info.AddProperty("count", static_cast<intptr_t>(0));
+      // The function has no code so it was never executed and thus we add a
+      // zero count hit for the line (or range of lines) the function is defined
+      // on.
+      intptr_t start_line = -1;
+      intptr_t end_line = -1;
+      script.GetTokenLocation(function.token_pos(), &start_line, NULL);
+      script.GetTokenLocation(function.end_token_pos(), &end_line, NULL);
+      if (start_line == end_line) {
+        hits_arr.AddValue(start_line);
+        hits_arr.AddValue(static_cast<intptr_t>(0));
+      } else {
+        OS::SNPrint(line_str, kMaxLineRangeLen, "%d-%d", start_line, end_line);

[Ivan Posva, 2013/09/27 20:19:54]

Please remove the : from the description of the change as well.

[Michael Lippautz (Google), 2013/09/27 21:46:50]

Done. There are no ranges anymore.

+        hits_arr.AddValue(line_str);
+        hits_arr.AddValue(static_cast<intptr_t>(0));
+      }
     }
+
+    index++;
+  }
+  return index;
+}
+
+void CodeCoverage::PrintClass(const Class& cls, const JSONArray& jsarr) {
+  Isolate* isolate = Isolate::Current();
+  const Array& functions = Array::Handle(cls.functions());
+  ASSERT(!functions.IsNull());
+  Function& function = Function::Handle();
+  Script& script = Script::Handle();
+  String& url = String::Handle();
+  int i = 0;
+  while (i < functions.Length()) {

[Ivan Posva, 2013/09/27 20:19:54]

As discussed off-line we also need to iterate over the closure functions to
gather their coverage once we have finished traversing all functions.

[Michael Lippautz (Google), 2013/09/27 21:46:50]

Done.

+    HANDLESCOPE(isolate);
+    function ^= functions.At(i);
+
+    JSONObject jsobj(&jsarr);
+    script = function.script();
+    url = script.url();
+    jsobj.AddProperty("source", url.ToCString());
+
+    JSONArray hits_arr(&jsobj, "hits");
+    i = PrintFunctionsInSource(url, functions, i, hits_arr);
   }
 }
 
 
 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;
   }
 
   JSONStream stream;
   {
     const GrowableObjectArray& libs = GrowableObjectArray::Handle(
         isolate, isolate->object_store()->libraries());
     Library& lib = Library::Handle();
     Class& cls = Class::Handle();
     JSONArray jsarr(&stream);
     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.is_finalized()) {

[Ivan Posva, 2013/09/27 20:19:54]

To have a more complete picture we should call EnsureIsFinalized instead of
skipping classes here.

[Michael Lippautz (Google), 2013/09/27 21:46:50]

Done.

           // Only classes that have been finalized do have a meaningful list of
           // functions.
           PrintClass(cls, jsarr);
         }
       }
     }
   }
 
   const char* format = "%s/dart-cov-%" Pd "-%" Pd ".json";
   intptr_t pid = OS::ProcessId();
   intptr_t len = OS::SNPrint(NULL, 0, format,
                              FLAG_coverage_dir, pid, isolate->main_port());
   char* filename = Isolate::Current()->current_zone()->Alloc<char>(len + 1);
   OS::SNPrint(filename, len + 1, format,
               FLAG_coverage_dir, pid, isolate->main_port());
   void* file = (*file_open)(filename, true);
   if (file == NULL) {
     OS::Print("Failed to write coverage file: %s\n", filename);
     return;
   }
   (*file_write)(stream.buffer()->buf(), stream.buffer()->length(), file);
   (*file_close)(file);
 }
 
 }  // namespace dart