Logo ROOT  
Reference Guide
TVirtualPacketizer Class Reference

The packetizer is a load balancing object created for each query.

It 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.

TVirtualPacketizer includes common parts of PROOF packetizers. Look in subclasses for details. The default packetizer is TPacketizerAdaptive (TPacketizer for Proof-Lite). To use an alternative one, for instance - the TPacketizer, call: proof->SetParameter("PROOF_Packetizer", "TPacketizer");

Definition at line 53 of file TVirtualPacketizer.h.


class  TVirtualSlaveStat

Public Types

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

Public Member Functions

virtual ~TVirtualPacketizer ()
 Destructor. More...
virtual Int_t AddProcessed (TSlave *, TProofProgressStatus *, Double_t, TList **)
virtual Int_t AddWorkers (TList *workers)
 Adds new workers. More...
virtual Int_t AssignWork (TDSet *, Long64_t, Long64_t)
virtual Int_t GetActiveWorkers ()
Long64_t GetBytesRead () const
TListGetConfigParams (Bool_t steal=kFALSE)
Double_t GetCumProcTime () const
virtual Float_t GetCurrentRate (Bool_t &all)
Long64_t GetEntriesProcessed () const
virtual Int_t GetEstEntriesProcessed (Float_t, Long64_t &ent, Long64_t &bytes, Long64_t &calls)
TListGetFailedPackets ()
Float_t GetInitTime () const
virtual TDSetElementGetNextPacket (TSlave *sl, TMessage *r)
 Get next packet. More...
Float_t GetProcTime () const
TNtupleGetProgressPerf (Bool_t steal=kFALSE)
Long64_t GetReadCalls () const
TMapGetSlaveStats () const
TProofProgressStatusGetStatus ()
Long64_t GetTotalEntries () const
virtual TClassIsA () 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...
virtual void Streamer (TBuffer &)
 Stream an object of class TObject. More...
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
- 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 Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. 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 TClassIsA () const
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...
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)
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)
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
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 Streamer (TBuffer &)
 Stream an object of class TObject. More...
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
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...

Static Public Member Functions

static TClassClass ()
static const char * Class_Name ()
static Version_t Class_Version ()
static const char * DeclFileName ()
- Static Public Member Functions inherited from TObject
static TClassClass ()
static const char * Class_Name ()
static Version_t Class_Version ()
static const char * DeclFileName ()
static Longptr_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

enum  EUseEstOpt { kEstOff = 0 , kEstCurrent = 1 , kEstAverage = 2 }
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }

Protected Member Functions

 TVirtualPacketizer (const TVirtualPacketizer &)
 TVirtualPacketizer (TList *input, TProofProgressStatus *st=0)
 Constructor. More...
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

Int_t fActWrksLast
Bool_t fAWLastFill
Long_t fCircN
TString fDataSet
Float_t fEffSessLast
Float_t fEvtRateLast
Float_t fInitTime
Double_t fMaxPacketTime
Float_t fMBsReadLast
Double_t fMinPacketTime
Float_t fProcTime
Float_t fProcTimeLast
Float_t fReportPeriod
TTime fStartTime
Bool_t fStop
Float_t fTimeUpdt
Long64_t fTotalEntries
EUseEstOpt fUseEstOpt
Bool_t fValid

#include <TVirtualPacketizer.h>

Inheritance diagram for TVirtualPacketizer:

Member Enumeration Documentation

◆ EStatusBits


Definition at line 115 of file TVirtualPacketizer.h.

◆ EUseEstOpt


Definition at line 59 of file TVirtualPacketizer.h.

Constructor & Destructor Documentation

◆ TVirtualPacketizer() [1/2]

