Manages buffers for branches of a Tree.
See picture in TTree.
Public Types | |
enum class | EIOBits : Char_t { kGenerateOffsetMap = BIT(0) , kSupported = kGenerateOffsetMap } |
enum class | EUnsupportedIOBits : Char_t { kUnsupported = 0 } |
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) } |
Public Member Functions | |
TBasket () | |
Default constructor. | |
TBasket (const char *name, const char *title, TBranch *branch) | |
Basket normal constructor, used during writing. | |
TBasket (TDirectory *motherDir) | |
Constructor used during reading. | |
virtual | ~TBasket () |
Basket destructor. | |
virtual void | AdjustSize (Int_t newsize) |
Increase the size of the current fBuffer up to newsize. | |
Long64_t | CopyTo (TFile *to) |
Copy the basket of this branch onto the file to. | |
virtual void | DeleteEntryOffset () |
Delete fEntryOffset array. | |
virtual Int_t | DropBuffers () |
Drop buffers of this basket if it is not the current basket. | |
TBranch * | GetBranch () const |
Int_t | GetBufferSize () const |
Int_t * | GetDisplacement () const |
Int_t * | GetEntryOffset () |
Int_t | GetEntryPointer (Int_t Entry) |
Get pointer to buffer for internal entry. | |
Int_t | GetLast () const |
Int_t | GetNevBuf () const |
Int_t | GetNevBufSize () const |
Bool_t | GetResetAllocationCount () const |
Int_t | LoadBasketBuffers (Long64_t pos, Int_t len, TFile *file, TTree *tree=0) |
Load basket buffers in memory without unziping. | |
virtual void | MoveEntries (Int_t dentries) |
Remove the first dentries of this basket, moving entries at dentries to the start of the buffer. | |
virtual void | PrepareBasket (Long64_t) |
Int_t | ReadBasketBuffers (Long64_t pos, Int_t len, TFile *file) |
Read basket buffers in memory and cleanup. | |
Int_t | ReadBasketBytes (Long64_t pos, TFile *file) |
Read basket buffers in memory and cleanup. | |
void | SetBranch (TBranch *branch) |
void | SetNevBufSize (Int_t n) |
virtual void | SetReadMode () |
Set read mode of basket. | |
virtual void | SetWriteMode () |
Set write mode of basket. | |
void | Update (Int_t newlast) |
virtual void | Update (Int_t newlast, Int_t skipped) |
Update basket header and EntryOffset table. | |
virtual Int_t | WriteBuffer () |
Write buffer of this basket on the current file. | |
virtual void | WriteReset () |
Reset the write basket to the starting state. | |
Public Member Functions inherited from TKey | |
TKey () | |
TKey default constructor. | |
TKey (const char *name, const char *title, const TClass *cl, Int_t nbytes, TDirectory *motherDir) | |
Create a TKey object with the specified name, title for the given class. | |
TKey (const TObject *obj, const char *name, Int_t bufsize, TDirectory *motherDir) | |
Create a TKey object for a TObject* and fill output buffer. | |
TKey (const TString &name, const TString &title, const TClass *cl, Int_t nbytes, TDirectory *motherDir) | |
Create a TKey object with the specified name, title for the given class. | |
TKey (const void *obj, const TClass *cl, const char *name, Int_t bufsize, TDirectory *motherDir) | |
Create a TKey object for any object obj of class cl d and fill output buffer. | |
TKey (Long64_t pointer, Int_t nbytes, TDirectory *motherDir=0) | |
Create a TKey object to read keys. | |
TKey (TDirectory *motherDir) | |
TKey default constructor. | |
TKey (TDirectory *motherDir, const TKey &orig, UShort_t pidOffset) | |
Copy a TKey from its original directory to the new 'motherDir'. | |
virtual | ~TKey () |
TKey default destructor. | |
virtual void | Browse (TBrowser *b) |
Read object from disk and call its Browse() method. | |
virtual void | Delete (Option_t *option="") |
Delete an object from the file. | |
virtual void | DeleteBuffer () |
Delete key buffer(s). | |
virtual void | FillBuffer (char *&buffer) |
Encode key header into output buffer. | |
virtual char * | GetBuffer () const |
TBuffer * | GetBufferRef () const |
virtual const char * | GetClassName () const |
Short_t | GetCycle () const |
Return cycle number associated to this key. | |
const TDatime & | GetDatime () const |
TFile * | GetFile () const |
Returns file to which key belong. | |
virtual const char * | GetIconName () const |
Title can keep 32x32 xpm thumbnail/icon of the parent object. | |
Short_t | GetKeep () const |
Returns the "KEEP" status. | |
Int_t | GetKeylen () const |
TDirectory * | GetMotherDir () const |
Int_t | GetNbytes () const |
Int_t | GetObjlen () const |
virtual Long64_t | GetSeekKey () const |
virtual Long64_t | GetSeekPdir () const |
virtual const char * | GetTitle () const |
Returns title (title can contain 32x32 xpm thumbnail/icon). | |
Int_t | GetVersion () const |
virtual void | IncrementPidOffset (UShort_t offset) |
Increment fPidOffset by 'offset'. | |
Bool_t | IsFolder () const |
Check if object referenced by the key is a folder. | |
virtual void | Keep () |
Set the "KEEP" status. | |
virtual void | ls (Bool_t current) const |
List Key contents. | |
virtual void | ls (Option_t *option="") const |
List Key contents. | |
virtual void | Print (Option_t *option="") const |
Print key contents. | |
virtual Int_t | Read (TObject *obj) |
To read an object from the file. | |
virtual void | ReadBuffer (char *&buffer) |
Decode input buffer. | |
virtual Bool_t | ReadFile () |
Read the key structure from the file. | |
void | ReadKeyBuffer (char *&buffer) |
Decode input buffer. | |
virtual TObject * | ReadObj () |
To read a TObject* from the file. | |
template<typename T > | |
T * | ReadObject () |
To read an object (non deriving from TObject) from the file. | |
virtual void * | ReadObjectAny (const TClass *expectedClass) |
To read an object (non deriving from TObject) from the file. | |
virtual TObject * | ReadObjWithBuffer (char *bufferRead) |
To read a TObject* from bufferRead. | |
virtual void | SetBuffer () |
void | SetMotherDir (TDirectory *dir) |
virtual void | SetParent (const TObject *parent) |
Set parent in key buffer. | |
virtual Int_t | Sizeof () const |
Return the size in bytes of the key header structure. | |
virtual Int_t | WriteFile (Int_t cycle=1, TFile *f=0) |
Write the encoded object supported by this key. | |
Public Member Functions inherited from TNamed | |
TNamed () | |
TNamed (const char *name, const char *title) | |
TNamed (const TNamed &named) | |
TNamed copy ctor. | |
TNamed (const TString &name, const TString &title) | |
virtual | ~TNamed () |
TNamed destructor. | |
virtual void | Clear (Option_t *option="") |
Set name and title to empty strings (""). | |
virtual TObject * | Clone (const char *newname="") const |
Make a clone of an object using the Streamer facility. | |
virtual Int_t | Compare (const TObject *obj) const |
Compare two TNamed objects. | |
virtual void | Copy (TObject &named) const |
Copy this to obj. | |
virtual const char * | GetName () const |
Returns name of object. | |
virtual ULong_t | Hash () const |
Return hash value for this object. | |
virtual Bool_t | IsSortable () const |
TNamed & | operator= (const TNamed &rhs) |
TNamed assignment operator. | |
virtual void | SetName (const char *name) |
Set the name of the TNamed. | |
virtual void | SetNameTitle (const char *name, const char *title) |
Set all the TNamed parameters (name and title). | |
virtual void | SetTitle (const char *title="") |
Set the title of the TNamed. | |
Public Member Functions inherited from TObject | |
TObject () | |
TObject constructor. | |
TObject (const TObject &object) | |
TObject copy ctor. | |
virtual | ~TObject () |
TObject destructor. | |
void | AbstractMethod (const char *method) const |
Use this method to implement an "abstract" method that you don't want to leave purely abstract. | |
virtual void | AppendPad (Option_t *option="") |
Append graphics object to current pad. | |
ULong_t | CheckedHash () |
Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. | |
virtual const char * | ClassName () const |
Returns name of class to which the object belongs. | |
virtual Int_t | DistancetoPrimitive (Int_t px, Int_t py) |
Computes distance from point (px,py) to the object. | |
virtual void | Draw (Option_t *option="") |
Default Draw method for all objects. | |
virtual void | DrawClass () const |
Draw class inheritance tree of the class to which this object belongs. | |
virtual TObject * | DrawClone (Option_t *option="") const |
Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad) . | |
virtual void | Dump () const |
Dump contents of object on stdout. | |
virtual void | Error (const char *method, const char *msgfmt,...) const |
Issue error message. | |
virtual void | Execute (const char *method, const char *params, Int_t *error=0) |
Execute method on this object with the given parameter string, e.g. | |
virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=0) |
Execute method on this object with parameters stored in the TObjArray. | |
virtual void | ExecuteEvent (Int_t event, Int_t px, Int_t py) |
Execute action corresponding to an event at (px,py). | |
virtual void | Fatal (const char *method, const char *msgfmt,...) const |
Issue fatal error message. | |
virtual TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. | |
virtual Option_t * | GetDrawOption () const |
Get option used by the graphics system to draw this object. | |
virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
Returns string containing info about the object at position (px,py). | |
virtual Option_t * | GetOption () const |
virtual UInt_t | GetUniqueID () const |
Return the unique object id. | |
virtual Bool_t | HandleTimer (TTimer *timer) |
Execute action in response of a timer timing out. | |
Bool_t | HasInconsistentHash () const |
Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. | |
virtual void | Info (const char *method, const char *msgfmt,...) const |
Issue info message. | |
virtual Bool_t | InheritsFrom (const char *classname) const |
Returns kTRUE if object inherits from class "classname". | |
virtual Bool_t | InheritsFrom (const TClass *cl) const |
Returns kTRUE if object inherits from TClass cl. | |
virtual void | Inspect () const |
Dump contents of this object in a graphics canvas. | |
void | InvertBit (UInt_t f) |
virtual Bool_t | IsEqual (const TObject *obj) const |
Default equal comparison (objects are equal if they have the same address in memory). | |
R__ALWAYS_INLINE Bool_t | IsOnHeap () const |
R__ALWAYS_INLINE Bool_t | IsZombie () const |
void | MayNotUse (const char *method) const |
Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). | |
virtual Bool_t | Notify () |
This method must be overridden to handle object notification. | |
void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
Use this method to declare a method obsolete. | |
void | operator delete (void *ptr) |
Operator delete. | |
void | operator delete[] (void *ptr) |
Operator delete []. | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *vp) |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, void *vp) |
TObject & | operator= (const TObject &rhs) |
TObject assignment operator. | |
virtual void | Paint (Option_t *option="") |
This method must be overridden if a class wants to paint itself. | |
virtual void | Pop () |
Pop on object drawn in a pad to the top of the display list. | |
virtual void | RecursiveRemove (TObject *obj) |
Recursively remove this object from a list. | |
void | ResetBit (UInt_t f) |
virtual void | SaveAs (const char *filename="", Option_t *option="") const |
Save this object in the file specified by filename. | |
virtual void | SavePrimitive (std::ostream &out, Option_t *option="") |
Save a primitive as a C++ statement(s) on output stream "out". | |
void | SetBit (UInt_t f) |
void | SetBit (UInt_t f, Bool_t set) |
Set or unset the user status bits as specified in f. | |
virtual void | SetDrawOption (Option_t *option="") |
Set drawing option for object. | |
virtual void | SetUniqueID (UInt_t uid) |
Set the unique object id. | |
virtual void | SysError (const char *method, const char *msgfmt,...) const |
Issue system error message. | |
R__ALWAYS_INLINE Bool_t | TestBit (UInt_t f) const |
Int_t | TestBits (UInt_t f) const |
virtual void | UseCurrentStyle () |
Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. | |
virtual void | Warning (const char *method, const char *msgfmt,...) const |
Issue warning message. | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) |
Write this object to the current directory. | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const |
Write this object to the current directory. | |
Static Public Attributes | |
static constexpr int | kIOBitCount = 1 |
Protected Member Functions | |
virtual void | ReadResetBuffer (Int_t basketnumber) |
Reset the read basket TBuffer memory allocation if needed. | |
Protected Member Functions inherited from TKey | |
void | Build (TDirectory *motherDir, const char *classname, Long64_t filepos) |
Method used in all TKey constructor to initialize basic data fields. | |
virtual void | Create (Int_t nbytes, TFile *f=0) |
Create a TKey object of specified size. | |
virtual Int_t | Read (const char *name) |
Read contents of object with specified name from the current directory. | |
void | Reset () |
Reset the key as it had not been 'filled' yet. | |
virtual Int_t | WriteFileKeepBuffer (TFile *f=0) |
Write the encoded object supported by this key. | |
Protected Member Functions inherited from TObject | |
virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
Interface to ErrorHandler (protected). | |
void | MakeZombie () |
Protected Attributes | |
TBranch * | fBranch {nullptr} |
Pointer to the basket support branch. | |
Int_t | fBufferSize {0} |
fBuffer length in bytes | |
TBuffer * | fCompressedBufferRef {nullptr} |
! Compressed buffer. | |
Int_t * | fDisplacement {nullptr} |
![fNevBuf] Displacement of entries in fBuffer(TKey) | |
Int_t * | fEntryOffset {nullptr} |
[fNevBuf] Offset of entries in fBuffer(TKey); generated at runtime. | |
Bool_t | fHeaderOnly {kFALSE} |
True when only the basket header must be read/written. | |
UChar_t | fIOBits {0} |
!IO feature flags. Serialized in custom portion of streamer to avoid forward compat issues unless needed. | |
Int_t | fLast {0} |
Pointer to last used byte in basket. | |
Int_t | fLastWriteBufferSize [3] = {0,0,0} |
! Size of the buffer last three buffers we wrote it to disk | |
Int_t | fNevBuf {0} |
Number of entries in basket. | |
Int_t | fNevBufSize {0} |
Length in Int_t of fEntryOffset OR fixed length of each entry if fEntryOffset is null! | |
UChar_t | fNextBufferSizeRecord {0} |
! Index into fLastWriteBufferSize of the last buffer written to disk | |
Bool_t | fOwnsCompressedBuffer {kFALSE} |
! Whether or not we own the compressed buffer. | |
Bool_t | fReadEntryOffset {kFALSE} |
!Set to true if offset array was read from a file. | |
Bool_t | fResetAllocation {false} |
! True if last reset re-allocated the memory | |
Protected Attributes inherited from TKey | |
char * | fBuffer |
Object buffer. | |
TBuffer * | fBufferRef |
Pointer to the TBuffer object. | |
TString | fClassName |
Object Class name. | |
Short_t | fCycle |
Cycle number. | |
TDatime | fDatime |
Date/Time of insertion in file. | |
Short_t | fKeylen |
Number of bytes for the key itself. | |
Int_t | fLeft |
Number of bytes left in current segment. | |
TDirectory * | fMotherDir |
!pointer to mother directory | |
Int_t | fNbytes |
Number of bytes for the object on file. | |
Int_t | fObjlen |
Length of uncompressed object in bytes. | |
UShort_t | fPidOffset |
!Offset to be added to the pid index in this key/buffer. This is actually saved in the high bits of fSeekPdir | |
Long64_t | fSeekKey |
Location of object on file. | |
Long64_t | fSeekPdir |
Location of parent directory on file. | |
Int_t | fVersion |
Key version identifier. | |
Protected Attributes inherited from TNamed | |
TString | fName |
TString | fTitle |
Private Member Functions | |
TBasket (const TBasket &) | |
TBasket objects are not copiable. | |
void | AdoptBuffer (TBuffer *user_buffer) |
Adopt a buffer from an external entity. | |
Bool_t | CanGenerateOffsetArray () |
Determine whether we can generate the offset array when this branch is read. | |
void | DisownBuffer () |
Disown all references to the internal buffer - some other object likely now owns it. | |
Int_t * | GetCalculatedEntryOffset () |
Calculates the entry offset array, if possible. | |
void | InitializeCompressedBuffer (Int_t len, TFile *file) |
Initialize the compressed buffer; either from the TTree or create a local one. | |
TBasket & | operator= (const TBasket &) |
TBasket objects are not copiable. | |
Int_t | ReadBasketBuffersUncompressedCase () |
By-passing buffer unzipping has been requested and is possible (only 1 entry in this basket). | |
Int_t | ReadBasketBuffersUnzip (char *, Int_t, Bool_t, TFile *) |
We always create the TBuffer for the basket but it hold the buffer from the cache. | |
void | ResetEntryOffset () |
Friends | |
class | TBranch |
Additional Inherited Members | |
Static Public Member Functions inherited from TObject | |
static Long_t | GetDtorOnly () |
Return destructor only flag. | |
static Bool_t | GetObjectStat () |
Get status of object stat flag. | |
static void | SetDtorOnly (void *obj) |
Set destructor only flag. | |
static void | SetObjectStat (Bool_t stat) |
Turn on/off tracking of objects in the TObjectTable. | |
Protected Types inherited from TObject | |
enum | { kOnlyPrepStep = BIT(3) } |
#include <TBasket.h>
|
strong |
|
strong |
TBasket::TBasket | ( | ) |
Default constructor.
Definition at line 47 of file TBasket.cxx.
TBasket::TBasket | ( | TDirectory * | motherDir | ) |
Constructor used during reading.
Definition at line 54 of file TBasket.cxx.
TBasket::TBasket | ( | const char * | name, |
const char * | title, | ||
TBranch * | branch | ||
) |
Basket normal constructor, used during writing.
Definition at line 61 of file TBasket.cxx.
|
virtual |
Basket destructor.
Definition at line 104 of file TBasket.cxx.
Increase the size of the current fBuffer up to newsize.
Definition at line 127 of file TBasket.cxx.
Adopt a buffer from an external entity.
Definition at line 721 of file TBasket.cxx.
|
private |
Determine whether we can generate the offset array when this branch is read.
Definition at line 218 of file TBasket.cxx.
Copy the basket of this branch onto the file to.
Definition at line 146 of file TBasket.cxx.
|
virtual |
Delete fEntryOffset array.
Definition at line 164 of file TBasket.cxx.
|
private |
Disown all references to the internal buffer - some other object likely now owns it.
This TBasket is now useless and invalid until it is told to adopt a buffer.
Definition at line 713 of file TBasket.cxx.
|
virtual |
Drop buffers of this basket if it is not the current basket.
Definition at line 173 of file TBasket.cxx.
|
private |
Calculates the entry offset array, if possible.
Result is cached, meaning that this should only be invoked once per basket.
Definition at line 195 of file TBasket.cxx.
Get pointer to buffer for internal entry.
Definition at line 230 of file TBasket.cxx.
Initialize the compressed buffer; either from the TTree or create a local one.
Definition at line 432 of file TBasket.cxx.
Load basket buffers in memory without unziping.
This function is called by TTreeCloner. The function returns 0 in case of success, 1 in case of error.
Definition at line 245 of file TBasket.cxx.
Remove the first dentries of this basket, moving entries at dentries to the start of the buffer.
Definition at line 310 of file TBasket.cxx.
Reimplemented in TBasketSQL.
Read basket buffers in memory and cleanup.
Read a basket buffer. Check if buffers of previous ReadBasket should not be dropped. Remember, we keep buffers in memory up to fMaxVirtualSize. The function returns 0 in case of success, 1 in case of error This function was modified with the addition of the parallel unzipping, it will try to get the unzipped file from the cache receiving only a pointer to that buffer (so we shall not delete that pointer), although we get a new buffer in case it's not found in the cache. There is a lot of code duplication but it was necessary to assure the expected behavior when there is no cache.
Definition at line 464 of file TBasket.cxx.
|
private |
By-passing buffer unzipping has been requested and is possible (only 1 entry in this basket).
Definition at line 358 of file TBasket.cxx.
|
private |
We always create the TBuffer for the basket but it hold the buffer from the cache.
Definition at line 380 of file TBasket.cxx.
Read basket buffers in memory and cleanup.
Read first bytes of a logical record starting at position pos return record length (first 4 bytes of record).
Definition at line 698 of file TBasket.cxx.
Reset the read basket TBuffer memory allocation if needed.
This allows to reduce the number of memory allocation while avoiding to always use the maximum size.
Definition at line 733 of file TBasket.cxx.
|
private |
Definition at line 441 of file TBasket.cxx.
|
virtual |
Set read mode of basket.
Definition at line 925 of file TBasket.cxx.
|
virtual |
Set write mode of basket.
Definition at line 934 of file TBasket.cxx.
Update basket header and EntryOffset table.
Reimplemented in TBasketSQL.
Definition at line 1088 of file TBasket.cxx.
|
virtual |
Write buffer of this basket on the current file.
The function returns the number of bytes committed to the memory. If a write error occurs, the number of bytes returned is -1. If no data are written, the number of bytes returned is 0.
Definition at line 1131 of file TBasket.cxx.
|
virtual |
Reset the write basket to the starting state.
i.e. as it was after calling the constructor (and potentially attaching a TBuffer.) Reduce memory used by fEntryOffset and the TBuffer if needed ..
Definition at line 806 of file TBasket.cxx.
|
protected |
|
protected |
|
protected |
|
protected |
![fNevBuf] Displacement of entries in fBuffer(TKey)
|
protected |
[fNevBuf] Offset of entries in fBuffer(TKey); generated at runtime.
Special value of -1
indicates that the offset generation MUST be performed on first read.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |