[UMA] Use proper C++ objects to serialize tracked_objects across process boundaries.

base/tracked_objects.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "base/tracked_objects.h"
 
 #include <math.h>
 
 #include "base/format_macros.h"
+#include "base/memory/scoped_ptr.h"
 #include "base/message_loop.h"
+#include "base/process_util.h"
 #include "base/profiler/alternate_timer.h"
 #include "base/stringprintf.h"
 #include "base/third_party/valgrind/memcheck.h"
 #include "base/threading/thread_restrictions.h"
+#include "base/port.h"
+#include "base/values.h"
 #include "build/build_config.h"
-#include "base/port.h"
 
+using base::DictionaryValue;
 using base::TimeDelta;
+using base::Value;
 
 namespace tracked_objects {
 
 namespace {
 
 // Flag to compile out almost all of the task tracking code.
 const bool kTrackAllTaskObjects = true;
 
 // Flag to compile out parent-child link recording.
 const bool kTrackParentChildLinks = false;
 
 // When ThreadData is first initialized, should we start in an ACTIVE state to
 // record all of the startup-time tasks, or should we start up DEACTIVATED, so
 // that we only record after parsing the command line flag --enable-tracking.
 // Note that the flag may force either state, so this really controls only the
 // period of time up until that flag is parsed. If there is no flag seen, then
 // this state may prevail for much or all of the process lifetime.
 const ThreadData::Status kInitialStartupState =
     ThreadData::PROFILING_CHILDREN_ACTIVE;
 
 // Control whether an alternate time source (Now() function) is supported by
 // the ThreadData class.  This compile time flag should be set to true if we
 // want other modules (such as a memory allocator, or a thread-specific CPU time
 // clock) to be able to provide a thread-specific Now() function.  Without this
 // compile-time flag, the code will only support the wall-clock time.  This flag
 // can be flipped to efficiently disable this path (if there is a performance
 // problem with its presence).
 static const bool kAllowAlternateTimeSourceHandling = true;
+
 }  // namespace
 
 //------------------------------------------------------------------------------
 // DeathData tallies durations when a death takes place.
 
 DeathData::DeathData() {
   Clear();
 }
 
 DeathData::DeathData(int count) {
@@ skipping 49 matching lines @@
 }
 
 DurationInt DeathData::queue_duration_max() const {
   return queue_duration_max_;
 }
 
 DurationInt DeathData::queue_duration_sample() const {
   return queue_duration_sample_;
 }
 
-
-base::DictionaryValue* DeathData::ToValue() const {
-  base::DictionaryValue* dictionary = new base::DictionaryValue;
-  dictionary->Set("count", base::Value::CreateIntegerValue(count_));
-  dictionary->Set("run_ms",
-      base::Value::CreateIntegerValue(run_duration_sum()));
-  dictionary->Set("run_ms_max",
-      base::Value::CreateIntegerValue(run_duration_max()));
-  dictionary->Set("run_ms_sample",
-      base::Value::CreateIntegerValue(run_duration_sample()));
-  dictionary->Set("queue_ms",
-      base::Value::CreateIntegerValue(queue_duration_sum()));
-  dictionary->Set("queue_ms_max",
-      base::Value::CreateIntegerValue(queue_duration_max()));
-  dictionary->Set("queue_ms_sample",
-      base::Value::CreateIntegerValue(queue_duration_sample()));
-  return dictionary;
-}
-
 void DeathData::ResetMax() {
   run_duration_max_ = 0;
   queue_duration_max_ = 0;
 }
 
 void DeathData::Clear() {
   count_ = 0;
   run_duration_sum_ = 0;
   run_duration_max_ = 0;
   run_duration_sample_ = 0;
   queue_duration_sum_ = 0;
   queue_duration_max_ = 0;
   queue_duration_sample_ = 0;
 }
 
 //------------------------------------------------------------------------------
+SerializedDeathData::SerializedDeathData() {
+}
+
+SerializedDeathData::SerializedDeathData(
+    const tracked_objects::DeathData& death_data)
+    : count(death_data.count()),
+      run_duration_sum(death_data.run_duration_sum()),
+      run_duration_max(death_data.run_duration_max()),
+      run_duration_sample(death_data.run_duration_sample()),
+      queue_duration_sum(death_data.queue_duration_sum()),
+      queue_duration_max(death_data.queue_duration_max()),
+      queue_duration_sample(death_data.queue_duration_sample()) {
+}
+
+SerializedDeathData::~SerializedDeathData() {
+}
+
+void SerializedDeathData::ToValue(DictionaryValue* dictionary) const {
+  dictionary->Set("count", Value::CreateIntegerValue(count));
+  dictionary->Set("run_ms", Value::CreateIntegerValue(run_duration_sum));
+  dictionary->Set("run_ms_max", Value::CreateIntegerValue(run_duration_max));
+  dictionary->Set("run_ms_sample",
+      Value::CreateIntegerValue(run_duration_sample));
+  dictionary->Set("queue_ms", Value::CreateIntegerValue(queue_duration_sum));
+  dictionary->Set("queue_ms_max",
+      Value::CreateIntegerValue(queue_duration_max));
+  dictionary->Set("queue_ms_sample",
+      Value::CreateIntegerValue(queue_duration_sample));
+}
+
+//------------------------------------------------------------------------------
 BirthOnThread::BirthOnThread(const Location& location,
                              const ThreadData& current)
     : location_(location),
       birth_thread_(&current) {
 }
 
-const Location BirthOnThread::location() const { return location_; }
-const ThreadData* BirthOnThread::birth_thread() const { return birth_thread_; }
+//------------------------------------------------------------------------------
+SerializedBirthOnThread::SerializedBirthOnThread() {
+}
 
-void BirthOnThread::ToValue(const std::string& prefix,
-                            base::DictionaryValue* dictionary) const {
-  dictionary->Set(prefix + "_location", location_.ToValue());
-  dictionary->Set(prefix + "_thread",
-                  base::Value::CreateStringValue(birth_thread_->thread_name()));
+SerializedBirthOnThread::SerializedBirthOnThread(
+    const tracked_objects::BirthOnThread& birth)
+    : location(birth.location()),
+      thread_name(birth.birth_thread()->thread_name()) {
+}
+
+SerializedBirthOnThread::~SerializedBirthOnThread() {
+}
+
+void SerializedBirthOnThread::ToValue(const std::string& prefix,
+                                      DictionaryValue* dictionary) const {
+  scoped_ptr<DictionaryValue> location_value(new DictionaryValue);
+  location.ToValue(location_value.get());
+
+  // TODO(jar): Remove the if/else below and disallow passing an empty prefix,
+  // but that will require fixing unit tests, and JS to take "birth_location"
+  // rather than "location".
+  std::string location_key = "location";
+  std::string thread_name_key = "thread";
+  if (!prefix.empty()) {
+    location_key = prefix + "_" + location_key;
+    thread_name_key = prefix + "_" + thread_name_key;
+  } else {
+    // For not we special-case the birth thread, as the renderer code expects
+    // "location" rather than "birth_location".
+    thread_name_key = "birth_" + thread_name_key;
+  }
+
+  dictionary->Set(location_key, location_value.release());
+  dictionary->Set(thread_name_key, Value::CreateStringValue(thread_name));
 }
 
 //------------------------------------------------------------------------------
 Births::Births(const Location& location, const ThreadData& current)
     : BirthOnThread(location, current),
       birth_count_(1) { }
 
 int Births::birth_count() const { return birth_count_; }
 
 void Births::RecordBirth() { ++birth_count_; }
@@ skipping 152 matching lines @@
     return;
   }
   // We must NOT do any allocations during this callback.
   // Using the simple linked lists avoids all allocations.
   DCHECK_EQ(this->next_retired_worker_, reinterpret_cast<ThreadData*>(NULL));
   this->next_retired_worker_ = first_retired_worker_;
   first_retired_worker_ = this;
 }
 
 // static