TVirtualPacketizer::TVirtualPacketizer ( TList input,
TProofProgressStatus st = 0 


Definition at line 64 of file TVirtualPacketizer.cxx.

◆ TVirtualPacketizer() [2/2]

TVirtualPacketizer::TVirtualPacketizer ( const TVirtualPacketizer )

◆ ~TVirtualPacketizer()

TVirtualPacketizer::~TVirtualPacketizer ( )


Definition at line 171 of file TVirtualPacketizer.cxx.

Member Function Documentation

◆ AddProcessed()

virtual Int_t TVirtualPacketizer::AddProcessed ( TSlave ,
TProofProgressStatus ,
Double_t  ,
TList **   

Reimplemented in TPacketizerAdaptive, and TPacketizerMulti.

Definition at line 142 of file TVirtualPacketizer.h.

◆ AddWorkers()

Int_t TVirtualPacketizer::AddWorkers ( TList workers)

Adds new workers.

Must be implemented by each real packetizer properly. Returns the number of workers added, or -1 on failure.

Reimplemented in TPacketizer, and TPacketizerUnit.

Definition at line 443 of file TVirtualPacketizer.cxx.

◆ AssignWork()

virtual Int_t TVirtualPacketizer::AssignWork ( TDSet ,
Long64_t  ,

Reimplemented in TPacketizerUnit.

Definition at line 118 of file TVirtualPacketizer.h.

◆ Class()

static TClass * TVirtualPacketizer::Class ( )
TClass describing this class

◆ Class_Name()

static const char * TVirtualPacketizer::Class_Name ( )
Name of this class

◆ Class_Version()

static Version_t TVirtualPacketizer::Class_Version ( )
Version of this class

Definition at line 152 of file TVirtualPacketizer.h.

◆ CreateNewPacket()

TDSetElement * TVirtualPacketizer::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.

The function returns a new created objects which have to be deleted.

Definition at line 254 of file TVirtualPacketizer.cxx.

◆ DeclFileName()

static const char * TVirtualPacketizer::DeclFileName ( )
Name of the file containing the class declaration

Definition at line 152 of file TVirtualPacketizer.h.

◆ GetActiveWorkers()

virtual Int_t TVirtualPacketizer::GetActiveWorkers ( )

◆ GetBytesRead()

Long64_t TVirtualPacketizer::GetBytesRead ( ) const

Definition at line 132 of file TVirtualPacketizer.h.

◆ GetConfigParams()

TList * TVirtualPacketizer::GetConfigParams ( Bool_t  steal = kFALSE)

Definition at line 139 of file TVirtualPacketizer.h.

◆ GetCumProcTime()

Double_t TVirtualPacketizer::GetCumProcTime ( ) const

Definition at line 134 of file TVirtualPacketizer.h.

◆ GetCurrentRate()

virtual Float_t TVirtualPacketizer::GetCurrentRate ( Bool_t all)

◆ GetEntries()

Long64_t TVirtualPacketizer::GetEntries ( Bool_t  tree,
TDSetElement e 

Get entries.

Definition at line 184 of file TVirtualPacketizer.cxx.

◆ GetEntriesProcessed()

Long64_t TVirtualPacketizer::GetEntriesProcessed ( ) const

Definition at line 120 of file TVirtualPacketizer.h.

◆ GetEstEntriesProcessed()

virtual Int_t TVirtualPacketizer::GetEstEntriesProcessed ( Float_t  ,
Long64_t ent,
Long64_t bytes,
Long64_t calls 

Reimplemented in TPacketizerMulti, and TPacketizerAdaptive.

Definition at line 121 of file TVirtualPacketizer.h.

◆ GetFailedPackets()

TList * TVirtualPacketizer::GetFailedPackets ( )

Definition at line 128 of file TVirtualPacketizer.h.

◆ GetInitTime()

Float_t TVirtualPacketizer::GetInitTime ( ) const

Definition at line 135 of file TVirtualPacketizer.h.

◆ GetNextPacket()

TDSetElement * TVirtualPacketizer::GetNextPacket ( TSlave sl,
TMessage r 

Get next packet.

Reimplemented in TPacketizer, TPacketizerAdaptive, TPacketizerUnit, TPacketizerFile, and TPacketizerMulti.

Definition at line 234 of file TVirtualPacketizer.cxx.

◆ GetProcTime()

Float_t TVirtualPacketizer::GetProcTime ( ) const

Definition at line 136 of file TVirtualPacketizer.h.

◆ GetProgressPerf()

TNtuple * TVirtualPacketizer::GetProgressPerf ( Bool_t  steal = kFALSE)

Definition at line 137 of file TVirtualPacketizer.h.

◆ GetReadCalls()

Long64_t TVirtualPacketizer::GetReadCalls ( ) const

Definition at line 133 of file TVirtualPacketizer.h.

◆ GetSlaveStats()

TMap * TVirtualPacketizer::GetSlaveStats ( ) const

Definition at line 148 of file TVirtualPacketizer.h.

◆ GetStatus()

TProofProgressStatus * TVirtualPacketizer::GetStatus ( )

Definition at line 144 of file TVirtualPacketizer.h.

◆ GetTotalEntries()

Long64_t TVirtualPacketizer::GetTotalEntries ( ) const

Definition at line 124 of file TVirtualPacketizer.h.

◆ HandleTimer()

Bool_t TVirtualPacketizer::HandleTimer ( TTimer timer)

Send progress message to client.

Reimplemented from TObject.

Definition at line 283 of file TVirtualPacketizer.cxx.

◆ IsA()

virtual TClass * TVirtualPacketizer::IsA ( ) const
TClass describing current object

Reimplemented from TObject.

Definition at line 152 of file TVirtualPacketizer.h.

◆ IsValid()

Bool_t TVirtualPacketizer::IsValid ( ) const

Definition at line 119 of file TVirtualPacketizer.h.

◆ MarkBad()

virtual void TVirtualPacketizer::MarkBad ( TSlave ,
TProofProgressStatus ,
TList **   

Reimplemented in TPacketizerAdaptive, and TPacketizerMulti.

Definition at line 141 of file TVirtualPacketizer.h.

◆ operator=()

void TVirtualPacketizer::operator= ( const TVirtualPacketizer )

◆ SetFailedPackets()

void TVirtualPacketizer::SetFailedPackets ( TList list)

Definition at line 129 of file TVirtualPacketizer.h.

◆ SetInitTime()

void TVirtualPacketizer::SetInitTime ( )

Set the initialization time.

Definition at line 429 of file TVirtualPacketizer.cxx.

◆ SetProgressStatus()

void TVirtualPacketizer::SetProgressStatus ( TProofProgressStatus st)

Definition at line 145 of file TVirtualPacketizer.h.

◆ SetTotalEntries()

void TVirtualPacketizer::SetTotalEntries ( Long64_t  ent)

Definition at line 146 of file TVirtualPacketizer.h.

◆ StopProcess()

void TVirtualPacketizer::StopProcess ( Bool_t  abort,
Bool_t  stoptimer = kFALSE 

Stop process.

Reimplemented in TPacketizerMulti.

Definition at line 243 of file TVirtualPacketizer.cxx.

◆ Streamer()

virtual void TVirtualPacketizer::Streamer ( TBuffer R__b)

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TVirtualPacketizer::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)

Definition at line 152 of file TVirtualPacketizer.h.

Member Data Documentation

◆ fActWrksLast

Int_t TVirtualPacketizer::fActWrksLast

Definition at line 90 of file TVirtualPacketizer.h.

◆ fAWLastFill

Bool_t TVirtualPacketizer::fAWLastFill

Definition at line 94 of file TVirtualPacketizer.h.

◆ fCircN

Long_t TVirtualPacketizer::fCircN

Definition at line 86 of file TVirtualPacketizer.h.

◆ fCircProg

TNtupleD* TVirtualPacketizer::fCircProg

Definition at line 84 of file TVirtualPacketizer.h.

◆ fConfigParams

TList* TVirtualPacketizer::fConfigParams

Definition at line 68 of file TVirtualPacketizer.h.

◆ fDataSet

TString TVirtualPacketizer::fDataSet

Definition at line 102 of file TVirtualPacketizer.h.

◆ fEffSessLast

Float_t TVirtualPacketizer::fEffSessLast

Definition at line 93 of file TVirtualPacketizer.h.

◆ fEvtRateLast

Float_t TVirtualPacketizer::fEvtRateLast

Definition at line 91 of file TVirtualPacketizer.h.

◆ fFailedPackets

TList* TVirtualPacketizer::fFailedPackets

Definition at line 77 of file TVirtualPacketizer.h.

◆ fInitTime

Float_t TVirtualPacketizer::fInitTime

Definition at line 81 of file TVirtualPacketizer.h.

◆ fInput

TList* TVirtualPacketizer::fInput

Definition at line 104 of file TVirtualPacketizer.h.

◆ fMaxPacketTime

Double_t TVirtualPacketizer::fMaxPacketTime

Definition at line 67 of file TVirtualPacketizer.h.

◆ fMBsReadLast

Float_t TVirtualPacketizer::fMBsReadLast

Definition at line 92 of file TVirtualPacketizer.h.

◆ fMinPacketTime

Double_t TVirtualPacketizer::fMinPacketTime

Definition at line 66 of file TVirtualPacketizer.h.

◆ fProcTime

Float_t TVirtualPacketizer::fProcTime

Definition at line 82 of file TVirtualPacketizer.h.

◆ fProcTimeLast

Float_t TVirtualPacketizer::fProcTimeLast

Definition at line 89 of file TVirtualPacketizer.h.

◆ fProgress

TTimer* TVirtualPacketizer::fProgress

Definition at line 73 of file TVirtualPacketizer.h.

◆ fProgressPerf

TNtuple* TVirtualPacketizer::fProgressPerf

Definition at line 88 of file TVirtualPacketizer.h.

◆ fProgressStatus

TProofProgressStatus* TVirtualPacketizer::fProgressStatus

Definition at line 72 of file TVirtualPacketizer.h.

◆ fReportPeriod

Float_t TVirtualPacketizer::fReportPeriod

Definition at line 95 of file TVirtualPacketizer.h.

◆ fSlaveStats

TMap* TVirtualPacketizer::fSlaveStats

Definition at line 70 of file TVirtualPacketizer.h.

◆ fStartTime

TTime TVirtualPacketizer::fStartTime

Definition at line 80 of file TVirtualPacketizer.h.

◆ fStop

Bool_t TVirtualPacketizer::fStop

Definition at line 100 of file TVirtualPacketizer.h.

◆ fTimeUpdt

Float_t TVirtualPacketizer::fTimeUpdt

Definition at line 83 of file TVirtualPacketizer.h.

◆ fTotalEntries

Long64_t TVirtualPacketizer::fTotalEntries

Definition at line 75 of file TVirtualPacketizer.h.

◆ fUseEstOpt

EUseEstOpt TVirtualPacketizer::fUseEstOpt

Definition at line 97 of file TVirtualPacketizer.h.

◆ fValid

Bool_t TVirtualPacketizer::fValid

Definition at line 99 of file TVirtualPacketizer.h.

Libraries for TVirtualPacketizer:

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