A++ » INCLUDE » TTreeCacheUnzip

class TTreeCacheUnzip: public TTreeCache


TTreeCacheUnzip

Specialization of TTreeCache for parallel Unzipping

Fabrizio Furano (CERN) Aug 2009
Core TTree-related code borrowed from the previous version
by Leandro Franco and Rene Brun

Function Members (Methods)

public:
virtual~TTreeCacheUnzip()
voidTObject::AbstractMethod(const char* method) const
virtual Int_tAddBranch(TBranch* b, Bool_t subbranches = kFALSE)
virtual Int_tAddBranch(const char* branch, Bool_t subbranches = kFALSE)
virtual voidTFileCacheRead::AddNoCacheBytesRead(Long64_t len)
virtual voidTFileCacheRead::AddNoCacheReadCalls(Int_t reads)
virtual voidTObject::AppendPad(Option_t* option = "")
virtual voidTObject::Browse(TBrowser* b)
static TClass*Class()
virtual const char*TObject::ClassName() const
virtual voidTObject::Clear(Option_t* = "")
virtual TObject*TObject::Clone(const char* newname = "") const
virtual voidTFileCacheRead::Close(Option_t* option = "")
virtual Int_tTObject::Compare(const TObject* obj) const
virtual voidTObject::Copy(TObject& object) const
virtual voidTObject::Delete(Option_t* option = "")MENU
virtual voidTTreeCache::Disable()
virtual Int_tTObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual voidTObject::Draw(Option_t* option = "")
virtual voidTObject::DrawClass() constMENU
virtual TObject*TObject::DrawClone(Option_t* option = "") constMENU
virtual Int_tTTreeCache::DropBranch(TBranch* b, Bool_t subbranches = kFALSE)
virtual Int_tTTreeCache::DropBranch(const char* branch, Bool_t subbranches = kFALSE)
virtual voidTObject::Dump() constMENU
virtual voidTTreeCache::Enable()
virtual voidTObject::Error(const char* method, const char* msgfmt) const
virtual voidTObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual voidTObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual voidTObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual voidTObject::Fatal(const char* method, const char* msgfmt) const
virtual Bool_tFillBuffer()
virtual TObject*TObject::FindObject(const char* name) const
virtual TObject*TObject::FindObject(const TObject* obj) const
virtual Int_tTFileCacheRead::GetBufferSize() const
virtual Long64_tTFileCacheRead::GetBytesRead() const
virtual Long64_tTFileCacheRead::GetBytesReadExtra() const
const TObjArray*TTreeCache::GetCachedBranches() const
TTreeCache::EPrefillTypeTTreeCache::GetConfiguredPrefillType() const
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
Double_tTTreeCache::GetEfficiency() const
Double_tTTreeCache::GetEfficiencyRel() const
virtual Int_tTTreeCache::GetEntryMax() const
virtual Int_tTTreeCache::GetEntryMin() const
TFile*TFileCacheRead::GetFile() const
virtual const char*TObject::GetIconName() const
static Int_tTTreeCache::GetLearnEntries()
virtual TTreeCache::EPrefillTypeTTreeCache::GetLearnPrefill() const
virtual const char*TObject::GetName() const
Int_tGetNFound()
Int_tGetNMissed()
virtual Long64_tTFileCacheRead::GetNoCacheBytesRead() const
virtual Int_tTFileCacheRead::GetNoCacheReadCalls() const
Int_tTFileCacheRead::GetNseek() const
Int_tTFileCacheRead::GetNtot() const
Int_tGetNUnzip()
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_tTObject::GetObjectStat()
virtual Option_t*TObject::GetOption() const
static TTreeCacheUnzip::EParUnzipModeGetParallelUnzip()
Long64_tTFileCacheRead::GetPrefetchedBlocks() const
virtual TFilePrefetch*TFileCacheRead::GetPrefetchObj()
virtual Int_tTFileCacheRead::GetReadCalls() const
Int_tGetRecordHeader(char* buf, Int_t maxbytes, Int_t& nbytes, Int_t& objlen, Int_t& keylen)
virtual const char*TObject::GetTitle() const
TTree*TTreeCache::GetTree() const
virtual UInt_tTObject::GetUniqueID() const
virtual Int_tGetUnzipBuffer(char** buf, Long64_t pos, Int_t len, Bool_t* free)
virtual Bool_tTObject::HandleTimer(TTimer* timer)
virtual ULong_tTObject::Hash() const
virtual voidTObject::Info(const char* method, const char* msgfmt) const
virtual Bool_tTObject::InheritsFrom(const char* classname) const
virtual Bool_tTObject::InheritsFrom(const TClass* cl) const
virtual voidTObject::Inspect() constMENU
voidTObject::InvertBit(UInt_t f)
virtual TClass*IsA() const
Bool_tIsActiveThread()
virtual Bool_tTFileCacheRead::IsAsyncReading() const
Bool_tTTreeCache::IsAutoCreated() const
virtual Bool_tTTreeCache::IsEnabled() const
virtual Bool_tTFileCacheRead::IsEnablePrefetching() const
virtual Bool_tTObject::IsEqual(const TObject* obj) const
virtual Bool_tTObject::IsFolder() const
virtual Bool_tTTreeCache::IsLearning() const
Bool_tTObject::IsOnHeap() const
static Bool_tIsParallelUnzip()
Bool_tIsQueueEmpty()
virtual Bool_tTObject::IsSortable() const
Bool_tTObject::IsZombie() const
virtual voidTTreeCache::LearnPrefill()
virtual voidTObject::ls(Option_t* option = "") const
voidTObject::MayNotUse(const char* method) const
virtual Bool_tTObject::Notify()
voidTObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
voidTObject::operator delete(void* ptr)
voidTObject::operator delete(void* ptr, void* vp)
voidTObject::operator delete[](void* ptr)
voidTObject::operator delete[](void* ptr, void* vp)
void*TObject::operator new(size_t sz)
void*TObject::operator new(size_t sz, void* vp)
void*TObject::operator new[](size_t sz)
void*TObject::operator new[](size_t sz, void* vp)
virtual voidTObject::Paint(Option_t* option = "")
virtual voidTObject::Pop()
virtual voidTFileCacheRead::Prefetch(Long64_t pos, Int_t len)
virtual voidPrint(Option_t* option = "") const
virtual Int_tTObject::Read(const char* name)
virtual Int_tTTreeCache::ReadBuffer(char* buf, Long64_t pos, Int_t len)
virtual Int_tReadBufferExt(char* buf, Long64_t pos, Int_t len, Int_t& loc)
virtual Int_tTFileCacheRead::ReadBufferExtNormal(char* buf, Long64_t pos, Int_t len, Int_t& loc)
virtual Int_tTFileCacheRead::ReadBufferExtPrefetch(char* buf, Long64_t pos, Int_t len, Int_t& loc)
virtual Int_tTTreeCache::ReadBufferNormal(char* buf, Long64_t pos, Int_t len)
virtual Int_tTTreeCache::ReadBufferPrefetch(char* buf, Long64_t pos, Int_t len)
virtual voidTObject::RecursiveRemove(TObject* obj)
voidTObject::ResetBit(UInt_t f)
virtual voidResetCache()
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual voidTObject::SavePrimitive(ostream& out, Option_t* option = "")
virtual voidTFileCacheRead::SecondPrefetch(Long64_t, Int_t)
virtual voidTFileCacheRead::SecondSort()
voidSendUnzipStartSignal(Bool_t broadcast)
voidTTreeCache::SetAutoCreated(Bool_t val)
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f, Bool_t set)
virtual Int_tSetBufferSize(Int_t buffersize)
virtual voidTObject::SetDrawOption(Option_t* option = "")MENU
static voidTObject::SetDtorOnly(void* obj)
virtual voidTFileCacheRead::SetEnablePrefetching(Bool_t setPrefetching = kFALSE)
virtual voidSetEntryRange(Long64_t emin, Long64_t emax)
virtual voidTTreeCache::SetFile(TFile* file, TFile::ECacheAction action = TFile::kDisconnect)
static voidTTreeCache::SetLearnEntries(Int_t n = 10)
virtual voidTTreeCache::SetLearnPrefill(TTreeCache::EPrefillType type = kNoPrefill)
static voidTObject::SetObjectStat(Bool_t stat)
static Int_tSetParallelUnzip(TTreeCacheUnzip::EParUnzipMode option = TTreeCacheUnzip::kEnable)
virtual voidTFileCacheRead::SetSkipZip(Bool_t = kTRUE)
virtual voidTObject::SetUniqueID(UInt_t uid)
voidSetUnzipBufferSize(Long64_t bufferSize)
static voidSetUnzipRelBufferSize(Float_t relbufferSize)
virtual voidShowMembers(TMemberInspector& insp) const
virtual voidTFileCacheRead::Sort()
voidTTreeCache::StartLearningPhase()
virtual voidStopLearningPhase()
virtual voidStreamer(TBuffer&)
voidStreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
Bool_tTObject::TestBit(UInt_t f) const
Int_tTObject::TestBits(UInt_t f) const
TTreeCacheUnzip()
TTreeCacheUnzip(TTree* tree, Int_t buffersize = 0)
Int_tUnzipBuffer(char** dest, char* src)
Int_tUnzipCache(Int_t& startindex, Int_t& locbuffsz, char*& locbuff)
static void*UnzipLoop(void* arg)
virtual voidUpdateBranches(TTree* tree)
virtual voidTObject::UseCurrentStyle()
virtual voidTFileCacheRead::WaitFinishPrefetch()
voidWaitUnzipStartSignal()
virtual voidTObject::Warning(const char* method, const char* msgfmt) const
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const
protected:
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
voidTObject::MakeZombie()
voidTFileCacheRead::SetEnablePrefetchingImpl(Bool_t setPrefetching = kFALSE)

