[tracing] Memory dump provider for leveldb_proto

components/leveldb_proto/leveldb_database.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 "components/leveldb_proto/leveldb_database.h"
 
+#include <inttypes.h>
+
 #include <string>
 #include <vector>
 
 #include "base/files/file_path.h"
 #include "base/files/file_util.h"
 #include "base/metrics/histogram.h"
+#include "base/strings/string_number_conversions.h"
 #include "base/strings/string_split.h"
+#include "base/strings/stringprintf.h"
+#include "base/threading/sequenced_task_runner_handle.h"
 #include "base/threading/thread_checker.h"
+#include "base/trace_event/memory_dump_manager.h"
+#include "base/trace_event/process_memory_dump.h"
 #include "third_party/leveldatabase/env_chromium.h"
 #include "third_party/leveldatabase/src/helpers/memenv/memenv.h"
 #include "third_party/leveldatabase/src/include/leveldb/db.h"
 #include "third_party/leveldatabase/src/include/leveldb/env.h"
 #include "third_party/leveldatabase/src/include/leveldb/iterator.h"
 #include "third_party/leveldatabase/src/include/leveldb/options.h"
 #include "third_party/leveldatabase/src/include/leveldb/slice.h"
 #include "third_party/leveldatabase/src/include/leveldb/status.h"
 #include "third_party/leveldatabase/src/include/leveldb/write_batch.h"
 
 namespace leveldb_proto {
 
 // static
 bool LevelDB::Destroy(const base::FilePath& database_dir) {
   const leveldb::Status s =
       leveldb::DestroyDB(database_dir.AsUTF8Unsafe(), leveldb::Options());
   return s.ok();
 }
 
-LevelDB::LevelDB(const char* client_name) : open_histogram_(nullptr) {
+LevelDB::LevelDB(const char* client_name)
+    : open_histogram_(nullptr), client_name_(client_name) {
   // Used in lieu of UMA_HISTOGRAM_ENUMERATION because the histogram name is
   // not a constant.
   open_histogram_ = base::LinearHistogram::FactoryGet(
-      std::string("LevelDB.Open.") + client_name, 1,
+      std::string("LevelDB.Open.") + client_name_, 1,
       leveldb_env::LEVELDB_STATUS_MAX, leveldb_env::LEVELDB_STATUS_MAX + 1,
       base::Histogram::kUmaTargetedHistogramFlag);
 }
 
 LevelDB::~LevelDB() {
   DFAKE_SCOPED_LOCK(thread_checker_);
+  base::trace_event::MemoryDumpManager::GetInstance()->UnregisterDumpProvider(

[nyquist, 2016/09/21 06:04:16]

is thiss safe to do even if Register was never called?

[ssid, 2016/09/21 19:08:50]

yes.

+      this);
 }
 
 bool LevelDB::InitWithOptions(const base::FilePath& database_dir,
                               const leveldb::Options& options) {
   DFAKE_SCOPED_LOCK(thread_checker_);
 
   std::string path = database_dir.AsUTF8Unsafe();
 
   leveldb::DB* db = NULL;
   leveldb::Status status = leveldb::DB::Open(options, path, &db);
   if (open_histogram_)
     open_histogram_->Add(leveldb_env::GetLevelDBStatusUMAValue(status));
   if (status.IsCorruption()) {
     base::DeleteFile(database_dir, true);
     status = leveldb::DB::Open(options, path, &db);
   }
 
   if (status.ok()) {
     CHECK(db);
     db_.reset(db);
+
+    base::trace_event::MemoryDumpManager::GetInstance()
+        ->RegisterDumpProviderWithSequencedTaskRunner(
+            this, "LevelDB", base::SequencedTaskRunnerHandle::Get(),
+            base::trace_event::MemoryDumpProvider::Options());
     return true;
   }
 
   LOG(WARNING) << "Unable to open " << database_dir.value() << ": "
                << status.ToString();
   return false;
 }
 
 bool LevelDB::Init(const base::FilePath& database_dir) {
   leveldb::Options options;
@@ skipping 62 matching lines @@
   if (status.IsNotFound()) {
     *found = false;
     return true;
   }
 
   DLOG(WARNING) << "Failed loading leveldb_proto entry with key \"" << key
                 << "\": " << status.ToString();
   return false;
 }
 
+bool LevelDB::OnMemoryDump(const base::trace_event::MemoryDumpArgs& dump_args,
+                           base::trace_event::ProcessMemoryDump* pmd) {

[nyquist, 2016/09/21 06:04:16]

Is there any way of testing this?

[ssid, 2016/09/21 19:08:50]

added unittest

+  DFAKE_SCOPED_LOCK(thread_checker_);
+  if (!db_)
+    return false;
+  std::string value;

[nyquist, 2016/09/21 06:04:16]

Nit: Could you add an empty line before this?

[ssid, 2016/09/21 19:08:50]

Done.

+  uint64_t size;
+  bool res = db_->GetProperty("leveldb.approximate-memory-usage", &value);
+  DCHECK(res);
+  res = base::StringToUint64(value, &size);
+  DCHECK(res);
+
+  auto* dump = pmd->CreateAllocatorDump(

[nyquist, 2016/09/21 06:04:16]

Could this just be base::MemoryAllocatorDump*? I don't find that auto increases
readability in this case.

[ssid, 2016/09/21 19:08:50]

auto bcos base::trace_event::MemoryAllocatorDump was too long. Fixed.

+      base::StringPrintf("leveldb/leveldb_proto/0x%" PRIXPTR,
+                         reinterpret_cast<uintptr_t>(db_.get())));
+  dump->AddScalar(base::trace_event::MemoryAllocatorDump::kNameSize,
+                  base::trace_event::MemoryAllocatorDump::kUnitsBytes, size);
+  if (!client_name_.empty() &&
+      dump_args.level_of_detail !=
+          base::trace_event::MemoryDumpLevelOfDetail::BACKGROUND) {
+    dump->AddString("client_name", "", client_name_);
+  }
+
+  // Memory is allocated from system allocator (malloc).
+  pmd->AddSuballocation(dump->guid(),
+                        base::trace_event::MemoryDumpManager::GetInstance()
+                            ->system_allocator_pool_name());
+  return true;
+}
+
 }  // namespace leveldb_proto