base/trace_event/memory_dump_provider.h

   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
   5 #ifndef BASE_TRACE_EVENT_MEMORY_DUMP_PROVIDER_H_
   6 #define BASE_TRACE_EVENT_MEMORY_DUMP_PROVIDER_H_
   7
   8 #include "base/base_export.h"
   9 #include "base/macros.h"
  10
  11 namespace base {
  12 namespace trace_event {
  13
  14 class ProcessMemoryDump;
  15
  16 // The contract interface that memory dump providers must implement.
  17 class BASE_EXPORT MemoryDumpProvider {
  18  public:
  19   // Called by the MemoryDumpManager when generating memory dumps.
  20   // The embedder should return true if the |pmd| was successfully populated,
  21   // false if something went wrong and the dump should be considered invalid.
  22   // (Note, the MemoryDumpManager has a fail-safe logic which will disable the
  23   // MemoryDumpProvider for the entire trace session if it fails consistently).
  24   virtual bool OnMemoryDump(ProcessMemoryDump* pmd) = 0;
  25
  26  protected:
  27   MemoryDumpProvider() {}
  28   virtual ~MemoryDumpProvider() {}
  29
  30   DISALLOW_COPY_AND_ASSIGN(MemoryDumpProvider);
  31 };
  32
  33 }  // namespace trace_event
  34 }  // namespace base
  35
  36 #endif  // BASE_TRACE_EVENT_MEMORY_DUMP_PROVIDER_H_