Data Members

public:
static TTreeCache::EPrefillTypeTTreeCache::kAllBranches
static TObject::(anonymous)TObject::kBitMask
static TObject::EStatusBitsTObject::kCanDelete
static TObject::EStatusBitsTObject::kCannotPick
static TTreeCacheUnzip::EParUnzipModekDisable
static TTreeCacheUnzip::EParUnzipModekEnable
static TTreeCacheUnzip::EParUnzipModekForce
static TObject::EStatusBitsTObject::kHasUUID
static TObject::EStatusBitsTObject::kInvalidObject
static TObject::(anonymous)TObject::kIsOnHeap
static TObject::EStatusBitsTObject::kIsReferenced
static TObject::EStatusBitsTObject::kMustCleanup
static TObject::EStatusBitsTObject::kNoContextMenu
static TTreeCache::EPrefillTypeTTreeCache::kNoPrefill
static TObject::(anonymous)TObject::kNotDeleted
static TObject::EStatusBitsTObject::kObjInCanvas
static TObject::(anonymous)TObject::kOverwrite
static TObject::(anonymous)TObject::kSingleKey
static TObject::(anonymous)TObject::kWriteDelete
static TObject::(anonymous)TObject::kZombie
protected:
queue<Int_t>fActiveBlksThe blocks which are active now
Bool_tfActiveThreadUsed to terminate gracefully the unzippers
Bool_tfAsyncReading
Bool_tTFileCacheRead::fAsyncReading
Bool_tTTreeCache::fAutoCreated! true if cache was automatically created
Bool_tTFileCacheRead::fBIsSorted
Bool_tTFileCacheRead::fBIsTransferred
Int_t*TFileCacheRead::fBLen[fBNb]
Int_tTFileCacheRead::fBNb
Int_tTFileCacheRead::fBNseek
Int_tTFileCacheRead::fBNtot
Long64_t*TFileCacheRead::fBPos[fBNb]
Long64_t*TFileCacheRead::fBSeek[fBNseek]
Int_t*TFileCacheRead::fBSeekIndex[fBNseek]
Int_t*TFileCacheRead::fBSeekLen[fBNseek]
Int_t*TFileCacheRead::fBSeekPos[fBNseek]
Int_tTFileCacheRead::fBSeekSize
Long64_t*TFileCacheRead::fBSeekSort[fBNseek]
Int_t*TFileCacheRead::fBSeekSortLen[fBNseek]
Int_tfBlocksToGo
TList*TTreeCache::fBrNames! list of branch names in the cache
TObjArray*TTreeCache::fBranches! List of branches to be stored in the cache
char*TFileCacheRead::fBuffer[fBufferSize] buffer of contiguous prefetched blocks
Int_tTFileCacheRead::fBufferLenCurrent buffer length (<= fBufferSize)
Int_tTFileCacheRead::fBufferSizeAllocated size of fBuffer (at a given time)
Int_tTFileCacheRead::fBufferSizeMinOriginal size of fBuffer
Long64_tTFileCacheRead::fBytesReadNumber of bytes read for this cache
Long64_tTFileCacheRead::fBytesReadExtraNumber of extra bytes (overhead) read by the readahead buffer
Int_tfCycle
Bool_tTFileCacheRead::fEnablePrefetchingreading by prefetching asynchronously
Bool_tTTreeCache::fEnabled! cache enabled for cached reading
Long64_tTTreeCache::fEntryCurrent! current lowest entry number in the cache
Long64_tTTreeCache::fEntryMax! last entry in the cache
Long64_tTTreeCache::fEntryMin! first entry in the cache
Long64_tTTreeCache::fEntryNext! next entry number where cache must be filled
TFile*TFileCacheRead::fFilePointer to file
Int_tTTreeCache::fFillTimes! how many times we can fill the current buffer
Bool_tTTreeCache::fFirstBuffer! true if first buffer is used for prefetching
Long64_tTTreeCache::fFirstEntry! save the value of the first entry
Bool_tTTreeCache::fFirstTime! save the fact that we processes the first entry
TMutex*fIOMutex
Bool_tTTreeCache::fIsLearning! true if cache is in learning mode
Bool_tTTreeCache::fIsManual! true if cache is StopLearningPhase was used
Bool_tTFileCacheRead::fIsSortedTrue if fSeek array is sorted
Bool_tTFileCacheRead::fIsTransferredTrue when fBuffer contains something valid
Int_tfLastReadPos
Int_t*TFileCacheRead::fLen[fNb] Length of long buffers
TMutex*fMutexListMutex to protect the various lists. Used by the condvars.
Int_tfNFound! number of blocks that were found in the cache
Int_tfNMissed! number of blocks that were not found in the cache and were unzipped
Int_tTTreeCache::fNReadMissNumber of blocks read and not found in the cache
Int_tTTreeCache::fNReadOkNumber of blocks read and found in the cache
Int_tTTreeCache::fNReadPrefNumber of blocks that were prefetched
Int_tfNStalls! number of hits which caused a stall
Int_tfNUnzip! number of blocks that were unzipped
Int_tTFileCacheRead::fNbNumber of long buffers
Int_tTTreeCache::fNbranches! Number of branches in the cache
Long64_tTFileCacheRead::fNoCacheBytesReadNumber of bytes read by basket to fill cached tree
Int_tTFileCacheRead::fNoCacheReadCallsNumber of read calls by basket to fill cached tree
Int_tTFileCacheRead::fNseekNumber of blocks to be prefetched
Int_tfNseekMax! fNseek can change so we need to know its max size
Int_tTFileCacheRead::fNtotTotal size of prefetched blocks
Bool_tTTreeCache::fOneTime! used in the learning phase
Bool_tfParallelIndicate if we want to activate the parallelism (for this instance)
Long64_t*TFileCacheRead::fPos[fNb] start of long buffers
TFilePrefetch*TFileCacheRead::fPrefetch! Object that does the asynchronous reading in another thread
Long64_tTFileCacheRead::fPrefetchedBlocksNumber of blocks prefetched.
TTreeCache::EPrefillTypeTTreeCache::fPrefillTypeWhether a pre-filling is enabled (and if applicable which type)
Int_tTFileCacheRead::fReadCallsNumber of read calls for this cache
Bool_tTTreeCache::fReadDirectionSet! read direction established
Bool_tTTreeCache::fReverseRead! reading in reverse mode
Long64_t*TFileCacheRead::fSeek[fNseek] Position on file of buffers to be prefetched
Int_t*TFileCacheRead::fSeekIndex[fNseek] sorted index table of fSeek
Int_t*TFileCacheRead::fSeekLen[fNseek] Length of buffers to be prefetched
Int_t*TFileCacheRead::fSeekPos[fNseek] Position of sorted blocks in fBuffer
Int_tTFileCacheRead::fSeekSizeAllocated size of fSeek
Long64_t*TFileCacheRead::fSeekSort[fNseek] Position on file of buffers to be prefetched (sorted)
Int_t*TFileCacheRead::fSeekSortLen[fNseek] Length of buffers to be prefetched (sorted)
Long64_tfTotalUnzipBytes! The total sum of the currently unzipped blks
TTree*TTreeCache::fTree! pointer to the current Tree
Long64_tfUnzipBufferSize! Max Size for the ready unzipped blocks (default is 2*fBufferSize)
char**fUnzipChunks! [fNseek] Individual unzipped chunks. Their summed size is kept under control.
TCondition*fUnzipDoneConditionUsed to wait for an unzip tour to finish. Gives the Async feel.
Int_t*fUnzipLen! [fNseek] Length of the unzipped buffers
TCondition*fUnzipStartConditionUsed to signal the threads to start.
Byte_t*fUnzipStatus! [fNSeek] For each blk, tells us if it's unzipped or pending
TThread*fUnzipThread[10]
static Int_tTTreeCache::fgLearnEntriesnumber of entries used for learning mode
static TTreeCacheUnzip::EParUnzipModefgParallelIndicate if we want to activate the parallelism
static Double_tfgRelBuffSizeThis is the percentage of the TTreeCacheUnzip that will be used
private:
char*fCompBuffer
Int_tfCompBufferSize

