base/trace_event/winheap_dump_provider_win.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_WINHEAP_DUMP_PROVIDER_WIN_H_
   6 #define BASE_TRACE_EVENT_WINHEAP_DUMP_PROVIDER_WIN_H_
   7
   8 #include <set>
   9
  10 #include "base/memory/singleton.h"
  11 #include "base/trace_event/memory_dump_provider.h"
  12
  13 namespace base {
  14 namespace trace_event {
  15
  16 // A structure containing some information about a given heap.
  17 struct WinHeapInfo {
  18   HANDLE heap_id;
  19   size_t committed_size;
  20   size_t allocated_size;
  21   size_t block_count;
  22 };
  23
  24 // Dump provider which collects process-wide heap memory stats. This provider
  25 // iterates over all the heaps of the current process to gather some metrics
  26 // about them.
  27 class BASE_EXPORT WinHeapDumpProvider : public MemoryDumpProvider {
  28  public:
  29   // Name of the allocated_objects dump. Use this to declare suballocator dumps
  30   // from other dump providers.
  31   static const char kAllocatedObjects[];
  32
  33   static WinHeapDumpProvider* GetInstance();
  34
  35   // MemoryDumpProvider implementation.
  36   bool OnMemoryDump(const MemoryDumpArgs& args,
  37                     ProcessMemoryDump* pmd) override;
  38
  39  private:
  40   friend struct DefaultSingletonTraits<WinHeapDumpProvider>;
  41
  42   // Retrieves the information about given heap. The |heap_info| should contain
  43   // a valid handle to an existing heap. The blocks contained in the
  44   // |block_to_skip| set will be ignored.
  45   bool GetHeapInformation(WinHeapInfo* heap_info,
  46                           const std::set<void*>& block_to_skip);
  47
  48   WinHeapDumpProvider() {}
  49   ~WinHeapDumpProvider() override {}
  50
  51   DISALLOW_COPY_AND_ASSIGN(WinHeapDumpProvider);
  52 };
  53
  54 }  // namespace trace_event
  55 }  // namespace base
  56
  57 #endif  // BASE_TRACE_EVENT_WINHEAP_DUMP_PROVIDER_WIN_H_