TTree I/O performance measurement.

see example of use below.

The function FileReadEvent is called from TFile::ReadBuffer. For each call the following information is stored in fGraphIO

x[i] = Tree entry number
y[i] = 1e-6*(file position)
ey[i] = 1e-9*number of bytes read For each call the following information is stored in fGraphTime
x[i] = Tree entry number
y[i] = Time now
ey[i] = readtime, eg timenow - start The TTreePerfStats object can be saved in a ROOT file in such a way that its inspection can be done outside the job that generated it.

Example of use:

{
  TFile *f = TFile::Open("RelValMinBias-GEN-SIM-RECO.root");
  T = (TTree*)f->Get("Events");
  Long64_t nentries = T->GetEntries();
  T->SetCacheSize(10000000);
  T->SetCacheEntryRange(0,nentries);
  T->AddBranchToCache("*");
//
  TTreePerfStats *ps= new TTreePerfStats("ioperf",T);
//
  for (Int_t i=0;i<nentries;i++) {
     T->GetEntry(i);
  }
  ps->SaveAs("cmsperf.root");
}

then, in a root interactive session, one can do:

root > TFile f("cmsperf.root");
root > ioperf->Draw();
root > ioperf->Print();

The Draw or Print functions print the following information:

TreeCache = TTree cache size in MBytes
N leaves = Number of leaves in the TTree
ReadTotal = Total number of zipped bytes read
ReadUnZip = Total number of unzipped bytes read
ReadCalls = Total number of disk reads
ReadSize = Average read size in KBytes
Readahead = Readahead size in KBytes
Readextra = Readahead overhead in percent
Real Time = Real Time in seconds
CPU Time = CPU Time in seconds
Disk Time = Real Time spent in pure raw disk IO
Disk IO = Raw disk IO speed in MBytes/second
ReadUZRT = Unzipped MBytes per RT second
ReadUZCP = Unipped MBytes per CP second
ReadRT = Zipped MBytes per RT second
ReadCP = Zipped MBytes per CP second

NOTE 1 :

The ReadTotal value indicates the effective number of zipped bytes returned to the application. The physical number of bytes read from the device (as measured for example with strace) is ReadTotal +ReadTotal*Readextra/100. Same for ReadSize.

NOTE 2 :

A consequence of NOTE1, the Disk I/O speed corresponds to the effective number of bytes returned to the application per second. The Physical disk speed is DiskIO + DiskIO*ReadExtra/100.

Definition at line 38 of file TTreePerfStats.h.

Classes
struct	BasketInfo

Public Types
using	BasketList_t = std::vector< std::pair< TBranch *, std::vector< size_t > > >

Public Types inherited from TVirtualPerfStats
enum	EEventType { kUnDefined , kPacket , kStart , kStop , kFile , kFileOpen , kFileRead , kRate , kNumEventType }

Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum	EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }

Public Member Functions
	TTreePerfStats ()
	default constructor (used when reading an object only)

	TTreePerfStats (const char name, TTree T)
	Create a TTree I/O perf stats object.

virtual	~TTreePerfStats ()
	Destructor.

virtual void	Browse (TBrowser *b)
	Browse.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Return distance to one of the objects in the TTreePerfStats.

virtual void	Draw (Option_t *option="")
	Draw the TTree I/O perf graph.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Return distance to one of the objects in the TTreePerfStats.

virtual void	FileEvent (const char , const char , const char , const char , Bool_t)

virtual void	FileOpenEvent (TFile , const char , Double_t)

virtual void	FileReadEvent (TFile *file, Int_t len, Double_t start)
	Record TTree file read event.

virtual void	Finish ()
	When the run is finished this function must be called to save the current parameters in the file and Tree in this object the function is automatically called by Draw and Print.

virtual Long64_t	GetBytesRead () const

virtual Long64_t	GetBytesReadExtra () const

virtual Double_t	GetCpuTime () const

virtual Double_t	GetDiskTime () const

BasketList_t	GetDuplicateBasketCache () const
	Return the collection of baskets which have been read by the TTreeCache more than once.

TGraphErrors *	GetGraphIO ()

TGraphErrors *	GetGraphTime ()

