Logo ROOT   6.21/01
Reference Guide
TPacketizer Class Reference

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.

Public Member Functions

 TPacketizer (TDSet *dset, TList *slaves, Long64_t first, Long64_t num, TList *input, TProofProgressStatus *st)
 Constructor. More...
 
virtual ~TPacketizer ()
 Destructor. More...
 
Int_t AddWorkers (TList *workers)
 Adds new workers. Returns the number of workers added, or -1 on failure. More...
 
Int_t GetActiveWorkers ()
 Return the number of workers still processing. More...
 
Float_t GetCurrentRate (Bool_t &all)
 Get Estimation of the current rate; just summing the current rates of the active workers. More...
 
Long64_t GetEntriesProcessed (TSlave *sl) const
 Get entries processed by the specified slave. More...
 
TDSetElementGetNextPacket (TSlave *sl, TMessage *r)
 Get next packet. More...
 
- Public Member Functions inherited from TVirtualPacketizer
virtual ~TVirtualPacketizer ()
 Destructor. More...
 
virtual Int_t AddProcessed (TSlave *, TProofProgressStatus *, Double_t, TList **)
 
virtual Int_t AssignWork (TDSet *, Long64_t, Long64_t)
 
Long64_t GetBytesRead () const
 
TListGetConfigParams (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)
 
TListGetFailedPackets ()
 
Float_t GetInitTime () const
 
Float_t GetProcTime () const
 
TNtupleGetProgressPerf (Bool_t steal=kFALSE)
 
Long64_t GetReadCalls () const
 
TMapGetSlaveStats () const
 
TProofProgressStatusGetStatus ()
 
Long64_t GetTotalEntries () const
 
Bool_t IsValid () const
 
virtual void MarkBad (TSlave *, TProofProgressStatus *, TList **)
 
void SetFailedPackets (TList *list)
 
virtual void SetInitTime ()
 Set the initialization time. More...
 
void SetProgressStatus (TProofProgressStatus *st)
 
void SetTotalEntries (Long64_t ent)
 
virtual void StopProcess (Bool_t abort, Bool_t stoptimer=kFALSE)
 Stop process. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
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. More...
 
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). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Private Member Functions

 TPacketizer ()
 
 TPacketizer (const TPacketizer &)
 
TFileStat * GetNextActive ()
 Get next active file. More...
 
TFileStat * GetNextUnAlloc (TFileNode *node=0)
 Get next unallocated file. More...
 
TFileNode * NextActiveNode ()
 Get next active node. More...
 
TFileNode * NextUnAllocNode ()
 Get next unallocated node. More...
 
void operator= (const TPacketizer &)
 
void RemoveActive (TFileStat *file)
 Remove file from the list of actives. More...
 
void RemoveActiveNode (TFileNode *)
 Remove node from the list of actives. More...
 
void RemoveUnAllocNode (TFileNode *)
 Remove unallocated node. More...
 
void Reset ()
 Reset the internal datastructure for packet distribution. More...
 
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. More...
 

Private Attributes

TListfActive
 
Bool_t fDefMaxWrkNode
 
TListfFileNodes
 
Bool_t fHeuristicPSiz
 
Int_t fMaxPerfIdx
 
Long_t fMaxSlaveCnt
 
Int_t fPacketAsAFraction
 
TListfPackets
 
Long64_t fPacketSize
 
TListfUnAllocated
 

Additional Inherited Members

- Public Types inherited from TVirtualPacketizer
enum  EStatusBits { kIsInitializing = BIT(16), kIsDone = BIT(17), kIsTree = BIT(18) }
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Protected Types inherited from TVirtualPacketizer
enum  EUseEstOpt { kEstOff = 0, kEstCurrent = 1, kEstAverage = 2 }
 
- Protected Member Functions inherited from TVirtualPacketizer
 TVirtualPacketizer (TList *input, TProofProgressStatus *st=0)
 Constructor. More...
 
 TVirtualPacketizer (const TVirtualPacketizer &)
 
TDSetElementCreateNewPacket (TDSetElement *base, Long64_t first, Long64_t num)
 Creates a new TDSetElement from from base packet starting from the first entry with num entries. More...
 
Long64_t GetEntries (Bool_t tree, TDSetElement *e)
 Get entries. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Send progress message to client. More...
 
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). More...
 
void MakeZombie ()
 
- Protected Attributes inherited from TVirtualPacketizer
Int_t fActWrksLast
 
Bool_t fAWLastFill
 
Long_t fCircN
 
TNtupleDfCircProg
 
TListfConfigParams
 
TString fDataSet
 
Float_t fEffSessLast
 
Float_t fEvtRateLast
 
TListfFailedPackets
 
Float_t fInitTime
 
TListfInput
 
Double_t fMaxPacketTime
 
Float_t fMBsReadLast
 
Double_t fMinPacketTime
 
Float_t fProcTime
 
Float_t fProcTimeLast
 
TTimerfProgress
 
TNtuplefProgressPerf
 
TProofProgressStatusfProgressStatus
 
Float_t fReportPeriod
 
TMapfSlaveStats
 
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 275 of file TPacketizer.cxx.

◆ ~TPacketizer()

TPacketizer::~TPacketizer ( )
virtual

Destructor.

Definition at line 580 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 596 of file TPacketizer.cxx.

◆ GetActiveWorkers()

Int_t TPacketizer::GetActiveWorkers ( )
virtual

Return the number of workers still processing.

Reimplemented from TVirtualPacketizer.

Definition at line 1314 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 1114 of file TPacketizer.cxx.

◆ GetEntriesProcessed()

Long64_t TPacketizer::GetEntriesProcessed ( TSlave sl) const

Get entries processed by the specified slave.

Definition at line 1099 of file TPacketizer.cxx.

◆ GetNextActive()

TPacketizer::TFileStat * TPacketizer::GetNextActive ( )
private

Get next active file.

Definition at line 690 of file TPacketizer.cxx.

◆ GetNextPacket()

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

Get next packet.

Reimplemented from TVirtualPacketizer.

Definition at line 1139 of file TPacketizer.cxx.

◆ GetNextUnAlloc()

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

Get next unallocated file.

Definition at line 634 of file TPacketizer.cxx.

◆ NextActiveNode()

TPacketizer::TFileNode * TPacketizer::NextActiveNode ( )
private

Get next active node.

Definition at line 706 of file TPacketizer.cxx.

◆ NextUnAllocNode()

TPacketizer::TFileNode * TPacketizer::NextUnAllocNode ( )
private

Get next unallocated node.

Definition at line 661 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 727 of file TPacketizer.cxx.

◆ RemoveActiveNode()

void TPacketizer::RemoveActiveNode ( TFileNode *  node)
private

Remove node from the list of actives.

Definition at line 738 of file TPacketizer.cxx.

◆ RemoveUnAllocNode()

void TPacketizer::RemoveUnAllocNode ( TFileNode *  node)
private

Remove unallocated node.

Definition at line 682 of file TPacketizer.cxx.

◆ Reset()

void TPacketizer::Reset ( void  )
private

Reset the internal datastructure for packet distribution.

Definition at line 746 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 780 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 44 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: