Logo ROOT   6.15/01
Reference Guide
TFile.h
Go to the documentation of this file.
1 // @(#)root/io:$Id$
2 // Author: Rene Brun 28/11/94
3 
4 /*************************************************************************
5  * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
6  * All rights reserved. *
7  * *
8  * For the licensing terms see $ROOTSYS/LICENSE. *
9  * For the list of contributors see $ROOTSYS/README/CREDITS. *
10  *************************************************************************/
11 
12 #ifndef ROOT_TFile
13 #define ROOT_TFile
14 
15 
16 //////////////////////////////////////////////////////////////////////////
17 // //
18 // TFile //
19 // //
20 // ROOT file. //
21 // //
22 //////////////////////////////////////////////////////////////////////////
23 
24 #include <atomic>
25 
26 #include "Compression.h"
27 #include "TDirectoryFile.h"
28 #include "TMap.h"
29 #include "TUrl.h"
31 
32 #ifdef R__USE_IMT
33 #include "ROOT/TRWSpinLock.hxx"
34 #include <mutex>
35 #endif
36 
37 
38 class TFree;
39 class TArrayC;
40 class TArchiveFile;
41 class TFileOpenHandle;
42 class TFileCacheRead;
43 class TFileCacheWrite;
44 class TProcessID;
45 class TStopwatch;
46 class TFilePrefetch;
47 
48 class TFile : public TDirectoryFile {
49  friend class TDirectoryFile;
50  friend class TFilePrefetch;
51 // TODO: We need to make sure only one TBasket is being written at a time
52 // if we are writing multiple baskets in parallel.
53 #ifdef R__USE_IMT
54  friend class TBasket;
55 #endif
56 
57 public:
58  /// Asynchronous open request status
61  /// Open timeout constants
62  enum EOpenTimeOut { kInstantTimeout = 0, kEternalTimeout = 999999999 };
63 
64  /// TTreeCache flushing semantics
66 
67 protected:
68  Double_t fSumBuffer; ///<Sum of buffer sizes of objects written so far
69  Double_t fSum2Buffer; ///<Sum of squares of buffer sizes of objects written so far
70  Long64_t fBytesWrite; ///<Number of bytes written to this file
71  Long64_t fBytesRead; ///<Number of bytes read from this file
72  Long64_t fBytesReadExtra; ///<Number of extra bytes (overhead) read by the readahead buffer
73  Long64_t fBEGIN; ///<First used byte in file
74  Long64_t fEND; ///<Last used byte in file
75  Long64_t fSeekFree; ///<Location on disk of free segments structure
76  Long64_t fSeekInfo; ///<Location on disk of StreamerInfo record
77  Int_t fD; ///<File descriptor
78  Int_t fVersion; ///<File format version
79  Int_t fCompress; ///<Compression level and algorithm
80  Int_t fNbytesFree; ///<Number of bytes for free segments structure
81  Int_t fNbytesInfo; ///<Number of bytes for StreamerInfo record
82  Int_t fWritten; ///<Number of objects written so far
83  Int_t fNProcessIDs; ///<Number of TProcessID written to this file
84  Int_t fReadCalls; ///<Number of read calls ( not counting the cache calls )
85  TString fRealName; ///<Effective real file name (not original url)
86  TString fOption; ///<File options
87  Char_t fUnits; ///<Number of bytes for file pointers
88  TList *fFree; ///<Free segments linked list table
89  TArrayC *fClassIndex; ///<!Index of TStreamerInfo classes written to this file
90  TObjArray *fProcessIDs; ///<!Array of pointers to TProcessIDs
91  Long64_t fOffset; ///<!Seek offset cache
92  TArchiveFile *fArchive; ///<!Archive file from which we read this file
93  TFileCacheRead *fCacheRead; ///<!Pointer to the read cache (if any)
94  TMap *fCacheReadMap; ///<!Pointer to the read cache (if any)
95  TFileCacheWrite *fCacheWrite; ///<!Pointer to the write cache (if any)
96  Long64_t fArchiveOffset; ///<!Offset at which file starts in archive
97  Bool_t fIsArchive : 1; ///<!True if this is a pure archive file
98  Bool_t fNoAnchorInName : 1; ///<!True if we don't want to force the anchor to be appended to the file name
99  Bool_t fIsRootFile : 1; ///<!True is this is a ROOT file, raw file otherwise
100  Bool_t fInitDone : 1; ///<!True if the file has been initialized
101  Bool_t fMustFlush : 1; ///<!True if the file buffers must be flushed
102  Bool_t fIsPcmFile : 1; ///<!True if the file is a ROOT pcm file.
103  TFileOpenHandle *fAsyncHandle; ///<!For proper automatic cleanup
104  EAsyncOpenStatus fAsyncOpenStatus; ///<!Status of an asynchronous open request
105  TUrl fUrl; ///<!URL of file
106 
107  TList *fInfoCache; ///<!Cached list of the streamer infos in this file
108  TList *fOpenPhases; ///<!Time info about open phases
109 
110 #ifdef R__USE_IMT
111  static ROOT::TRWSpinLock fgRwLock; ///<!Read-write lock to protect global PID list
112  std::mutex fWriteMutex; ///<!Lock for writing baskets / keys into the file.
113  static ROOT::Internal::RConcurrentHashColl fgTsSIHashes; ///<!TS Set of hashes built from read streamer infos
114 #endif
115 
116  static TList *fgAsyncOpenRequests; //List of handles for pending open requests
117 
118  static TString fgCacheFileDir; ///<Directory where to locally stage files
119  static Bool_t fgCacheFileDisconnected; ///<Indicates, we trust in the files in the cache dir without stat on the cached file
120  static Bool_t fgCacheFileForce; ///<Indicates, to force all READ to CACHEREAD
121  static UInt_t fgOpenTimeout; ///<Timeout for open operations in ms - 0 corresponds to blocking i/o
122  static Bool_t fgOnlyStaged ; ///<Before the file is opened, it is checked, that the file is staged, if not, the open fails
123 
124  static std::atomic<Long64_t> fgBytesWrite; ///<Number of bytes written by all TFile objects
125  static std::atomic<Long64_t> fgBytesRead; ///<Number of bytes read by all TFile objects
126  static std::atomic<Long64_t> fgFileCounter; ///<Counter for all opened files
127  static std::atomic<Int_t> fgReadCalls; ///<Number of bytes read from all TFile objects
128  static Int_t fgReadaheadSize; ///<Readahead buffer size
129  static Bool_t fgReadInfo; ///<if true (default) ReadStreamerInfo is called when opening a file
131  virtual void Init(Bool_t create);
133  Int_t ReadBufferViaCache(char *buf, Int_t len);
134  Int_t WriteBufferViaCache(const char *buf, Int_t len);
135 
136  ////////////////////////////////////////////////////////////////////////////////
137  /// \brief Simple struct of the return value of GetStreamerInfoListImpl
138  struct InfoListRet {
142  };
143 
144  virtual InfoListRet GetStreamerInfoListImpl(bool lookupSICache);
145 
146  // Creating projects
147  Int_t MakeProjectParMake(const char *packname, const char *filename);
148  Int_t MakeProjectParProofInf(const char *packname, const char *proofinfdir);
149 
150  // Interface to basic system I/O routines
151  virtual Int_t SysOpen(const char *pathname, Int_t flags, UInt_t mode);
152  virtual Int_t SysClose(Int_t fd);
153  virtual Int_t SysRead(Int_t fd, void *buf, Int_t len);
154  virtual Int_t SysWrite(Int_t fd, const void *buf, Int_t len);
155  virtual Long64_t SysSeek(Int_t fd, Long64_t offset, Int_t whence);
156  virtual Int_t SysStat(Int_t fd, Long_t *id, Long64_t *size, Long_t *flags, Long_t *modtime);
157  virtual Int_t SysSync(Int_t fd);
158 
159  // Interface for text-based TDirectory I/O
160  virtual Long64_t DirCreateEntry(TDirectory*) { return 0; }
161  virtual Int_t DirReadKeys(TDirectory*) { return 0; }
162  virtual void DirWriteKeys(TDirectory*) {}
163  virtual void DirWriteHeader(TDirectory*) {}
164 
165 private:
166  TFile(const TFile &); //Files cannot be copied
167  void operator=(const TFile &);
168 
169  static void CpProgress(Long64_t bytesread, Long64_t size, TStopwatch &watch);
170  static TFile *OpenFromCache(const char *name, Option_t * = "",
171  const char *ftitle = "", Int_t compress = ROOT::kUseGeneralPurposeCompressionSetting,
172  Int_t netopt = 0);
173 
174 public:
175  /// TFile status bits. BIT(13) is taken up by TObject
176  enum EStatusBits {
179  kDevNull = BIT(12),
183  };
184  enum ERelativeTo { kBeg = 0, kCur = 1, kEnd = 2 };
185  enum { kStartBigFile = 2000000000 };
186  /// File type
187  enum EFileType { kDefault = 0, kLocal = 1, kNet = 2, kWeb = 3, kFile = 4, kMerge = 5};
188 
189  TFile();
190  TFile(const char *fname, Option_t *option="", const char *ftitle="", Int_t compress = ROOT::kUseGeneralPurposeCompressionSetting);
191  virtual ~TFile();
192  virtual void Close(Option_t *option=""); // *MENU*
193  virtual void Copy(TObject &) const { MayNotUse("Copy(TObject &)"); }
194  virtual Bool_t Cp(const char *dst, Bool_t progressbar = kTRUE,UInt_t buffersize = 1000000);
195  virtual TKey* CreateKey(TDirectory* mother, const TObject* obj, const char* name, Int_t bufsize);
196  virtual TKey* CreateKey(TDirectory* mother, const void* obj, const TClass* cl,
197  const char* name, Int_t bufsize);
198  static TFile *&CurrentFile(); // Return the current file for this thread.
199  virtual void Delete(const char *namecycle="");
200  virtual void Draw(Option_t *option="");
201  virtual void DrawMap(const char *keys="*",Option_t *option=""); // *MENU*
202  virtual void FillBuffer(char *&buffer);
203  virtual void Flush();
204  TArchiveFile *GetArchive() const { return fArchive; }
206  Int_t GetBestBuffer() const;
207  virtual Int_t GetBytesToPrefetch() const;
208  TFileCacheRead *GetCacheRead(const TObject* tree = 0) const;
210  TArrayC *GetClassIndex() const { return fClassIndex; }
212  Int_t GetCompressionLevel() const;
215  virtual Long64_t GetEND() const { return fEND; }
216  virtual Int_t GetErrno() const;
217  virtual void ResetErrno() const;
218  Int_t GetFd() const { return fD; }
219  virtual const TUrl *GetEndpointUrl() const { return &fUrl; }
221  TList *GetListOfFree() const { return fFree; }
222  virtual Int_t GetNfree() const { return fFree->GetSize(); }
223  virtual Int_t GetNProcessIDs() const { return fNProcessIDs; }
224  Option_t *GetOption() const { return fOption.Data(); }
225  virtual Long64_t GetBytesRead() const { return fBytesRead; }
226  virtual Long64_t GetBytesReadExtra() const { return fBytesReadExtra; }
227  virtual Long64_t GetBytesWritten() const;
228  virtual Int_t GetReadCalls() const { return fReadCalls; }
229  Int_t GetVersion() const { return fVersion; }
230  Int_t GetRecordHeader(char *buf, Long64_t first, Int_t maxbytes,
231  Int_t &nbytes, Int_t &objlen, Int_t &keylen);
232  virtual Int_t GetNbytesInfo() const {return fNbytesInfo;}
233  virtual Int_t GetNbytesFree() const {return fNbytesFree;}
234  virtual TString GetNewUrl() { return ""; }
235  Long64_t GetRelOffset() const { return fOffset - fArchiveOffset; }
236  virtual Long64_t GetSeekFree() const {return fSeekFree;}
237  virtual Long64_t GetSeekInfo() const {return fSeekInfo;}
238  virtual Long64_t GetSize() const;
239  virtual TList *GetStreamerInfoList() final; // Note: to override behavior, please override GetStreamerInfoListImpl
240  const TList *GetStreamerInfoCache();
241  virtual void IncrementProcessIDs() { fNProcessIDs++; }
242  virtual Bool_t IsArchive() const { return fIsArchive; }
243  Bool_t IsBinary() const { return TestBit(kBinaryFile); }
244  Bool_t IsRaw() const { return !fIsRootFile; }
245  virtual Bool_t IsOpen() const;
246  virtual void ls(Option_t *option="") const;
247  virtual void MakeFree(Long64_t first, Long64_t last);
248  virtual void MakeProject(const char *dirname, const char *classes="*",
249  Option_t *option="new"); // *MENU*
250  virtual void Map(Option_t *opt); // *MENU*
251  virtual void Map() { Map(""); }; // *MENU*
252  virtual Bool_t Matches(const char *name);
253  virtual Bool_t MustFlush() const {return fMustFlush;}
254  virtual void Paint(Option_t *option="");
255  virtual void Print(Option_t *option="") const;
256  virtual Bool_t ReadBufferAsync(Long64_t offs, Int_t len);
257  virtual Bool_t ReadBuffer(char *buf, Int_t len);
258  virtual Bool_t ReadBuffer(char *buf, Long64_t pos, Int_t len);
259  virtual Bool_t ReadBuffers(char *buf, Long64_t *pos, Int_t *len, Int_t nbuf);
260  virtual void ReadFree();
261  virtual TProcessID *ReadProcessID(UShort_t pidf);
262  virtual void ReadStreamerInfo();
263  virtual Int_t Recover();
264  virtual Int_t ReOpen(Option_t *mode);
265  virtual void Seek(Long64_t offset, ERelativeTo pos = kBeg);
266  virtual void SetCacheRead(TFileCacheRead *cache, TObject* tree = 0, ECacheAction action = kDisconnect);
267  virtual void SetCacheWrite(TFileCacheWrite *cache);
271  virtual void SetEND(Long64_t last) { fEND = last; }
272  virtual void SetOffset(Long64_t offset, ERelativeTo pos = kBeg);
273  virtual void SetOption(Option_t *option=">") { fOption = option; }
274  virtual void SetReadCalls(Int_t readcalls = 0) { fReadCalls = readcalls; }
275  virtual void ShowStreamerInfo();
276  virtual Int_t Sizeof() const;
277  void SumBuffer(Int_t bufsize);
278  virtual Bool_t WriteBuffer(const char *buf, Int_t len);
279  virtual Int_t Write(const char *name=0, Int_t opt=0, Int_t bufsiz=0);
280  virtual Int_t Write(const char *name=0, Int_t opt=0, Int_t bufsiz=0) const;
281  virtual void WriteFree();
282  virtual void WriteHeader();
283  virtual UShort_t WriteProcessID(TProcessID *pid);
284  virtual void WriteStreamerInfo();
285 
286  static TFileOpenHandle
287  *AsyncOpen(const char *name, Option_t *option = "",
288  const char *ftitle = "", Int_t compress = ROOT::kUseGeneralPurposeCompressionSetting,
289  Int_t netopt = 0);
290  static TFile *Open(const char *name, Option_t *option = "",
291  const char *ftitle = "", Int_t compress = ROOT::kUseGeneralPurposeCompressionSetting,
292  Int_t netopt = 0);
293  static TFile *Open(TFileOpenHandle *handle);
294 
295  static EFileType GetType(const char *name, Option_t *option = "", TString *prefix = 0);
296 
297  static EAsyncOpenStatus GetAsyncOpenStatus(const char *name);
299  static const TUrl *GetEndpointUrl(const char *name);
300 
301  static Long64_t GetFileBytesRead();
302  static Long64_t GetFileBytesWritten();
303  static Int_t GetFileReadCalls();
304  static Int_t GetReadaheadSize();
305 
306  static void SetFileBytesRead(Long64_t bytes = 0);
307  static void SetFileBytesWritten(Long64_t bytes = 0);
308  static void SetFileReadCalls(Int_t readcalls = 0);
309  static void SetReadaheadSize(Int_t bufsize = 256000);
310  static void SetReadStreamerInfo(Bool_t readinfo=kTRUE);
311  static Bool_t GetReadStreamerInfo();
312 
313  static Long64_t GetFileCounter();
314  static void IncrementFileCounter();
315 
316  static Bool_t SetCacheFileDir(ROOT::Internal::TStringView cacheDir, Bool_t operateDisconnected = kTRUE,
317  Bool_t forceCacheread = kFALSE)
318  { return SetCacheFileDir(std::string_view(cacheDir), operateDisconnected, forceCacheread); }
319  static Bool_t SetCacheFileDir(std::string_view cacheDir, Bool_t operateDisconnected = kTRUE,
320  Bool_t forceCacheread = kFALSE);
321  static const char *GetCacheFileDir();
322  static Bool_t ShrinkCacheFileDir(Long64_t shrinkSize, Long_t cleanupInteval = 0);
323  static Bool_t Cp(const char *src, const char *dst, Bool_t progressbar = kTRUE,
324  UInt_t buffersize = 1000000);
325 
326  static UInt_t SetOpenTimeout(UInt_t timeout); // in ms
327  static UInt_t GetOpenTimeout(); // in ms
328  static Bool_t SetOnlyStaged(Bool_t onlystaged);
329  static Bool_t GetOnlyStaged();
330 
331  ClassDef(TFile,8) //ROOT file
332 };
333 
334 #ifndef __CINT__
335 #define gFile (TFile::CurrentFile())
336 
337 #elif defined(__MAKECINT__)
338 // To properly handle the use of gFile in header files (in static declarations)
340 #endif
341 
342 /**
343 \class TFileOpenHandle
344 \ingroup IO
345 Class holding info about the file being opened
346 */
347 class TFileOpenHandle : public TNamed {
348 
349 friend class TFile;
350 friend class TAlienFile;
351 
352 private:
353  TString fOpt; ///< Options
354  Int_t fCompress; ///< Compression level and algorithm
355  Int_t fNetOpt; ///< Network options
356  TFile *fFile; ///< TFile instance of the file being opened
357 
359  fNetOpt(0), fFile(f) { }
360  TFileOpenHandle(const char *n, const char *o, const char *t, Int_t cmp,
361  Int_t no) : TNamed(n,t), fOpt(o), fCompress(cmp),
362  fNetOpt(no), fFile(0) { }
365 
366  TFile *GetFile() const { return fFile; }
367 
368 public:
370 
371  Bool_t Matches(const char *name);
372 
373  const char *GetOpt() const { return fOpt; }
374  Int_t GetCompress() const { return fCompress; }
375  Int_t GetNetOpt() const { return fNetOpt; }
376 };
377 
378 //______________________________________________________________________________
380 {
381  return (fCompress < 0) ? -1 : fCompress / 100;
382 }
383 
384 //______________________________________________________________________________
386 {
387  return (fCompress < 0) ? -1 : fCompress % 100;
388 }
389 
390 //______________________________________________________________________________
392 {
393  return (fCompress < 0) ? -1 : fCompress;
394 }
395 
396 #endif
Long64_t GetRelOffset() const
Definition: TFile.h:235
virtual void DirWriteKeys(TDirectory *)
Definition: TFile.h:162
Bool_t fIsArchive
!True if this is a pure archive file
Definition: TFile.h:97
static ROOT::TRWSpinLock fgRwLock
!Read-write lock to protect global PID list
Definition: TFile.h:111
Bool_t fIsPcmFile
!True if the file is a ROOT pcm file.
Definition: TFile.h:102
Class describing an archive file containing multiple sub-files, like a ZIP or TAR archive...
Definition: TArchiveFile.h:24
virtual void DrawMap(const char *keys="*", Option_t *option="")
Draw map of objects in this file.
Definition: TFile.cxx:1082
virtual Int_t Recover()
Attempt to recover file if not correctly closed.
Definition: TFile.cxx:1941
TFileCacheRead * fCacheRead
!Pointer to the read cache (if any)
Definition: TFile.h:93
An array of TObjects.
Definition: TObjArray.h:37
Char_t fUnits
Number of bytes for file pointers.
Definition: TFile.h:87
virtual Int_t SysStat(Int_t fd, Long_t *id, Long64_t *size, Long_t *flags, Long_t *modtime)
Return file stat information.
Definition: TFile.cxx:4408
void operator=(const TFile &)
TObjArray * fProcessIDs
!Array of pointers to TProcessIDs
Definition: TFile.h:90
Long64_t fBEGIN
First used byte in file.
Definition: TFile.h:73
long long Long64_t
Definition: RtypesCore.h:69
static Bool_t fgReadInfo
if true (default) ReadStreamerInfo is called when opening a file
Definition: TFile.h:129
virtual Long64_t SysSeek(Int_t fd, Long64_t offset, Int_t whence)
Interface to system lseek.
Definition: TFile.cxx:4390
Long64_t fBytesWrite
Number of bytes written to this file.
Definition: TFile.h:70
EAsyncOpenStatus
Asynchronous open request status.
Definition: TFile.h:59
Namespace for new ROOT classes and functions.
Definition: StringConv.hxx:21
virtual void FillBuffer(char *&buffer)
Encode file output buffer.
Definition: TFile.cxx:1124
Double_t fSumBuffer
Sum of buffer sizes of objects written so far.
Definition: TFile.h:68
static std::atomic< Long64_t > fgBytesRead
Number of bytes read by all TFile objects.
Definition: TFile.h:125
virtual Long64_t GetSeekInfo() const
Definition: TFile.h:237
virtual Int_t ReOpen(Option_t *mode)
Reopen a file with a different access mode.
Definition: TFile.cxx:2055
float Float_t
Definition: RtypesCore.h:53
Int_t fCompress
Compression level and algorithm.
Definition: TFile.h:79
TArchiveFile * GetArchive() const
Definition: TFile.h:204
TArrayC * fClassIndex
!Index of TStreamerInfo classes written to this file
Definition: TFile.h:89
static void IncrementFileCounter()
Definition: TFile.cxx:4485
virtual void ReadFree()
Read the FREE linked list.
Definition: TFile.cxx:1821
A cache when reading files over the network.
const char Option_t
Definition: RtypesCore.h:62
Int_t GetNetOpt() const
Definition: TFile.h:375
TString fOpt
Options.
Definition: TFile.h:353
virtual void Flush()
Synchronize a file&#39;s in-memory and on-disk states.
Definition: TFile.cxx:1095
virtual void SetCacheRead(TFileCacheRead *cache, TObject *tree=0, ECacheAction action=kDisconnect)
Set a pointer to the read cache.
Definition: TFile.cxx:2260
static TList * fgAsyncOpenRequests
Definition: TFile.h:116
virtual void SetOffset(Long64_t offset, ERelativeTo pos=kBeg)
Set position from where to start reading.
Definition: TFile.cxx:2148
This class represents a WWW compatible URL.
Definition: TUrl.h:35
virtual void SetEND(Long64_t last)
Definition: TFile.h:271
virtual TKey * CreateKey(TDirectory *mother, const TObject *obj, const char *name, Int_t bufsize)
Creates key for object and converts data to buffer.
Definition: TFile.cxx:1010
unsigned short UShort_t
Definition: RtypesCore.h:36
Class holding info about the file being opened.
Definition: TFile.h:347
static UInt_t fgOpenTimeout
Timeout for open operations in ms - 0 corresponds to blocking i/o.
Definition: TFile.h:121
virtual void SetCompressionLevel(Int_t level=ROOT::kUseMinCompressionLevel)
See comments for function SetCompressionSettings.
Definition: TFile.cxx:2214
#define BIT(n)
Definition: Rtypes.h:82
TArrayC * GetClassIndex() const
Definition: TFile.h:210
virtual void Seek(Long64_t offset, ERelativeTo pos=kBeg)
Seek to a specific position in the file. Pos it either kBeg, kCur or kEnd.
Definition: TFile.cxx:2169
virtual void DirWriteHeader(TDirectory *)
Definition: TFile.h:163
TObjArray * GetListOfProcessIDs() const
Definition: TFile.h:220
A ROOT file is a suite of consecutive data records (TKey instances) with a well defined format...
Definition: TFile.h:48
static void SetFileReadCalls(Int_t readcalls=0)
Definition: TFile.cxx:4479
virtual Bool_t ReadBuffer(char *buf, Int_t len)
Read a buffer from the file.
Definition: TFile.cxx:1666
static Bool_t SetCacheFileDir(ROOT::Internal::TStringView cacheDir, Bool_t operateDisconnected=kTRUE, Bool_t forceCacheread=kFALSE)
Definition: TFile.h:316
virtual void SetReadCalls(Int_t readcalls=0)
Definition: TFile.h:274
R__ALWAYS_INLINE Bool_t TestBit(UInt_t f) const
Definition: TObject.h:172
virtual Long64_t GetBytesWritten() const
Return the total number of bytes written so far to the file.
Definition: TFile.cxx:4431
TFileOpenHandle(TFile *f)
Definition: TFile.h:358
Basic string class.
Definition: TString.h:131
static Bool_t ShrinkCacheFileDir(Long64_t shrinkSize, Long_t cleanupInteval=0)
Try to shrink the cache to the desired size.
Definition: TFile.cxx:4531
~TFileOpenHandle()
Definition: TFile.h:369
#define f(i)
Definition: RSha256.hxx:104
int Int_t
Definition: RtypesCore.h:41
bool Bool_t
Definition: RtypesCore.h:59
Int_t WriteBufferViaCache(const char *buf, Int_t len)
Write buffer via cache.
Definition: TFile.cxx:2414
Long64_t fBytesReadExtra
Number of extra bytes (overhead) read by the readahead buffer.
Definition: TFile.h:72
ERelativeTo
Definition: TFile.h:184
TList * fInfoCache
!Cached list of the streamer infos in this file
Definition: TFile.h:107
virtual TList * GetStreamerInfoList() final
Read the list of TStreamerInfo objects written to this file.
Definition: TFile.cxx:1390
static void SetReadStreamerInfo(Bool_t readinfo=kTRUE)
Specify if the streamerinfos must be read at file opening.
Definition: TFile.cxx:3619
Long64_t fSeekInfo
Location on disk of StreamerInfo record.
Definition: TFile.h:76
Int_t fReadCalls
Number of read calls ( not counting the cache calls )
Definition: TFile.h:84
This class is a TS set of unsigned set.
TArchiveFile * fArchive
!Archive file from which we read this file
Definition: TFile.h:92
static void SetReadaheadSize(Int_t bufsize=256000)
Definition: TFile.cxx:4470
Long64_t GetArchiveOffset() const
Definition: TFile.h:205
Int_t fNetOpt
Network options.
Definition: TFile.h:355
static TFileOpenHandle * AsyncOpen(const char *name, Option_t *option="", const char *ftitle="", Int_t compress=ROOT::kUseGeneralPurposeCompressionSetting, Int_t netopt=0)
Submit an asynchronous open request.
Definition: TFile.cxx:4211
virtual Bool_t IsArchive() const
Definition: TFile.h:242
void SumBuffer(Int_t bufsize)
Increment statistics for buffer sizes of objects in this file.
Definition: TFile.cxx:2312
virtual Bool_t Cp(const char *dst, Bool_t progressbar=kTRUE, UInt_t buffersize=1000000)
Allows to copy this file to the dst URL.
Definition: TFile.cxx:4869
#define gFile
Definition: TFile.h:335
static void SetFileBytesWritten(Long64_t bytes=0)
Definition: TFile.cxx:4476
virtual Long64_t GetSeekFree() const
Definition: TFile.h:236
virtual Int_t GetErrno() const
Method returning errno. Is overriden in TRFIOFile.
Definition: TFile.cxx:1195
Bool_t IsBinary() const
Definition: TFile.h:243
Int_t fNbytesInfo
Number of bytes for StreamerInfo record.
Definition: TFile.h:81
virtual void SetCompressionAlgorithm(Int_t algorithm=ROOT::kUseGlobalCompressionAlgorithm)
See comments for function SetCompressionSettings.
Definition: TFile.cxx:2200
TMap * fCacheReadMap
!Pointer to the read cache (if any)
Definition: TFile.h:94
Use the global compression algorithm.
Definition: Compression.h:48
virtual void ResetErrno() const
Method resetting the errno. Is overridden in TRFIOFile.
Definition: TFile.cxx:1203
Int_t GetVersion() const
Definition: TFile.h:229
TUrl fUrl
!URL of file
Definition: TFile.h:105
Int_t fD
File descriptor.
Definition: TFile.h:77
#define ClassDef(name, id)
Definition: Rtypes.h:324
Service class for TFile.
Definition: TFree.h:27
static Bool_t GetReadStreamerInfo()
If the streamerinfos are to be read at file opening.
Definition: TFile.cxx:3629
virtual void MakeProject(const char *dirname, const char *classes="*", Option_t *option="new")
Generate source code necessary to access the objects stored in the file.
Definition: TFile.cxx:2618
virtual void WriteFree()
Write FREE linked list on the file.
Definition: TFile.cxx:2438
The TNamed class is the base class for all named ROOT classes.
Definition: TNamed.h:29
TString fRealName
Effective real file name (not original url)
Definition: TFile.h:85
std::mutex fWriteMutex
!Lock for writing baskets / keys into the file.
Definition: TFile.h:112
static Long64_t GetFileBytesRead()
Static function returning the total number of bytes read from all files.
Definition: TFile.cxx:4439
static EFileType GetType(const char *name, Option_t *option="", TString *prefix=0)
Resolve the file type as a function of the protocol field in &#39;name&#39;.
Definition: TFile.cxx:4686
static Long64_t GetFileBytesWritten()
Static function returning the total number of bytes written to all files.
Definition: TFile.cxx:4448
virtual Int_t GetReadCalls() const
Definition: TFile.h:228
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 clas...
Definition: TObject.cxx:933
TFile * GetFile() const
Definition: TFile.h:366
Book space in a file, create I/O buffers, to fill them, (un)compress them.
Definition: TKey.h:24
A TProcessID identifies a ROOT job in a unique way in time and space.
Definition: TProcessID.h:69
virtual TString GetNewUrl()
Definition: TFile.h:234
virtual void Map()
Definition: TFile.h:251
Simple struct of the return value of GetStreamerInfoListImpl.
Definition: TFile.h:138
virtual Int_t SysWrite(Int_t fd, const void *buf, Int_t len)
Interface to system write. All arguments like in POSIX write().
Definition: TFile.cxx:4379
virtual void IncrementProcessIDs()
Definition: TFile.h:241
virtual Int_t SysSync(Int_t fd)
Interface to system fsync. All arguments like in POSIX fsync().
Definition: TFile.cxx:4417
A doubly linked list.
Definition: TList.h:44
Int_t GetRecordHeader(char *buf, Long64_t first, Int_t maxbytes, Int_t &nbytes, Int_t &objlen, Int_t &keylen)
Read the logical record header starting at a certain postion.
Definition: TFile.cxx:1248
virtual Long64_t DirCreateEntry(TDirectory *)
Definition: TFile.h:160
TFileOpenHandle(const char *n, const char *o, const char *t, Int_t cmp, Int_t no)
Definition: TFile.h:360
virtual Int_t SysClose(Int_t fd)
Interface to system close. All arguments like in POSIX close().
Definition: TFile.cxx:4362
Int_t GetCompressionAlgorithm() const
Definition: TFile.h:379
static UInt_t GetOpenTimeout()
Returns open timeout (in ms).
Definition: TFile.cxx:4599
virtual void ShowStreamerInfo()
Show the StreamerInfo of all classes written to this file.
Definition: TFile.cxx:3637
EFileType
File type.
Definition: TFile.h:187
virtual Int_t SysRead(Int_t fd, void *buf, Int_t len)
Interface to system read. All arguments like in POSIX read().
Definition: TFile.cxx:4371
const char * GetOpt() const
Definition: TFile.h:373
virtual Int_t GetNfree() const
Definition: TFile.h:222
static TFile * Open(const char *name, Option_t *option="", const char *ftitle="", Int_t compress=ROOT::kUseGeneralPurposeCompressionSetting, Int_t netopt=0)
Create / open a file.
Definition: TFile.cxx:3971
Long64_t fEND
Last used byte in file.
Definition: TFile.h:74
virtual Int_t SysOpen(const char *pathname, Int_t flags, UInt_t mode)
Interface to system open. All arguments like in POSIX open().
Definition: TFile.cxx:4346
TList * fList
Definition: TFile.h:139
virtual void WriteStreamerInfo()
Write the list of TStreamerInfo as a single object in this file The class Streamer description for al...
Definition: TFile.cxx:3679
A ROOT file is structured in Directories (like a file system).
virtual Int_t Write(const char *name=0, Int_t opt=0, Int_t bufsiz=0)
Write memory objects to this file.
Definition: TFile.cxx:2331
virtual Int_t GetBytesToPrefetch() const
Max number of bytes to prefetch.
Definition: TFile.cxx:5089
virtual void SetOption(Option_t *option=">")
Definition: TFile.h:273
virtual void Delete(const char *namecycle="")
Delete object namecycle.
Definition: TFile.cxx:1061
virtual InfoListRet GetStreamerInfoListImpl(bool lookupSICache)
See documentation of GetStreamerInfoList for more details.
Definition: TFile.cxx:1323
virtual Bool_t WriteBuffer(const char *buf, Int_t len)
Write a buffer to the file.
Definition: TFile.cxx:2371
virtual Bool_t MustFlush() const
Definition: TFile.h:253
Use the recommended general-purpose setting; moderate read / write speed and compression ratio...
Definition: Compression.h:83
EAsyncOpenStatus fAsyncOpenStatus
!Status of an asynchronous open request
Definition: TFile.h:104
unsigned int UInt_t
Definition: RtypesCore.h:42
virtual void MakeFree(Long64_t first, Long64_t last)
Mark unused bytes on the file.
Definition: TFile.cxx:1429
static std::atomic< Long64_t > fgFileCounter
Counter for all opened files.
Definition: TFile.h:126
Manages buffers for branches of a Tree.
Definition: TBasket.h:34
static std::atomic< Long64_t > fgBytesWrite
Number of bytes written by all TFile objects.
Definition: TFile.h:124
virtual Int_t DirReadKeys(TDirectory *)
Definition: TFile.h:161
static void CpProgress(Long64_t bytesread, Long64_t size, TStopwatch &watch)
Print file copy progress.
Definition: TFile.cxx:4841
static std::atomic< Int_t > fgReadCalls
Number of bytes read from all TFile objects.
Definition: TFile.h:127
The ROOT global object gROOT contains a list of all defined classes.
Definition: TClass.h:75
virtual void Draw(Option_t *option="")
Fill Graphics Structure and Paint.
Definition: TFile.cxx:1074
TFileCacheRead * GetCacheRead(const TObject *tree=0) const
Return a pointer to the current read cache.
Definition: TFile.cxx:1211
static Int_t GetFileReadCalls()
Static function returning the total number of read calls from all files.
Definition: TFile.cxx:4456
virtual void Init(Bool_t create)
Initialize a TFile object.
Definition: TFile.cxx:593
Int_t ReadBufferViaCache(char *buf, Int_t len)
Read buffer via cache.
Definition: TFile.cxx:1785
static TFile *& CurrentFile()
Return the current ROOT file if any.
Definition: TFile.cxx:1030
Option_t * GetOption() const
Definition: TFile.h:224
const Bool_t kFALSE
Definition: RtypesCore.h:88
virtual Long64_t GetBytesRead() const
Definition: TFile.h:225
static Bool_t fgOnlyStaged
Before the file is opened, it is checked, that the file is staged, if not, the open fails...
Definition: TFile.h:122
static Bool_t GetOnlyStaged()
Returns staged only flag.
Definition: TFile.cxx:4619
virtual void ReadStreamerInfo()
Read the list of StreamerInfo from this file.
Definition: TFile.cxx:3494
Double_t fSum2Buffer
Sum of squares of buffer sizes of objects written so far.
Definition: TFile.h:69
virtual Int_t GetNbytesFree() const
Definition: TFile.h:233
long Long_t
Definition: RtypesCore.h:50
TFile()
File default Constructor.
Definition: TFile.cxx:175
TList * fFree
Free segments linked list table.
Definition: TFile.h:88
TFile * fFile
Pointer to current file in memory.
virtual Int_t GetNbytesInfo() const
Definition: TFile.h:232
static TFile * OpenFromCache(const char *name, Option_t *="", const char *ftitle="", Int_t compress=ROOT::kUseGeneralPurposeCompressionSetting, Int_t netopt=0)
Open a file for reading through the file cache.
Definition: TFile.cxx:3762
virtual Bool_t IsOpen() const
Returns kTRUE in case file is open and kFALSE if file is not open.
Definition: TFile.cxx:1414
Int_t fNbytesFree
Number of bytes for free segments structure.
Definition: TFile.h:80
static Bool_t fgCacheFileForce
Indicates, to force all READ to CACHEREAD.
Definition: TFile.h:120
TFile * fFile
TFile instance of the file being opened.
Definition: TFile.h:356
Int_t fReturnCode
Definition: TFile.h:140
double Double_t
Definition: RtypesCore.h:55
static Int_t GetReadaheadSize()
Static function returning the readahead buffer size.
Definition: TFile.cxx:4464
Describe directory structure in memory.
Definition: TDirectory.h:34
EStatusBits
Definition: TObject.h:57
TFileCacheWrite * GetCacheWrite() const
Return a pointer to the current write cache.
Definition: TFile.cxx:1228
TMap implements an associative array of (key,value) pairs using a THashTable for efficient retrieval ...
Definition: TMap.h:40
virtual void SetCompressionSettings(Int_t settings=ROOT::kUseGeneralPurposeCompressionSetting)
Used to specify the compression level and algorithm.
Definition: TFile.cxx:2233
virtual Long64_t GetSize() const
Returns the current file size.
Definition: TFile.cxx:1294
Bool_t fNoAnchorInName
!True if we don&#39;t want to force the anchor to be appended to the file name
Definition: TFile.h:98
static Bool_t fgCacheFileDisconnected
Indicates, we trust in the files in the cache dir without stat on the cached file.
Definition: TFile.h:119
TList * fOpenPhases
!Time info about open phases
Definition: TFile.h:108
basic_string_view< char > string_view
Definition: RStringView.hxx:35
TString fOption
File options.
Definition: TFile.h:86
The prefetching mechanism uses two classes (TFilePrefetch and TFPBlock) to prefetch in advance a bloc...
Definition: TFilePrefetch.h:31
Bool_t fMustFlush
!True if the file buffers must be flushed
Definition: TFile.h:101
Float_t GetCompressionFactor()
Return the file compression factor.
Definition: TFile.cxx:1151
Int_t GetCompress() const
Definition: TFile.h:374
virtual Long64_t GetBytesReadExtra() const
Definition: TFile.h:226
static ROOT::Internal::RConcurrentHashColl fgTsSIHashes
!TS Set of hashes built from read streamer infos
Definition: TFile.h:113
Bool_t fIsRootFile
!True is this is a ROOT file, raw file otherwise
Definition: TFile.h:99
const TList * GetStreamerInfoCache()
Returns the cached list of StreamerInfos used in this file.
Definition: TFile.cxx:1313
Mother of all ROOT objects.
Definition: TObject.h:37
Bool_t FlushWriteCache()
Flush the write cache if active.
Definition: TFile.cxx:1112
static Bool_t SetOnlyStaged(Bool_t onlystaged)
Sets only staged flag.
Definition: TFile.cxx:4609
virtual Long64_t GetEND() const
Definition: TFile.h:215
virtual void Paint(Option_t *option="")
Paint all objects in the file.
Definition: TFile.cxx:1594
#define R__EXTERN
Definition: DllImport.h:27
char Char_t
Definition: RtypesCore.h:29
static TString fgCacheFileDir
Directory where to locally stage files.
Definition: TFile.h:118
virtual const TUrl * GetEndpointUrl() const
Definition: TFile.h:219
virtual ~TFile()
File destructor.
Definition: TFile.cxx:543
Int_t MakeProjectParProofInf(const char *packname, const char *proofinfdir)
Create BUILD.sh and SETUP.C under &#39;proofinf&#39; for PAR package &#39;pack&#39;.
Definition: TFile.cxx:3375
virtual void Print(Option_t *option="") const
Print all objects in the file.
Definition: TFile.cxx:1602
TList * GetListOfFree() const
Definition: TFile.h:221
virtual UShort_t WriteProcessID(TProcessID *pid)
Check if the ProcessID pidd is already in the file, if not, add it and return the index number in the...
Definition: TFile.cxx:3650
virtual Bool_t ReadBuffers(char *buf, Long64_t *pos, Int_t *len, Int_t nbuf)
Read the nbuf blocks described in arrays pos and len.
Definition: TFile.cxx:1717
virtual Int_t GetNProcessIDs() const
Definition: TFile.h:223
Int_t fNProcessIDs
Number of TProcessID written to this file.
Definition: TFile.h:83
virtual Int_t Sizeof() const
Return the size in bytes of the file header.
Definition: TFile.cxx:2292
static UInt_t SetOpenTimeout(UInt_t timeout)
Sets open timeout time (in ms). Returns previous timeout value.
Definition: TFile.cxx:4589
Definition: tree.py:1
Int_t GetFd() const
Definition: TFile.h:218
Int_t fVersion
File format version.
Definition: TFile.h:78
Long64_t fArchiveOffset
!Offset at which file starts in archive
Definition: TFile.h:96
Int_t fCompress
Compression level and algorithm.
Definition: TFile.h:354
Definition: first.py:1
Int_t fWritten
Number of objects written so far.
Definition: TFile.h:82
static Int_t fgReadaheadSize
Readahead buffer size.
Definition: TFile.h:128
Long64_t fOffset
!Seek offset cache
Definition: TFile.h:91
virtual void WriteHeader()
Write File Header.
Definition: TFile.cxx:2510
Bool_t fInitDone
!True if the file has been initialized
Definition: TFile.h:100
TFileOpenHandle * fAsyncHandle
!For proper automatic cleanup
Definition: TFile.h:103
EOpenTimeOut
Open timeout constants.
Definition: TFile.h:62
virtual Int_t GetSize() const
Return the capacity of the collection, i.e.
Definition: TCollection.h:182
static void SetFileBytesRead(Long64_t bytes=0)
Definition: TFile.cxx:4473
virtual void ls(Option_t *option="") const
List file contents.
Definition: TFile.cxx:1402
const Bool_t kTRUE
Definition: RtypesCore.h:87
Long64_t fSeekFree
Location on disk of free segments structure.
Definition: TFile.h:75
static Long64_t GetFileCounter()
Definition: TFile.cxx:4482
const Int_t n
Definition: legend1.C:16
virtual void SetCacheWrite(TFileCacheWrite *cache)
Set a pointer to the write cache.
Definition: TFile.cxx:2283
Int_t GetCompressionLevel() const
Definition: TFile.h:385
Long64_t fBytesRead
Number of bytes read from this file.
Definition: TFile.h:71
char name[80]
Definition: TGX11.cxx:109
static const char * GetCacheFileDir()
Get the directory where to locally stage/cache remote files.
Definition: TFile.cxx:4519
virtual TProcessID * ReadProcessID(UShort_t pidf)
The TProcessID with number pidf is read from this file.
Definition: TFile.cxx:1847
A cache when writing files over the network.
Int_t GetCompressionSettings() const
Definition: TFile.h:391
Int_t GetBestBuffer() const
Return the best buffer size of objects on this file.
Definition: TFile.cxx:1137
virtual void Copy(TObject &) const
Copy this to obj.
Definition: TFile.h:193
Int_t MakeProjectParMake(const char *packname, const char *filename)
Create makefile at &#39;filemake&#39; for PAR package &#39;pack&#39;.
Definition: TFile.cxx:3253
virtual Bool_t ReadBufferAsync(Long64_t offs, Int_t len)
Definition: TFile.cxx:5075
TFileCacheWrite * fCacheWrite
!Pointer to the write cache (if any)
Definition: TFile.h:95
virtual void Close(Option_t *option="")
Close a file.
Definition: TFile.cxx:913
virtual Bool_t Matches(const char *name)
Return kTRUE if &#39;url&#39; matches the coordinates of this file.
Definition: TFile.cxx:4631
Bool_t IsRaw() const
Definition: TFile.h:244
const char * Data() const
Definition: TString.h:364
Array of chars or bytes (8 bits per element).
Definition: TArrayC.h:27
ECacheAction
TTreeCache flushing semantics.
Definition: TFile.h:65
ROOT::Internal::RConcurrentHashColl::HashValue fHash
Definition: TFile.h:141
Stopwatch class.
Definition: TStopwatch.h:28
virtual EAsyncOpenStatus GetAsyncOpenStatus()
Definition: TFile.h:130