const char *	GetHostInfo () const

const char *	GetName () const
	Returns name of object.

virtual Int_t	GetNleaves () const

virtual Long64_t	GetNumEvents () const

TPaveText *	GetPave ()

virtual Int_t	GetReadaheadSize () const

virtual Int_t	GetReadCalls () const

virtual Double_t	GetRealTime () const

TStopwatch *	GetStopwatch () const

virtual Int_t	GetTreeCacheSize () const

virtual Double_t	GetUnzipTime () const

virtual TClass *	IsA () const

virtual void	PacketEvent (const char , const char , const char *, Long64_t, Double_t, Double_t, Double_t, Long64_t)

virtual void	Paint (Option_t *chopt="")
	Draw the TTree I/O perf graph.

virtual void	Print (Option_t *option="") const
	Print the TTree I/O perf stats.

virtual void	PrintBasketInfo (Option_t *option="") const
	Print the TTree basket information.

virtual void	RateEvent (Double_t, Double_t, Long64_t, Long64_t)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object to filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save primitive as a C++ statement(s) on output stream out.

virtual void	SetBytesRead (Long64_t nbytes)

virtual void	SetBytesReadExtra (Long64_t nbytes)

virtual void	SetCompress (Double_t cx)

virtual void	SetCpuTime (Double_t cptime)

virtual void	SetDiskTime (Double_t t)

virtual void	SetGraphIO (TGraphErrors *gr)

virtual void	SetGraphTime (TGraphErrors *gr)

virtual void	SetHostInfo (const char *info)

virtual void	SetLoaded (size_t bi, size_t basketNumber)

virtual void	SetLoaded (TBranch *b, size_t basketNumber)

virtual void	SetLoadedMiss (size_t bi, size_t basketNumber)

virtual void	SetLoadedMiss (TBranch *b, size_t basketNumber)

virtual void	SetMissed (size_t bi, size_t basketNumber)

virtual void	SetMissed (TBranch *b, size_t basketNumber)

virtual void	SetName (const char *name)

virtual void	SetNleaves (Int_t nleaves)

virtual void	SetNumEvents (Long64_t)

virtual void	SetReadaheadSize (Int_t nbytes)

virtual void	SetReadCalls (Int_t ncalls)

virtual void	SetRealNorm (Double_t rnorm)

virtual void	SetRealTime (Double_t rtime)

virtual void	SetTreeCacheSize (Int_t nbytes)

virtual void	SetUnzipTime (Double_t uztime)

virtual void	SetUsed (size_t bi, size_t basketNumber)

virtual void	SetUsed (TBranch *b, size_t basketNumber)

virtual void	SimpleEvent (EEventType)

virtual void	Streamer (TBuffer &)
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	UnzipEvent (TObject *tree, Long64_t pos, Double_t start, Int_t complen, Int_t objlen)
	Record TTree unzip event.

virtual void	UpdateBranchIndices (TObjArray *branchNames)
	Update the fBranchIndexCache collection to match the current TTree given the ordered list of branch names.

Public Member Functions inherited from TVirtualPerfStats
virtual	~TVirtualPerfStats ()

TClass *	IsA () const override

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

virtual void	Copy (TObject &object) const
	Copy this to obj.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object.

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

virtual ULong_t	Hash () const
	Return hash value for this object.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

virtual Bool_t	IsSortable () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout.

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification.

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete[] (void *ptr)
	Operator delete [].

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TVirtualPerfStats
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static TVirtualPerfStats *&	CurrentPerfStats ()
	Return the current ROOT perf stats if any.

static const char *	DeclFileName ()

static const char *	EventType (EEventType type)
	Return the name of the event type.

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Protected Member Functions
BasketInfo &	GetBasketInfo (size_t bi, size_t basketNumber)
	Return the BasketInfo corresponding to the given branch and basket.

BasketInfo &	GetBasketInfo (TBranch *b, size_t basketNumber)
	Return the BasketInfo corresponding to the given branch and basket.

virtual void	SetFile (TFile *newfile)

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

Protected Attributes
std::vector< std::vector< BasketInfo > >	fBasketsInfo

