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/trace_event/memory_allocator_attributes.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 dump points.
  20   // Returns: true if the |pmd| was successfully populated, false otherwise.
  21   virtual bool DumpInto(ProcessMemoryDump* pmd) = 0;
  22
  23   virtual const char* GetFriendlyName() const = 0;
  24
  25   const MemoryAllocatorDeclaredAttributes& allocator_attributes() const {
  26     return allocator_attributes_;
  27   }
  28
  29  protected:
  30   MemoryDumpProvider();
  31   virtual ~MemoryDumpProvider();
  32
  33   void DeclareAllocatorAttribute(const MemoryAllocatorDeclaredAttribute& attr);
  34
  35  private:
  36   // The map (attribute name -> type) that specifies the semantic of the
  37   // extra attributes that the MemoryAllocatorDump(s) produced by this
  38   // MemoryDumpProvider will have.
  39   MemoryAllocatorDeclaredAttributes allocator_attributes_;
  40
  41   DISALLOW_COPY_AND_ASSIGN(MemoryDumpProvider);
  42 };
  43
  44 }  // namespace trace_event
  45 }  // namespace base
  46
  47 #endif  // BASE_TRACE_EVENT_MEMORY_DUMP_PROVIDER_H_