Logo ROOT   master
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 "TUrl.h"
30 
31 // Not a part of TFile interface; provide a forward declaration instead of #include.
32 // #ifndef R__LESS_INCLUDES
33 // #include "TMap.h"
34 // #endif
35 
36 #ifdef R__USE_IMT
37 #include "ROOT/TRWSpinLock.hxx"
38 #include <mutex>
39 #endif
40 
41 
42 class TMap;
43 class TFree;
44 class TArrayC;
45 class TArchiveFile;
46 class TFileOpenHandle;
47 class TFileCacheRead;
48 class TFileCacheWrite;
49 class TProcessID;
50 class TStopwatch;
51 class TFilePrefetch;
52 
53 class TFile : public TDirectoryFile {
54  friend class TDirectoryFile;
55  friend class TFilePrefetch;
56 // TODO: We need to make sure only one TBasket is being written at a time
57 // if we are writing multiple baskets in parallel.
58 #ifdef R__USE_IMT
59  friend class TBasket;
60 #endif
61 
62 public:
63  /// Asynchronous open request status
66  /// Open timeout constants
67  enum EOpenTimeOut { kInstantTimeout = 0, kEternalTimeout = 999999999 };
68 
69  /// TTreeCache flushing semantics
71 
72 protected:
73  Double_t fSumBuffer{0}; ///<Sum of buffer sizes of objects written so far
74  Double_t fSum2Buffer{0}; ///<Sum of squares of buffer sizes of objects written so far
75  Long64_t fBytesWrite{0}; ///<Number of bytes written to this file
76  Long64_t fBytesRead{0}; ///<Number of bytes read from this file
77  Long64_t fBytesReadExtra{0}; ///<Number of extra bytes (overhead) read by the readahead buffer
78  Long64_t fBEGIN{0}; ///<First used byte in file
79  Long64_t fEND{0}; ///<Last used byte in file
80  Long64_t fSeekFree{0}; ///<Location on disk of free segments structure
81  Long64_t fSeekInfo{0}; ///<Location on disk of StreamerInfo record
82  Int_t fD{-1}; ///<File descriptor
83  Int_t fVersion{0}; ///<File format version
84  Int_t fCompress{0}; ///<Compression level and algorithm
85  Int_t fNbytesFree{0}; ///<Number of bytes for free segments structure
86  Int_t fNbytesInfo{0}; ///<Number of bytes for StreamerInfo record
87  Int_t fWritten{0}; ///<Number of objects written so far
88  Int_t fNProcessIDs{0}; ///<Number of TProcessID written to this file
89  Int_t fReadCalls{0}; ///<Number of read calls ( not counting the cache calls )
90  TString fRealName; ///<Effective real file name (not original url)
91  TString fOption; ///<File options
92  Char_t fUnits{0}; ///<Number of bytes for file pointers
93  TList *fFree{nullptr}; ///<Free segments linked list table
94  TArrayC *fClassIndex{nullptr}; ///<!Index of TStreamerInfo classes written to this file
95  TObjArray *fProcessIDs{nullptr}; ///<!Array of pointers to TProcessIDs
96  Long64_t fOffset{0}; ///<!Seek offset cache
97  TArchiveFile *fArchive{nullptr}; ///<!Archive file from which we read this file
98  TFileCacheRead *fCacheRead{nullptr}; ///<!Pointer to the read cache (if any)
99  TMap *fCacheReadMap{nullptr}; ///<!Pointer to the read cache (if any)
100  TFileCacheWrite *fCacheWrite{nullptr}; ///<!Pointer to the write cache (if any)
101  Long64_t fArchiveOffset{0}; ///<!Offset at which file starts in archive
102  Bool_t fIsArchive{kFALSE}; ///<!True if this is a pure archive file
103  Bool_t fNoAnchorInName{kFALSE}; ///<!True if we don't want to force the anchor to be appended to the file name
104  Bool_t fIsRootFile{kTRUE}; ///<!True is this is a ROOT file, raw file otherwise
105  Bool_t fInitDone{kFALSE}; ///<!True if the file has been initialized
106  Bool_t fMustFlush{kTRUE}; ///<!True if the file buffers must be flushed
107  Bool_t fIsPcmFile{kFALSE}; ///<!True if the file is a ROOT pcm file.
108  TFileOpenHandle *fAsyncHandle{nullptr}; ///<!For proper automatic cleanup
109  EAsyncOpenStatus fAsyncOpenStatus{kAOSNotAsync}; ///<!Status of an asynchronous open request
110  TUrl fUrl; ///<!URL of file
111 
112  TList *fInfoCache{nullptr}; ///<!Cached list of the streamer infos in this file
113  TList *fOpenPhases{nullptr}; ///<!Time info about open phases
114 
115 #ifdef R__USE_IMT
116  std::mutex fWriteMutex; ///<!Lock for writing baskets / keys into the file.
117  static ROOT::Internal::RConcurrentHashColl fgTsSIHashes; ///<!TS Set of hashes built from read streamer infos
118 #endif
119 
120  static TList *fgAsyncOpenRequests; //List of handles for pending open requests
121 
122  static TString fgCacheFileDir; ///<Directory where to locally stage files
123  static Bool_t fgCacheFileDisconnected; ///<Indicates, we trust in the files in the cache dir without stat on the cached file
124  static Bool_t fgCacheFileForce; ///<Indicates, to force all READ to CACHEREAD
125  static UInt_t fgOpenTimeout; ///<Timeout for open operations in ms - 0 corresponds to blocking i/o
126  static Bool_t fgOnlyStaged ; ///<Before the file is opened, it is checked, that the file is staged, if not, the open fails
127 
128  static std::atomic<Long64_t> fgBytesWrite; ///<Number of bytes written by all TFile objects
129  static std::atomic<Long64_t> fgBytesRead; ///<Number of bytes read by all TFile objects
130  static std::atomic<Long64_t> fgFileCounter; ///<Counter for all opened files
131  static std::atomic<Int_t> fgReadCalls; ///<Number of bytes read from all TFile objects
132  static Int_t fgReadaheadSize; ///<Readahead buffer size
133  static Bool_t fgReadInfo; ///<if true (default) ReadStreamerInfo is called when opening a file
134 
136  virtual void Init(Bool_t create);
138  Int_t ReadBufferViaCache(char *buf, Int_t len);
139  Int_t WriteBufferViaCache(const char *buf, Int_t len);
140 
141  ////////////////////////////////////////////////////////////////////////////////
142  /// \brief Simple struct of the return value of GetStreamerInfoListImpl
143  struct InfoListRet {
147  };
148 
149  virtual InfoListRet GetStreamerInfoListImpl(bool lookupSICache);
150 
151  // Creating projects
152  Int_t MakeProjectParMake(const char *packname, const char *filename);
153  Int_t MakeProjectParProofInf(const char *packname, const char *proofinfdir);
154 
155  // Interface to basic system I/O routines
156  virtual Int_t SysOpen(const char *pathname, Int_t flags, UInt_t mode);
157  virtual Int_t SysClose(Int_t fd);
158  virtual Int_t SysRead(Int_t fd, void *buf, Int_t len);
159  virtual Int_t SysWrite(Int_t fd, const void *buf, Int_t len);
160  virtual Long64_t SysSeek(Int_t fd, Long64_t offset, Int_t whence);
161  virtual Int_t SysStat(Int_t fd, Long_t *id, Long64_t *size, Long_t *flags, Long_t *modtime);
162  virtual Int_t SysSync(Int_t fd);
163 
164  // Interface for text-based TDirectory I/O
165  virtual Long64_t DirCreateEntry(TDirectory*) { return 0; }
166  virtual Int_t DirReadKeys(TDirectory*) { return 0; }
167  virtual void DirWriteKeys(TDirectory*) {}
168  virtual void DirWriteHeader(TDirectory*) {}
169 
170 private:
171  TFile(const TFile &) = delete; //Files cannot be copied
172  void operator=(const TFile &) = delete;
173 
174  static void CpProgress(Long64_t bytesread, Long64_t size, TStopwatch &watch);
175  static TFile *OpenFromCache(const char *name, Option_t * = "",
176  const char *ftitle = "", Int_t compress = ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault,
177  Int_t netopt = 0);
178 
179 public:
180  /// TFile status bits. BIT(13) is taken up by TObject
181  enum EStatusBits {
184  kDevNull = BIT(12),
189  };
190  enum ERelativeTo { kBeg = 0, kCur = 1, kEnd = 2 };
191  enum { kStartBigFile = 2000000000 };
192  /// File type
193  enum EFileType { kDefault = 0, kLocal = 1, kNet = 2, kWeb = 3, kFile = 4, kMerge = 5 };
194 
195  TFile();
196  TFile(const char *fname, Option_t *option="", const char *ftitle="", Int_t compress = ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault);
197  virtual ~TFile();
198 
199  void Close(Option_t *option="") override; // *MENU*
200  void Copy(TObject &) const override { MayNotUse("Copy(TObject &)"); }
201  virtual Bool_t Cp(const char *dst, Bool_t progressbar = kTRUE,UInt_t buffersize = 1000000);
202  virtual TKey* CreateKey(TDirectory* mother, const TObject* obj, const char* name, Int_t bufsize);
203  virtual TKey* CreateKey(TDirectory* mother, const void* obj, const TClass* cl,
204  const char* name, Int_t bufsize);
205  static TFile *&CurrentFile(); // Return the current file for this thread.
206  void Delete(const char *namecycle="") override;
207  void Draw(Option_t *option="") override;
208  virtual void DrawMap(const char *keys="*",Option_t *option=""); // *MENU*
209  void FillBuffer(char *&buffer) override;
210  virtual void Flush();
211  TArchiveFile *GetArchive() const { return fArchive; }
213  Int_t GetBestBuffer() const;
214  virtual Int_t GetBytesToPrefetch() const;
215  TFileCacheRead *GetCacheRead(const TObject* tree = nullptr) const;
217  TArrayC *GetClassIndex() const { return fClassIndex; }
219  Int_t GetCompressionLevel() const;
222  virtual Long64_t GetEND() const { return fEND; }
223  virtual Int_t GetErrno() const;
224  virtual void ResetErrno() const;
225  Int_t GetFd() const { return fD; }
226  virtual const TUrl *GetEndpointUrl() const { return &fUrl; }
228  TList *GetListOfFree() const { return fFree; }
229  virtual Int_t GetNfree() const { return fFree->GetSize(); }
230  virtual Int_t GetNProcessIDs() const { return fNProcessIDs; }
231  Option_t *GetOption() const override { return fOption.Data(); }
232  virtual Long64_t GetBytesRead() const { return fBytesRead; }
233  virtual Long64_t GetBytesReadExtra() const { return fBytesReadExtra; }
234  virtual Long64_t GetBytesWritten() const;
235  virtual Int_t GetReadCalls() const { return fReadCalls; }
236  Int_t GetVersion() const { return fVersion; }
237  Int_t GetRecordHeader(char *buf, Long64_t first, Int_t maxbytes,
238  Int_t &nbytes, Int_t &objlen, Int_t &keylen);
239  virtual Int_t GetNbytesInfo() const {return fNbytesInfo;}
240  virtual Int_t GetNbytesFree() const {return fNbytesFree;}
241  virtual TString GetNewUrl() { return ""; }
243  virtual Long64_t GetSeekFree() const {return fSeekFree;}
244  virtual Long64_t GetSeekInfo() const {return fSeekInfo;}
245  virtual Long64_t GetSize() const;
246  virtual TList *GetStreamerInfoList() final; // Note: to override behavior, please override GetStreamerInfoListImpl
247  const TList *GetStreamerInfoCache();
248  virtual void IncrementProcessIDs() { fNProcessIDs++; }
249  virtual Bool_t IsArchive() const { return fIsArchive; }
250  Bool_t IsBinary() const { return TestBit(kBinaryFile); }
251  Bool_t IsRaw() const { return !fIsRootFile; }
252  virtual Bool_t IsOpen() const;
253  void ls(Option_t *option="") const override;
254  virtual void MakeFree(Long64_t first, Long64_t last);
255  virtual void MakeProject(const char *dirname, const char *classes="*",
256  Option_t *option="new"); // *MENU*
257  virtual void Map(Option_t *opt); // *MENU*
258  virtual void Map() { Map(""); }; // *MENU*
259  virtual Bool_t Matches(const char *name);
260  virtual Bool_t MustFlush() const {return fMustFlush;}
261  void Paint(Option_t *option="") override;
262  void Print(Option_t *option="") const override;
263  virtual Bool_t ReadBufferAsync(Long64_t offs, Int_t len);
264  virtual Bool_t ReadBuffer(char *buf, Int_t len);
265  virtual Bool_t ReadBuffer(char *buf, Long64_t pos, Int_t len);
266  virtual Bool_t ReadBuffers(char *buf, Long64_t *pos, Int_t *len, Int_t nbuf);
267  virtual void ReadFree();
268  virtual TProcessID *ReadProcessID(UShort_t pidf);
269  virtual void ReadStreamerInfo();
270  virtual Int_t Recover();
271  virtual Int_t ReOpen(Option_t *mode);
272  virtual void Seek(Long64_t offset, ERelativeTo pos = kBeg);
273  virtual void SetCacheRead(TFileCacheRead *cache, TObject* tree = 0, ECacheAction action = kDisconnect);
274  virtual void SetCacheWrite(TFileCacheWrite *cache);
278  virtual void SetEND(Long64_t last) { fEND = last; }
279  virtual void SetOffset(Long64_t offset, ERelativeTo pos = kBeg);
280  virtual void SetOption(Option_t *option=">") { fOption = option; }
281  virtual void SetReadCalls(Int_t readcalls = 0) { fReadCalls = readcalls; }
282  virtual void ShowStreamerInfo();
283  Int_t Sizeof() const override;
284  void SumBuffer(Int_t bufsize);
285  virtual Bool_t WriteBuffer(const char *buf, Int_t len);
286  Int_t Write(const char *name=nullptr, Int_t opt=0, Int_t bufsiz=0) override;
287  Int_t Write(const char *name=nullptr, Int_t opt=0, Int_t bufsiz=0) const override;
288  virtual void WriteFree();
289  virtual void WriteHeader();
290  virtual UShort_t WriteProcessID(TProcessID *pid);
291  virtual void WriteStreamerInfo();
292 
293  static TFileOpenHandle
294  *AsyncOpen(const char *name, Option_t *option = "",
295  const char *ftitle = "", Int_t compress = ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault,
296  Int_t netopt = 0);
297  static TFile *Open(const char *name, Option_t *option = "",
298  const char *ftitle = "", Int_t compress = ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault,
299  Int_t netopt = 0);
300  static TFile *Open(TFileOpenHandle *handle);
301 
302  static EFileType GetType(const char *name, Option_t *option = "", TString *prefix = nullptr);
303 
304  static EAsyncOpenStatus GetAsyncOpenStatus(const char *name);
306  static const TUrl *GetEndpointUrl(const char *name);
307 
308  static Long64_t GetFileBytesRead();
309  static Long64_t GetFileBytesWritten();
310  static Int_t GetFileReadCalls();
311  static Int_t GetReadaheadSize();
312 
313  static void SetFileBytesRead(Long64_t bytes = 0);
314  static void SetFileBytesWritten(Long64_t bytes = 0);
315  static void SetFileReadCalls(Int_t readcalls = 0);
316  static void SetReadaheadSize(Int_t bufsize = 256000);
317  static void SetReadStreamerInfo(Bool_t readinfo=kTRUE);
318  static Bool_t GetReadStreamerInfo();
319 
320  static Long64_t GetFileCounter();
321  static void IncrementFileCounter();
322 
323  static Bool_t SetCacheFileDir(ROOT::Internal::TStringView cacheDir, Bool_t operateDisconnected = kTRUE,
324  Bool_t forceCacheread = kFALSE)
325  { return SetCacheFileDir(std::string_view(cacheDir), operateDisconnected, forceCacheread); }
326  static Bool_t SetCacheFileDir(std::string_view cacheDir, Bool_t operateDisconnected = kTRUE,
327  Bool_t forceCacheread = kFALSE);
328  static const char *GetCacheFileDir();
329  static Bool_t ShrinkCacheFileDir(Long64_t shrinkSize, Long_t cleanupInteval = 0);
330  static Bool_t Cp(const char *src, const char *dst, Bool_t progressbar = kTRUE,
331  UInt_t buffersize = 1000000);
332 
333  static UInt_t SetOpenTimeout(UInt_t timeout); // in ms
334  static UInt_t GetOpenTimeout(); // in ms
335  static Bool_t SetOnlyStaged(Bool_t onlystaged);
336  static Bool_t GetOnlyStaged();
337 
338  ClassDefOverride(TFile,8) //ROOT file
339 };
340 
341 #ifndef __CINT__
342 #define gFile (TFile::CurrentFile())
343 
344 #elif defined(__MAKECINT__)
345 // To properly handle the use of gFile in header files (in static declarations)
347 #endif
348 
349 /**
350 \class TFileOpenHandle
351 \ingroup IO
352 Class holding info about the file being opened
353 */
354 class TFileOpenHandle : public TNamed {
355 
356 friend class TFile;
357 friend class TAlienFile;
358 
359 private:
360  TString fOpt; ///< Options
361  Int_t fCompress{0}; ///< Compression level and algorithm
362  Int_t fNetOpt{0}; ///< Network options
363  TFile *fFile{nullptr}; ///< TFile instance of the file being opened
364 
365  TFileOpenHandle(TFile *f) : TNamed("",""), fOpt(""), fCompress(ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault),
366  fNetOpt(0), fFile(f) { }
367  TFileOpenHandle(const char *n, const char *o, const char *t, Int_t cmp,
368  Int_t no) : TNamed(n,t), fOpt(o), fCompress(cmp),
369  fNetOpt(no), fFile(nullptr) { }
370  TFileOpenHandle(const TFileOpenHandle&) = delete;
371  TFileOpenHandle& operator=(const TFileOpenHandle&) = delete;
372 
373  TFile *GetFile() const { return fFile; }
374 
375 public:
377 
378  Bool_t Matches(const char *name);
379 
380  const char *GetOpt() const { return fOpt; }
381  Int_t GetCompress() const { return fCompress; }
382  Int_t GetNetOpt() const { return fNetOpt; }
383 };
384 
385 //______________________________________________________________________________
387 {
388  return (fCompress < 0) ? -1 : fCompress / 100;
389 }
390 
391 //______________________________________________________________________________
393 {
394  return (fCompress < 0) ? -1 : fCompress % 100;
395 }
396 
397 //______________________________________________________________________________
399 {
400  return (fCompress < 0) ? -1 : fCompress;
401 }
402 
403 #endif
void operator=(const TFile &)=delete
Long64_t GetRelOffset() const
Definition: TFile.h:242
virtual void DirWriteKeys(TDirectory *)
Definition: TFile.h:167
Bool_t fIsArchive
!True if this is a pure archive file
Definition: TFile.h:102
Bool_t fIsPcmFile
!True if the file is a ROOT pcm file.
Definition: TFile.h:107
Class describing an archive file containing multiple sub-files, like a ZIP or TAR archive...
Definition: TArchiveFile.h:24
Compression level reserved when we are not sure what to use (1 is for the fastest compression) ...
Definition: Compression.h:68
virtual void DrawMap(const char *keys="*", Option_t *option="")
Draw map of objects in this file.
Definition: TFile.cxx:1043
virtual Int_t Recover()
Attempt to recover file if not correctly closed.
Definition: TFile.cxx:1910
TFileCacheRead * fCacheRead
!Pointer to the read cache (if any)
Definition: TFile.h:98
An array of TObjects.
Definition: TObjArray.h:37
Char_t fUnits
Number of bytes for file pointers.
Definition: TFile.h:92
static TFile * OpenFromCache(const char *name, Option_t *="", const char *ftitle="", Int_t compress=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault, Int_t netopt=0)
Open a file for reading through the file cache.
Definition: TFile.cxx:3735
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:4380
virtual void SetCompressionSettings(Int_t settings=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault)
Used to specify the compression level and algorithm.
Definition: TFile.cxx:2200
TObjArray * fProcessIDs
!Array of pointers to TProcessIDs
Definition: TFile.h:95
Long64_t fBEGIN
First used byte in file.
Definition: TFile.h:78
long long Long64_t
Definition: RtypesCore.h:71
void Paint(Option_t *option="") override
Paint all objects in the file.
Definition: TFile.cxx:1560
static TFile * Open(const char *name, Option_t *option="", const char *ftitle="", Int_t compress=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault, Int_t netopt=0)
Create / open a file.
Definition: TFile.cxx:3944
static Bool_t fgReadInfo
if true (default) ReadStreamerInfo is called when opening a file
Definition: TFile.h:133
virtual Long64_t SysSeek(Int_t fd, Long64_t offset, Int_t whence)
Interface to system lseek.
Definition: TFile.cxx:4362
Long64_t fBytesWrite
Number of bytes written to this file.
Definition: TFile.h:75
EAsyncOpenStatus
Asynchronous open request status.
Definition: TFile.h:64
Returns the available number of logical cores.
Definition: StringConv.hxx:21
Double_t fSumBuffer
Sum of buffer sizes of objects written so far.
Definition: TFile.h:73
static std::atomic< Long64_t > fgBytesRead
Number of bytes read by all TFile objects.
Definition: TFile.h:129
virtual Long64_t GetSeekInfo() const
Definition: TFile.h:244
virtual Int_t ReOpen(Option_t *mode)
Reopen a file with a different access mode.
Definition: TFile.cxx:2024
float Float_t
Definition: RtypesCore.h:55
Int_t fCompress
Compression level and algorithm.
Definition: TFile.h:84
TArchiveFile * GetArchive() const
Definition: TFile.h:211
TArrayC * fClassIndex
!Index of TStreamerInfo classes written to this file
Definition: TFile.h:94
Bool_t Matches(const char *name)
Return kTRUE if this async request matches the open request specified by &#39;url&#39;.
Definition: TFile.cxx:4627
static void IncrementFileCounter()
Definition: TFile.cxx:4457
virtual void ReadFree()
Read the FREE linked list.
Definition: TFile.cxx:1787
A cache when reading files over the network.
const char Option_t
Definition: RtypesCore.h:64
Int_t GetNetOpt() const
Definition: TFile.h:382
TString fOpt
Options.
Definition: TFile.h:360
virtual void Flush()
Synchronize a file&#39;s in-memory and on-disk states.
Definition: TFile.cxx:1056
virtual void SetCacheRead(TFileCacheRead *cache, TObject *tree=0, ECacheAction action=kDisconnect)
Set a pointer to the read cache.
Definition: TFile.cxx:2227
static TList * fgAsyncOpenRequests
Definition: TFile.h:120
virtual void SetOffset(Long64_t offset, ERelativeTo pos=kBeg)
Set position from where to start reading.
Definition: TFile.cxx:2115
This class represents a WWW compatible URL.
Definition: TUrl.h:33
virtual void SetEND(Long64_t last)
Definition: TFile.h:278
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:971
unsigned short UShort_t
Definition: RtypesCore.h:38
Class holding info about the file being opened
Definition: TFile.h:354
static UInt_t fgOpenTimeout
Timeout for open operations in ms - 0 corresponds to blocking i/o.
Definition: TFile.h:125
#define BIT(n)
Definition: Rtypes.h:83
TArrayC * GetClassIndex() const
Definition: TFile.h:217
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:2136
virtual void DirWriteHeader(TDirectory *)
Definition: TFile.h:168
TObjArray * GetListOfProcessIDs() const
Definition: TFile.h:227
A ROOT file is a suite of consecutive data records (TKey instances) with a well defined format...
Definition: TFile.h:53
static void SetFileReadCalls(Int_t readcalls=0)
Definition: TFile.cxx:4451
virtual Bool_t ReadBuffer(char *buf, Int_t len)
Read a buffer from the file.
Definition: TFile.cxx:1632
static Bool_t SetCacheFileDir(ROOT::Internal::TStringView cacheDir, Bool_t operateDisconnected=kTRUE, Bool_t forceCacheread=kFALSE)
Definition: TFile.h:323
virtual void SetReadCalls(Int_t readcalls=0)
Definition: TFile.h:281
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:4403
TFileOpenHandle(TFile *f)
Definition: TFile.h:365
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:4503
~TFileOpenHandle()
Definition: TFile.h:376
#define f(i)
Definition: RSha256.hxx:104
int Int_t
Definition: RtypesCore.h:43
bool Bool_t
Definition: RtypesCore.h:61
Int_t WriteBufferViaCache(const char *buf, Int_t len)
Write buffer via cache.
Definition: TFile.cxx:2381
Long64_t fBytesReadExtra
Number of extra bytes (overhead) read by the readahead buffer.
Definition: TFile.h:77
ERelativeTo
Definition: TFile.h:190
TList * fInfoCache
!Cached list of the streamer infos in this file
Definition: TFile.h:112
virtual TList * GetStreamerInfoList() final
Read the list of TStreamerInfo objects written to this file.
Definition: TFile.cxx:1356
void FillBuffer(char *&buffer) override
Encode file output buffer.
Definition: TFile.cxx:1085
static void SetReadStreamerInfo(Bool_t readinfo=kTRUE)
Specify if the streamerinfos must be read at file opening.
Definition: TFile.cxx:3592
Long64_t fSeekInfo
Location on disk of StreamerInfo record.
Definition: TFile.h:81
Int_t fReadCalls
Number of read calls ( not counting the cache calls )
Definition: TFile.h:89
This class is a TS set of unsigned set.
TArchiveFile * fArchive
!Archive file from which we read this file
Definition: TFile.h:97
static EFileType GetType(const char *name, Option_t *option="", TString *prefix=nullptr)
Resolve the file type as a function of the protocol field in &#39;name&#39;.
Definition: TFile.cxx:4658
static void SetReadaheadSize(Int_t bufsize=256000)
Definition: TFile.cxx:4442
Long64_t GetArchiveOffset() const
Definition: TFile.h:212
Int_t fNetOpt
Network options.
Definition: TFile.h:362
virtual Bool_t IsArchive() const
Definition: TFile.h:249
void SumBuffer(Int_t bufsize)
Increment statistics for buffer sizes of objects in this file.
Definition: TFile.cxx:2279
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:4841
#define gFile
Definition: TFile.h:342
static void SetFileBytesWritten(Long64_t bytes=0)
Definition: TFile.cxx:4448
virtual Long64_t GetSeekFree() const
Definition: TFile.h:243
virtual Int_t GetErrno() const
Method returning errno.
Definition: TFile.cxx:1161
Use the global compression algorithm.
Definition: Compression.h:88
Bool_t IsBinary() const
Definition: TFile.h:250
Int_t fNbytesInfo
Number of bytes for StreamerInfo record.
Definition: TFile.h:86
TMap * fCacheReadMap
!Pointer to the read cache (if any)
Definition: TFile.h:99
virtual void ResetErrno() const
Method resetting the errno.
Definition: TFile.cxx:1169
Int_t GetVersion() const
Definition: TFile.h:236
TUrl fUrl
!URL of file
Definition: TFile.h:110
Int_t fD
File descriptor.
Definition: TFile.h:82
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:3602
void Draw(Option_t *option="") override
Fill Graphics Structure and Paint.
Definition: TFile.cxx:1035
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:2588
virtual void WriteFree()
Write FREE linked list on the file.
Definition: TFile.cxx:2405
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:90
std::mutex fWriteMutex
!Lock for writing baskets / keys into the file.
Definition: TFile.h:116
static Long64_t GetFileBytesRead()
Static function returning the total number of bytes read from all files.
Definition: TFile.cxx:4411
Option_t * GetOption() const override
Definition: TFile.h:231
static Long64_t GetFileBytesWritten()
Static function returning the total number of bytes written to all files.
Definition: TFile.cxx:4420
virtual Int_t GetReadCalls() const
Definition: TFile.h:235
Int_t Write(const char *name=nullptr, Int_t opt=0, Int_t bufsiz=0) override
Write memory objects to this file.
Definition: TFile.cxx:2298
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:941
TFile * GetFile() const
Definition: TFile.h:373
Use the compile-time default setting.
Definition: Compression.h:50
Book space in a file, create I/O buffers, to fill them, (un)compress them.
Definition: TKey.h:28
A TProcessID identifies a ROOT job in a unique way in time and space.
Definition: TProcessID.h:74
virtual TString GetNewUrl()
Definition: TFile.h:241
virtual void Map()
Definition: TFile.h:258
Simple struct of the return value of GetStreamerInfoListImpl.
Definition: TFile.h:143
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:4351
void Delete(const char *namecycle="") override
Delete object namecycle.
Definition: TFile.cxx:1022
virtual void IncrementProcessIDs()
Definition: TFile.h:248
virtual Int_t SysSync(Int_t fd)
Interface to system fsync. All arguments like in POSIX fsync().
Definition: TFile.cxx:4389
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:1214
virtual Long64_t DirCreateEntry(TDirectory *)
Definition: TFile.h:165
TFileOpenHandle(const char *n, const char *o, const char *t, Int_t cmp, Int_t no)
Definition: TFile.h:367
virtual Int_t SysClose(Int_t fd)
Interface to system close. All arguments like in POSIX close().
Definition: TFile.cxx:4334
Int_t GetCompressionAlgorithm() const
Definition: TFile.h:386
static UInt_t GetOpenTimeout()
Returns open timeout (in ms).
Definition: TFile.cxx:4571
virtual void ShowStreamerInfo()
Show the StreamerInfo of all classes written to this file.
Definition: TFile.cxx:3610
EFileType
File type.
Definition: TFile.h:193
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:4343
const char * GetOpt() const
Definition: TFile.h:380
virtual Int_t GetNfree() const
Definition: TFile.h:229
void ls(Option_t *option="") const override
List file contents.
Definition: TFile.cxx:1368
Long64_t fEND
Last used byte in file.
Definition: TFile.h:79
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:4318
TList * fList
Definition: TFile.h:144
virtual void WriteStreamerInfo()
Write the list of TStreamerInfo as a single object in this file The class Streamer description for al...
Definition: TFile.cxx:3652
A ROOT file is structured in Directories (like a file system).
virtual Int_t GetBytesToPrefetch() const
Max number of bytes to prefetch.
Definition: TFile.cxx:5060
virtual void SetOption(Option_t *option=">")
Definition: TFile.h:280
virtual InfoListRet GetStreamerInfoListImpl(bool lookupSICache)
See documentation of GetStreamerInfoList for more details.
Definition: TFile.cxx:1289
virtual Bool_t WriteBuffer(const char *buf, Int_t len)
Write a buffer to the file.
Definition: TFile.cxx:2338
virtual Bool_t MustFlush() const
Definition: TFile.h:260
EAsyncOpenStatus fAsyncOpenStatus
!Status of an asynchronous open request
Definition: TFile.h:109
unsigned int UInt_t
Definition: RtypesCore.h:44
virtual void MakeFree(Long64_t first, Long64_t last)
Mark unused bytes on the file.
Definition: TFile.cxx:1395
static std::atomic< Long64_t > fgFileCounter
Counter for all opened files.
Definition: TFile.h:130
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:128
virtual Int_t DirReadKeys(TDirectory *)
Definition: TFile.h:166
static void CpProgress(Long64_t bytesread, Long64_t size, TStopwatch &watch)
Print file copy progress.
Definition: TFile.cxx:4813
static std::atomic< Int_t > fgReadCalls
Number of bytes read from all TFile objects.
Definition: TFile.h:131
TClass instances represent classes, structs and namespaces in the ROOT type system.
Definition: TClass.h:80
static Int_t GetFileReadCalls()
Static function returning the total number of read calls from all files.
Definition: TFile.cxx:4428
void Print(Option_t *option="") const override
Print all objects in the file.
Definition: TFile.cxx:1568
virtual void Init(Bool_t create)
Initialize a TFile object.
Definition: TFile.cxx:550
void Close(Option_t *option="") override
Close a file.
Definition: TFile.cxx:874
Int_t ReadBufferViaCache(char *buf, Int_t len)
Read buffer via cache.
Definition: TFile.cxx:1751
static TFile *& CurrentFile()
Return the current ROOT file if any.
Definition: TFile.cxx:991
TFileOpenHandle & operator=(const TFileOpenHandle &)=delete
const Bool_t kFALSE
Definition: RtypesCore.h:90
virtual Long64_t GetBytesRead() const
Definition: TFile.h:232
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:126
static Bool_t GetOnlyStaged()
Returns staged only flag.
Definition: TFile.cxx:4591
virtual void ReadStreamerInfo()
Read the list of StreamerInfo from this file.
Definition: TFile.cxx:3467
Double_t fSum2Buffer
Sum of squares of buffer sizes of objects written so far.
Definition: TFile.h:74
virtual Int_t GetNbytesFree() const
Definition: TFile.h:240
long Long_t
Definition: RtypesCore.h:52
TFile()
File default Constructor.
Definition: TFile.cxx:175
TList * fFree
Free segments linked list table.
Definition: TFile.h:93
virtual Int_t GetNbytesInfo() const
Definition: TFile.h:239
virtual Bool_t IsOpen() const
Returns kTRUE in case file is open and kFALSE if file is not open.
Definition: TFile.cxx:1380
Int_t fNbytesFree
Number of bytes for free segments structure.
Definition: TFile.h:85
static Bool_t fgCacheFileForce
Indicates, to force all READ to CACHEREAD.
Definition: TFile.h:124
TFile * fFile
TFile instance of the file being opened.
Definition: TFile.h:363
Int_t fReturnCode
Definition: TFile.h:145
static Int_t GetReadaheadSize()
Static function returning the readahead buffer size.
Definition: TFile.cxx:4436
Describe directory structure in memory.
Definition: TDirectory.h:40
EStatusBits
Definition: TObject.h:57
TFileCacheWrite * GetCacheWrite() const
Return a pointer to the current write cache.
Definition: TFile.cxx:1194
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:1260
Bool_t fNoAnchorInName
!True if we don&#39;t want to force the anchor to be appended to the file name
Definition: TFile.h:103
static Bool_t fgCacheFileDisconnected
Indicates, we trust in the files in the cache dir without stat on the cached file.
Definition: TFile.h:123
TList * fOpenPhases
!Time info about open phases
Definition: TFile.h:113
TString fOption
File options.
Definition: TFile.h:91
The prefetching mechanism uses two classes (TFilePrefetch and TFPBlock) to prefetch in advance a blo...
Definition: TFilePrefetch.h:33
Bool_t fMustFlush
!True if the file buffers must be flushed
Definition: TFile.h:106
Float_t GetCompressionFactor()
Return the file compression factor.
Definition: TFile.cxx:1117
Int_t GetCompress() const
Definition: TFile.h:381
virtual Long64_t GetBytesReadExtra() const
Definition: TFile.h:233
static ROOT::Internal::RConcurrentHashColl fgTsSIHashes
!TS Set of hashes built from read streamer infos
Definition: TFile.h:117
void Copy(TObject &) const override
Copy this to obj.
Definition: TFile.h:200
Bool_t fIsRootFile
!True is this is a ROOT file, raw file otherwise
Definition: TFile.h:104
const TList * GetStreamerInfoCache()
Returns the cached list of StreamerInfos used in this file.
Definition: TFile.cxx:1279
Mother of all ROOT objects.
Definition: TObject.h:37
Bool_t FlushWriteCache()
Flush the write cache if active.
Definition: TFile.cxx:1073
static Bool_t SetOnlyStaged(Bool_t onlystaged)
Sets only staged flag.
Definition: TFile.cxx:4581
virtual Long64_t GetEND() const
Definition: TFile.h:222
#define R__EXTERN
Definition: DllImport.h:27
char Char_t
Definition: RtypesCore.h:31
static TString fgCacheFileDir
Directory where to locally stage files.
Definition: TFile.h:122
virtual const TUrl * GetEndpointUrl() const
Definition: TFile.h:226
static TFileOpenHandle * AsyncOpen(const char *name, Option_t *option="", const char *ftitle="", Int_t compress=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault, Int_t netopt=0)
Submit an asynchronous open request.
Definition: TFile.cxx:4182
TFileCacheRead * GetCacheRead(const TObject *tree=nullptr) const
Return a pointer to the current read cache.
Definition: TFile.cxx:1177
virtual ~TFile()
File destructor.
Definition: TFile.cxx:500
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:3348
TList * GetListOfFree() const
Definition: TFile.h:228
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:3623
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:1683
virtual Int_t GetNProcessIDs() const
Definition: TFile.h:230
Int_t fNProcessIDs
Number of TProcessID written to this file.
Definition: TFile.h:88
static UInt_t SetOpenTimeout(UInt_t timeout)
Sets open timeout time (in ms). Returns previous timeout value.
Definition: TFile.cxx:4561
Definition: tree.py:1
Int_t GetFd() const
Definition: TFile.h:225
Int_t fVersion
File format version.
Definition: TFile.h:83
Long64_t fArchiveOffset
!Offset at which file starts in archive
Definition: TFile.h:101
#define ClassDefOverride(name, id)
Definition: Rtypes.h:326
Int_t Sizeof() const override
Return the size in bytes of the file header.
Definition: TFile.cxx:2259
Int_t fCompress
Compression level and algorithm.
Definition: TFile.h:361
Definition: first.py:1
Int_t fWritten
Number of objects written so far.
Definition: TFile.h:87
static Int_t fgReadaheadSize
Readahead buffer size.
Definition: TFile.h:132
Long64_t fOffset
!Seek offset cache
Definition: TFile.h:96
virtual void WriteHeader()
Write File Header.
Definition: TFile.cxx:2477
Bool_t fInitDone
!True if the file has been initialized
Definition: TFile.h:105
TFileOpenHandle * fAsyncHandle
!For proper automatic cleanup
Definition: TFile.h:108
EOpenTimeOut
Open timeout constants.
Definition: TFile.h:67
virtual void SetCompressionAlgorithm(Int_t algorithm=ROOT::RCompressionSetting::EAlgorithm::kUseGlobal)
See comments for function SetCompressionSettings.
Definition: TFile.cxx:2167
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:4445
const Bool_t kTRUE
Definition: RtypesCore.h:89
Long64_t fSeekFree
Location on disk of free segments structure.
Definition: TFile.h:80
static Long64_t GetFileCounter()
Definition: TFile.cxx:4454
const Int_t n
Definition: legend1.C:16
virtual void SetCacheWrite(TFileCacheWrite *cache)
Set a pointer to the write cache.
Definition: TFile.cxx:2250
Int_t GetCompressionLevel() const
Definition: TFile.h:392
Long64_t fBytesRead
Number of bytes read from this file.
Definition: TFile.h:76
char name[80]
Definition: TGX11.cxx:109
static const char * GetCacheFileDir()
Get the directory where to locally stage/cache remote files.
Definition: TFile.cxx:4491
virtual TProcessID * ReadProcessID(UShort_t pidf)
The TProcessID with number pidf is read from this file.
Definition: TFile.cxx:1813
A cache when writing files over the network
Int_t GetCompressionSettings() const
Definition: TFile.h:398
Int_t GetBestBuffer() const
Return the best buffer size of objects on this file.
Definition: TFile.cxx:1098
Int_t MakeProjectParMake(const char *packname, const char *filename)
Create makefile at &#39;filemake&#39; for PAR package &#39;pack&#39;.
Definition: TFile.cxx:3226
virtual Bool_t ReadBufferAsync(Long64_t offs, Int_t len)
Definition: TFile.cxx:5046
TFileCacheWrite * fCacheWrite
!Pointer to the write cache (if any)
Definition: TFile.h:100
virtual void SetCompressionLevel(Int_t level=ROOT::RCompressionSetting::ELevel::kUseMin)
See comments for function SetCompressionSettings.
Definition: TFile.cxx:2181
virtual Bool_t Matches(const char *name)
Return kTRUE if &#39;url&#39; matches the coordinates of this file.
Definition: TFile.cxx:4603
Bool_t IsRaw() const
Definition: TFile.h:251
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:70
ROOT::Internal::RConcurrentHashColl::HashValue fHash
Definition: TFile.h:146
Stopwatch class.
Definition: TStopwatch.h:28
virtual EAsyncOpenStatus GetAsyncOpenStatus()
Definition: TFile.h:135