std::unordered_map< TBranch *, size_t >	fBranchIndexCache

Long64_t	fBytesRead
	Number of bytes read.

Long64_t	fBytesReadExtra
	Number of bytes (overhead) of the read-ahead cache.

Double_t	fCompress
	Tree compression factor.

Double_t	fCpuTime
	Cpu time.

Double_t	fDiskTime
	Time spent in pure raw disk IO.

TFile *	fFile
	! Pointer to the file containing the Tree

TGraphErrors *	fGraphIO
	Pointer to the graph with IO data.

TGraphErrors *	fGraphTime
	Pointer to the graph with timestamp info.

TString	fHostInfo
	Name of the host system, ROOT version and date.

TText *	fHostInfoText
	Graphics Text object with the fHostInfo data.

TString	fName
	Name of this TTreePerfStats.

Int_t	fNleaves
	Number of leaves in the tree.

TPaveText *	fPave
	Pointer to annotation pavetext.

Int_t	fReadaheadSize
	Read-ahead cache size.

Int_t	fReadCalls
	Number of read calls.

Double_t	fRealNorm
	Real time scale factor for fGraphTime.

Double_t	fRealTime
	Real time.

TGaxis *	fRealTimeAxis
	Pointer to TGaxis object showing real-time.

TTree *	fTree
	! Pointer to the Tree being monitored

Int_t	fTreeCacheSize
	TTreeCache buffer size.

Long64_t	fUnzipInputSize
	Compressed bytes seen by the decompressor.

Long64_t	fUnzipObjSize
	Uncompressed bytes produced by the decompressor.

Double_t	fUnzipTime
	Time spent uncompressing the data.

TStopwatch *	fWatch
	TStopwatch pointer.

Additional Inherited Members
Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

#include <TTreePerfStats.h>

Inheritance diagram for TTreePerfStats:

[legend]

Member Typedef Documentation

◆ BasketList_t

using TTreePerfStats::BasketList_t = std::vector<std::pair<TBranch*, std::vector<size_t> >>

Definition at line 48 of file TTreePerfStats.h.

Constructor & Destructor Documentation

◆ TTreePerfStats() [1/2]

TTreePerfStats::TTreePerfStats ( )

default constructor (used when reading an object only)

Definition at line 107 of file TTreePerfStats.cxx.

◆ TTreePerfStats() [2/2]

TTreePerfStats::TTreePerfStats	(	const char *	name,
		TTree *	T
	)

Create a TTree I/O perf stats object.

Definition at line 138 of file TTreePerfStats.cxx.

◆ ~TTreePerfStats()

TTreePerfStats::~TTreePerfStats ( )

virtual

Destructor.

Definition at line 188 of file TTreePerfStats.cxx.

Member Function Documentation

◆ Browse()

void TTreePerfStats::Browse ( TBrowser * b )

virtual

Browse.

Reimplemented from TObject.

Definition at line 208 of file TTreePerfStats.cxx.

◆ Class()

static TClass * TTreePerfStats::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TTreePerfStats::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TTreePerfStats::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 157 of file TTreePerfStats.h.

◆ DeclFileName()

static const char * TTreePerfStats::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 157 of file TTreePerfStats.h.

◆ DistancetoPrimitive()

Int_t TTreePerfStats::DistancetoPrimitive	(	Int_t	px,
		Int_t	py
	)

virtual

Return distance to one of the objects in the TTreePerfStats.

Reimplemented from TObject.

Definition at line 217 of file TTreePerfStats.cxx.

◆ Draw()

void TTreePerfStats::Draw ( Option_t * option = "" )

virtual

Draw the TTree I/O perf graph.

by default the graph is drawn with option "al" Specify option ="ap" to show only the read blocks and not the line connecting the blocks

Reimplemented from TObject.

Definition at line 250 of file TTreePerfStats.cxx.

◆ ExecuteEvent()

void TTreePerfStats::ExecuteEvent	(	Int_t	event,
		Int_t	px,
		Int_t	py
	)

virtual

Return distance to one of the objects in the TTreePerfStats.

Reimplemented from TObject.

Definition at line 277 of file TTreePerfStats.cxx.

◆ FileEvent()

