This class generates packets to be processed on PROOF worker servers.

A packet is an event range (begin entry and number of entries) or object range (first object and number of objects) in a TTree (entries) or a directory (objects) in a file. Packets are generated taking into account the performance of the remote machine, the time it took to process a previous packet on the remote machine, the locality of the database files, etc.

Definition at line 39 of file TPacketizer.h.

Classes
class	TFileNode

class	TFileStat

class	TSlaveStat

Public Member Functions
	TPacketizer (TDSet dset, TList slaves, Long64_t first, Long64_t num, TList input, TProofProgressStatus st)
	Constructor.

virtual	~TPacketizer ()
	Destructor.

Int_t	AddWorkers (TList *workers)
	Adds new workers. Returns the number of workers added, or -1 on failure.

Int_t	GetActiveWorkers ()
	Return the number of workers still processing.

Float_t	GetCurrentRate (Bool_t &all)
	Get Estimation of the current rate; just summing the current rates of the active workers.

Long64_t	GetEntriesProcessed (TSlave *sl) const
	Get entries processed by the specified slave.

TDSetElement *	GetNextPacket (TSlave sl, TMessage r)
	Get next packet.

Public Member Functions inherited from TVirtualPacketizer
virtual	~TVirtualPacketizer ()
	Destructor.

virtual Int_t	AddProcessed (TSlave , TProofProgressStatus , Double_t, TList **)

virtual Int_t	AssignWork (TDSet *, Long64_t, Long64_t)

Long64_t	GetBytesRead () const

TList *	GetConfigParams (Bool_t steal=kFALSE)

Double_t	GetCumProcTime () const

Long64_t	GetEntriesProcessed () const

virtual Int_t	GetEstEntriesProcessed (Float_t, Long64_t &ent, Long64_t &bytes, Long64_t &calls)

TList *	GetFailedPackets ()

Float_t	GetInitTime () const

Float_t	GetProcTime () const

TNtuple *	GetProgressPerf (Bool_t steal=kFALSE)

Long64_t	GetReadCalls () const

TMap *	GetSlaveStats () const

TProofProgressStatus *	GetStatus ()

Long64_t	GetTotalEntries () const

virtual TClass *	IsA () const

Bool_t	IsValid () const

virtual void	MarkBad (TSlave , TProofProgressStatus , TList **)

void	SetFailedPackets (TList *list)

virtual void	SetInitTime ()
	Set the initialization time.

void	SetProgressStatus (TProofProgressStatus *st)

void	SetTotalEntries (Long64_t ent)

virtual void	StopProcess (Bool_t abort, Bool_t stoptimer=kFALSE)
	Stop process.

virtual void	Streamer (TBuffer &)
	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.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

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 Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

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	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

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 const char *	GetName () const
	Returns 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 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	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

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

virtual void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself.

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)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

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

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.

Private Member Functions
	TPacketizer ()

	TPacketizer (const TPacketizer &)

TFileStat *	GetNextActive ()
	Get next active file.

TFileStat *	GetNextUnAlloc (TFileNode *node=0)
	Get next unallocated file.

TFileNode *	NextActiveNode ()
	Get next active node.

TFileNode *	NextUnAllocNode ()
	Get next unallocated node.

void	operator= (const TPacketizer &)

void	RemoveActive (TFileStat *file)
	Remove file from the list of actives.

void	RemoveActiveNode (TFileNode *)
	Remove node from the list of actives.

void	RemoveUnAllocNode (TFileNode *)
	Remove unallocated node.

void	Reset ()
	Reset the internal datastructure for packet distribution.

void	ValidateFiles (TDSet dset, TList slaves, Long64_t maxent=-1, Bool_t byfile=kFALSE)
	Check existence of file/dir/tree an get number of entries.

Private Attributes
TList *	fActive

Bool_t	fDefMaxWrkNode

TList *	fFileNodes

Bool_t	fHeuristicPSiz

Int_t	fMaxPerfIdx

Long_t	fMaxSlaveCnt

Int_t	fPacketAsAFraction

TList *	fPackets

Long64_t	fPacketSize

TList *	fUnAllocated

