Logo ROOT  
Reference Guide
TFileMerger.h
Go to the documentation of this file.
1// @(#)root/io:$Id$
2// Author: Andreas Peters + Fons Rademakers 26/5/2005
3
4/*************************************************************************
5 * Copyright (C) 1995-2005, 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_TFileMerger
13#define ROOT_TFileMerger
14
15#include "TObject.h"
16#include "TList.h"
17#include "TString.h"
18#include "TStopwatch.h"
19#include <string>
20
21class TFile;
22class TDirectory;
23class THashList;
24class TKey;
25
26namespace ROOT {
27class TIOFeatures;
28} // namespace ROOT
29
30class TFileMerger : public TObject {
31private:
33
34 TFileMerger(const TFileMerger&) = delete;
36
37protected:
38 TStopwatch fWatch; ///< Stop watch to measure file copy speed
39 TList fFileList; ///< A list the file (TFile*) which shall be merged
40 TFile *fOutputFile{nullptr}; ///< The outputfile for merging
41 TString fOutputFilename; ///< The name of the outputfile for merging
42 Bool_t fFastMethod{kTRUE}; ///< True if using Fast merging algorithm (default)
43 Bool_t fNoTrees{kFALSE}; ///< True if Trees should not be merged (default is kFALSE)
44 Bool_t fExplicitCompLevel{kFALSE}; ///< True if the user explicitly requested a compression level change (default kFALSE)
45 Bool_t fCompressionChange{kFALSE}; ///< True if the output and input have different compression level (default kFALSE)
46 Int_t fPrintLevel{0}; ///< How much information to print out at run time
47 TString fMergeOptions; ///< Options (in string format) to be passed down to the Merge functions
48 TIOFeatures *fIOFeatures{nullptr}; ///< IO features to use in the output file.
49 TString fMsgPrefix{"TFileMerger"}; ///< Prefix to be used when printing informational message (default TFileMerger)
50
51 Int_t fMaxOpenedFiles; ///< Maximum number of files opened at the same time by the TFileMerger
52 Bool_t fLocal; ///< Makes local copies of merging files if True (default is kTRUE)
53 Bool_t fHistoOneGo; ///< Merger histos in one go (default is kTRUE)
54 TString fObjectNames; ///< List of object names to be either merged exclusively or skipped
55 TList fMergeList; ///< list of TObjString containing the name of the files need to be merged
56 TList fExcessFiles; ///<! List of TObjString containing the name of the files not yet added to fFileList due to user or system limitation on the max number of files opened.
57
59 virtual Bool_t AddFile(TFile *source, Bool_t own, Bool_t cpProgress);
60 virtual Bool_t MergeRecursive(TDirectory *target, TList *sourcelist, Int_t type = kRegular | kAll);
61
62 virtual Bool_t MergeOne(TDirectory *target, TList *sourcelist, Int_t type,
63 TFileMergeInfo &info, TString &oldkeyname, THashList &allNames, Bool_t &status, Bool_t &onlyListed,
64 const TString &path,
65 TDirectory *current_sourcedir, TFile *current_file,
66 TKey *key, TObject *obj, TIter &nextkey);
67public:
68 /// Type of the partial merge
70 kRegular = 0, ///< Normal merge, overwriting the output file.
71 kIncremental = BIT(1), ///< Merge the input file with the content of the output file (if already existing).
72 kResetable = BIT(2), ///< Only the objects with a MergeAfterReset member function.
73 kNonResetable = BIT(3), ///< Only the objects without a MergeAfterReset member function.
74 kDelayWrite = BIT(4), ///< Delay the TFile write (to reduce the number of write when reusing the file)
75
76 kAll = BIT(2)|BIT(3), ///< Merge all type of objects (default)
77 kAllIncremental = kIncremental | kAll, ///< Merge incrementally all type of objects.
78
79 kOnlyListed = BIT(5), ///< Only the objects specified in fObjectNames list
80 kSkipListed = BIT(6), ///< Skip objects specified in fObjectNames list
81 kKeepCompression= BIT(7) ///< Keep compression level unchanged for each input files
82 };
83
84 TFileMerger(Bool_t isLocal = kTRUE, Bool_t histoOneGo = kTRUE);
85 virtual ~TFileMerger();
86
87 Int_t GetPrintLevel() const { return fPrintLevel; }
88 void SetPrintLevel(Int_t level) { fPrintLevel = level; }
90 const char *GetOutputFileName() const { return fOutputFilename; }
92 TFile *GetOutputFile() const { return fOutputFile; }
94 void SetMaxOpenedFiles(Int_t newmax);
95 const char *GetMsgPrefix() const { return fMsgPrefix; }
96 void SetMsgPrefix(const char *prefix);
97 const char *GetMergeOptions() { return fMergeOptions; }
98 void SetMergeOptions(const TString &options) { fMergeOptions = options; }
99 void SetMergeOptions(const std::string_view &options) { fMergeOptions = options; }
100 void SetIOFeatures(ROOT::TIOFeatures &features) { fIOFeatures = &features; }
101 void AddObjectNames(const char *name) {fObjectNames += name; fObjectNames += " ";}
102 const char *GetObjectNames() const {return fObjectNames.Data();}
104
105 //--- file management interface
106 virtual Bool_t SetCWD(const char * /*path*/) { MayNotUse("SetCWD"); return kFALSE; }
107 virtual const char *GetCWD() { MayNotUse("GetCWD"); return 0; }
108
109 //--- file merging interface
110 virtual void Reset();
111 virtual Bool_t AddFile(const char *url, Bool_t cpProgress = kTRUE);
112 virtual Bool_t AddFile(TFile *source, Bool_t cpProgress = kTRUE);
113 virtual Bool_t AddAdoptFile(TFile *source, Bool_t cpProgress = kTRUE);
114 virtual Bool_t OutputFile(const char *url, Bool_t force);
115 virtual Bool_t OutputFile(const char *url, Bool_t force, Int_t compressionLevel);
116 virtual Bool_t OutputFile(const char *url, const char *mode = "RECREATE");
117 virtual Bool_t OutputFile(const char *url, const char *mode, Int_t compressionLevel);
118 virtual Bool_t OutputFile(std::unique_ptr<TFile> file);
119 virtual void PrintFiles(Option_t *options);
120 virtual Bool_t Merge(Bool_t = kTRUE);
122 virtual void SetFastMethod(Bool_t fast=kTRUE) {fFastMethod = fast;}
123 Bool_t GetNotrees() const { return fNoTrees; }
124 virtual void SetNotrees(Bool_t notrees=kFALSE) {fNoTrees = notrees;}
125 virtual void RecursiveRemove(TObject *obj);
126
127 ClassDef(TFileMerger, 6) // File copying and merging services
128};
129
130#endif
131
int Int_t
Definition: RtypesCore.h:45
const Bool_t kFALSE
Definition: RtypesCore.h:101
bool Bool_t
Definition: RtypesCore.h:63
const Bool_t kTRUE
Definition: RtypesCore.h:100
const char Option_t
Definition: RtypesCore.h:66
#define ClassDef(name, id)
Definition: Rtypes.h:325
#define BIT(n)
Definition: Rtypes.h:85
char name[80]
Definition: TGX11.cxx:110
int type
Definition: TGX11.cxx:121
TIOFeatures provides the end-user with the ability to change the IO behavior of data written via a TT...
Definition: TIOFeatures.hxx:69
Describe directory structure in memory.
Definition: TDirectory.h:45
This class provides file copy and merging services.
Definition: TFileMerger.h:30
virtual void SetFastMethod(Bool_t fast=kTRUE)
Definition: TFileMerger.h:122
TString fObjectNames
List of object names to be either merged exclusively or skipped.
Definition: TFileMerger.h:54
virtual Bool_t OutputFile(const char *url, Bool_t force)
Open merger output file.
TList fMergeList
list of TObjString containing the name of the files need to be merged
Definition: TFileMerger.h:55
Bool_t GetNotrees() const
Definition: TFileMerger.h:123
TFile * GetOutputFile() const
Definition: TFileMerger.h:92
virtual Bool_t AddFile(TFile *source, Bool_t own, Bool_t cpProgress)
Add the TFile to this file merger and give ownership of the TFile to this object (unless kFALSE is re...
virtual void PrintFiles(Option_t *options)
Print list of files being merged.
const char * GetMsgPrefix() const
Definition: TFileMerger.h:95
Bool_t fHistoOneGo
Merger histos in one go (default is kTRUE)
Definition: TFileMerger.h:53
virtual Bool_t MergeRecursive(TDirectory *target, TList *sourcelist, Int_t type=kRegular|kAll)
Merge all objects in a directory.
TList fFileList
A list the file (TFile*) which shall be merged.
Definition: TFileMerger.h:39
virtual Bool_t Merge(Bool_t=kTRUE)
Merge the files.
virtual Bool_t MergeOne(TDirectory *target, TList *sourcelist, Int_t type, TFileMergeInfo &info, TString &oldkeyname, THashList &allNames, Bool_t &status, Bool_t &onlyListed, const TString &path, TDirectory *current_sourcedir, TFile *current_file, TKey *key, TObject *obj, TIter &nextkey)
TList * GetMergeList()
Definition: TFileMerger.h:91
TString fOutputFilename
The name of the outputfile for merging.
Definition: TFileMerger.h:41
const char * GetObjectNames() const
Definition: TFileMerger.h:102
virtual void RecursiveRemove(TObject *obj)
Intercept the case where the output TFile is deleted!
const char * GetOutputFileName() const
Definition: TFileMerger.h:90
TString fMsgPrefix
Prefix to be used when printing informational message (default TFileMerger)
Definition: TFileMerger.h:49
void ClearObjectNames()
Definition: TFileMerger.h:103
TIOFeatures * fIOFeatures
IO features to use in the output file.
Definition: TFileMerger.h:48
TFileMerger(const TFileMerger &)=delete
const char * GetMergeOptions()
Definition: TFileMerger.h:97
void SetMsgPrefix(const char *prefix)
Set the prefix to be used when printing informational message.
Int_t GetPrintLevel() const
Definition: TFileMerger.h:87
Bool_t fNoTrees
True if Trees should not be merged (default is kFALSE)
Definition: TFileMerger.h:43
Bool_t HasCompressionChange() const
Definition: TFileMerger.h:89
void SetPrintLevel(Int_t level)
Definition: TFileMerger.h:88
void AddObjectNames(const char *name)
Definition: TFileMerger.h:101
EPartialMergeType
Type of the partial merge.
Definition: TFileMerger.h:69
@ kAll
Merge all type of objects (default)
Definition: TFileMerger.h:76
@ kIncremental
Merge the input file with the content of the output file (if already existing).
Definition: TFileMerger.h:71
@ kKeepCompression
Keep compression level unchanged for each input files.
Definition: TFileMerger.h:81
@ kSkipListed
Skip objects specified in fObjectNames list.
Definition: TFileMerger.h:80
@ kNonResetable
Only the objects without a MergeAfterReset member function.
Definition: TFileMerger.h:73
@ kResetable
Only the objects with a MergeAfterReset member function.
Definition: TFileMerger.h:72
@ kOnlyListed
Only the objects specified in fObjectNames list.
Definition: TFileMerger.h:79
@ kAllIncremental
Merge incrementally all type of objects.
Definition: TFileMerger.h:77
@ kRegular
Normal merge, overwriting the output file.
Definition: TFileMerger.h:70
@ kDelayWrite
Delay the TFile write (to reduce the number of write when reusing the file)
Definition: TFileMerger.h:74
void SetMergeOptions(const TString &options)
Definition: TFileMerger.h:98
Bool_t fExplicitCompLevel
True if the user explicitly requested a compression level change (default kFALSE)
Definition: TFileMerger.h:44
Bool_t fCompressionChange
True if the output and input have different compression level (default kFALSE)
Definition: TFileMerger.h:45
virtual ~TFileMerger()
Cleanup.
virtual void SetNotrees(Bool_t notrees=kFALSE)
Definition: TFileMerger.h:124
Int_t fPrintLevel
How much information to print out at run time.
Definition: TFileMerger.h:46
void SetMaxOpenedFiles(Int_t newmax)
Set a limit to the number of files that TFileMerger will open simultaneously.
TString fMergeOptions
Options (in string format) to be passed down to the Merge functions.
Definition: TFileMerger.h:47
Int_t GetMaxOpenedFiles() const
Definition: TFileMerger.h:93
Bool_t OpenExcessFiles()
Open up to fMaxOpenedFiles of the excess files.
void SetIOFeatures(ROOT::TIOFeatures &features)
Definition: TFileMerger.h:100
TList fExcessFiles
! List of TObjString containing the name of the files not yet added to fFileList due to user or syste...
Definition: TFileMerger.h:56
virtual const char * GetCWD()
Definition: TFileMerger.h:107
TStopwatch fWatch
Stop watch to measure file copy speed.
Definition: TFileMerger.h:38
TFile * fOutputFile
The outputfile for merging.
Definition: TFileMerger.h:40
void SetMergeOptions(const std::string_view &options)
Definition: TFileMerger.h:99
virtual Bool_t PartialMerge(Int_t type=kAll|kIncremental)
Merge the files.
Bool_t fLocal
Makes local copies of merging files if True (default is kTRUE)
Definition: TFileMerger.h:52
TFileMerger & operator=(const TFileMerger &)=delete
virtual void Reset()
Reset merger file list.
Int_t fMaxOpenedFiles
Maximum number of files opened at the same time by the TFileMerger.
Definition: TFileMerger.h:51
virtual Bool_t SetCWD(const char *)
Definition: TFileMerger.h:106
virtual Bool_t AddAdoptFile(TFile *source, Bool_t cpProgress=kTRUE)
Add the TFile to this file merger and give ownership of the TFile to this object (unless kFALSE is re...
Bool_t fFastMethod
True if using Fast merging algorithm (default)
Definition: TFileMerger.h:42
A ROOT file is a suite of consecutive data records (TKey instances) with a well defined format.
Definition: TFile.h:54
THashList implements a hybrid collection class consisting of a hash table and a list to store TObject...
Definition: THashList.h:34
Book space in a file, create I/O buffers, to fill them, (un)compress them.
Definition: TKey.h:28
A doubly linked list.
Definition: TList.h:44
Mother of all ROOT objects.
Definition: TObject.h:37
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:946
Stopwatch class.
Definition: TStopwatch.h:28
Basic string class.
Definition: TString.h:136
void Clear()
Clear string without changing its capacity.
Definition: TString.cxx:1201
const char * Data() const
Definition: TString.h:369
basic_string_view< char > string_view
tbb::task_arena is an alias of tbb::interface7::task_arena, which doesn't allow to forward declare tb...
Definition: file.py:1