virtual void TTreePerfStats::FileEvent	(	const char *	,
		const char *	,
		const char *	,
		const char *	,
		Bool_t
	)

inlinevirtual

Implements TVirtualPerfStats.

Definition at line 118 of file TTreePerfStats.h.

◆ FileOpenEvent()

virtual void TTreePerfStats::FileOpenEvent	(	TFile *	,
		const char *	,
		Double_t
	)

inlinevirtual

Implements TVirtualPerfStats.

Definition at line 119 of file TTreePerfStats.h.

◆ FileReadEvent()

void TTreePerfStats::FileReadEvent	(	TFile *	file,
		Int_t	len,
		Double_t	start
	)

virtual

Record TTree file read event.

start is the TimeStamp before reading
len is the number of bytes read

Implements TVirtualPerfStats.

Definition at line 286 of file TTreePerfStats.cxx.

◆ Finish()

void TTreePerfStats::Finish ( )

virtual

When the run is finished this function must be called to save the current parameters in the file and Tree in this object the function is automatically called by Draw and Print.

Definition at line 328 of file TTreePerfStats.cxx.

◆ GetBasketInfo() [1/2]

TTreePerfStats::BasketInfo & TTreePerfStats::GetBasketInfo	(	size_t	bi,
		size_t	basketNumber
	)

protected

Return the BasketInfo corresponding to the given branch and basket.

Definition at line 408 of file TTreePerfStats.cxx.

◆ GetBasketInfo() [2/2]

TTreePerfStats::BasketInfo & TTreePerfStats::GetBasketInfo	(	TBranch *	b,
		size_t	basketNumber
	)

protected

Return the BasketInfo corresponding to the given branch and basket.

Definition at line 372 of file TTreePerfStats.cxx.

◆ GetBytesRead()

virtual Long64_t TTreePerfStats::GetBytesRead ( ) const

inlinevirtual

Implements TVirtualPerfStats.

Definition at line 95 of file TTreePerfStats.h.

◆ GetBytesReadExtra()

virtual Long64_t TTreePerfStats::GetBytesReadExtra ( ) const

inlinevirtual

Definition at line 96 of file TTreePerfStats.h.

◆ GetCpuTime()

virtual Double_t TTreePerfStats::GetCpuTime ( ) const

inlinevirtual

Definition at line 97 of file TTreePerfStats.h.

◆ GetDiskTime()

virtual Double_t TTreePerfStats::GetDiskTime ( ) const

inlinevirtual

Definition at line 98 of file TTreePerfStats.h.

◆ GetDuplicateBasketCache()

TTreePerfStats::BasketList_t TTreePerfStats::GetDuplicateBasketCache ( ) const

Return the collection of baskets which have been read by the TTreeCache more than once.

Definition at line 424 of file TTreePerfStats.cxx.

◆ GetGraphIO()

TGraphErrors * TTreePerfStats::GetGraphIO ( )

inline

Definition at line 99 of file TTreePerfStats.h.

◆ GetGraphTime()

TGraphErrors * TTreePerfStats::GetGraphTime ( )

inline

Definition at line 100 of file TTreePerfStats.h.

◆ GetHostInfo()

const char * TTreePerfStats::GetHostInfo ( ) const

inline

Definition at line 101 of file TTreePerfStats.h.

◆ GetName()

const char * TTreePerfStats::GetName ( ) const

inlinevirtual

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 102 of file TTreePerfStats.h.

◆ GetNleaves()

virtual Int_t TTreePerfStats::GetNleaves ( ) const

inlinevirtual

Definition at line 103 of file TTreePerfStats.h.

◆ GetNumEvents()

virtual Long64_t TTreePerfStats::GetNumEvents ( ) const

inlinevirtual

Implements TVirtualPerfStats.

Definition at line 104 of file TTreePerfStats.h.

◆ GetPave()

TPaveText * TTreePerfStats::GetPave ( )

inline

Definition at line 105 of file TTreePerfStats.h.

◆ GetReadaheadSize()

virtual Int_t TTreePerfStats::GetReadaheadSize ( ) const

inlinevirtual

Definition at line 106 of file TTreePerfStats.h.

◆ GetReadCalls()

