Corrections to obey our coding conventions
[u/mrichter/AliRoot.git] / STEER / AliMemoryWatcher.cxx
CommitLineData
d60522e4 1/**************************************************************************
2 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
3 * *
4 * Author: The ALICE Off-line Project. *
5 * Contributors are mentioned in the code where appropriate. *
6 * *
7 * Permission to use, copy, modify and distribute this software and its *
8 * documentation strictly for non-commercial purposes is hereby granted *
9 * without fee, provided that the above copyright notice appears in all *
10 * copies and that both the copyright notice and this permission notice *
11 * appear in the supporting documentation. The authors make no claims *
12 * about the suitability of this software for any purpose. It is *
13 * provided "as is" without express or implied warranty. *
14 **************************************************************************/
15/* $Id$ */
16//_________________________________________________________________________
00399209 17//Basic Memory Leak utility.
18// You can use this tiny class to *see* if your program is leaking.
19// Usage:
ac8cd48d 20// AliMemoryWatcher memwatcher;
00399209 21// some program loop on events here {
22// if ( nevents % x == 0 )
23// {
24// // take a sample every x events
25// memwatcher.watch(nevents);
26// }
27// }
28// TFile f("out.root","RECREATE");
29// memwatcher.write();
30// f.Close();
31// In the output root file you'll get 3 graphs representing
32// the evolAliPHOSon, as a function of the number of events, of :
33// - VSIZE is the virtual size (in KBytes) of your program, that is sort of
34// the total memory used
35// - RSSIZE is the resident size (in KBytes), that is, the part of your
36// program which is really in physical memory.
37// - TIME is an estimate of time per event (really it's the time elasped
38// between two calls to watch method)
39// WARNING: this is far from a bulletproof memory report (it's basically
40// using UNIX command ps -h -p [PID] -o vsize,rssize to do its job).
41// It has only been tested on Linux so far.
42// But by fitting the VSIZE by a pol1 under ROOT, you'll see right away
43// by how much your program is leaking.
d60522e4 44//*-- Author: Laurent Aphecetche(SUBATECH)
d60522e4 45// --- std system ---
b01af8c2 46class assert ;
d60522e4 47// --- AliRoot header files ---
ac8cd48d 48#include "AliMemoryWatcher.h"
d60522e4 49// --- ROOT system ---
50#include "TSystem.h"
51#include "TGraph.h"
52#include "TH2.h"
53#include "TStopwatch.h"
dfe7f75b 54
ac8cd48d 55ClassImp(AliMemoryWatcher)
dfe7f75b 56
d60522e4 57//_____________________________________________________________________________
ac8cd48d 58AliMemoryWatcher::AliMemoryWatcher(UInt_t maxsize)
d60522e4 59{
b01af8c2 60 //ctor
d60522e4 61 fMAXSIZE=maxsize;
62 fPID = gSystem->GetPid();
63 sprintf(fCmd,"ps -h -p %d -o vsize,rssize",fPID);
b01af8c2 64 fX = new Int_t[fMAXSIZE];
65 fVSIZE = new Int_t[fMAXSIZE];
66 fRSSIZE = new Int_t[fMAXSIZE];
67 fTIME = new Double_t[fMAXSIZE];
d60522e4 68 fSize=0;
69 fDisabled=false;
70 fTimer=0;
71}
d60522e4 72//_____________________________________________________________________________
d1898505 73AliMemoryWatcher::AliMemoryWatcher(const AliMemoryWatcher& mw):
74 TObject(mw)
00399209 75{
76 //copy ctor
77 fMAXSIZE = mw.fMAXSIZE ;
78 fPID = mw.fPID ;
79 strcpy(fCmd, mw.fCmd) ;
80 fX = new Int_t[fMAXSIZE];
81 fVSIZE = new Int_t[fMAXSIZE];
82 fRSSIZE = new Int_t[fMAXSIZE];
83 fTIME = new Double_t[fMAXSIZE];
84 fSize=0;
85 fDisabled=false;
86 fTimer=0;
87}
88//_____________________________________________________________________________
ac8cd48d 89AliMemoryWatcher::~AliMemoryWatcher()
d60522e4 90{
2a6e66b9 91 // dtor
d60522e4 92 delete[] fVSIZE;
93 delete[] fRSSIZE;
94 delete[] fX;
95 delete[] fTIME;
96 delete fTimer;
97}
d60522e4 98//_____________________________________________________________________________
ac8cd48d 99void AliMemoryWatcher::Watch(Int_t x)
d60522e4 100{
b01af8c2 101 // Sets the point where CPU parameters have to be monitored
d60522e4 102 if ( !fDisabled && fSize < fMAXSIZE ) {
d60522e4 103 if ( fSize==0 ) {
104 assert(fTimer==0);
105 fTimer = new TStopwatch;
106 fTimer->Start(true);
107 fTimer->Stop();
108 }
b01af8c2 109 static Int_t vsize, rssize;
d60522e4 110 static FILE* pipe = 0;
d60522e4 111 pipe = popen(fCmd,"r");
d60522e4 112 if ( pipe ) {
113
114 fscanf(pipe,"%d %d",&vsize,&rssize);
115
116 fX[fSize] = x ;
117 fVSIZE[fSize] = vsize ;
118 fRSSIZE[fSize] = rssize ;
119 fTIME[fSize] = fTimer->CpuTime();
120 fSize++;
121 }
d60522e4 122 assert(pclose(pipe)!=-1);
d60522e4 123 fTimer->Start(true);
d60522e4 124 }
125 else {
126 fDisabled=true;
21cd0c07 127 Error("watch", "I'm full !" ) ;
d60522e4 128 }
129}
d60522e4 130//_____________________________________________________________________________
131TGraph*
ac8cd48d 132AliMemoryWatcher::GraphVSIZE(void)
d60522e4 133{
b01af8c2 134 // Fills the graph with the virtual memory sized used
d60522e4 135 TGraph* g = 0;
00399209 136 if ( Size() )
d60522e4 137 {
00399209 138 g = new TGraph(Size());
b01af8c2 139 Int_t i ;
140 for (i=0; i < g->GetN(); i++ ) {
d60522e4 141 g->SetPoint(i,X(i),VSIZE(i));
142 }
143 }
144 return g;
145}
d60522e4 146//_____________________________________________________________________________
147TGraph*
ac8cd48d 148AliMemoryWatcher::GraphRSSIZE(void)
d60522e4 149{
b01af8c2 150 // Fills the graph with the real memory sized used
d60522e4 151 TGraph* g = 0;
00399209 152 if ( Size() )
d60522e4 153 {
00399209 154 g = new TGraph(Size());
b01af8c2 155 Int_t i ;
156 for (i=0; i < g->GetN(); i++ ) {
d60522e4 157 g->SetPoint(i,X(i),RSSIZE(i));
158 }
159 }
160 return g;
161}
d60522e4 162//_____________________________________________________________________________
163TGraph*
ac8cd48d 164AliMemoryWatcher::GraphTIME(void)
d60522e4 165{
b01af8c2 166 // Fills the raph with the used CPU time
d60522e4 167 TGraph* g = 0;
00399209 168 if ( Size() )
d60522e4 169 {
00399209 170 g = new TGraph(Size());
b01af8c2 171 Int_t i ;
172 for (i=0; i < g->GetN(); i++ ) {
d60522e4 173 g->SetPoint(i,X(i),TIME(i));
174 }
175 }
176 return g;
177}
d60522e4 178//_____________________________________________________________________________
179TH2*
ac8cd48d 180AliMemoryWatcher::Frame(void) const
d60522e4 181{
b01af8c2 182 //creates the frame histo in which the graphs will be plotted
183 Double_t xmin=1E30;
184 Double_t xmax=0;
185 Double_t ymin=1;
186 Double_t ymax=0;
187 UInt_t i ;
00399209 188 for (i=0; i < Size() ; i++ ) {
d60522e4 189 if ( X(i) < xmin ) xmin = X(i);
190 if ( X(i) > xmax ) xmax = X(i);
b01af8c2 191 Double_t y = VSIZE(i)+RSSIZE(i);
d60522e4 192 if ( y > ymax ) ymax = y;
d60522e4 193 if ( VSIZE(i) < ymin ) ymin = VSIZE(i);
194 if ( RSSIZE(i) < ymin ) ymin = RSSIZE(i);
195 }
d60522e4 196 TH2F* h = new TH2F("frame","",10,xmin,xmax,10,ymin*0.8,ymax*1.2);
d60522e4 197 return h;
198}
d60522e4 199//_____________________________________________________________________________
200void
ac8cd48d 201AliMemoryWatcher::Write(void)
d60522e4 202{
b01af8c2 203 // Stores the graphs in a file
204 if ( GraphVSIZE() ) GraphVSIZE()->Write("VSIZE",TObject::kOverwrite);
00399209 205 if ( GraphRSSIZE() ) GraphRSSIZE() ->Write("RSSIZE",TObject::kOverwrite);
b01af8c2 206 if ( GraphTIME() ) GraphTIME()->Write("TIME",TObject::kOverwrite);
4ed9ed00 207}