sql/sql_memory_dump_provider.h

// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SQL_SQL_MEMORY_DUMP_PROVIDER_H_
#define SQL_SQL_MEMORY_DUMP_PROVIDER_H_

#include <cstdint>

#include "base/component_export.h"
#include "base/memory/singleton.h"
#include "base/trace_event/memory_dump_provider.h"

namespace base::trace_event {
struct MemoryDumpArgs;
}

namespace sql {

// Adds process-wide memory usage statistics about sqlite to chrome://tracing.
// sql::Database::OnMemoryDump adds per-connection memory statistics.
class COMPONENT_EXPORT(SQL) SqlMemoryDumpProvider
    : public base::trace_event::MemoryDumpProvider {
 public:
  static SqlMemoryDumpProvider* GetInstance();

  // Gets the memory used by SQLite, in bytes, and returns via return value. The
  // high water usage (highest recorded usage) is returned via out-param if
  // non-null. If `high_water` is non-null, the high water mark will also be
  // reset afterwards.
  static int64_t GetMemoryUse(int64_t* high_water = nullptr);

  SqlMemoryDumpProvider(const SqlMemoryDumpProvider&) = delete;
  SqlMemoryDumpProvider& operator=(const SqlMemoryDumpProvider&) = delete;

  // MemoryDumpProvider implementation.
  bool OnMemoryDump(const base::trace_event::MemoryDumpArgs& args,
                    base::trace_event::ProcessMemoryDump* pmd) override;

 private:
  friend struct base::DefaultSingletonTraits<SqlMemoryDumpProvider>;

  SqlMemoryDumpProvider();
  ~SqlMemoryDumpProvider() override;
};

}  // namespace sql

#endif  // SQL_SQL_MEMORY_DUMP_PROVIDER_H_