virtual Int_t TTreePerfStats::GetReadCalls ( ) const

inlinevirtual

Definition at line 107 of file TTreePerfStats.h.

◆ GetRealTime()

virtual Double_t TTreePerfStats::GetRealTime ( ) const

inlinevirtual

Definition at line 108 of file TTreePerfStats.h.

◆ GetStopwatch()

TStopwatch * TTreePerfStats::GetStopwatch ( ) const

inline

Definition at line 109 of file TTreePerfStats.h.

◆ GetTreeCacheSize()

virtual Int_t TTreePerfStats::GetTreeCacheSize ( ) const

inlinevirtual

Definition at line 110 of file TTreePerfStats.h.

◆ GetUnzipTime()

virtual Double_t TTreePerfStats::GetUnzipTime ( ) const

inlinevirtual

Definition at line 111 of file TTreePerfStats.h.

◆ IsA()

virtual TClass * TTreePerfStats::IsA ( ) const

inlinevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 157 of file TTreePerfStats.h.

◆ PacketEvent()

virtual void TTreePerfStats::PacketEvent	(	const char *	,
		const char *	,
		const char *	,
		Long64_t	,
		Double_t	,
		Double_t	,
		Double_t	,
		Long64_t
	)

inlinevirtual

Implements TVirtualPerfStats.

Definition at line 116 of file TTreePerfStats.h.

◆ Paint()

void TTreePerfStats::Paint ( Option_t * chopt = "" )

virtual

Draw the TTree I/O perf graph.

Reimplemented from TObject.

Definition at line 458 of file TTreePerfStats.cxx.

◆ Print()

void TTreePerfStats::Print ( Option_t * option = "" ) const

virtual

Print the TTree I/O perf stats.

Reimplemented from TObject.

Definition at line 540 of file TTreePerfStats.cxx.

◆ PrintBasketInfo()

void TTreePerfStats::PrintBasketInfo ( Option_t * option = "" ) const

virtual

Print the TTree basket information.

Implements TVirtualPerfStats.

Definition at line 581 of file TTreePerfStats.cxx.

◆ RateEvent()

virtual void TTreePerfStats::RateEvent	(	Double_t	,
		Double_t	,
		Long64_t	,
		Long64_t
	)

inlinevirtual

Implements TVirtualPerfStats.

Definition at line 122 of file TTreePerfStats.h.

◆ SaveAs()

void TTreePerfStats::SaveAs	(	const char *	filename = `""`,
		Option_t *	option = `""`
	)		const

virtual

Save this object to filename.

Reimplemented from TObject.

Definition at line 647 of file TTreePerfStats.cxx.

◆ SavePrimitive()

void TTreePerfStats::SavePrimitive	(	std::ostream &	out,
		Option_t *	option = `""`
	)

virtual

Save primitive as a C++ statement(s) on output stream out.

Reimplemented from TObject.

Definition at line 657 of file TTreePerfStats.cxx.

◆ SetBytesRead()

virtual void TTreePerfStats::SetBytesRead ( Long64_t nbytes )

inlinevirtual

Implements TVirtualPerfStats.

Definition at line 126 of file TTreePerfStats.h.

◆ SetBytesReadExtra()

virtual void TTreePerfStats::SetBytesReadExtra ( Long64_t nbytes )

inlinevirtual

Definition at line 127 of file TTreePerfStats.h.

◆ SetCompress()

virtual void TTreePerfStats::SetCompress ( Double_t cx )

inlinevirtual

Definition at line 128 of file TTreePerfStats.h.

◆ SetCpuTime()

virtual void TTreePerfStats::SetCpuTime ( Double_t cptime )

inlinevirtual

Definition at line 131 of file TTreePerfStats.h.

◆ SetDiskTime()

virtual void TTreePerfStats::SetDiskTime ( Double_t t )

inlinevirtual

Definition at line 129 of file TTreePerfStats.h.

◆ SetFile()

virtual void TTreePerfStats::SetFile ( TFile * newfile )

inlineprotectedvirtual

Implements TVirtualPerfStats.

Definition at line 82 of file TTreePerfStats.h.

◆ SetGraphIO()

