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 "TDirectoryFile.h"
27 #include "TMap.h"
28 #include "TUrl.h"
29 
30 #ifdef R__USE_IMT
31 #include "ROOT/TRWSpinLock.hxx"
33 #include <mutex>
34 #endif
35 
36 
37 class TFree;
38 class TArrayC;
39 class TArchiveFile;
40 class TFileOpenHandle;
41 class TFileCacheRead;
42 class TFileCacheWrite;
43 class TProcessID;
44 class TStopwatch;
45 class TFilePrefetch;
46 
47 class TFile : public TDirectoryFile {
48  friend class TDirectoryFile;
49  friend class TFilePrefetch;
50 // TODO: We need to make sure only one TBasket is being written at a time
51 // if we are writing multiple baskets in parallel.
52 #ifdef R__USE_IMT
53  friend class TBasket;
54 #endif
55 
56 public:
57  /// Asynchronous open request status
60  /// Open timeout constants
61  enum EOpenTimeOut { kInstantTimeout = 0, kEternalTimeout = 999999999 };
62 
63  /// TTreeCache flushing semantics
65 
66 protected:
67  Double_t fSumBuffer; ///<Sum of buffer sizes of objects written so far
68  Double_t fSum2Buffer; ///<Sum of squares of buffer sizes of objects written so far
69  Long64_t fBytesWrite; ///<Number of bytes written to this file
70  Long64_t fBytesRead; ///<Number of bytes read from this file
71  Long64_t fBytesReadExtra; ///<Number of extra bytes (overhead) read by the readahead buffer
72  Long64_t fBEGIN; ///<First used byte in file
73  Long64_t fEND; ///<Last used byte in file
74  Long64_t fSeekFree; ///<Location on disk of free segments structure
75  Long64_t fSeekInfo; ///<Location on disk of StreamerInfo record
76  Int_t fD; ///<File descriptor
77  Int_t fVersion; ///<File format version
78  Int_t fCompress; ///<Compression level and algorithm
79  Int_t fNbytesFree; ///<Number of bytes for free segments structure
80  Int_t fNbytesInfo; ///<Number of bytes for StreamerInfo record
81  Int_t fWritten; ///<Number of objects written so far
82  Int_t fNProcessIDs; ///<Number of TProcessID written to this file
83  Int_t fReadCalls; ///<Number of read calls ( not counting the cache calls )
84  TString fRealName; ///<Effective real file name (not original url)
85  TString fOption; ///<File options
86  Char_t fUnits; ///<Number of bytes for file pointers
87  TList *fFree; ///<Free segments linked list table
88  TArrayC *fClassIndex; ///<!Index of TStreamerInfo classes written to this file
89  TObjArray *fProcessIDs; ///<!Array of pointers to TProcessIDs
90  Long64_t fOffset; ///<!Seek offset cache
91  TArchiveFile *fArchive; ///<!Archive file from which we read this file
92  TFileCacheRead *fCacheRead; ///<!Pointer to the read cache (if any)
93  TMap *fCacheReadMap; ///<!Pointer to the read cache (if any)
94  TFileCacheWrite *fCacheWrite; ///<!Pointer to the write cache (if any)
95  Long64_t fArchiveOffset; ///<!Offset at which file starts in archive
96  Bool_t fIsArchive : 1; ///<!True if this is a pure archive file
97  Bool_t fNoAnchorInName : 1; ///<!True if we don't want to force the anchor to be appended to the file name
98  Bool_t fIsRootFile : 1; ///<!True is this is a ROOT file, raw file otherwise
99  Bool_t fInitDone : 1; ///<!True if the file has been initialized
100  Bool_t fMustFlush : 1; ///<!True if the file buffers must be flushed
101  Bool_t fIsPcmFile : 1; ///<!True if the file is a ROOT pcm file.
102  TFileOpenHandle *fAsyncHandle; ///<!For proper automatic cleanup
103  EAsyncOpenStatus fAsyncOpenStatus; ///<!Status of an asynchronous open request
104  TUrl fUrl; ///<!URL of file
105 
106  TList *fInfoCache; ///<!Cached list of the streamer infos in this file
107  TList *fOpenPhases; ///<!Time info about open phases
108 
109 #ifdef R__USE_IMT
110  static ROOT::TRWSpinLock fgRwLock; ///<!Read-write lock to protect global PID list
111  std::mutex fWriteMutex; ///<!Lock for writing baskets / keys into the file.
112  static ROOT::Internal::RConcurrentHashColl fgTsSIHashes; ///<!TS Set of hashes built from read streamer infos
113 #endif
114 
115  static TList *fgAsyncOpenRequests; //List of handles for pending open requests
116 
117  static TString fgCacheFileDir; ///<Directory where to locally stage files
118  static Bool_t fgCacheFileDisconnected; ///<Indicates, we trust in the files in the cache dir without stat on the cached file
119  static Bool_t fgCacheFileForce; ///<Indicates, to force all READ to CACHEREAD
120  static UInt_t fgOpenTimeout; ///<Timeout for open operations in ms - 0 corresponds to blocking i/o
121  static Bool_t fgOnlyStaged ; ///<Before the file is opened, it is checked, that the file is staged, if not, the open fails
122 
123  static std::atomic<Long64_t> fgBytesWrite; ///<Number of bytes written by all TFile objects
124  static std::atomic<Long64_t> fgBytesRead; ///<Number of bytes read by all TFile objects
125  static std::atomic<Long64_t> fgFileCounter; ///<Counter for all opened files
126  static std::atomic<Int_t> fgReadCalls; ///<Number of bytes read from all TFile objects
127  static Int_t fgReadaheadSize; ///<Readahead buffer size
128  static Bool_t fgReadInfo; ///<if true (default) ReadStreamerInfo is called when opening a file
130  virtual void Init(Bool_t create);
132  Int_t ReadBufferViaCache(char *buf, Int_t len);
133  Int_t WriteBufferViaCache(const char *buf, Int_t len);
134  std::pair<TList *, Int_t> GetStreamerInfoListImpl(bool readSI);
135 
136  // Creating projects
137  Int_t MakeProjectParMake(const char *packname, const char *filename);
138  Int_t MakeProjectParProofInf(const char *packname, const char *proofinfdir);
139 
140  // Interface to basic system I/O routines
141  virtual Int_t SysOpen(const char *pathname, Int_t flags, UInt_t mode);
142  virtual Int_t SysClose(Int_t fd);
143  virtual Int_t SysRead(Int_t fd, void *buf, Int_t len);
144  virtual Int_t SysWrite(Int_t fd, const void *buf, Int_t len);
145  virtual Long64_t SysSeek(Int_t fd, Long64_t offset, Int_t whence);
146  virtual Int_t SysStat(Int_t fd, Long_t *id, Long64_t *size, Long_t *flags, Long_t *modtime);
147  virtual Int_t SysSync(Int_t fd);
148 
149  // Interface for text-based TDirectory I/O
150  virtual Long64_t DirCreateEntry(TDirectory*) { return 0; }
151  virtual Int_t DirReadKeys(TDirectory*) { return 0; }
152  virtual void DirWriteKeys(TDirectory*) {}
153  virtual void DirWriteHeader(TDirectory*) {}
154 
155 private:
156  TFile(const TFile &); //Files cannot be copied
157  void operator=(const TFile &);
158 
159  static void CpProgress(Long64_t bytesread, Long64_t size, TStopwatch &watch);
160  static TFile *OpenFromCache(const char *name, Option_t * = "",
161  const char *ftitle = "", Int_t compress = 1,
162  Int_t netopt = 0);
163 
164 public:
165  /// TFile status bits. BIT(13) is taken up by TObject
166  enum EStatusBits {
169  kDevNull = BIT(12),
173  };
174  enum ERelativeTo { kBeg = 0, kCur = 1, kEnd = 2 };
175  enum { kStartBigFile = 2000000000 };
176  /// File type
177  enum EFileType { kDefault = 0, kLocal = 1, kNet = 2, kWeb = 3, kFile = 4, kMerge = 5};
178 
179  TFile();
180  TFile(const char *fname, Option_t *option="", const char *ftitle="", Int_t compress=4);
181  virtual ~TFile();
182  virtual void Close(Option_t *option=""); // *MENU*
183  virtual void Copy(TObject &) const { MayNotUse("Copy(TObject &)"); }
184  virtual Bool_t Cp(const char *dst, Bool_t progressbar = kTRUE,UInt_t buffersize = 1000000);
185  virtual TKey* CreateKey(TDirectory* mother, const TObject* obj, const char* name, Int_t bufsize);
186  virtual TKey* CreateKey(TDirectory* mother, const void* obj, const TClass* cl,
187  const char* name, Int_t bufsize);
188  static TFile *&CurrentFile(); // Return the current file for this thread.
189  virtual void Delete(const char *namecycle="");
190  virtual void Draw(Option_t *option="");
191  virtual void DrawMap(const char *keys="*",Option_t *option=""); // *MENU*
192  virtual void FillBuffer(char *&buffer);
193  virtual void Flush();
194  TArchiveFile *GetArchive() const { return fArchive; }
196  Int_t GetBestBuffer() const;
197  virtual Int_t GetBytesToPrefetch() const;
200  TArrayC *GetClassIndex() const { return fClassIndex; }
202  Int_t GetCompressionLevel() const;
205  virtual Long64_t GetEND() const { return fEND; }
206  virtual Int_t GetErrno() const;
207  virtual void ResetErrno() const;
208  Int_t GetFd() const { return fD; }
209  virtual const TUrl *GetEndpointUrl() const { return &fUrl; }
211  TList *GetListOfFree() const { return fFree; }
212  virtual Int_t GetNfree() const { return fFree->GetSize(); }
213  virtual Int_t GetNProcessIDs() const { return fNProcessIDs; }
214  Option_t *GetOption() const { return fOption.Data(); }
215  virtual Long64_t GetBytesRead() const { return fBytesRead; }
216  virtual Long64_t GetBytesReadExtra() const { return fBytesReadExtra; }
217  virtual Long64_t GetBytesWritten() const;
218  virtual Int_t GetReadCalls() const { return fReadCalls; }
219  Int_t GetVersion() const { return fVersion; }
220  Int_t GetRecordHeader(char *buf, Long64_t first, Int_t maxbytes,
221  Int_t &nbytes, Int_t &objlen, Int_t &keylen);
222  virtual Int_t GetNbytesInfo() const {return fNbytesInfo;}
223  virtual Int_t GetNbytesFree() const {return fNbytesFree;}
224  virtual TString GetNewUrl() { return ""; }
225  Long64_t GetRelOffset() const { return fOffset - fArchiveOffset; }
226  virtual Long64_t GetSeekFree() const {return fSeekFree;}
227  virtual Long64_t GetSeekInfo() const {return fSeekInfo;}
228  virtual Long64_t GetSize() const;
229  virtual TList *GetStreamerInfoList();
230  const TList *GetStreamerInfoCache();
231  virtual void IncrementProcessIDs() { fNProcessIDs++; }
232  virtual Bool_t IsArchive() const { return fIsArchive; }
233  Bool_t IsBinary() const { return TestBit(kBinaryFile); }
234  Bool_t IsRaw() const { return !fIsRootFile; }
235  virtual Bool_t IsOpen() const;
236  virtual void ls(Option_t *option="") const;
237  virtual void MakeFree(Long64_t first, Long64_t last);
238  virtual void MakeProject(const char *dirname, const char *classes="*",
239  Option_t *option="new"); // *MENU*
240  virtual void Map(Option_t *opt); // *MENU*
241  virtual void Map() { Map(""); }; // *MENU*
242  virtual Bool_t Matches(const char *name);
243  virtual Bool_t MustFlush() const {return fMustFlush;}
244  virtual void Paint(Option_t *option="");
245  virtual void Print(Option_t *option="") const;
246  virtual Bool_t ReadBufferAsync(Long64_t offs, Int_t len);
247  virtual Bool_t ReadBuffer(char *buf, Int_t len);
248  virtual Bool_t ReadBuffer(char *buf, Long64_t pos, Int_t len);
249  virtual Bool_t ReadBuffers(char *buf, Long64_t *pos, Int_t *len, Int_t nbuf);
250  virtual void ReadFree();
251  virtual TProcessID *ReadProcessID(UShort_t pidf);
252  virtual void ReadStreamerInfo();
253  virtual Int_t Recover();
254  virtual Int_t ReOpen(Option_t *mode);
255  virtual void Seek(Long64_t offset, ERelativeTo pos = kBeg);
256  virtual void SetCacheRead(TFileCacheRead *cache, TObject* tree = 0, ECacheAction action = kDisconnect);
257  virtual void SetCacheWrite(TFileCacheWrite *cache);
258  virtual void SetCompressionAlgorithm(Int_t algorithm=0);
259  virtual void SetCompressionLevel(Int_t level=4);
260  virtual void SetCompressionSettings(Int_t settings=4);
261  virtual void SetEND(Long64_t last) { fEND = last; }
262  virtual void SetOffset(Long64_t offset, ERelativeTo pos = kBeg);
263  virtual void SetOption(Option_t *option=">") { fOption = option; }
264  virtual void SetReadCalls(Int_t readcalls = 0) { fReadCalls = readcalls; }
265  virtual void ShowStreamerInfo();
266  virtual Int_t Sizeof() const;
267  void SumBuffer(Int_t bufsize);
268  virtual Bool_t WriteBuffer(const char *buf, Int_t len);
269  virtual Int_t Write(const char *name=0, Int_t opt=0, Int_t bufsiz=0);
270  virtual Int_t Write(const char *name=0, Int_t opt=0, Int_t bufsiz=0) const;
271  virtual void WriteFree();
272  virtual void WriteHeader();
273  virtual UShort_t WriteProcessID(TProcessID *pid);
274  virtual void WriteStreamerInfo();
275 
276  static TFileOpenHandle
277  *AsyncOpen(const char *name, Option_t *option = "",
278  const char *ftitle = "", Int_t compress = 1,
279  Int_t netopt = 0);
280  static TFile *Open(const char *name, Option_t *option = "",
281  const char *ftitle = "", Int_t compress = 1,
282  Int_t netopt = 0);
283  static TFile *Open(TFileOpenHandle *handle);
284 
285  static EFileType GetType(const char *name, Option_t *option = "", TString *prefix = 0);
286 
287  static EAsyncOpenStatus GetAsyncOpenStatus(const char *name);
289  static const TUrl *GetEndpointUrl(const char *name);
290 
291  static Long64_t GetFileBytesRead();
292  static Long64_t GetFileBytesWritten();
293  static Int_t GetFileReadCalls();
294  static Int_t GetReadaheadSize();
295 
296  static void SetFileBytesRead(Long64_t bytes = 0);
297  static void SetFileBytesWritten(Long64_t bytes = 0);
298  static void SetFileReadCalls(Int_t readcalls = 0);
299  static void SetReadaheadSize(Int_t bufsize = 256000);
300  static void SetReadStreamerInfo(Bool_t readinfo=kTRUE);
301  static Bool_t GetReadStreamerInfo();
302 
303  static Long64_t GetFileCounter();
304  static void IncrementFileCounter();
305 
306  static Bool_t SetCacheFileDir(ROOT::Internal::TStringView cacheDir, Bool_t operateDisconnected = kTRUE,
307  Bool_t forceCacheread = kFALSE)
308  { return SetCacheFileDir(std::string_view(cacheDir), operateDisconnected, forceCacheread); }
309  static Bool_t SetCacheFileDir(std::string_view cacheDir, Bool_t operateDisconnected = kTRUE,
310  Bool_t forceCacheread = kFALSE);
311  static const char *GetCacheFileDir();
312  static Bool_t ShrinkCacheFileDir(Long64_t shrinkSize, Long_t cleanupInteval = 0);
313  static Bool_t Cp(const char *src, const char *dst, Bool_t progressbar = kTRUE,
314  UInt_t buffersize = 1000000);
315 
316  static UInt_t SetOpenTimeout(UInt_t timeout); // in ms
317  static UInt_t GetOpenTimeout(); // in ms
318  static Bool_t SetOnlyStaged(Bool_t onlystaged);
319  static Bool_t GetOnlyStaged();
320 
321  ClassDef(TFile,8) //ROOT file
322 };
323 
324 #ifndef __CINT__
325 #define gFile (TFile::CurrentFile())
326 
327 #elif defined(__MAKECINT__)
328 // To properly handle the use of gFile in header files (in static declarations)
330 #endif
331 
332 /**
333 \class TFileOpenHandle
334 \ingroup IO
335 Class holding info about the file being opened
336 */
337 class TFileOpenHandle : public TNamed {
338 
339 friend class TFile;
340 friend class TAlienFile;
341 
342 private:
343  TString fOpt; ///< Options
344  Int_t fCompress; ///< Compression level and algorithm
345  Int_t fNetOpt; ///< Network options
346  TFile *fFile; ///< TFile instance of the file being opened
347 
348  TFileOpenHandle(TFile *f) : TNamed("",""), fOpt(""), fCompress(1),
349  fNetOpt(0), fFile(f) { }
350  TFileOpenHandle(const char *n, const char *o, const char *t, Int_t cmp,
351  Int_t no) : TNamed(n,t), fOpt(o), fCompress(cmp),
352  fNetOpt(no), fFile(0) { }
355 
356  TFile *GetFile() const { return fFile; }
357 
358 public:
360 
361  Bool_t Matches(const char *name);
362 
363  const char *GetOpt() const { return fOpt; }
364  Int_t GetCompress() const { return fCompress; }
365  Int_t GetNetOpt() const { return fNetOpt; }
366 };
367 
368 //______________________________________________________________________________
370 {
371  return (fCompress < 0) ? -1 : fCompress / 100;
372 }
373 
374 //______________________________________________________________________________
376 {
377  return (fCompress < 0) ? -1 : fCompress % 100;
378 }
379 
380 //______________________________________________________________________________
382 {
383  return (fCompress < 0) ? -1 : fCompress;
384 }
385 
386 #endif
Long64_t GetRelOffset() const
Definition: TFile.h:225
virtual void DirWriteKeys(TDirectory *)
Definition: TFile.h:152
Bool_t fIsArchive
!True if this is a pure archive file
Definition: TFile.h:96
static ROOT::TRWSpinLock fgRwLock
!Read-write lock to protect global PID list
Definition: TFile.h:110
Bool_t fIsPcmFile
!True if the file is a ROOT pcm file.
Definition: TFile.h:101
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:1084
virtual Int_t Recover()
Attempt to recover file if not correctly closed.
Definition: TFile.cxx:1948
TFileCacheRead * fCacheRead
!Pointer to the read cache (if any)
Definition: TFile.h:92
An array of TObjects.
Definition: TObjArray.h:37
Char_t fUnits
Number of bytes for file pointers.
Definition: TFile.h:86
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:4410
void operator=(const TFile &)
TObjArray * fProcessIDs
!Array of pointers to TProcessIDs
Definition: TFile.h:89
Long64_t fBEGIN
First used byte in file.
Definition: TFile.h:72
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:128
virtual Long64_t SysSeek(Int_t fd, Long64_t offset, Int_t whence)
Interface to system lseek.
Definition: TFile.cxx:4392
Long64_t fBytesWrite
Number of bytes written to this file.
Definition: TFile.h:69
EAsyncOpenStatus
Asynchronous open request status.
Definition: TFile.h:58
virtual void FillBuffer(char *&buffer)
Encode file output buffer.
Definition: TFile.cxx:1126
Double_t fSumBuffer
Sum of buffer sizes of objects written so far.
Definition: TFile.h:67
static std::atomic< Long64_t > fgBytesRead
Number of bytes read by all TFile objects.
Definition: TFile.h:124
virtual Long64_t GetSeekInfo() const
Definition: TFile.h:227
virtual Int_t ReOpen(Option_t *mode)
Reopen a file with a different access mode.
Definition: TFile.cxx:2062
float Float_t
Definition: RtypesCore.h:53
Int_t fCompress
Compression level and algorithm.
Definition: TFile.h:78
TArchiveFile * GetArchive() const
Definition: TFile.h:194
TArrayC * fClassIndex
!Index of TStreamerInfo classes written to this file
Definition: TFile.h:88
static void IncrementFileCounter()
Definition: TFile.cxx:4487
virtual void ReadFree()
Read the FREE linked list.
Definition: TFile.cxx:1828
A cache when reading files over the network.
const char Option_t
Definition: RtypesCore.h:62
Int_t GetNetOpt() const
Definition: TFile.h:365
TString fOpt
Options.
Definition: TFile.h:343
virtual void Flush()
Synchronize a file&#39;s in-memory and on-disk states.
Definition: TFile.cxx:1097
virtual void SetCacheRead(TFileCacheRead *cache, TObject *tree=0, ECacheAction action=kDisconnect)
Set a pointer to the read cache.
Definition: TFile.cxx:2268
static TList * fgAsyncOpenRequests
Definition: TFile.h:115
virtual void SetOffset(Long64_t offset, ERelativeTo pos=kBeg)
Set position from where to start reading.
Definition: TFile.cxx:2155
This class represents a WWW compatible URL.
Definition: TUrl.h:35
virtual void SetEND(Long64_t last)
Definition: TFile.h:261
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:1012
unsigned short UShort_t
Definition: RtypesCore.h:36
Class holding info about the file being opened.
Definition: TFile.h:337
static UInt_t fgOpenTimeout
Timeout for open operations in ms - 0 corresponds to blocking i/o.
Definition: TFile.h:120
#define BIT(n)
Definition: Rtypes.h:78
virtual void SetCompressionSettings(Int_t settings=4)
Used to specify the compression level and algorithm.
Definition: TFile.cxx:2241
TArrayC * GetClassIndex() const
Definition: TFile.h:200
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:2176
virtual void DirWriteHeader(TDirectory *)
Definition: TFile.h:153
TObjArray * GetListOfProcessIDs() const
Definition: TFile.h:210
A ROOT file is a suite of consecutive data records (TKey instances) with a well defined format...
Definition: TFile.h:47
static void SetFileReadCalls(Int_t readcalls=0)
Definition: TFile.cxx:4481
virtual Bool_t ReadBuffer(char *buf, Int_t len)
Read a buffer from the file.
Definition: TFile.cxx:1673
static Bool_t SetCacheFileDir(ROOT::Internal::TStringView cacheDir, Bool_t operateDisconnected=kTRUE, Bool_t forceCacheread=kFALSE)
Definition: TFile.h:306
virtual void SetReadCalls(Int_t readcalls=0)
Definition: TFile.h:264
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:4433
TFileOpenHandle(TFile *f)
Definition: TFile.h:348
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:4533
~TFileOpenHandle()
Definition: TFile.h:359
#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:2422
Long64_t fBytesReadExtra
Number of extra bytes (overhead) read by the readahead buffer.
Definition: TFile.h:71
ERelativeTo
Definition: TFile.h:174
TList * fInfoCache
!Cached list of the streamer infos in this file
Definition: TFile.h:106
static void SetReadStreamerInfo(Bool_t readinfo=kTRUE)
Specify if the streamerinfos must be read at file opening.
Definition: TFile.cxx:3621
Long64_t fSeekInfo
Location on disk of StreamerInfo record.
Definition: TFile.h:75
Int_t fReadCalls
Number of read calls ( not counting the cache calls )
Definition: TFile.h:83
This class is a TS set of unsigned set.
TArchiveFile * fArchive
!Archive file from which we read this file
Definition: TFile.h:91
static void SetReadaheadSize(Int_t bufsize=256000)
Definition: TFile.cxx:4472
Long64_t GetArchiveOffset() const
Definition: TFile.h:195
Int_t fNetOpt
Network options.
Definition: TFile.h:345
virtual void SetCompressionLevel(Int_t level=4)
See comments for function SetCompressionSettings.
Definition: TFile.cxx:2222
virtual Bool_t IsArchive() const
Definition: TFile.h:232
void SumBuffer(Int_t bufsize)
Increment statistics for buffer sizes of objects in this file.
Definition: TFile.cxx:2320
static TFile * Open(const char *name, Option_t *option="", const char *ftitle="", Int_t compress=1, Int_t netopt=0)
Create / open a file.
Definition: TFile.cxx:3973
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:4871
#define gFile
Definition: TFile.h:325
static void SetFileBytesWritten(Long64_t bytes=0)
Definition: TFile.cxx:4478
virtual Long64_t GetSeekFree() const
Definition: TFile.h:226
virtual Int_t GetErrno() const
Method returning errno. Is overriden in TRFIOFile.
Definition: TFile.cxx:1197
Bool_t IsBinary() const
Definition: TFile.h:233
Int_t fNbytesInfo
Number of bytes for StreamerInfo record.
Definition: TFile.h:80
TMap * fCacheReadMap
!Pointer to the read cache (if any)
Definition: TFile.h:93
virtual void ResetErrno() const
Method resetting the errno. Is overridden in TRFIOFile.
Definition: TFile.cxx:1205
Int_t GetVersion() const
Definition: TFile.h:219
TUrl fUrl
!URL of file
Definition: TFile.h:104
Int_t fD
File descriptor.
Definition: TFile.h:76
#define ClassDef(name, id)
Definition: Rtypes.h:320
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:3631
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:2626
virtual void WriteFree()
Write FREE linked list on the file.
Definition: TFile.cxx:2446
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:84
std::mutex fWriteMutex
!Lock for writing baskets / keys into the file.
Definition: TFile.h:111
static Long64_t GetFileBytesRead()
Static function returning the total number of bytes read from all files.
Definition: TFile.cxx:4441
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:4688
static TFile * OpenFromCache(const char *name, Option_t *="", const char *ftitle="", Int_t compress=1, Int_t netopt=0)
Open a file for reading through the file cache.
Definition: TFile.cxx:3764
static Long64_t GetFileBytesWritten()
Static function returning the total number of bytes written to all files.
Definition: TFile.cxx:4450
virtual Int_t GetReadCalls() const
Definition: TFile.h:218
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:356
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:224
virtual void Map()
Definition: TFile.h:241
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:4381
virtual void IncrementProcessIDs()
Definition: TFile.h:231
virtual Int_t SysSync(Int_t fd)
Interface to system fsync. All arguments like in POSIX fsync().
Definition: TFile.cxx:4419
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:1250
virtual Long64_t DirCreateEntry(TDirectory *)
Definition: TFile.h:150
TFileOpenHandle(const char *n, const char *o, const char *t, Int_t cmp, Int_t no)
Definition: TFile.h:350
virtual Int_t SysClose(Int_t fd)
Interface to system close. All arguments like in POSIX close().
Definition: TFile.cxx:4364
Int_t GetCompressionAlgorithm() const
Definition: TFile.h:369
static UInt_t GetOpenTimeout()
Returns open timeout (in ms).
Definition: TFile.cxx:4601
virtual void ShowStreamerInfo()
Show the StreamerInfo of all classes written to this file.
Definition: TFile.cxx:3639
EFileType
File type.
Definition: TFile.h:177
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:4373
const char * GetOpt() const
Definition: TFile.h:363
virtual Int_t GetNfree() const
Definition: TFile.h:212
Long64_t fEND
Last used byte in file.
Definition: TFile.h:73
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:4348
virtual void WriteStreamerInfo()
Write the list of TStreamerInfo as a single object in this file The class Streamer description for al...
Definition: TFile.cxx:3681
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:2339
virtual Int_t GetBytesToPrefetch() const
Max number of bytes to prefetch.
Definition: TFile.cxx:5091
virtual void SetOption(Option_t *option=">")
Definition: TFile.h:263
virtual void Delete(const char *namecycle="")
Delete object namecycle.
Definition: TFile.cxx:1063
virtual Bool_t WriteBuffer(const char *buf, Int_t len)
Write a buffer to the file.
Definition: TFile.cxx:2379
virtual Bool_t MustFlush() const
Definition: TFile.h:243
EAsyncOpenStatus fAsyncOpenStatus
!Status of an asynchronous open request
Definition: TFile.h:103
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:1436
static std::atomic< Long64_t > fgFileCounter
Counter for all opened files.
Definition: TFile.h:125
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:123
virtual Int_t DirReadKeys(TDirectory *)
Definition: TFile.h:151
static void CpProgress(Long64_t bytesread, Long64_t size, TStopwatch &watch)
Print file copy progress.
Definition: TFile.cxx:4843
static std::atomic< Int_t > fgReadCalls
Number of bytes read from all TFile objects.
Definition: TFile.h:126
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:1076
virtual TList * GetStreamerInfoList()
Read the list of TStreamerInfo objects written to this file.
Definition: TFile.cxx:1397
static Int_t GetFileReadCalls()
Static function returning the total number of read calls from all files.
Definition: TFile.cxx:4458
std::pair< TList *, Int_t > GetStreamerInfoListImpl(bool readSI)
See documentation of GetStreamerInfoList for more details.
Definition: TFile.cxx:1325
virtual void Init(Bool_t create)
Initialize a TFile object.
Definition: TFile.cxx:595
Int_t ReadBufferViaCache(char *buf, Int_t len)
Read buffer via cache.
Definition: TFile.cxx:1792
static TFile *& CurrentFile()
Return the current ROOT file if any.
Definition: TFile.cxx:1032
Option_t * GetOption() const
Definition: TFile.h:214
const Bool_t kFALSE
Definition: RtypesCore.h:88
virtual Long64_t GetBytesRead() const
Definition: TFile.h:215
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:121
static Bool_t GetOnlyStaged()
Returns staged only flag.
Definition: TFile.cxx:4621
virtual void ReadStreamerInfo()
Read the list of StreamerInfo from this file.
Definition: TFile.cxx:3502
Double_t fSum2Buffer
Sum of squares of buffer sizes of objects written so far.
Definition: TFile.h:68
virtual Int_t GetNbytesFree() const
Definition: TFile.h:223
long Long_t
Definition: RtypesCore.h:50
TFile()
File default Constructor.
Definition: TFile.cxx:174
TList * fFree
Free segments linked list table.
Definition: TFile.h:87
TFile * fFile
Pointer to current file in memory.
virtual Int_t GetNbytesInfo() const
Definition: TFile.h:222
virtual Bool_t IsOpen() const
Returns kTRUE in case file is open and kFALSE if file is not open.
Definition: TFile.cxx:1421
Int_t fNbytesFree
Number of bytes for free segments structure.
Definition: TFile.h:79
static Bool_t fgCacheFileForce
Indicates, to force all READ to CACHEREAD.
Definition: TFile.h:119
TFile * fFile
TFile instance of the file being opened.
Definition: TFile.h:346
double Double_t
Definition: RtypesCore.h:55
static Int_t GetReadaheadSize()
Static function returning the readahead buffer size.
Definition: TFile.cxx:4466
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:1230
TMap implements an associative array of (key,value) pairs using a THashTable for efficient retrieval ...
Definition: TMap.h:40
virtual Long64_t GetSize() const
Returns the current file size.
Definition: TFile.cxx:1296
Bool_t fNoAnchorInName
!True if we don&#39;t want to force the anchor to be appended to the file name
Definition: TFile.h:97
static Bool_t fgCacheFileDisconnected
Indicates, we trust in the files in the cache dir without stat on the cached file.
Definition: TFile.h:118
TList * fOpenPhases
!Time info about open phases
Definition: TFile.h:107
basic_string_view< char > string_view
Definition: RStringView.hxx:35
TString fOption
File options.
Definition: TFile.h:85
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:100
Float_t GetCompressionFactor()
Return the file compression factor.
Definition: TFile.cxx:1153
Int_t GetCompress() const
Definition: TFile.h:364
virtual Long64_t GetBytesReadExtra() const
Definition: TFile.h:216
static ROOT::Internal::RConcurrentHashColl fgTsSIHashes
!TS Set of hashes built from read streamer infos
Definition: TFile.h:112
Bool_t fIsRootFile
!True is this is a ROOT file, raw file otherwise
Definition: TFile.h:98
const TList * GetStreamerInfoCache()
Returns the cached list of StreamerInfos used in this file.
Definition: TFile.cxx:1315
Mother of all ROOT objects.
Definition: TObject.h:37
Bool_t FlushWriteCache()
Flush the write cache if active.
Definition: TFile.cxx:1114
static Bool_t SetOnlyStaged(Bool_t onlystaged)
Sets only staged flag.
Definition: TFile.cxx:4611
virtual Long64_t GetEND() const
Definition: TFile.h:205
virtual void Paint(Option_t *option="")
Paint all objects in the file.
Definition: TFile.cxx:1601
#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:117
virtual const TUrl * GetEndpointUrl() const
Definition: TFile.h:209
virtual ~TFile()
File destructor.
Definition: TFile.cxx:545
static TFileOpenHandle * AsyncOpen(const char *name, Option_t *option="", const char *ftitle="", Int_t compress=1, Int_t netopt=0)
Submit an asynchronous open request.
Definition: TFile.cxx:4213
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:3383
virtual void Print(Option_t *option="") const
Print all objects in the file.
Definition: TFile.cxx:1609
TList * GetListOfFree() const
Definition: TFile.h:211
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:3652
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:1724
virtual Int_t GetNProcessIDs() const
Definition: TFile.h:213
Int_t fNProcessIDs
Number of TProcessID written to this file.
Definition: TFile.h:82
virtual Int_t Sizeof() const
Return the size in bytes of the file header.
Definition: TFile.cxx:2300
static UInt_t SetOpenTimeout(UInt_t timeout)
Sets open timeout time (in ms). Returns previous timeout value.
Definition: TFile.cxx:4591
virtual void SetCompressionAlgorithm(Int_t algorithm=0)
See comments for function SetCompressionSettings.
Definition: TFile.cxx:2207
Definition: tree.py:1
Int_t GetFd() const
Definition: TFile.h:208
TFileCacheRead * GetCacheRead(TObject *tree=0) const
Return a pointer to the current read cache.
Definition: TFile.cxx:1213
Int_t fVersion
File format version.
Definition: TFile.h:77
Long64_t fArchiveOffset
!Offset at which file starts in archive
Definition: TFile.h:95
Int_t fCompress
Compression level and algorithm.
Definition: TFile.h:344
Definition: first.py:1
Int_t fWritten
Number of objects written so far.
Definition: TFile.h:81
static Int_t fgReadaheadSize
Readahead buffer size.
Definition: TFile.h:127
Long64_t fOffset
!Seek offset cache
Definition: TFile.h:90
virtual void WriteHeader()
Write File Header.
Definition: TFile.cxx:2518
Bool_t fInitDone
!True if the file has been initialized
Definition: TFile.h:99
TFileOpenHandle * fAsyncHandle
!For proper automatic cleanup
Definition: TFile.h:102
EOpenTimeOut
Open timeout constants.
Definition: TFile.h:61
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:4475
virtual void ls(Option_t *option="") const
List file contents.
Definition: TFile.cxx:1409
const Bool_t kTRUE
Definition: RtypesCore.h:87
Long64_t fSeekFree
Location on disk of free segments structure.
Definition: TFile.h:74
static Long64_t GetFileCounter()
Definition: TFile.cxx:4484
const Int_t n
Definition: legend1.C:16
virtual void SetCacheWrite(TFileCacheWrite *cache)
Set a pointer to the write cache.
Definition: TFile.cxx:2291
Int_t GetCompressionLevel() const
Definition: TFile.h:375
Long64_t fBytesRead
Number of bytes read from this file.
Definition: TFile.h:70
char name[80]
Definition: TGX11.cxx:109
static const char * GetCacheFileDir()
Get the directory where to locally stage/cache remote files.
Definition: TFile.cxx:4521
virtual TProcessID * ReadProcessID(UShort_t pidf)
The TProcessID with number pidf is read from this file.
Definition: TFile.cxx:1854
A cache when writing files over the network.
Int_t GetCompressionSettings() const
Definition: TFile.h:381
Int_t GetBestBuffer() const
Return the best buffer size of objects on this file.
Definition: TFile.cxx:1139
virtual void Copy(TObject &) const
Copy this to obj.
Definition: TFile.h:183
Int_t MakeProjectParMake(const char *packname, const char *filename)
Create makefile at &#39;filemake&#39; for PAR package &#39;pack&#39;.
Definition: TFile.cxx:3261
virtual Bool_t ReadBufferAsync(Long64_t offs, Int_t len)
Definition: TFile.cxx:5077
TFileCacheWrite * fCacheWrite
!Pointer to the write cache (if any)
Definition: TFile.h:94
virtual void Close(Option_t *option="")
Close a file.
Definition: TFile.cxx:915
virtual Bool_t Matches(const char *name)
Return kTRUE if &#39;url&#39; matches the coordinates of this file.
Definition: TFile.cxx:4633
Bool_t IsRaw() const
Definition: TFile.h:234
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:64
Stopwatch class.
Definition: TStopwatch.h:28
virtual EAsyncOpenStatus GetAsyncOpenStatus()
Definition: TFile.h:129