// @(#)root/tree:$Name: $:$Id: TBranch.cxx,v 1.58 2003/05/15 08:43:49 brun Exp $
// Author: Rene Brun 12/01/96
/*************************************************************************
* Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
* All rights reserved. *
* *
* For the licensing terms see $ROOTSYS/LICENSE. *
* For the list of contributors see $ROOTSYS/README/CREDITS. *
*************************************************************************/
#include <string.h>
#include <stdio.h>
#include "TROOT.h"
#include "TFile.h"
#include "TBranch.h"
#include "TTree.h"
#include "TBasket.h"
#include "TBrowser.h"
#include "TLeaf.h"
#include "TLeafObject.h"
#include "TLeafB.h"
#include "TLeafC.h"
#include "TLeafI.h"
#include "TLeafF.h"
#include "TLeafS.h"
#include "TLeafD.h"
#include "TMessage.h"
#include "TClonesArray.h"
#include "TVirtualPad.h"
#include "TSystem.h"
#include "TStreamerInfo.h"
TBranch *gBranch;
R__EXTERN TTree *gTree;
Int_t TBranch::fgCount = 0;
const Int_t kMaxRAM = 10;
const Int_t kMaxLen = 512;
ClassImp(TBranch)
//////////////////////////////////////////////////////////////////////////
// //
// A TTree is a list of TBranches // //
// //
// A TBranch supports: //
// - The list of TLeaf describing this branch. //
// - The list of TBasket (branch buffers). //
// //
// See TBranch structure in TTree. //
// //
// See also specialized branches: //
// TBranchObject in case the branch is one object //
// TBranchClones in case the branch is an array of clone objects //
//////////////////////////////////////////////////////////////////////////
//______________________________________________________________________________
TBranch::TBranch(): TNamed(), TAttFill(0,1001)
{
//*-*-*-*-*-*Default constructor for Branch*-*-*-*-*-*-*-*-*-*
//*-* ===================================
fCompress = 0;
fBasketSize = 32000;
fEntryOffsetLen = 1000;
fMaxBaskets = 1000;
fReadBasket = 0;
fReadEntry = -1;
fWriteBasket = 0;
fEntries = 0;
fTotBytes = 0;
fZipBytes = 0;
fSplitLevel = 0;
fNBasketRAM = kMaxRAM+1;
fBasketRAM = new Int_t[kMaxRAM]; for (Int_t i=0;i<kMaxRAM;i++) fBasketRAM[i] = -1;
fBasketEntry = 0;
fBasketBytes = 0;
fBasketSeek = 0;
fEntryNumber = 0;
fEntryBuffer = 0;
fNleaves = 0;
fTree = 0;
fAddress = 0;
fOffset = 0;
fDirectory = 0;
fSkipZip = kFALSE;
fFileName = "";
gBranch = this;
}
//______________________________________________________________________________
TBranch::TBranch(const char *name, void *address, const char *leaflist, Int_t basketsize, Int_t compress)
:TNamed(name,leaflist), TAttFill(0,1001)
{
//*-*-*-*-*-*-*-*-*-*-*-*-*Create a Branch*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
//*-* =====================
//
// * address is the address of the first item of a structure
// or the address of a pointer to an object (see example).
// * leaflist is the concatenation of all the variable names and types
// separated by a colon character :
// The variable name and the variable type are separated by a slash (/).
// The variable type may be 0,1 or 2 characters. If no type is given,
// the type of the variable is assumed to be the same as the previous
// variable. If the first variable does not have a type, it is assumed
// of type F by default. The list of currently supported types is given below:
// - C : a character string terminated by the 0 character
// - B : an 8 bit signed integer (Char_t)
// - b : an 8 bit unsigned integer (UChar_t)
// - S : a 16 bit signed integer (Short_t)
// - s : a 16 bit unsigned integer (UShort_t)
// - I : a 32 bit signed integer (Int_t)
// - i : a 32 bit unsigned integer (UInt_t)
// - F : a 32 bit floating point (Float_t)
// - D : a 64 bit floating point (Double_t)
//
// By default, a variable will be copied to the buffer with the number of
// bytes specified in the type descriptor character. However, if the type
// consists of 2 characters, the second character is an integer that
// specifies the number of bytes to be used when copying the variable
// to the output buffer. Example:
// X ; variable X, type Float_t
// Y/I : variable Y, type Int_t
// Y/I2 ; variable Y, type Int_t converted to a 16 bits integer
//
// See an example of a Branch definition in the TTree constructor.
//
// Note that in case the data type is an object, this branch can contain
// only this object.
//
// Note that this function is invoked by TTree::Branch
//
//*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
gBranch = this;
Int_t i;
fCompress = compress;
if (compress == -1 && gTree->GetDirectory()) {
TFile *bfile = gTree->GetDirectory()->GetFile();
if (bfile) fCompress = bfile->GetCompressionLevel();
}
if (basketsize < 100) basketsize = 100;
fBasketSize = basketsize;
fEntryOffsetLen = 0;
fMaxBaskets = 1000;
fReadBasket = 0;
fReadEntry = -1;
fWriteBasket = 0;
fEntryNumber = 0;
fEntryBuffer = 0;
fEntries = 0;
fTotBytes = 0;
fZipBytes = 0;
fSplitLevel = 0;
fOffset = 0;
fNleaves = 0;
fSkipZip = kFALSE;
fAddress = (char*)address;
fNBasketRAM = kMaxRAM+1;
fBasketRAM = new Int_t[kMaxRAM]; for (i=0;i<kMaxRAM;i++) fBasketRAM[i] = -1;
fBasketEntry = new Int_t[fMaxBaskets];
fBasketBytes = new Int_t[fMaxBaskets];
fBasketSeek = new Seek_t[fMaxBaskets];
fBasketEntry[0] = fEntryNumber;
for (i=0;i<fMaxBaskets;i++) {
fBasketBytes[i] = 0;
fBasketEntry[i] = 0;
fBasketSeek[i] = 0;
}
//*-*- Decode the leaflist (search for : as separator)
char * varcur = (char*)leaflist;
char * var = varcur;
Int_t lenvar = 0;
Int_t offset = 0;
char *leafname = new char[64];
char *leaftype = new char[32];
strcpy(leaftype,"F");
while (1) {
lenvar++;
if (*var == ':' || *var == 0) {
strncpy(leafname,varcur,lenvar-1);
leafname[lenvar-1] = 0;
char *ctype = strstr(leafname,"/");
if (ctype) { *ctype=0; strcpy(leaftype,ctype+1);}
TLeaf *leaf = 0;
if (*leaftype == 'C') {
leaf = new TLeafC(leafname,leaftype);
} else if (*leaftype == 'B') {
leaf = new TLeafB(leafname,leaftype);
} else if (*leaftype == 'b') {
leaf = new TLeafB(leafname,leaftype);
leaf->SetUnsigned();
} else if (*leaftype == 'S') {
leaf = new TLeafS(leafname,leaftype);
} else if (*leaftype == 's') {
leaf = new TLeafS(leafname,leaftype);
leaf->SetUnsigned();
} else if (*leaftype == 'I') {
leaf = new TLeafI(leafname,leaftype);
} else if (*leaftype == 'i') {
leaf = new TLeafI(leafname,leaftype);
leaf->SetUnsigned();
} else if (*leaftype == 'F') {
leaf = new TLeafF(leafname,leaftype);
} else if (*leaftype == 'D') {
leaf = new TLeafD(leafname,leaftype);
}
if (leaf->IsZombie()) {
delete leaf;
Error("TBranch","Illegal leaf:%s/%s",name,leaflist);
MakeZombie();
return;
}
if (!leaf) {
Error("TLeaf","Illegal data type");
return;
}
leaf->SetBranch(this);
leaf->SetAddress((char*)(fAddress+offset));
leaf->SetOffset(offset);
if (leaf->GetLeafCount()) fEntryOffsetLen = 1000;
if (leaf->InheritsFrom("TLeafC")) fEntryOffsetLen = 1000;
fNleaves++;
fLeaves.Add(leaf);
gTree->GetListOfLeaves()->Add(leaf);
if (*var == 0) break;
varcur = var+1;
offset += leaf->GetLenType()*leaf->GetLen();
lenvar = 0;
}
var++;
}
delete [] leafname;
delete [] leaftype;
//*-*- Create the first basket
fTree = gTree;
fDirectory = fTree->GetDirectory();
fFileName = "";
TBasket *basket = new TBasket(name,fTree->GetName(),this);
fBaskets.AddAt(basket,0);
}
//______________________________________________________________________________
TBranch::~TBranch()
{
//*-*-*-*-*-*Default destructor for a Branch*-*-*-*-*-*-*-*-*-*-*-*
//*-* ===============================
if (fBasketRAM) delete [] fBasketRAM;
if (fBasketEntry) delete [] fBasketEntry;
if (fBasketBytes) delete [] fBasketBytes;
if (fBasketSeek) delete [] fBasketSeek;
fBasketRAM = 0;
fBasketEntry = 0;
fBasketBytes = 0;
fBasketSeek = 0;
fLeaves.Delete();
fBaskets.Delete();
// Warning. Must use FindObject by name instead of fDirectory->GetFile()
// because two branches<may point to the same file and the file
// already deleted in the previous branch
if (fDirectory && fDirectory != fTree->GetDirectory()) {
TFile *file = (TFile*)gROOT->GetListOfFiles()->FindObject(GetFileName());
if (file ) delete file;
}
fTree = 0;
fDirectory = 0;
gBranch = 0;
}
//______________________________________________________________________________
void TBranch::Browse(TBrowser *b)
{
// Browser interface.
if (fNleaves > 1) {
fLeaves.Browse(b);
} else {
// Get the name and strip any extra brackets
// in order to get the full arrays.
TString name = GetName();
Int_t pos = name.First('[');
if (pos!=kNPOS) name.Remove(pos);
GetTree()->Draw(name);
if (gPad) gPad->Update();
}
}
//______________________________________________________________________________
void TBranch::DropBaskets()
{
// Loop on all branch baskets. Drop all except readbasket
Int_t i,j;
TBasket *basket;
// fast algorithm in case of only a few baskets in memory
if (fNBasketRAM < kMaxRAM) {
for (i=0;i<kMaxRAM;i++) {
j = fBasketRAM[i];
if (j < 0) continue;
if (j == fReadBasket || j == fWriteBasket) continue;
basket = (TBasket*)fBaskets.UncheckedAt(j);
if (!basket) continue;
basket->DropBuffers();
GetListOfBaskets()->RemoveAt(j);
delete basket;
fBasketRAM[i] = -1;
fNBasketRAM--;
}
if (fNBasketRAM < 0) {
Error("DropBaskets", "fNBasketRAM =%d",fNBasketRAM);
fNBasketRAM = 0;
}
i = 0;
for (j=0;j<kMaxRAM;j++) {
if (fBasketRAM[j] < 0) continue;
fBasketRAM[i] = fBasketRAM[j];
i++;
}
return;
}
//general algorithm looping on the full baskets table.
Int_t nbaskets = GetListOfBaskets()->GetEntriesFast();
fNBasketRAM = 0;
for (j=0;j<nbaskets-1;j++) {
basket = (TBasket*)fBaskets.UncheckedAt(j);
if (!basket) continue;
if (fNBasketRAM < kMaxRAM) fBasketRAM[fNBasketRAM] = j;
fNBasketRAM++;
if (j == fReadBasket || j == fWriteBasket) continue;
basket->DropBuffers();
GetListOfBaskets()->RemoveAt(j);
delete basket;
fNBasketRAM--;
fBasketRAM[fNBasketRAM] = -1;
if (!fTree->MemoryFull(0)) break;
}
}
//______________________________________________________________________________
Int_t TBranch::Fill()
{
//*-*-*-*-*-*-*-*Loop on all leaves of this branch to fill Basket buffer*-*-*
//*-* =======================================================
if (TestBit(kDoNotProcess)) return 0;
TBasket *basket = GetBasket(fWriteBasket);
if (!basket) return 0;
TBuffer *buf = basket->GetBufferRef();
//*-*- Fill basket buffer
Int_t nsize = 0;
if (buf->IsReading()) {
basket->SetWriteMode();
}
buf->ResetMap();
Int_t lold = buf->Length();
Int_t objectStart = 0;
Int_t last = 0;
Int_t lnew = 0;
Int_t nbytes = 0;
if ( fEntryBuffer!=0 ) {
if ( fEntryBuffer->IsA() == TMessage::Class() ) {
objectStart = 8;
}
if ( fEntryBuffer->TestBit(TBasket::kNotDecompressed) ) {
// The buffer given as input as not been decompressed.
if (basket->GetNevBuf()) {
// If the basket already contains entry we need to close it
// out. (This is because we can only transfer full compressed
// buffer)
WriteBasket(basket);
// And restart from scratch
return Fill();
}
Int_t startpos = fEntryBuffer->Length();
fEntryBuffer->SetBufferOffset(0);
static TBasket toread_fLast;
fEntryBuffer->SetReadMode();
toread_fLast.Streamer(*fEntryBuffer);
fEntryBuffer->SetWriteMode();
last = toread_fLast.GetLast(); // last now contains the decompressed number of bytes.
fEntryBuffer->SetBufferOffset(startpos);
buf->SetBufferOffset(0);
buf->SetBit(TBasket::kNotDecompressed);
basket->Update(lold);
} else {
// We are required to copy starting at the version number (so not
// including the class name.
// See if byte count is here, if not it class still be a newClass
const UInt_t kNewClassTag = 0xFFFFFFFF;
const UInt_t kByteCountMask = 0x40000000; // OR the byte count with this
UInt_t tag, startpos = fEntryBuffer->Length();
fEntryBuffer->SetBufferOffset(objectStart);
*fEntryBuffer >> tag;
if ( tag & kByteCountMask ) {
*fEntryBuffer >> tag;
}
if ( tag == kNewClassTag ) {
char s[80];
fEntryBuffer->ReadString(s, 80);
} else {
fEntryBuffer->SetBufferOffset(objectStart);
}
objectStart = fEntryBuffer->Length();
fEntryBuffer->SetBufferOffset(startpos);
basket->Update(lold, objectStart - fEntryBuffer->GetBufferDisplacement());
}
fEntries++;
fEntryNumber++;
UInt_t len, startpos = fEntryBuffer->Length();
if (startpos > UInt_t(objectStart)) {
// We assume this buffer have just been directly filled
// the current position in the buffer indicates the end of the object!
len = fEntryBuffer->Length() - objectStart;
} else {
// The buffer have been acquired either via TSocket or via
// TBuffer::SetBuffer(newloc,newsize)
// Only the actual size of the memory buffer gives us an hint about where
// the object ends.
len = fEntryBuffer->BufferSize() - objectStart;
}
buf->WriteBuf( fEntryBuffer->Buffer() + objectStart , len );
if ( fEntryBuffer->TestBit(TBasket::kNotDecompressed) ) {
// The original buffer came pre-compressed and thus the buffer Length
// does not really show the really object size
// lnew = nbytes = basket->GetLast();
lnew = nbytes = last;
} else {
lnew = buf->Length();
nbytes = lnew - lold;
}
} else {
basket->Update(lold);
fEntries++;
fEntryNumber++;
FillLeaves(*buf);
lnew = buf->Length();
nbytes = lnew - lold;
}
if (fEntryOffsetLen) {
Int_t nevbuf = basket->GetNevBuf();
nsize = nevbuf*sizeof(Int_t); //total size in bytes of EntryOffset table
} else {
if (!basket->GetNevBufSize()) basket->SetNevBufSize(nbytes);
}
//*-*- Should we create a new basket?
if ( (fSkipZip && (lnew>=TBuffer::kMinimalSize)) // fSkipZip force one entry per buffer
|| (buf->TestBit(TBasket::kNotDecompressed)) // Transfer full compressed buffer only
|| (lnew +2*nsize +nbytes >= fBasketSize) ) {
Int_t nout = basket->WriteBuffer(); // Write buffer
fBasketBytes[fWriteBasket] = basket->GetNbytes();
fBasketSeek[fWriteBasket] = basket->GetSeekKey();
Int_t addbytes = basket->GetObjlen() + basket->GetKeylen() ;
if (fDirectory != 0 && fDirectory != gROOT && fDirectory->IsWritable()) {
delete basket;
fBaskets[fWriteBasket] = 0;
}
fZipBytes += nout;
fTotBytes += addbytes;
fTree->AddTotBytes(addbytes);
fTree->AddZipBytes(nout);
basket = new TBasket(GetName(),fTree->GetName(),this); // create a new basket
fWriteBasket++;
fBaskets.AddAtAndExpand(basket,fWriteBasket);
if (fWriteBasket >= fMaxBaskets) {
//Increase BasketEntry buffer of a minimum of 10 locations
// and a maximum of 50 per cent of current size
Int_t newsize = TMath::Max(10,Int_t(1.5*fMaxBaskets));
fBasketEntry = TStorage::ReAllocInt(fBasketEntry, newsize, fMaxBaskets);
fBasketBytes = TStorage::ReAllocInt(fBasketBytes, newsize, fMaxBaskets);
#ifndef R__LARGEFILE64
fBasketSeek = TStorage::ReAllocInt(fBasketSeek, newsize, fMaxBaskets);
#else
fBasketSeek = (Seek_t*)TStorage::ReAlloc(fBasketSeek,
newsize*sizeof(Seek_t),fMaxBaskets*sizeof(Seek_t));
#endif
fMaxBaskets = newsize;
}
fBasketEntry[fWriteBasket] = fEntryNumber;
fBasketBytes[fWriteBasket] = 0;
fBasketSeek[fWriteBasket] = 0;
}
return nbytes;
}
//______________________________________________________________________________
void TBranch::FillLeaves(TBuffer &b)
{
for (Int_t i=0;i<fNleaves;i++) {
TLeaf *leaf = (TLeaf*)fLeaves.UncheckedAt(i);
leaf->FillBasket(b);
}
}
//______________________________________________________________________________
TBranch *TBranch::FindBranch(const char* searchname)
{
char brname[kMaxLen];
char longsearchname[kMaxLen];
TIter next(GetListOfBranches());
// For branches we allow for one level up to be prefixed to the
// name
strcpy(longsearchname,GetName());
char *dim = (char*)strstr(longsearchname,"[");
if (dim) dim[0]='0';
strcat(longsearchname,".");
strcat(longsearchname,searchname);
TBranch *branch;
while ((branch = (TBranch*)next())) {
strcpy(brname,branch->GetName());
dim = (char*)strstr(brname,"[");
if (dim) dim[0]='0';
if (!strcmp(searchname,brname)) return branch;
if (!strcmp(longsearchname,brname)) return branch;
}
//search in list of friends
return 0;
}
//______________________________________________________________________________
TLeaf *TBranch::FindLeaf(const char* searchname)
{
char leafname[kMaxLen];
char leaftitle[kMaxLen];
char longname[kMaxLen];
char longtitle[kMaxLen];
// For leaves we allow for one level up to be prefixed to the
// name
TIter next (GetListOfLeaves());
TLeaf *leaf;
while ((leaf = (TLeaf*)next())) {
strcpy(leafname,leaf->GetName());
char *dim = (char*)strstr(leafname,"[");
if (dim) dim[0]='0';
if (!strcmp(searchname,leafname)) return leaf;
// The TLeafElement contains the branch name in its name,
// let's use the title....
strcpy(leaftitle,leaf->GetTitle());
dim = (char*)strstr(leaftitle,"[");
if (dim) dim[0]='0';
if (!strcmp(searchname,leaftitle)) return leaf;
TBranch * branch = leaf->GetBranch();
if (branch) {
sprintf(longname,"%s.%s",branch->GetName(),leafname);
char *dim = (char*)strstr(longname,"[");
if (dim) dim[0]='0';
if (!strcmp(searchname,longname)) return leaf;
// The TLeafElement contains the branch name in its name
sprintf(longname,"%s.%s",branch->GetName(),searchname);
if (!strcmp(longname,leafname)) return leaf;
sprintf(longtitle,"%s.%s",branch->GetName(),leaftitle);
dim = (char*)strstr(longtitle,"[");
if (dim) dim[0]='0';
if (!strcmp(searchname,longtitle)) return leaf;
// The following is for the case where the branch is only
// a sub-branch. Since we do not see it through
// TTree::GetListOfBranches, we need to see it indirectly.
// This is the less sturdy part of this search ... it may
// need refining ...
if (strstr(searchname,".")
&& !strcmp(searchname,branch->GetName())) return leaf;
//printf("found leaf3=%s/%s, branch=%s, i=%dn",leaf->GetName(),leaf->GetTitle(),branch->GetName(),i);
}
}
//search in list of friends
return 0;
}
//______________________________________________________________________________
TBasket *TBranch::GetBasket(Int_t basketnumber)
{
//*-*-*-*-*Return pointer to basket basketnumber in this Branch*-*-*-*-*-*
//*-* ====================================================
static Int_t nerrors = 0;
// reference to an existing basket in memory ?
if (basketnumber <0 || basketnumber > fWriteBasket) return 0;
TBasket *basket = (TBasket*)fBaskets.UncheckedAt(basketnumber);
if (basket) return basket;
// must create a new basket
gBranch = this;
// create/decode basket parameters from buffer
TDirectory *cursav = gDirectory;
TFile *file = GetFile(0);
basket = new TBasket();
if (fSkipZip) basket->SetBit(TBasket::kNotDecompressed);
basket->SetBranch(this);
if (fBasketBytes[basketnumber] == 0) {
fBasketBytes[basketnumber] = basket->ReadBasketBytes(fBasketSeek[basketnumber],file);
}
Int_t badread = basket->ReadBasketBuffers(fBasketSeek[basketnumber],fBasketBytes[basketnumber],file);
if (badread || basket->GetSeekKey() != fBasketSeek[basketnumber]) {
cursav->cd();
nerrors++;
if (nerrors > 10) return 0;
if (nerrors == 10) {
printf(" file probably overwritten: stopping reporting error messagesn");
if (fBasketSeek[basketnumber] > 2000000000) {
printf("===>File is more than 2 Gigabytesn");
return 0;
}
if (fBasketSeek[basketnumber] > 1000000000) {
printf("===>Your file is may be bigger than the maximum file size allowed on your systemn");
printf(" Check your AFS maximum file size limit for examplen");
return 0;
}
}
Error("GetBasket","File: %s at byte:%d, branch:%s, entry:%d",file->GetName(),basket->GetSeekKey(),GetName(),fReadEntry);
return 0;
}
cursav->cd();
fBaskets[basketnumber] = basket;
if (fNBasketRAM < kMaxRAM) fBasketRAM[fNBasketRAM] = basketnumber;
fNBasketRAM++;
return basket;
}
//______________________________________________________________________________
Seek_t TBranch::GetBasketSeek(Int_t basketnumber) const
{
//*-*-*-*-*Return address of basket in the file*-*-*-*-*-*
//*-* ====================================
if (basketnumber <0 || basketnumber > fWriteBasket) return 0;
return fBasketSeek[basketnumber];
}
//______________________________________________________________________________
const char *TBranch::GetIconName() const
{
// Return icon name depending on type of branch.
if (IsFolder())
return "TBranchElement-folder";
else
return "TBranchElement-leaf";
}
//______________________________________________________________________________
Int_t TBranch::GetEntry(Int_t entry, Int_t getall)
{
//*-*-*-*-*-*Read all leaves of entry and return total number of bytes*-*-*
//*-* =========================================================
// The input argument entry is the entry serial number in the current tree.
// In case of a TChain, the entry number in the current Tree must be found
// before calling this function. example with TChain *chain;
// Int_t localEntry = chain->LoadTree(entry);
// branch->GetEntry(localEntry);
//
// The function returns the number of bytes read from the input buffer.
// If entry does not exist the function returns 0.
// If an I/O error occurs, the function returns -1.
//
// See IMPORTANT REMARKS in TTree::GetEntry
if (TestBit(kDoNotProcess) && !getall) return 0;
//if (fReadEntry == entry) return 1; //side effects in case user Clear his structures
if (entry < 0 || entry >= fEntryNumber) return 0;
Int_t nbytes;
Int_t first = fBasketEntry[fReadBasket];
Int_t last;
if (fReadBasket == fWriteBasket) last = fEntryNumber - 1;
else last = fBasketEntry[fReadBasket+1] - 1;
//
// Are we still in the same ReadBasket?
if (entry < first || entry > last) {
fReadBasket = TMath::BinarySearch(fWriteBasket+1, fBasketEntry, entry);
first = fBasketEntry[fReadBasket];
}
// We have found the basket containing this entry.
// make sure basket buffers are in memory.
TBasket *basket = (TBasket*)fBaskets.UncheckedAt(fReadBasket);
if (!basket) {
basket = GetBasket(fReadBasket);
if (!basket) return -1;
}
TBuffer *buf = basket->GetBufferRef();
// This test necessary to read very old Root files (NvE)
if (!buf) {
TFile *file = GetFile(0);
basket->ReadBasketBuffers(fBasketSeek[fReadBasket],fBasketBytes[fReadBasket],file);
buf = basket->GetBufferRef();
}
// Set entry offset in buffer and read data from all leaves
buf->ResetMap();
if (!buf->IsReading()) {
basket->SetReadMode();
}
Int_t bufbegin;
Int_t *entryOffset = basket->GetEntryOffset();
if (entryOffset) bufbegin = entryOffset[entry-first];
else bufbegin = basket->GetKeylen() + (entry-first)*basket->GetNevBufSize();
buf->SetBufferOffset(bufbegin);
Int_t *displacement = basket->GetDisplacement();
if (displacement) buf->SetBufferDisplacement(displacement[entry-first]);
else buf->SetBufferDisplacement();
ReadLeaves(*buf);
nbytes = buf->Length() - bufbegin;
fReadEntry = entry;
return nbytes;
}
//______________________________________________________________________________
Int_t TBranch::GetEntryExport(Int_t entry, Int_t /*getall*/,
TClonesArray *list, Int_t nentries)
{
//*-*-*-*-*-*Read all leaves of entry and return total number of bytes*-*-*
//*-* export buffers to real objects in the TClonesArray list.
//*-*
if (TestBit(kDoNotProcess)) return 0;
//if (fReadEntry == entry) return 1; //side effects in case user Clear his structures
if (entry < 0 || entry >= fEntryNumber) return 0;
Int_t nbytes;
Int_t first = fBasketEntry[fReadBasket];
Int_t last;
if (fReadBasket == fWriteBasket) last = fEntryNumber - 1;
else last = fBasketEntry[fReadBasket+1] - 1;
//
// Are we still in the same ReadBasket?
if (entry < first || entry > last) {
fReadBasket = TMath::BinarySearch(fWriteBasket+1, fBasketEntry, entry);
first = fBasketEntry[fReadBasket];
}
// We have found the basket containing this entry.
// make sure basket buffers are in memory.
TBasket *basket = GetBasket(fReadBasket);
if (!basket) return 0;
TBuffer *buf = basket->GetBufferRef();
// Set entry offset in buffer and read data from all leaves
if (!buf->IsReading()) {
basket->SetReadMode();
}
// Int_t bufbegin = basket->GetEntryPointer(entry-first);
Int_t bufbegin;
Int_t *entryOffset = basket->GetEntryOffset();
if (entryOffset) bufbegin = entryOffset[entry-first];
else bufbegin = basket->GetKeylen() + (entry-first)*basket->GetNevBufSize();
buf->SetBufferOffset(bufbegin);
Int_t *displacement = basket->GetDisplacement();
if (displacement) buf->SetBufferDisplacement(displacement[entry-first]);
else buf->SetBufferDisplacement();
TLeaf *leaf = (TLeaf*)fLeaves.UncheckedAt(0);
leaf->ReadBasketExport(*buf,list,nentries);
nbytes = buf->Length() - bufbegin;
fReadEntry = entry;
return nbytes;
}
//______________________________________________________________________________
TFile *TBranch::GetFile(Int_t mode)
{
// Return pointer to the file where branch buffers reside
if (fDirectory) return fDirectory->GetFile();
// check if a file with this name is in the list of Root files
TFile *file = (TFile*)gROOT->GetListOfFiles()->FindObject(fFileName.Data());
if (file) {
fDirectory = (TDirectory*)file;
return file;
}
if (fFileName.Length() == 0) return 0;
TString bFileName = fFileName;
// check if branch file name is absolute or a URL (e.g. /castor/...,
// root://host/...)
char *bname = gSystem->ExpandPathName(fFileName.Data());
if (!gSystem->IsAbsoluteFileName(bname) && !strstr(bname, "://")) {
// if not, get filename where tree header is stored
const char *tfn = fTree->GetCurrentFile()->GetName();
// if this is an absolute path or a URL then prepend this path
// to the branch file name
char *tname = gSystem->ExpandPathName(tfn);
if (gSystem->IsAbsoluteFileName(tname) || strstr(tname, "://")) {
bFileName = gSystem->DirName(tname);
bFileName += "/";
bFileName += fFileName;
}
delete [] tname;
}
delete [] bname;
// Open file (new file if mode = 1)
if (mode) file = TFile::Open(bFileName, "recreate");
else file = TFile::Open(bFileName);
if (file->IsZombie()) {delete file; return 0;}
fDirectory = (TDirectory*)file;
return file;
}
//______________________________________________________________________________
TLeaf *TBranch::GetLeaf(const char *name) const
{
//*-*-*-*-*-*Return pointer to the 1st Leaf named name in thisBranch-*-*-*-*-*
//*-* =======================================================
Int_t i;
for (i=0;i<fNleaves;i++) {
TLeaf *leaf = (TLeaf*)fLeaves.UncheckedAt(i);
if (!strcmp(leaf->GetName(),name)) return leaf;
}
return 0;
}
//______________________________________________________________________________
Int_t TBranch::GetRow(Int_t)
{
//*-*-*-*-*Return all elements of one row unpacked in internal array fValues*-*
//*-* =================================================================
return 1;
}
//______________________________________________________________________________
TBranch *TBranch::GetMother() const
{
// Get top level branch parent of this branch
// A top level branch has its fID negative.
TIter next(fTree->GetListOfBranches());
TBranch *branch;
while ((branch=(TBranch*)next())) {
TBranch *br = branch->GetSubBranch(this);
if (br) {
//if (br == this) return 0;
return branch;
}
}
return 0;
}
//______________________________________________________________________________
TBranch *TBranch::GetSubBranch(const TBranch *br) const
{
// recursively find branch br in the list of branches of this branch.
// return null if br is not in this branch hierarchy.
if (br == this) return (TBranch*)this;
TIter next(((TBranch*)this)->GetListOfBranches());
TBranch *branch;
while ((branch = (TBranch*)next())) {
if (branch == br) return (TBranch*)this;
TBranch *br2 = branch->GetSubBranch(br);
if (br2) return branch;
}
return 0;
}
//______________________________________________________________________________
Stat_t TBranch::GetTotalSize() const
{
// Return total number of bytes in the branch (including current buffer)
// =====================================================================
TBuffer b(TBuffer::kWrite,10000);
TBranch::Class()->WriteBuffer(b,(TBranch*)this);
return fTotBytes + b.Length();
}
//______________________________________________________________________________
Bool_t TBranch::IsAutoDelete() const
{
//*-*-*-*-*Return TRUE if an existing object in a TBranchObject must be deleted
//*-* ==================================================
return TestBit(kAutoDelete);
}
//______________________________________________________________________________
Bool_t TBranch::IsFolder() const
{
//*-*-*-*-*Return TRUE if more than one leaf, FALSE otherwise*-*
//*-* ==================================================
if (fNleaves > 1) return kTRUE;
else return kFALSE;
}
//______________________________________________________________________________
void TBranch::Print(Option_t *) const
{
//*-*-*-*-*-*-*-*-*-*-*-*Print TBranch parameters*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
//*-* ========================
const int kLINEND = 77;
Float_t cx = 1;
int aLength = strlen (GetTitle());
if (strcmp(GetName(),GetTitle()) == 0) aLength = 0;
int len = aLength;
aLength += (aLength / 54 + 1) * 80 + 100;
if (aLength < 200) aLength = 200;
char *bline = new char[aLength];
Double_t totBytes = GetTotalSize();
if (fZipBytes) cx = fTotBytes/fZipBytes;
if (len) sprintf(bline,"*Br%5d :%-9s : %-54s *",fgCount,GetName(),GetTitle());
else sprintf(bline,"*Br%5d :%-9s : %-54s *",fgCount,GetName()," ");
if (strlen(bline) > UInt_t(kLINEND)) {
char *tmp = new char[strlen(bline)+1];
if (len) strcpy(tmp, GetTitle());
sprintf(bline,"*Br%5d :%-9s : ",fgCount,GetName());
int pos = strlen (bline);
int npos = pos;
int beg=0, end;
while (beg < len) {
for (end=beg+1; end < len-1; end ++)
if (tmp[end] == ':') break;
if (npos + end-beg+1 >= 78) {
while (npos < kLINEND) {
bline[pos ++] = ' ';
npos ++;
}
bline[pos ++] = '*';
bline[pos ++] = 'n';
bline[pos ++] = '*';
npos = 1;
for (; npos < 12; npos ++)
bline[pos ++] = ' ';
bline[pos-2] = '|';
}
for (int n = beg; n <= end; n ++)
bline[pos+n-beg] = tmp[n];
pos += end-beg+1;
npos += end-beg+1;
beg = end+1;
}
while (npos < kLINEND) {
bline[pos ++] = ' ';
npos ++;
}
bline[pos ++] = '*';
bline[pos] = '0';
delete[] tmp;
}
Printf(bline);
if (fTotBytes > 2e9) {
Printf("*Entries :%9d : Total Size=%11g bytes File Size = %10d *",Int_t(fEntries),totBytes,Int_t(fZipBytes));
} else {
if (fZipBytes > 0) {
Printf("*Entries :%9d : Total Size=%11d bytes File Size = %10d *",Int_t(fEntries),Int_t(totBytes),Int_t(fZipBytes));
} else {
if (fWriteBasket > 0) {
Printf("*Entries :%9d : Total Size=%11d bytes All baskets in memory *",Int_t(fEntries),Int_t(totBytes));
} else {
Printf("*Entries :%9d : Total Size=%11d bytes One basket in memory *",Int_t(fEntries),Int_t(totBytes));
}
}
}
Printf("*Baskets :%9d : Basket Size=%11d bytes Compression= %6.2f *",fWriteBasket,fBasketSize,cx);
Printf("*............................................................................*");
delete [] bline;
fgCount++;
}
//______________________________________________________________________________
void TBranch::ReadBasket(TBuffer &)
{
//*-*-*-*-*-*-*-*Loop on all leaves of this branch to read Basket buffer*-*-*
//*-* =======================================================
// fLeaves->ReadBasket(basket);
}
//______________________________________________________________________________
void TBranch::ReadLeaves(TBuffer &b)
{
for (Int_t i=0;i<fNleaves;i++) {
TLeaf *leaf = (TLeaf*)fLeaves.UncheckedAt(i);
leaf->ReadBasket(b);
}
}
//______________________________________________________________________________
void TBranch::Reset(Option_t *)
{
//*-*-*-*-*-*-*-*Reset a Branch*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
//*-* ====================
//
// Existing buffers are deleted
// Entries, max and min are reset
//
Int_t nbaskets = fBaskets.GetEntries();
fBaskets.Delete();
fReadBasket = 0;
fReadEntry = -1;
fWriteBasket = 0;
fEntries = 0;
fTotBytes = 0;
fZipBytes = 0;
fEntryNumber = 0;
for (Int_t i=0;i<fMaxBaskets;i++) {
if (fBasketBytes) fBasketBytes[i] = 0;
if (fBasketEntry) fBasketEntry[i] = 0;
if (fBasketSeek) fBasketSeek[i] = 0;
}
if (nbaskets) {
TBasket *basket = new TBasket(GetName(),fTree->GetName(),this);
fBaskets.AddAt(basket,0);
}
}
//______________________________________________________________________________
void TBranch::SetAddress(void *add)
{
//*-*-*-*-*-*-*-*Set address of this branch*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
//*-* ====================
//
if (TestBit(kDoNotProcess)) return;
fReadEntry = -1;
fAddress = (char*)add;
Int_t i,offset;
for (i=0;i<fNleaves;i++) {
TLeaf *leaf = (TLeaf*)fLeaves.UncheckedAt(i);
offset = leaf->GetOffset();
if (TestBit(kIsClone)) offset = 0;
leaf->SetAddress(fAddress+offset);
}
}
//______________________________________________________________________________
void TBranch::SetAutoDelete(Bool_t autodel)
{
//*-*-*-*-*-*-*-*Set the AutoDelete bit
//*-* ====================
// this bit is used by TBranchObject::ReadBasket to decide if an object
// referenced by a TBranchObject must be deleted or not before reading
// a new entry
// if autodel is kTRUE, this existing object will be deleted, a new object
// created by the default constructor, then object->Streamer
// if autodel is kFALSE, the existing object is not deleted. Root assumes
// that the user is taking care of deleting any internal object or array
// This can be done in Streamer itself.
if (autodel) SetBit(kAutoDelete,1);
else SetBit(kAutoDelete,0);
}
//______________________________________________________________________________
void TBranch::SetBasketSize(Int_t buffsize)
{
// Set the basket size
// The function makes sure that the basket size is greater than fEntryOffsetlen
if (buffsize < 100+fEntryOffsetLen) buffsize = 100+fEntryOffsetLen;
fBasketSize = buffsize;
}
//______________________________________________________________________________
void TBranch::SetBufferAddress(TBuffer *buf)
{
// Set address of this branch directly from a TBuffer to avoid streaming.
// Check this is possible
if ( (fNleaves != 1)
|| (strcmp("TLeafObject",fLeaves.UncheckedAt(0)->ClassName())!=0) ) {
Error("TBranch::SetAddress","Filling from a TBuffer can only be done with a not split object branch. Request ignored.");
} else {
fReadEntry = -1;
fEntryBuffer = buf;
}
}
//______________________________________________________________________________
void TBranch::SetCompressionLevel(Int_t level)
{
//*-*-*-*-*-*-*-*Set the branch/subbranches compression level
//*-* ============================================
fCompress = level;
Int_t nb = fBranches.GetEntriesFast();
for (Int_t i=0;i<nb;i++) {
TBranch *branch = (TBranch*)fBranches.UncheckedAt(i);
branch->SetCompressionLevel(level);
}
}
//______________________________________________________________________________
void TBranch::SetFile(TFile *file)
{
// Set file where this branch writes/reads its buffers.
// By default the branch buffers reside in the file where the
// Tree was created.
// If the file name where the tree was created is an absolute
// path name or an URL (e.g. /castor/... or root://host/...)
// and if the fname is not an absolute path name or an URL then
// the path of the tree file is prepended to fname to make the
// branch file relative to the tree file. In this case one can
// move the tree + all branch files to a different location in
// the file system and still access the branch files.
// The ROOT file will be connected only when necessary.
// If called by TBranch::Fill (via TBasket::WriteFile), the file
// will be created with the option "recreate".
// If called by TBranch::GetEntry (via TBranch::GetBasket), the file
// will be opened in read mode.
// To open a file in "update" mode or with a certain compression
// level, use TBranch::SetFile(TFile *file).
if (file == 0) file = fTree->GetCurrentFile();
fDirectory = (TDirectory*)file;
if (file == fTree->GetCurrentFile()) fFileName = "";
else fFileName = file->GetName();
//apply to all existing baskets
TIter nextb(GetListOfBaskets());
TBasket *basket;
while ((basket = (TBasket*)nextb())) {
basket->SetParent(file);
}
//apply to sub-branches as well
TIter next(GetListOfBranches());
TBranch *branch;
while ((branch = (TBranch*)next())) {
branch->SetFile(file);
}
}
//______________________________________________________________________________
void TBranch::SetFile(const char *fname)
{
// Set file where this branch writes/reads its buffers.
// By default the branch buffers reside in the file where the
// Tree was created.
// If the file name where the tree was created is an absolute
// path name or an URL (e.g. /castor/... or root://host/...)
// and if the fname is not an absolute path name or an URL then
// the path of the tree file is prepended to fname to make the
// branch file relative to the tree file. In this case one can
// move the tree + all branch files to a different location in
// the file system and still access the branch files.
// The ROOT file will be connected only when necessary.
// If called by TBranch::Fill (via TBasket::WriteFile), the file
// will be created with the option "recreate".
// If called by TBranch::GetEntry (via TBranch::GetBasket), the file
// will be opened in read mode.
// To open a file in "update" mode or with a certain compression
// level, use TBranch::SetFile(TFile *file).
fFileName = fname;
fDirectory = 0;
//apply to sub-branches as well
TIter next(GetListOfBranches());
TBranch *branch;
while ((branch = (TBranch*)next())) {
branch->SetFile(fname);
}
}
//_______________________________________________________________________
void TBranch::Streamer(TBuffer &b)
{
//*-*-*-*-*-*-*-*-*Stream a class object*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
//*-* =========================================
if (b.IsReading()) {
UInt_t R__s, R__c;
fTree = gTree;
fAddress = 0;
gROOT->SetReadingObject(kTRUE);
Version_t v = b.ReadVersion(&R__s, &R__c);
if (v > 5) {
TBranch::Class()->ReadBuffer(b, this, v, R__s, R__c);
fDirectory = gDirectory;
if (fFileName.Length() != 0) fDirectory = 0;
TIter next(GetListOfLeaves());
TLeaf *leaf;
while ((leaf=(TLeaf*)next())) {
leaf->SetBranch(this);
}
fNleaves = fLeaves.GetEntriesFast();
if (!fSplitLevel && fBranches.GetEntriesFast()) fSplitLevel = 1;
gROOT->SetReadingObject(kFALSE);
return;
}
//====process old versions before automatic schema evolution
TNamed::Streamer(b);
b >> fCompress;
b >> fBasketSize;
b >> fEntryOffsetLen;
b >> fMaxBaskets;
b >> fWriteBasket;
b >> fEntryNumber;
b >> fEntries;
b >> fTotBytes;
b >> fZipBytes;
b >> fOffset;
fBranches.Streamer(b);
gBranch = this; // must be set again, was changed in previous statement
fLeaves.Streamer(b);
fBaskets.Streamer(b);
fNleaves = fLeaves.GetEntriesFast();
fBasketEntry = new Int_t[fMaxBaskets];
Int_t n = b.ReadArray(fBasketEntry);
fBasketBytes = new Int_t[fMaxBaskets];
if (v > 4) {
n = b.ReadArray(fBasketBytes);
} else {
for (n=0;n<fMaxBaskets;n++) fBasketBytes[n] = 0;
}
if (v < 2) {
fBasketSeek = new Seek_t[fMaxBaskets];
for (n=0;n<fWriteBasket;n++) {
fBasketSeek[n] = GetBasket(n)->GetSeekKey();
}
} else {
fBasketSeek = new Seek_t[fMaxBaskets];
n = b.ReadArray(fBasketSeek);
}
fDirectory = gDirectory;
if (v > 2) {
fFileName.Streamer(b);
if (fFileName.Length() != 0) fDirectory = 0;
}
if (v < 4) SetAutoDelete(kTRUE);
if (!fSplitLevel && fBranches.GetEntriesFast()) fSplitLevel = 1;
gROOT->SetReadingObject(kFALSE);
b.CheckByteCount(R__s, R__c, TBranch::IsA());
//====end of old versions
} else {
TBranch::Class()->WriteBuffer(b,this);
}
}
//_______________________________________________________________________
void TBranch::WriteBasket(TBasket* basket)
{
//*-*-*-*-*-*-*-*-*Write the current basket to disk*-*-*-*-*
//*-* =========================================
Int_t nout = basket->WriteBuffer(); // Write buffer
fBasketBytes[fWriteBasket] = basket->GetNbytes();
fBasketSeek[fWriteBasket] = basket->GetSeekKey();
Int_t addbytes = basket->GetObjlen() + basket->GetKeylen() ;
if (fDirectory != gROOT && fDirectory->IsWritable()) {
delete basket;
fBaskets[fWriteBasket] = 0;
}
fZipBytes += nout;
fTotBytes += addbytes;
fTree->AddTotBytes(addbytes);
fTree->AddZipBytes(nout);
basket = new TBasket(GetName(),fTree->GetName(),this); // create a new basket
fWriteBasket++;
fBaskets.AddAtAndExpand(basket,fWriteBasket);
if (fWriteBasket >= fMaxBaskets) {
//Increase BasketEntry buffer of a minimum of 10 locations
// and a maximum of 50 per cent of current size
Int_t newsize = TMath::Max(10,Int_t(1.5*fMaxBaskets));
fBasketEntry = TStorage::ReAllocInt(fBasketEntry, newsize, fMaxBaskets);
fBasketBytes = TStorage::ReAllocInt(fBasketBytes, newsize, fMaxBaskets);
#ifndef R__LARGEFILE64
fBasketSeek = TStorage::ReAllocInt(fBasketSeek, newsize, fMaxBaskets);
#else
fBasketSeek = (Seek_t*)TStorage::ReAlloc(fBasketSeek,
newsize*sizeof(Seek_t),fMaxBaskets*sizeof(Seek_t));
#endif
fMaxBaskets = newsize;
}
fBasketEntry[fWriteBasket] = fEntryNumber;
fBasketBytes[fWriteBasket] = 0;
fBasketSeek[fWriteBasket] = 0;
}
ROOT page - Class index - Top of the page
This page has been automatically generated. If you have any comments or suggestions about the page layout send a mail to ROOT support, or contact the developers with any questions or problems regarding ROOT.