virtual void TTreePerfStats::SetGraphIO ( TGraphErrors * gr )

inlinevirtual

Definition at line 132 of file TTreePerfStats.h.

◆ SetGraphTime()

virtual void TTreePerfStats::SetGraphTime ( TGraphErrors * gr )

inlinevirtual

Definition at line 133 of file TTreePerfStats.h.

◆ SetHostInfo()

virtual void TTreePerfStats::SetHostInfo ( const char * info )

inlinevirtual

Definition at line 134 of file TTreePerfStats.h.

◆ SetLoaded() [1/2]

virtual void TTreePerfStats::SetLoaded	(	size_t	bi,
		size_t	basketNumber
	)

inlinevirtual

Implements TVirtualPerfStats.

Definition at line 146 of file TTreePerfStats.h.

◆ SetLoaded() [2/2]

virtual void TTreePerfStats::SetLoaded	(	TBranch *	b,
		size_t	basketNumber
	)

inlinevirtual

Implements TVirtualPerfStats.

Definition at line 145 of file TTreePerfStats.h.

◆ SetLoadedMiss() [1/2]

virtual void TTreePerfStats::SetLoadedMiss	(	size_t	bi,
		size_t	basketNumber
	)

inlinevirtual

Implements TVirtualPerfStats.

Definition at line 148 of file TTreePerfStats.h.

◆ SetLoadedMiss() [2/2]

virtual void TTreePerfStats::SetLoadedMiss	(	TBranch *	b,
		size_t	basketNumber
	)

inlinevirtual

Implements TVirtualPerfStats.

Definition at line 147 of file TTreePerfStats.h.

◆ SetMissed() [1/2]

virtual void TTreePerfStats::SetMissed	(	size_t	bi,
		size_t	basketNumber
	)

inlinevirtual

Implements TVirtualPerfStats.

Definition at line 150 of file TTreePerfStats.h.

◆ SetMissed() [2/2]

virtual void TTreePerfStats::SetMissed	(	TBranch *	b,
		size_t	basketNumber
	)

inlinevirtual

Implements TVirtualPerfStats.

Definition at line 149 of file TTreePerfStats.h.

◆ SetName()

virtual void TTreePerfStats::SetName ( const char * name )

inlinevirtual

Definition at line 135 of file TTreePerfStats.h.

◆ SetNleaves()

virtual void TTreePerfStats::SetNleaves ( Int_t nleaves )

inlinevirtual

Definition at line 136 of file TTreePerfStats.h.

◆ SetNumEvents()

virtual void TTreePerfStats::SetNumEvents ( Long64_t )

inlinevirtual

Implements TVirtualPerfStats.

Definition at line 130 of file TTreePerfStats.h.

◆ SetReadaheadSize()

virtual void TTreePerfStats::SetReadaheadSize ( Int_t nbytes )

inlinevirtual

Definition at line 137 of file TTreePerfStats.h.

◆ SetReadCalls()

virtual void TTreePerfStats::SetReadCalls ( Int_t ncalls )

inlinevirtual

Definition at line 138 of file TTreePerfStats.h.

◆ SetRealNorm()

virtual void TTreePerfStats::SetRealNorm ( Double_t rnorm )

inlinevirtual

Definition at line 139 of file TTreePerfStats.h.

◆ SetRealTime()

virtual void TTreePerfStats::SetRealTime ( Double_t rtime )

inlinevirtual

Definition at line 140 of file TTreePerfStats.h.

◆ SetTreeCacheSize()

virtual void TTreePerfStats::SetTreeCacheSize ( Int_t nbytes )

inlinevirtual

Definition at line 141 of file TTreePerfStats.h.

◆ SetUnzipTime()

virtual void TTreePerfStats::SetUnzipTime ( Double_t uztime )

inlinevirtual

Definition at line 142 of file TTreePerfStats.h.

◆ SetUsed() [1/2]

virtual void TTreePerfStats::SetUsed	(	size_t	bi,
		size_t	basketNumber
	)

inlinevirtual

Implements TVirtualPerfStats.

Definition at line 152 of file TTreePerfStats.h.

◆ SetUsed() [2/2]

