STEER/AliMemoryWatcher.h

   1 #ifndef ALIMEMORYWATCHER_H
   2 #define ALIMEMORYWATCHER_H
   3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   4  * See cxx source for full Copyright notice     */
   5 /* $Id$ */
   6 //_________________________________________________________________________
   7 /*Basic Memory Leak utility.
   8
   9     You can use this tiny class to *see* if your program is leaking.
  10     Usage:
  11     AliMemoryWatcher memwatcher;
  12     some program loop on events here {
  13       if ( nevents % x == 0 )
  14       {
  15       // take a sample every x events
  16         memwatcher.watch(nevents);
  17       }
  18     }
  19     TFile f("out.root","RECREATE");
  20     memwatcher.write();
  21     f.Close();
  22     In the output root file you'll get 3 graphs representing
  23     the evolAliPHOSon, as a function of the number of events, of :
  24     - VSIZE is the virtual size (in KBytes) of your program, that is sort of
  25     the total memory used
  26     - RSSIZE is the resident size (in KBytes), that is, the part of your
  27     program which is really in physical memory.
  28     - TIME is an estimate of time per event (really it's the time elasped
  29     between two calls to watch method)
  30     WARNING: this is far from a bulletproof memory report (it's basically
  31     using UNIX command ps -h -p [PID] -o vsize,rssize to do its job).
  32     It has only been tested on Linux so far.
  33
  34     But by fitting the VSIZE by a pol1 under ROOT, you'll see right away
  35     by how much your program is leaking.
  36 */
  37 //*-- Author: Laurent Aphecetche(SUBATECH)
  38 // --- ROOT system ---
  39 #include "TObject.h"
  40 class TH2;
  41 class TGraph;
  42 class TStopwatch;
  43 class AliMemoryWatcher : public TObject
  44 {
  45 public:
  46   AliMemoryWatcher(UInt_t maxsize=10000);
  47   AliMemoryWatcher(AliMemoryWatcher& mw);
  48   AliMemoryWatcher(const AliMemoryWatcher & watcher) {
  49     // copy ctor: no implementation yet
  50     Fatal("cpy ctor", "not implemented") ;
  51   }
  52   ~AliMemoryWatcher() ;
  53   void Watch(Int_t x);
  54
  55   UInt_t Size(void) const { return fSize; }
  56   Int_t X(Int_t n) const { return fX[n]; }
  57   Int_t VSIZE(Int_t n) const { return fVSIZE[n]; }
  58   Int_t RSSIZE(Int_t n) const { return fRSSIZE[n]; }
  59   Double_t TIME(Int_t n) const { return fTIME[n]; }
  60   TGraph* GraphVSIZE(void);
  61   TGraph* GraphRSSIZE(void);
  62   TGraph* GraphTIME(void);
  63   TH2* Frame(void) const ;
  64   void Write(void);
  65   AliMemoryWatcher & operator = (const AliMemoryWatcher &) { return *this; }
  66 private:
  67   Int_t fPID;          // PID of the process to watch
  68   char fCmd[1024];     // the command sent to the system to retrieve things ("ps .....")
  69   UInt_t fMAXSIZE;     // maximum size of arrays where the informationis stored
  70   UInt_t fSize;        // the requested size of information to be retrieved
  71   Int_t* fX;           // array that contains the step numbers
  72   Int_t* fVSIZE;       // array that contains the virtual memory at each step
  73   Int_t* fRSSIZE;      // array that contains the real memory at each step
  74   Double_t* fTIME;     // array that contains the CPU time at each step
  75   TStopwatch* fTimer;  // the chronometer
  76   Bool_t fDisabled;    // to switch on/off the monitoring
  77
  78   ClassDef(AliMemoryWatcher,1) // General purpose memory watcher
  79
  80 } ;
  81 #endif