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.
5 #include "sql/database_memory_dump_provider.h"
9 #include <ostream> // Needed to compile NOTREACHED() with operator <<.
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"
22 DatabaseMemoryDumpProvider::DatabaseMemoryDumpProvider(sqlite3* db,
23 const std::string& name)
24 : db_(db), connection_name_(name) {}
26 DatabaseMemoryDumpProvider::~DatabaseMemoryDumpProvider() = default;
28 void DatabaseMemoryDumpProvider::ResetDatabase() {
29 base::AutoLock lock(lock_);
33 bool DatabaseMemoryDumpProvider::OnMemoryDump(
34 const base::trace_event::MemoryDumpArgs& args,
35 base::trace_event::ProcessMemoryDump* pmd) {
36 if (args.level_of_detail ==
37 base::trace_event::MemoryDumpLevelOfDetail::kLight) {
41 MemoryUsageResult memory_usage = GetDbMemoryUsage();
42 if (!memory_usage.is_valid)
45 base::trace_event::MemoryAllocatorDump* dump =
46 pmd->CreateAllocatorDump(FormatDumpName());
47 dump->AddScalar(base::trace_event::MemoryAllocatorDump::kNameSize,
48 base::trace_event::MemoryAllocatorDump::kUnitsBytes,
49 memory_usage.cache_size + memory_usage.schema_size +
50 memory_usage.statement_size);
51 dump->AddScalar("cache_size",
52 base::trace_event::MemoryAllocatorDump::kUnitsBytes,
53 memory_usage.cache_size);
54 dump->AddScalar("schema_size",
55 base::trace_event::MemoryAllocatorDump::kUnitsBytes,
56 memory_usage.schema_size);
57 dump->AddScalar("statement_size",
58 base::trace_event::MemoryAllocatorDump::kUnitsBytes,
59 memory_usage.statement_size);
63 bool DatabaseMemoryDumpProvider::ReportMemoryUsage(
64 base::trace_event::ProcessMemoryDump* pmd,
65 const std::string& dump_name) {
66 MemoryUsageResult memory_usage = GetDbMemoryUsage();
67 if (!memory_usage.is_valid)
70 auto* mad = pmd->CreateAllocatorDump(dump_name);
71 mad->AddScalar(base::trace_event::MemoryAllocatorDump::kNameSize,
72 base::trace_event::MemoryAllocatorDump::kUnitsBytes,
73 memory_usage.cache_size + memory_usage.schema_size +
74 memory_usage.statement_size);
75 pmd->AddSuballocation(mad->guid(), FormatDumpName());
80 DatabaseMemoryDumpProvider::MemoryUsageResult
81 DatabaseMemoryDumpProvider::GetDbMemoryUsage() {
82 MemoryUsageResult result;
84 // Lock is acquired here so that db_ is not reset in ResetDatabase when
86 base::AutoLock lock(lock_);
88 DCHECK_EQ(result.is_valid, false);
92 // The following calls all set the high watermark to zero.
93 // See /https://www.sqlite.org/c3ref/c_dbstatus_options.html
94 int high_watermark = 0;
96 auto sqlite_result_code = ToSqliteResultCode(sqlite3_db_status(
97 db_, SQLITE_DBSTATUS_CACHE_USED, &result.cache_size, &high_watermark,
99 DCHECK_EQ(sqlite_result_code, SqliteResultCode::kOk)
100 << "sqlite3_db_status(SQLITE_DBSTATUS_CACHE_USED) failed";
103 int shared_cache_size = 0;
104 sqlite_result_code = ToSqliteResultCode(
105 sqlite3_db_status(db_, SQLITE_DBSTATUS_CACHE_USED_SHARED,
106 &shared_cache_size, &high_watermark, /*resetFlg=*/0));
107 DCHECK_EQ(sqlite_result_code, SqliteResultCode::kOk)
108 << "sqlite3_db_status(SQLITE_DBSTATUS_CACHE_USED_SHARED) failed";
109 DCHECK_EQ(shared_cache_size, result.cache_size)
110 << "Memory counting assumes that each database uses a private page cache";
111 #endif // DCHECK_IS_ON()
113 sqlite_result_code = ToSqliteResultCode(sqlite3_db_status(
114 db_, SQLITE_DBSTATUS_SCHEMA_USED, &result.schema_size, &high_watermark,
116 DCHECK_EQ(sqlite_result_code, SqliteResultCode::kOk)
117 << "sqlite3_db_status(SQLITE_DBSTATUS_SCHEMA_USED) failed";
119 sqlite_result_code = ToSqliteResultCode(sqlite3_db_status(
120 db_, SQLITE_DBSTATUS_STMT_USED, &result.statement_size, &high_watermark,
122 DCHECK_EQ(sqlite_result_code, SqliteResultCode::kOk)
123 << "sqlite3_db_status(SQLITE_DBSTATUS_STMT_USED) failed";
125 result.is_valid = true;
129 std::string DatabaseMemoryDumpProvider::FormatDumpName() const {
130 return base::StringPrintf(
131 "sqlite/%s_connection/0x%" PRIXPTR,
132 connection_name_.empty() ? "Unknown" : connection_name_.c_str(),
133 reinterpret_cast<uintptr_t>(this));