virtual void TTreePerfStats::SetUsed	(	TBranch *	b,
		size_t	basketNumber
	)

inlinevirtual

Implements TVirtualPerfStats.

Definition at line 151 of file TTreePerfStats.h.

◆ SimpleEvent()

virtual void TTreePerfStats::SimpleEvent ( EEventType )

inlinevirtual

Implements TVirtualPerfStats.

Definition at line 115 of file TTreePerfStats.h.

◆ Streamer()

virtual void TTreePerfStats::Streamer ( TBuffer & R__b )

virtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TTreePerfStats::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 157 of file TTreePerfStats.h.

◆ UnzipEvent()

void TTreePerfStats::UnzipEvent	(	TObject *	tree,
		Long64_t	pos,
		Double_t	start,
		Int_t	complen,
		Int_t	objlen
	)

virtual

Record TTree unzip event.

start is the TimeStamp before unzip
pos is where in the file the compressed buffer came from
complen is the length of the compressed buffer
objlen is the length of the de-compressed buffer

Implements TVirtualPerfStats.

Definition at line 312 of file TTreePerfStats.cxx.

◆ UpdateBranchIndices()

void TTreePerfStats::UpdateBranchIndices ( TObjArray * branchNames )

virtual

Update the fBranchIndexCache collection to match the current TTree given the ordered list of branch names.

Implements TVirtualPerfStats.

Definition at line 360 of file TTreePerfStats.cxx.

Member Data Documentation

◆ fBasketsInfo

std::vector<std::vector<BasketInfo> > TTreePerfStats::fBasketsInfo

protected

Definition at line 77 of file TTreePerfStats.h.

◆ fBranchIndexCache

std::unordered_map<TBranch*, size_t> TTreePerfStats::fBranchIndexCache

protected

Definition at line 76 of file TTreePerfStats.h.

◆ fBytesRead

Long64_t TTreePerfStats::fBytesRead

protected

Number of bytes read.

Definition at line 55 of file TTreePerfStats.h.

◆ fBytesReadExtra

Long64_t TTreePerfStats::fBytesReadExtra

protected

Number of bytes (overhead) of the read-ahead cache.

Definition at line 56 of file TTreePerfStats.h.

◆ fCompress

Double_t TTreePerfStats::fCompress

protected

Tree compression factor.

Definition at line 64 of file TTreePerfStats.h.

◆ fCpuTime

Double_t TTreePerfStats::fCpuTime

protected

Cpu time.

Definition at line 59 of file TTreePerfStats.h.

◆ fDiskTime

Double_t TTreePerfStats::fDiskTime

protected

Time spent in pure raw disk IO.

Definition at line 60 of file TTreePerfStats.h.

◆ fFile

TFile* TTreePerfStats::fFile

protected

! Pointer to the file containing the Tree

Definition at line 67 of file TTreePerfStats.h.

◆ fGraphIO

TGraphErrors* TTreePerfStats::fGraphIO

protected

Pointer to the graph with IO data.

Definition at line 69 of file TTreePerfStats.h.

◆ fGraphTime

TGraphErrors* TTreePerfStats::fGraphTime

protected

Pointer to the graph with timestamp info.

Definition at line 70 of file TTreePerfStats.h.

◆ fHostInfo

TString TTreePerfStats::fHostInfo

protected

Name of the host system, ROOT version and date.

Definition at line 66 of file TTreePerfStats.h.

◆ fHostInfoText

TText* TTreePerfStats::fHostInfoText

protected

Graphics Text object with the fHostInfo data.

Definition at line 74 of file TTreePerfStats.h.

◆ fName

TString TTreePerfStats::fName

protected

Name of this TTreePerfStats.

Definition at line 65 of file TTreePerfStats.h.

◆ fNleaves

Int_t TTreePerfStats::fNleaves

protected

Number of leaves in the tree.

Definition at line 52 of file TTreePerfStats.h.

◆ fPave

TPaveText* TTreePerfStats::fPave

protected

Pointer to annotation pavetext.

Definition at line 71 of file TTreePerfStats.h.

◆ fReadaheadSize

Int_t TTreePerfStats::fReadaheadSize

protected

Read-ahead cache size.

