xpcom/base/nsMemoryInfoDumper.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_nsMemoryInfoDumper_h
   8 #define mozilla_nsMemoryInfoDumper_h
   9
  10 #include "nsIMemoryInfoDumper.h"
  11 #include <stdio.h>
  12
  13 /**
  14  * This class facilitates dumping information about our memory usage to disk.
  15  *
  16  * Its cpp file also has Linux-only code which watches various OS signals and
  17  * dumps memory info upon receiving a signal.  You can activate these listeners
  18  * by calling Initialize().
  19  */
  20 class nsMemoryInfoDumper : public nsIMemoryInfoDumper {
  21   virtual ~nsMemoryInfoDumper();
  22
  23  public:
  24   NS_DECL_ISUPPORTS
  25   NS_DECL_NSIMEMORYINFODUMPER
  26
  27   nsMemoryInfoDumper();
  28
  29   static void Initialize();
  30
  31 #ifdef MOZ_DMD
  32   // Open an appropriately named file for a DMD report.  If DMD is
  33   // disabled, return a null FILE* instead.
  34   static nsresult OpenDMDFile(const nsAString& aIdentifier, int aPid,
  35                               FILE** aOutFile);
  36   // Write a DMD report to the given file and close it.
  37   static nsresult DumpDMDToFile(FILE* aFile);
  38 #endif
  39 };
  40
  41 #define NS_MEMORY_INFO_DUMPER_CID                    \
  42   {                                                  \
  43     0x00bd71fb, 0x7f09, 0x4ec3, {                    \
  44       0x96, 0xaf, 0xa0, 0xb5, 0x22, 0xb7, 0x79, 0x69 \
  45     }                                                \
  46   }
  47
  48 #endif