-base::DictionaryValue* ThreadData::ToValue(bool reset_max) {
-  DataCollector collected_data;  // Gather data.
-  // Request multiple calls to collected_data.Append() for all threads.
-  SendAllMaps(reset_max, &collected_data);
-  collected_data.AddListOfLivingObjects();  // Add births that are still alive.
-  base::DictionaryValue* dictionary = new base::DictionaryValue();
-  collected_data.ToValue(dictionary);
-  return dictionary;
+void ThreadData::ToSerializedProcessData(bool reset_max,
+                                         SerializedProcessData* process_data) {
+  // Add births that have run to completion to |collected_data|.
+  // |birth_counts| tracks the total number of births recorded at each location
+  // for which we have not seen a death count.
+  std::map<const BirthOnThread*, int> birth_counts;
+  ThreadData::SerializeAllExecutedTasks(reset_max, process_data, &birth_counts);
+
+  // Add births that are still active -- i.e. objects that have tallied a birth,
+  // but have not yet tallied a matching death, and hence must be either
+  // running, queued up, or being held in limbo for future posting.
+  for (std::map<const BirthOnThread*, int>::const_iterator it =
+           birth_counts.begin();
+       it != birth_counts.end(); ++it) {
+    if (it->second > 0) {
+      process_data->snapshots.push_back(
+          SerializedSnapshot(*it->first,
+                             DeathData(it->second),
+                             "Still_Alive"));
+    }
+  }
 }
 
 Births* ThreadData::TallyABirth(const Location& location) {
   BirthMap::iterator it = birth_map_.find(location);
   Births* child;
   if (it != birth_map_.end()) {
     child =  it->second;
     child->RecordBirth();
   } else {
     child = new Births(location, *this);  // Leak this.
@@ skipping 165 matching lines @@
 
   DurationInt queue_duration = 0;
   DurationInt run_duration = 0;
   if (!start_of_run.is_null() && !end_of_run.is_null())
     run_duration = (end_of_run - start_of_run).InMilliseconds();
   current_thread_data->TallyADeath(*birth, queue_duration, run_duration);
 }
 
 const std::string ThreadData::thread_name() const { return thread_name_; }
 
+// static
+void ThreadData::SerializeAllExecutedTasks(
+    bool reset_max,
+    SerializedProcessData* process_data,
+    std::map<const BirthOnThread*, int>* birth_counts) {
+  if (!kTrackAllTaskObjects)
+    return;  // Not compiled in.
+
+  // Get an unchanging copy of a ThreadData list.
+  ThreadData* my_list = ThreadData::first();
+
+  // Gather data serially.
+  // This hackish approach *can* get some slighly corrupt tallies, as we are
+  // grabbing values without the protection of a lock, but it has the advantage
+  // of working even with threads that don't have message loops.  If a user
+  // sees any strangeness, they can always just run their stats gathering a
+  // second time.
+  for (ThreadData* thread_data = my_list;
+       thread_data;
+       thread_data = thread_data->next()) {
+    thread_data->SerializeExecutedTasks(reset_max, process_data, birth_counts);
+  }
+}
+
+void ThreadData::SerializeExecutedTasks(
+    bool reset_max,
+    SerializedProcessData* process_data,
+    std::map<const BirthOnThread*, int>* birth_counts) {
+  // Get copy of data, so that the data will not change during the iterations
+  // and processing.
+  ThreadData::BirthMap birth_map;
+  ThreadData::DeathMap death_map;
+  ThreadData::ParentChildSet parent_child_set;
+  SnapshotMaps(reset_max, &birth_map, &death_map, &parent_child_set);
+
+  for (ThreadData::DeathMap::const_iterator it = death_map.begin();
+       it != death_map.end(); ++it) {
+    process_data->snapshots.push_back(
+        SerializedSnapshot(*it->first, it->second, thread_name()));
+    (*birth_counts)[it->first] -= it->first->birth_count();
+  }
+
+  for (ThreadData::BirthMap::const_iterator it = birth_map.begin();
+       it != birth_map.end(); ++it) {
+    (*birth_counts)[it->second] += it->second->birth_count();
+  }
+
+  if (!kTrackParentChildLinks)
+    return;
+
+  for (ThreadData::ParentChildSet::const_iterator it = parent_child_set.begin();
+       it != parent_child_set.end(); ++it) {
+    process_data->descendants.push_back(SerializedParentChildPair(*it));
+  }
+}
+
 // This may be called from another thread.
 void ThreadData::SnapshotMaps(bool reset_max,
                               BirthMap* birth_map,
                               DeathMap* death_map,
                               ParentChildSet* parent_child_set) {
   base::AutoLock lock(map_lock_);
   for (BirthMap::const_iterator it = birth_map_.begin();
        it != birth_map_.end(); ++it)
     (*birth_map)[it->first] = it->second;
   for (DeathMap::iterator it = death_map_.begin();
        it != death_map_.end(); ++it) {
     (*death_map)[it->first] = it->second;
     if (reset_max)
       it->second.ResetMax();
   }
 
   if (!kTrackParentChildLinks)
     return;
 
   for (ParentChildSet::iterator it = parent_child_set_.begin();
        it != parent_child_set_.end(); ++it)
     parent_child_set->insert(*it);
 }
 
 // static
-void ThreadData::SendAllMaps(bool reset_max, class DataCollector* target) {
-  if (!kTrackAllTaskObjects)
-    return;  // Not compiled in.
-  // Get an unchanging copy of a ThreadData list.
-  ThreadData* my_list = ThreadData::first();
-
-  // Gather data serially.
-  // This hackish approach *can* get some slighly corrupt tallies, as we are
-  // grabbing values without the protection of a lock, but it has the advantage
-  // of working even with threads that don't have message loops.  If a user
-  // sees any strangeness, they can always just run their stats gathering a
-  // second time.
-  for (ThreadData* thread_data = my_list;
-       thread_data;
-       thread_data = thread_data->next()) {
-    // Get copy of data.
-    ThreadData::BirthMap birth_map;
-    ThreadData::DeathMap death_map;
-    ThreadData::ParentChildSet parent_child_set;
-    thread_data->SnapshotMaps(reset_max, &birth_map, &death_map,
-                              &parent_child_set);
-    target->Append(*thread_data, birth_map, death_map, parent_child_set);
-  }
-}
-
-// static
 void ThreadData::ResetAllThreadData() {
   ThreadData* my_list = first();
 
   for (ThreadData* thread_data = my_list;
        thread_data;
        thread_data = thread_data->next())
     thread_data->Reset();
 }
 
 void ThreadData::Reset() {
@@ skipping 187 matching lines @@
     thread_data_list = thread_data_list->next();
 
     for (BirthMap::iterator it = next_thread_data->birth_map_.begin();
          next_thread_data->birth_map_.end() != it; ++it)
       delete it->second;  // Delete the Birth Records.
     delete next_thread_data;  // Includes all Death Records.
   }
 }
 
 //------------------------------------------------------------------------------
-// Individual 3-tuple of birth (place and thread) along with death thread, and
-// the accumulated stats for instances (DeathData).
-
-Snapshot::Snapshot(const BirthOnThread& birth_on_thread,
-                   const ThreadData& death_thread,
-                   const DeathData& death_data)
-    : birth_(&birth_on_thread),
-      death_thread_(&death_thread),
-      death_data_(death_data) {
+SerializedSnapshot::SerializedSnapshot() {
 }
 
-Snapshot::Snapshot(const BirthOnThread& birth_on_thread, int count)
-    : birth_(&birth_on_thread),
-      death_thread_(NULL),
-      death_data_(DeathData(count)) {
+SerializedSnapshot::SerializedSnapshot(const BirthOnThread& birth,
+                                       const DeathData& death_data,
+                                       const std::string& death_thread_name)
+    : birth(birth),
+      death_data(death_data),
+      death_thread_name(death_thread_name) {
 }
 
-const std::string Snapshot::DeathThreadName() const {
-  if (death_thread_)
-    return death_thread_->thread_name();
-  return "Still_Alive";
+SerializedSnapshot::~SerializedSnapshot() {
 }
 
-base::DictionaryValue* Snapshot::ToValue() const {
-  base::DictionaryValue* dictionary = new base::DictionaryValue;
-  // TODO(jar): Switch the next two lines to:
-  // birth_->ToValue("birth", dictionary);
-  // ...but that will require fixing unit tests, and JS to take
-  // "birth_location" rather than "location"
-  dictionary->Set("birth_thread",
-      base::Value::CreateStringValue(birth_->birth_thread()->thread_name()));
-  dictionary->Set("location", birth_->location().ToValue());
+void SerializedSnapshot::ToValue(DictionaryValue* dictionary) const {
+  // TODO(jar): Update the first argument below to be "birth" rather than an
+  // empty string, but that will require fixing unit tests, and JS to take
+  // "birth_location" rather than "location".
+  birth.ToValue(std::string(), dictionary);
 
-  dictionary->Set("death_data", death_data_.ToValue());
-  dictionary->Set("death_thread",
-      base::Value::CreateStringValue(DeathThreadName()));
-  return dictionary;
+  scoped_ptr<DictionaryValue> death_value(new DictionaryValue);
+  death_data.ToValue(death_value.get());
+  dictionary->Set("death_data", death_value.release());
+
+  dictionary->Set("death_thread", Value::CreateStringValue(death_thread_name));
 }
 
 //------------------------------------------------------------------------------
-// DataCollector
+// SerializedParentChildPair
 
-DataCollector::DataCollector() {}
-
-DataCollector::~DataCollector() {
+SerializedParentChildPair::SerializedParentChildPair(){
 }
 
-void DataCollector::Append(const ThreadData& thread_data,
-                           const ThreadData::BirthMap& birth_map,
-                           const ThreadData::DeathMap& death_map,
-                           const ThreadData::ParentChildSet& parent_child_set) {
-  for (ThreadData::DeathMap::const_iterator it = death_map.begin();
-       it != death_map.end(); ++it) {
-    collection_.push_back(Snapshot(*it->first, thread_data, it->second));
-    global_birth_count_[it->first] -= it->first->birth_count();
-  }
-
-  for (ThreadData::BirthMap::const_iterator it = birth_map.begin();
-       it != birth_map.end(); ++it) {
-    global_birth_count_[it->second] += it->second->birth_count();
-  }
-
-  if (!kTrackParentChildLinks)
-    return;
-
-  for (ThreadData::ParentChildSet::const_iterator it = parent_child_set.begin();
-       it != parent_child_set.end(); ++it) {
-    parent_child_set_.insert(*it);
-  }
+SerializedParentChildPair::SerializedParentChildPair(
+    const ThreadData::ParentChildPair& parent_child)
+        : parent(*parent_child.first),
+          child(*parent_child.second) {
 }
 
-DataCollector::Collection* DataCollector::collection() {
-  return &collection_;
+SerializedParentChildPair::~SerializedParentChildPair() {
 }
 
-void DataCollector::AddListOfLivingObjects() {
-  for (BirthCount::iterator it = global_birth_count_.begin();
-       it != global_birth_count_.end(); ++it) {
-    if (it->second > 0)
-      collection_.push_back(Snapshot(*it->first, it->second));
-  }
+void SerializedParentChildPair::ToValue(
+    base::DictionaryValue* dictionary) const {
+  parent.ToValue("parent", dictionary);
+  child.ToValue("child", dictionary);
 }
 
-void DataCollector::ToValue(base::DictionaryValue* dictionary) const {
-  base::ListValue* list = new base::ListValue;
-  for (size_t i = 0; i < collection_.size(); ++i) {
-    list->Append(collection_[i].ToValue());
+
+//------------------------------------------------------------------------------
+// SerializedProcessData
+
+SerializedProcessData::SerializedProcessData()
+    : process_id(base::GetCurrentProcId()) {
+}
+
+SerializedProcessData::~SerializedProcessData() {
+}
+
+void SerializedProcessData::ToValue(DictionaryValue* dictionary) const {
+  scoped_ptr<base::ListValue> snapshots_list(new base::ListValue);
+  for (std::vector<tracked_objects::SerializedSnapshot>::const_iterator it =
+           snapshots.begin();
+       it != snapshots.end(); ++it) {
+    scoped_ptr<DictionaryValue> snapshot(new DictionaryValue);
+    it->ToValue(snapshot.get());
+    snapshots_list->Append(snapshot.release());
   }
-  dictionary->Set("list", list);
+  dictionary->Set("list", snapshots_list.release());
 
-  base::ListValue* descendants = new base::ListValue;
-  for (ThreadData::ParentChildSet::const_iterator it =
-           parent_child_set_.begin();
-       it != parent_child_set_.end();
-       ++it) {
-    base::DictionaryValue* parent_child = new base::DictionaryValue;
-    it->first->ToValue("parent", parent_child);
-    it->second->ToValue("child", parent_child);
-    descendants->Append(parent_child);
+  dictionary->SetInteger("process_id", process_id);
+
+  scoped_ptr<base::ListValue> descendants_list(new base::ListValue);
+  for (std::vector<SerializedParentChildPair>::const_iterator it =
+           descendants.begin();
+       it != descendants.end(); ++it) {
+    scoped_ptr<base::DictionaryValue> parent_child(new base::DictionaryValue);
+    it->ToValue(parent_child.get());
+    descendants_list->Append(parent_child.release());
   }
-  dictionary->Set("descendants", descendants);
+  dictionary->Set("descendants", descendants_list.release());
 }
 
 }  // namespace tracked_objects