[tracing] Add memory statistics from level db clients to tracing.

extensions/browser/value_store/leveldb_value_store.cc

 // Copyright 2014 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 "extensions/browser/value_store/leveldb_value_store.h"
 
 #include "base/files/file_util.h"
 #include "base/json/json_reader.h"
 #include "base/json/json_writer.h"
 #include "base/logging.h"
+#include "base/strings/string_number_conversions.h"
 #include "base/strings/string_util.h"
 #include "base/strings/stringprintf.h"
 #include "base/strings/sys_string_conversions.h"
+#include "base/thread_task_runner_handle.h"
+#include "base/trace_event/memory_dump_manager.h"
+#include "base/trace_event/process_memory_dump.h"
 #include "content/public/browser/browser_thread.h"
 #include "extensions/browser/value_store/value_store_util.h"
 #include "third_party/leveldatabase/env_chromium.h"
 #include "third_party/leveldatabase/src/include/leveldb/iterator.h"
 #include "third_party/leveldatabase/src/include/leveldb/write_batch.h"
 
 namespace util = value_store_util;
 using content::BrowserThread;
 
 namespace {
@@ skipping 28 matching lines @@
                                      const base::FilePath& db_path)
     : db_path_(db_path), open_histogram_(nullptr) {
   DCHECK_CURRENTLY_ON(BrowserThread::FILE);
 
   // Used in lieu of UMA_HISTOGRAM_ENUMERATION because the histogram name is
   // not a constant.
   open_histogram_ = base::LinearHistogram::FactoryGet(
       "Extensions.Database.Open." + uma_client_name, 1,
       leveldb_env::LEVELDB_STATUS_MAX, leveldb_env::LEVELDB_STATUS_MAX + 1,
       base::Histogram::kUmaTargetedHistogramFlag);
+  base::trace_event::MemoryDumpManager::GetInstance()->RegisterDumpProvider(
+      this, base::ThreadTaskRunnerHandle::Get());
 }
 
 LeveldbValueStore::~LeveldbValueStore() {
   DCHECK_CURRENTLY_ON(BrowserThread::FILE);
+  base::trace_event::MemoryDumpManager::GetInstance()->UnregisterDumpProvider(
+      this);
 
   // Delete the database from disk if it's empty (but only if we managed to
   // open it!). This is safe on destruction, assuming that we have exclusive
   // access to the database.
   if (db_ && IsEmpty())
     DeleteDbFile();
 }
 
 size_t LeveldbValueStore::GetBytesInUse(const std::string& key) {
   // Let SettingsStorageQuotaEnforcer implement this.
@@ skipping 242 matching lines @@
   }
 
   // The restore succeeded if there is no corruption error.
   return !result->IsCorrupted();
 }
 
 bool LeveldbValueStore::WriteToDbForTest(leveldb::WriteBatch* batch) {
   return !WriteToDb(batch).get();
 }
 
+bool LeveldbValueStore::OnMemoryDump(
+    const base::trace_event::MemoryDumpArgs& args,
+    base::trace_event::ProcessMemoryDump* pmd) {
+  DCHECK_CURRENTLY_ON(BrowserThread::FILE);
+  if (!db_)
+    return true;

[cmumford, 2015/10/15 18:35:44]

Should you be returning false here?

[ssid, 2015/11/04 11:41:49]

This has to return true for temporary failures and return false only for
permanent failures. If it returns false the provider is disabled forever.
So,returning true. I guess this value must be changed to an enum.

+
+  std::string value;
+  uint64 size;
+  bool res = db_->GetProperty("leveldb.approximate-memory-usage", &value);
+  DCHECK(res);

[cmumford, 2015/10/15 18:35:44]

What about returning false if GetProperty returns false? I'm OK with the DCHECK
- because we really know that leveldb will always succeed (assuming it's the
right version), but it'd be more future-proof to leveldb changes if we add this
check.

[ssid, 2015/11/04 11:41:49]

The DCHECK is placed so that if in future the api changes the build breaks and
we will fix it. Instead of silently ignoring the error.

+  base::StringToUint64(value, &size);

[cmumford, 2015/10/15 18:35:44]

I guess not super important to check this, but might not be a bad idea.

[ssid, 2015/11/04 11:41:49]

Done.

+
+  base::trace_event::MemoryAllocatorDump* dump = pmd->CreateAllocatorDump(

[cmumford, 2015/10/15 18:35:44]

You could make this "auto" if you want - but perfectly fine as-is.

[ssid, 2015/11/04 11:41:49]

Done.

+      "leveldb/value_store/" + open_histogram_->histogram_name());
+  dump->AddScalar(base::trace_event::MemoryAllocatorDump::kNameSize,
+                  base::trace_event::MemoryAllocatorDump::kUnitsBytes, size);
+
+  // Memory is allocated from system allocator (malloc).
+  pmd->AddSuballocation(dump->guid(),
+                        base::trace_event::MemoryDumpManager::GetInstance()
+                            ->system_allocator_pool_name());
+  return true;
+}
+
 scoped_ptr<ValueStore::Error> LeveldbValueStore::EnsureDbIsOpen() {
   DCHECK_CURRENTLY_ON(BrowserThread::FILE);
 
   if (db_)
     return util::NoError();
 
   leveldb::Options options;
   options.max_open_files = 0;  // Use minimum.
   options.create_if_missing = true;
   options.reuse_logs = leveldb_env::kDefaultLogReuseOptionValue;
@@ skipping 105 matching lines @@
   CHECK(!status.IsNotFound());  // not an error
 
   std::string message = status.ToString();
   // The message may contain |db_path_|, which may be considered sensitive
   // data, and those strings are passed to the extension, so strip it out.
   base::ReplaceSubstringsAfterOffset(
       &message, 0u, db_path_.AsUTF8Unsafe(), "...");
 
   return Error::Create(CORRUPTION, message, key.Pass());
 }