Definition at line 54 of file TTreePerfStats.h.

◆ fReadCalls

Int_t TTreePerfStats::fReadCalls

protected

Number of read calls.

Definition at line 53 of file TTreePerfStats.h.

◆ fRealNorm

Double_t TTreePerfStats::fRealNorm

protected

Real time scale factor for fGraphTime.

Definition at line 57 of file TTreePerfStats.h.

◆ fRealTime

Double_t TTreePerfStats::fRealTime

protected

Real time.

Definition at line 58 of file TTreePerfStats.h.

◆ fRealTimeAxis

TGaxis* TTreePerfStats::fRealTimeAxis

protected

Pointer to TGaxis object showing real-time.

Definition at line 73 of file TTreePerfStats.h.

◆ fTree

TTree* TTreePerfStats::fTree

protected

! Pointer to the Tree being monitored

Definition at line 68 of file TTreePerfStats.h.

◆ fTreeCacheSize

Int_t TTreePerfStats::fTreeCacheSize

protected

TTreeCache buffer size.

Definition at line 51 of file TTreePerfStats.h.

◆ fUnzipInputSize

Long64_t TTreePerfStats::fUnzipInputSize

protected

Compressed bytes seen by the decompressor.

Definition at line 62 of file TTreePerfStats.h.

◆ fUnzipObjSize

Long64_t TTreePerfStats::fUnzipObjSize

protected

Uncompressed bytes produced by the decompressor.

Definition at line 63 of file TTreePerfStats.h.

◆ fUnzipTime

Double_t TTreePerfStats::fUnzipTime

protected

Time spent uncompressing the data.

Definition at line 61 of file TTreePerfStats.h.

◆ fWatch

TStopwatch* TTreePerfStats::fWatch

protected

TStopwatch pointer.

Definition at line 72 of file TTreePerfStats.h.

Libraries for TTreePerfStats:

[legend]

The documentation for this class was generated from the following files:

tree/treeplayer/inc/TTreePerfStats.h
tree/treeplayer/src/TTreePerfStats.cxx

NOTE 1 :

NOTE 2 :

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

◆ BasketList_t

Constructor & Destructor Documentation

◆ TTreePerfStats() [1/2]

◆ TTreePerfStats() [2/2]

◆ ~TTreePerfStats()

Member Function Documentation

◆ Browse()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ DistancetoPrimitive()

◆ Draw()

◆ ExecuteEvent()

◆ FileEvent()

◆ FileOpenEvent()

◆ FileReadEvent()

◆ Finish()

◆ GetBasketInfo() [1/2]

◆ GetBasketInfo() [2/2]

◆ GetBytesRead()

◆ GetBytesReadExtra()

◆ GetCpuTime()

◆ GetDiskTime()

◆ GetDuplicateBasketCache()

◆ GetGraphIO()

◆ GetGraphTime()

◆ GetHostInfo()

◆ GetName()

◆ GetNleaves()

◆ GetNumEvents()

◆ GetPave()

◆ GetReadaheadSize()

◆ GetReadCalls()

◆ GetRealTime()

◆ GetStopwatch()

◆ GetTreeCacheSize()

◆ GetUnzipTime()

◆ IsA()

◆ PacketEvent()

◆ Paint()

◆ Print()

◆ PrintBasketInfo()

◆ RateEvent()

◆ SaveAs()

◆ SavePrimitive()

◆ SetBytesRead()

◆ SetBytesReadExtra()

◆ SetCompress()

◆ SetCpuTime()

◆ SetDiskTime()

◆ SetFile()

◆ SetGraphIO()

◆ SetGraphTime()

◆ SetHostInfo()

◆ SetLoaded() [1/2]

◆ SetLoaded() [2/2]

◆ SetLoadedMiss() [1/2]

◆ SetLoadedMiss() [2/2]

◆ SetMissed() [1/2]

◆ SetMissed() [2/2]

◆ SetName()

◆ SetNleaves()

◆ SetNumEvents()

◆ SetReadaheadSize()

◆ SetReadCalls()

◆ SetRealNorm()

◆ SetRealTime()

◆ SetTreeCacheSize()

◆ SetUnzipTime()