sql/database_memory_dump_provider.cc

   1 // Copyright 2015 The Chromium Authors
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "sql/database_memory_dump_provider.h"
   6
   7 #include <inttypes.h>
   8
   9 #include <ostream>  // Needed to compile NOTREACHED() with operator <<.
  10 #include <string>
  11
  12 #include "base/strings/stringprintf.h"
  13 #include "base/synchronization/lock.h"
  14 #include "base/trace_event/memory_dump_request_args.h"
  15 #include "base/trace_event/process_memory_dump.h"
  16 #include "sql/sqlite_result_code.h"
  17 #include "sql/sqlite_result_code_values.h"
  18 #include "third_party/sqlite/sqlite3.h"
  19
  20 namespace sql {
  21
  22 DatabaseMemoryDumpProvider::DatabaseMemoryDumpProvider(sqlite3* db,
  23                                                        const std::string& name)
  24     : db_(db), connection_name_(name) {}
  25
  26 DatabaseMemoryDumpProvider::~DatabaseMemoryDumpProvider() = default;
  27
  28 void DatabaseMemoryDumpProvider::ResetDatabase() {
  29   base::AutoLock lock(lock_);
  30   db_ = nullptr;
  31 }
  32
  33 bool DatabaseMemoryDumpProvider::OnMemoryDump(
  34     const base::trace_event::MemoryDumpArgs& args,
  35     base::trace_event::ProcessMemoryDump* pmd) {
  36   if (args.level_of_detail == base::trace_event::MemoryDumpLevelOfDetail::LIGHT)
  37     return true;
  38
  39   MemoryUsageResult memory_usage = GetDbMemoryUsage();
  40   if (!memory_usage.is_valid)
  41     return false;
  42
  43   base::trace_event::MemoryAllocatorDump* dump =
  44       pmd->CreateAllocatorDump(FormatDumpName());
  45   dump->AddScalar(base::trace_event::MemoryAllocatorDump::kNameSize,
  46                   base::trace_event::MemoryAllocatorDump::kUnitsBytes,
  47                   memory_usage.cache_size + memory_usage.schema_size +
  48                       memory_usage.statement_size);
  49   dump->AddScalar("cache_size",
  50                   base::trace_event::MemoryAllocatorDump::kUnitsBytes,
  51                   memory_usage.cache_size);
  52   dump->AddScalar("schema_size",
  53                   base::trace_event::MemoryAllocatorDump::kUnitsBytes,
  54                   memory_usage.schema_size);
  55   dump->AddScalar("statement_size",
  56                   base::trace_event::MemoryAllocatorDump::kUnitsBytes,
  57                   memory_usage.statement_size);
  58   return true;
  59 }
  60
  61 bool DatabaseMemoryDumpProvider::ReportMemoryUsage(
  62     base::trace_event::ProcessMemoryDump* pmd,
  63     const std::string& dump_name) {
  64   MemoryUsageResult memory_usage = GetDbMemoryUsage();
  65   if (!memory_usage.is_valid)
  66     return false;
  67
  68   auto* mad = pmd->CreateAllocatorDump(dump_name);
  69   mad->AddScalar(base::trace_event::MemoryAllocatorDump::kNameSize,
  70                  base::trace_event::MemoryAllocatorDump::kUnitsBytes,
  71                  memory_usage.cache_size + memory_usage.schema_size +
  72                      memory_usage.statement_size);
  73   pmd->AddSuballocation(mad->guid(), FormatDumpName());
  74
  75   return true;
  76 }
  77
  78 DatabaseMemoryDumpProvider::MemoryUsageResult
  79 DatabaseMemoryDumpProvider::GetDbMemoryUsage() {
  80   MemoryUsageResult result;
  81
  82   // Lock is acquired here so that db_ is not reset in ResetDatabase when
  83   // collecting stats.
  84   base::AutoLock lock(lock_);
  85   if (!db_) {
  86     DCHECK_EQ(result.is_valid, false);
  87     return result;
  88   }
  89
  90   // The following calls all set the high watermark to zero.
  91   // See /https://www.sqlite.org/c3ref/c_dbstatus_options.html
  92   int high_watermark = 0;
  93
  94   auto sqlite_result_code = ToSqliteResultCode(sqlite3_db_status(
  95       db_, SQLITE_DBSTATUS_CACHE_USED, &result.cache_size, &high_watermark,
  96       /*resetFlg=*/0));
  97   DCHECK_EQ(sqlite_result_code, SqliteResultCode::kOk)
  98       << "sqlite3_db_status(SQLITE_DBSTATUS_CACHE_USED) failed";
  99
 100 #if DCHECK_IS_ON()
 101   int shared_cache_size = 0;
 102   sqlite_result_code = ToSqliteResultCode(
 103       sqlite3_db_status(db_, SQLITE_DBSTATUS_CACHE_USED_SHARED,
 104                         &shared_cache_size, &high_watermark, /*resetFlg=*/0));
 105   DCHECK_EQ(sqlite_result_code, SqliteResultCode::kOk)
 106       << "sqlite3_db_status(SQLITE_DBSTATUS_CACHE_USED_SHARED) failed";
 107   DCHECK_EQ(shared_cache_size, result.cache_size)
 108       << "Memory counting assumes that each database uses a private page cache";
 109 #endif  // DCHECK_IS_ON()
 110
 111   sqlite_result_code = ToSqliteResultCode(sqlite3_db_status(
 112       db_, SQLITE_DBSTATUS_SCHEMA_USED, &result.schema_size, &high_watermark,
 113       /*resetFlg=*/0));
 114   DCHECK_EQ(sqlite_result_code, SqliteResultCode::kOk)
 115       << "sqlite3_db_status(SQLITE_DBSTATUS_SCHEMA_USED) failed";
 116
 117   sqlite_result_code = ToSqliteResultCode(sqlite3_db_status(
 118       db_, SQLITE_DBSTATUS_STMT_USED, &result.statement_size, &high_watermark,
 119       /*resetFlg=*/0));
 120   DCHECK_EQ(sqlite_result_code, SqliteResultCode::kOk)
 121       << "sqlite3_db_status(SQLITE_DBSTATUS_STMT_USED) failed";
 122
 123   result.is_valid = true;
 124   return result;
 125 }
 126
 127 std::string DatabaseMemoryDumpProvider::FormatDumpName() const {
 128   return base::StringPrintf(
 129       "sqlite/%s_connection/0x%" PRIXPTR,
 130       connection_name_.empty() ? "Unknown" : connection_name_.c_str(),
 131       reinterpret_cast<uintptr_t>(this));
 132 }
 133
 134 }  // namespace sql