Class Charts

Inheritance Chart:
TObject
←
TFileCacheRead
←
TTreeCache
←
TTreeCacheUnzip

Function documentation

TTreeCacheUnzip(const TTreeCacheUnzip& )
TTreeCacheUnzip& operator=(const TTreeCacheUnzip& )
void Init()
 Private methods
Int_t StartThreadUnzip(Int_t nthreads)
Int_t StopThreadUnzip()
TTreeCacheUnzip()
TTreeCacheUnzip(TTree* tree, Int_t buffersize = 0)
virtual ~TTreeCacheUnzip()
Int_t AddBranch(TBranch* b, Bool_t subbranches = kFALSE)
Int_t AddBranch(const char* branch, Bool_t subbranches = kFALSE)
Bool_t FillBuffer()
Int_t ReadBufferExt(char* buf, Long64_t pos, Int_t len, Int_t& loc)
void SetEntryRange(Long64_t emin, Long64_t emax)
void StopLearningPhase()
void UpdateBranches(TTree* tree)
EParUnzipMode GetParallelUnzip()
 Methods related to the thread
Bool_t IsParallelUnzip()
Int_t SetParallelUnzip(TTreeCacheUnzip::EParUnzipMode option = TTreeCacheUnzip::kEnable)
Bool_t IsActiveThread()
Bool_t IsQueueEmpty()
void WaitUnzipStartSignal()
void SendUnzipStartSignal(Bool_t broadcast)
Int_t GetRecordHeader(char* buf, Int_t maxbytes, Int_t& nbytes, Int_t& objlen, Int_t& keylen)
 Unzipping related methods
void ResetCache()
Int_t GetUnzipBuffer(char** buf, Long64_t pos, Int_t len, Bool_t* free)
Int_t SetBufferSize(Int_t buffersize)
void SetUnzipBufferSize(Long64_t bufferSize)
void SetUnzipRelBufferSize(Float_t relbufferSize)
Int_t UnzipBuffer(char** dest, char* src)
Int_t UnzipCache(Int_t& startindex, Int_t& locbuffsz, char*& locbuff)
Int_t GetNUnzip()
 Methods to get stats
{ return fNUnzip; }
Int_t GetNFound()
{ return fNFound; }
Int_t GetNMissed()
{ return fNMissed; }
void Print(Option_t* option = "") const
void* UnzipLoop(void* arg)
 static members