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 class nsACString;
  14
  15 /**
  16  * This class facilitates dumping information about our memory usage to disk.
  17  *
  18  * Its cpp file also has Linux-only code which watches various OS signals and
  19  * dumps memory info upon receiving a signal.  You can activate these listeners
  20  * by calling Initialize().
  21  */
  22 class nsMemoryInfoDumper : public nsIMemoryInfoDumper
  23 {
  24   virtual ~nsMemoryInfoDumper();
  25
  26 public:
  27   NS_DECL_ISUPPORTS
  28   NS_DECL_NSIMEMORYINFODUMPER
  29
  30   nsMemoryInfoDumper();
  31
  32   static void Initialize();
  33
  34 #ifdef MOZ_DMD
  35   // Write a DMD report.
  36   static nsresult DumpDMD(const nsAString& aIdentifier);
  37   // Open an appropriately named file for a DMD report.  If DMD is
  38   // disabled, return a null FILE* instead.
  39   static nsresult OpenDMDFile(const nsAString& aIdentifier, int aPid,
  40                               FILE** aOutFile);
  41   // Write a DMD report to the given file and close it.
  42   static nsresult DumpDMDToFile(FILE* aFile);
  43 #endif
  44 };
  45
  46 #define NS_MEMORY_INFO_DUMPER_CID \
  47 { 0x00bd71fb, 0x7f09, 0x4ec3, \
  48 { 0x96, 0xaf, 0xa0, 0xb5, 0x22, 0xb7, 0x79, 0x69 } }
  49
  50 #endif