Logo ROOT   6.12/07
Reference Guide
TVirtualPerfStats.h
Go to the documentation of this file.
1 // @(#)root/base:$Id$
2 // Author: Kristjan Gulbrandsen 11/05/04
3 
4 /*************************************************************************
5  * Copyright (C) 1995-2004, Rene Brun and Fons Rademakers. *
6  * All rights reserved. *
7  * *
8  * For the licensing terms see $ROOTSYS/LICENSE. *
9  * For the list of contributors see $ROOTSYS/README/CREDITS. *
10  *************************************************************************/
11 
12 #ifndef ROOT_TVirtualPerfStats
13 #define ROOT_TVirtualPerfStats
14 
15 //////////////////////////////////////////////////////////////////////////
16 // //
17 // TVirtualPerfStats //
18 // //
19 // Provides the interface for the PROOF internal performance measurment //
20 // and event tracing. //
21 // //
22 //////////////////////////////////////////////////////////////////////////
23 
24 
25 #include "TObject.h"
26 
27 
28 class TFile;
29 
30 
31 class TVirtualPerfStats : public TObject {
32 
33 public:
34  virtual ~TVirtualPerfStats() {}
35 
36  enum EEventType {
38  kPacket, //info of single packet processing
39  kStart, //begin of run
40  kStop, //end of run
41  kFile, //file started/finished in packetizer
42  kFileOpen, //opening data file statistics
43  kFileRead, //reading data file event
44  kRate, //processing {evt, MB} rates
45  kNumEventType //number of entries, must be last
46  };
47 
48  static TVirtualPerfStats *&CurrentPerfStats(); // Return the current perfStats for this thread.
49 
50  virtual void SimpleEvent(EEventType type) = 0;
51 
52  virtual void PacketEvent(const char *slave, const char *slavename, const char *filename,
53  Long64_t eventsprocessed, Double_t latency,
54  Double_t proctime, Double_t cputime,
55  Long64_t bytesRead) = 0;
56 
57  virtual void FileEvent(const char *slave, const char *slavename, const char *nodename,
58  const char *filename, Bool_t isStart) = 0;
59 
60  virtual void FileOpenEvent(TFile *file, const char *filename, Double_t start) = 0;
61 
62  virtual void FileReadEvent(TFile *file, Int_t len, Double_t start) = 0;
63 
64  virtual void UnzipEvent(TObject *tree, Long64_t pos, Double_t start, Int_t complen, Int_t objlen) = 0;
65 
66  virtual void RateEvent(Double_t proctime, Double_t deltatime,
67  Long64_t eventsprocessed, Long64_t bytesRead) = 0;
68 
69  virtual void SetBytesRead(Long64_t num) = 0;
70  virtual Long64_t GetBytesRead() const = 0;
71  virtual void SetNumEvents(Long64_t num) = 0;
72  virtual Long64_t GetNumEvents() const = 0;
73 
74  static const char *EventType(EEventType type);
75 
76  ClassDef(TVirtualPerfStats,0) // ABC for collecting PROOF statistics
77 };
78 
79 
80 #ifndef __CINT__
81 #define gPerfStats (TVirtualPerfStats::CurrentPerfStats())
82 
83 #elif defined(__MAKECINT__)
84 // To properly handle the use of gPerfStats in header files (in static declarations)
86 #endif
87 
88 
89 #endif
virtual void UnzipEvent(TObject *tree, Long64_t pos, Double_t start, Int_t complen, Int_t objlen)=0
long long Long64_t
Definition: RtypesCore.h:69
virtual void RateEvent(Double_t proctime, Double_t deltatime, Long64_t eventsprocessed, Long64_t bytesRead)=0
Provides the interface for the PROOF internal performance measurement and event tracing.
static TVirtualPerfStats *& CurrentPerfStats()
Return the current ROOT perf stats if any.
static const char * EventType(EEventType type)
Return the name of the event type.
A ROOT file is a suite of consecutive data records (TKey instances) with a well defined format...
Definition: TFile.h:46
virtual void PacketEvent(const char *slave, const char *slavename, const char *filename, Long64_t eventsprocessed, Double_t latency, Double_t proctime, Double_t cputime, Long64_t bytesRead)=0
int Int_t
Definition: RtypesCore.h:41
bool Bool_t
Definition: RtypesCore.h:59
virtual Long64_t GetBytesRead() const =0
virtual void SimpleEvent(EEventType type)=0
#define ClassDef(name, id)
Definition: Rtypes.h:320
virtual ~TVirtualPerfStats()
virtual void SetBytesRead(Long64_t num)=0
virtual Long64_t GetNumEvents() const =0
virtual void FileReadEvent(TFile *file, Int_t len, Double_t start)=0
#define gPerfStats
double Double_t
Definition: RtypesCore.h:55
int type
Definition: TGX11.cxx:120
Mother of all ROOT objects.
Definition: TObject.h:37
#define R__EXTERN
Definition: DllImport.h:27
Definition: file.py:1
Definition: tree.py:1
virtual void FileEvent(const char *slave, const char *slavename, const char *nodename, const char *filename, Bool_t isStart)=0
virtual void FileOpenEvent(TFile *file, const char *filename, Double_t start)=0
virtual void SetNumEvents(Long64_t num)=0