Additional Inherited Members
Public Types inherited from TVirtualPacketizer
enum	EStatusBits { kIsInitializing = (1ULL << ( 16 )) , kIsDone = (1ULL << ( 17 )) , kIsTree = (1ULL << ( 18 )) }

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 )) }

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

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

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 Types inherited from TVirtualPacketizer
enum	EUseEstOpt { kEstOff = 0 , kEstCurrent = 1 , kEstAverage = 2 }

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

Protected Member Functions inherited from TVirtualPacketizer
	TVirtualPacketizer (const TVirtualPacketizer &)

	TVirtualPacketizer (TList input, TProofProgressStatus st=0)
	Constructor.

TDSetElement *	CreateNewPacket (TDSetElement *base, Long64_t first, Long64_t num)
	Creates a new TDSetElement from from base packet starting from the first entry with num entries.

Long64_t	GetEntries (Bool_t tree, TDSetElement *e)
	Get entries.

virtual Bool_t	HandleTimer (TTimer *timer)
	Send progress message to client.

void	operator= (const TVirtualPacketizer &)

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 inherited from TVirtualPacketizer
Int_t	fActWrksLast

Bool_t	fAWLastFill

Long_t	fCircN

TNtupleD *	fCircProg

TList *	fConfigParams

TString	fDataSet

Float_t	fEffSessLast

Float_t	fEvtRateLast

TList *	fFailedPackets

Float_t	fInitTime

TList *	fInput

Double_t	fMaxPacketTime

Float_t	fMBsReadLast

Double_t	fMinPacketTime

Float_t	fProcTime

Float_t	fProcTimeLast

TTimer *	fProgress

TNtuple *	fProgressPerf

TProofProgressStatus *	fProgressStatus

Float_t	fReportPeriod

TMap *	fSlaveStats

TTime	fStartTime

Bool_t	fStop

Float_t	fTimeUpdt

Long64_t	fTotalEntries

EUseEstOpt	fUseEstOpt

Bool_t	fValid

#include <TPacketizer.h>

Inheritance diagram for TPacketizer:

[legend]

Constructor & Destructor Documentation

◆ TPacketizer() [1/3]

TPacketizer::TPacketizer ( )

private

◆ TPacketizer() [2/3]

TPacketizer::TPacketizer ( const TPacketizer & )

private

◆ TPacketizer() [3/3]

TPacketizer::TPacketizer	(	TDSet *	dset,
		TList *	slaves,
		Long64_t	first,
		Long64_t	num,
		TList *	input,
		TProofProgressStatus *	st
	)

Constructor.

Definition at line 274 of file TPacketizer.cxx.

◆ ~TPacketizer()

TPacketizer::~TPacketizer ( )

virtual

Destructor.

Definition at line 579 of file TPacketizer.cxx.

Member Function Documentation

◆ AddWorkers()

Int_t TPacketizer::AddWorkers ( TList * workers )

virtual

Adds new workers. Returns the number of workers added, or -1 on failure.

Reimplemented from TVirtualPacketizer.

Definition at line 595 of file TPacketizer.cxx.

◆ GetActiveWorkers()

Int_t TPacketizer::GetActiveWorkers ( )

virtual

Return the number of workers still processing.

Reimplemented from TVirtualPacketizer.

Definition at line 1313 of file TPacketizer.cxx.

◆ GetCurrentRate()

Float_t TPacketizer::GetCurrentRate ( Bool_t & all )

virtual

Get Estimation of the current rate; just summing the current rates of the active workers.

Reimplemented from TVirtualPacketizer.

Definition at line 1113 of file TPacketizer.cxx.

◆ GetEntriesProcessed()

Long64_t TPacketizer::GetEntriesProcessed ( TSlave * sl ) const

Get entries processed by the specified slave.

Definition at line 1098 of file TPacketizer.cxx.

◆ GetNextActive()

TPacketizer::TFileStat * TPacketizer::GetNextActive ( )

private

Get next active file.

Definition at line 689 of file TPacketizer.cxx.

◆ GetNextPacket()

TDSetElement * TPacketizer::GetNextPacket	(	TSlave *	sl,
		TMessage *	r
	)

virtual

Get next packet.

Reimplemented from TVirtualPacketizer.

Definition at line 1138 of file TPacketizer.cxx.

◆ GetNextUnAlloc()

