database_memory_dump_provider.cc 4.9 KB

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