TPacketizer::TFileStat * TPacketizer::GetNextUnAlloc ( TFileNode * node = 0 )

private

Get next unallocated file.

Definition at line 633 of file TPacketizer.cxx.

◆ NextActiveNode()

TPacketizer::TFileNode * TPacketizer::NextActiveNode ( )

private

Get next active node.

Definition at line 705 of file TPacketizer.cxx.

◆ NextUnAllocNode()

TPacketizer::TFileNode * TPacketizer::NextUnAllocNode ( )

private

Get next unallocated node.

Definition at line 660 of file TPacketizer.cxx.

◆ operator=()

void TPacketizer::operator= ( const TPacketizer & )

private

◆ RemoveActive()

void TPacketizer::RemoveActive ( TFileStat * file )

private

Remove file from the list of actives.

Definition at line 726 of file TPacketizer.cxx.

◆ RemoveActiveNode()

void TPacketizer::RemoveActiveNode ( TFileNode * node )

private

Remove node from the list of actives.

Definition at line 737 of file TPacketizer.cxx.

◆ RemoveUnAllocNode()

void TPacketizer::RemoveUnAllocNode ( TFileNode * node )

private

Remove unallocated node.

Definition at line 681 of file TPacketizer.cxx.

◆ Reset()

void TPacketizer::Reset ( )

private

Reset the internal datastructure for packet distribution.

Definition at line 745 of file TPacketizer.cxx.

◆ ValidateFiles()

void TPacketizer::ValidateFiles	(	TDSet *	dset,
		TList *	slaves,
		Long64_t	maxent = `-1`,
		Bool_t	byfile = `kFALSE`
	)

private

Check existence of file/dir/tree an get number of entries.

Assumes the files have been setup.

Definition at line 779 of file TPacketizer.cxx.

Member Data Documentation

◆ fActive

TList* TPacketizer::fActive

private

Definition at line 51 of file TPacketizer.h.

◆ fDefMaxWrkNode

Bool_t TPacketizer::fDefMaxWrkNode

private

Definition at line 69 of file TPacketizer.h.

◆ fFileNodes

TList* TPacketizer::fFileNodes

private

Definition at line 49 of file TPacketizer.h.

◆ fHeuristicPSiz

Bool_t TPacketizer::fHeuristicPSiz

private

Definition at line 68 of file TPacketizer.h.

◆ fMaxPerfIdx

Int_t TPacketizer::fMaxPerfIdx

private

Definition at line 56 of file TPacketizer.h.

◆ fMaxSlaveCnt

Long_t TPacketizer::fMaxSlaveCnt

private

Definition at line 58 of file TPacketizer.h.

◆ fPacketAsAFraction

Int_t TPacketizer::fPacketAsAFraction

private

Definition at line 60 of file TPacketizer.h.

◆ fPackets

TList* TPacketizer::fPackets

private

Definition at line 47 of file TPacketizer.h.

◆ fPacketSize

Long64_t TPacketizer::fPacketSize

private

Definition at line 53 of file TPacketizer.h.

◆ fUnAllocated

TList* TPacketizer::fUnAllocated

private

Definition at line 50 of file TPacketizer.h.

Libraries for TPacketizer:

[legend]

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

proof/proofplayer/inc/TPacketizer.h
proof/proofplayer/src/TPacketizer.cxx

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TPacketizer() [1/3]

◆ TPacketizer() [2/3]

◆ TPacketizer() [3/3]

◆ ~TPacketizer()

Member Function Documentation

◆ AddWorkers()

◆ GetActiveWorkers()

◆ GetCurrentRate()

◆ GetEntriesProcessed()

◆ GetNextActive()

◆ GetNextPacket()

◆ GetNextUnAlloc()

◆ NextActiveNode()

◆ NextUnAllocNode()

◆ operator=()

◆ RemoveActive()

◆ RemoveActiveNode()

◆ RemoveUnAllocNode()

◆ Reset()

◆ ValidateFiles()

Member Data Documentation

◆ fActive

◆ fDefMaxWrkNode

◆ fFileNodes

◆ fHeuristicPSiz

◆ fMaxPerfIdx

◆ fMaxSlaveCnt

◆ fPacketAsAFraction

◆ fPackets

◆ fPacketSize

◆ fUnAllocated