Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
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
58 bool fOutFileWasExplicitlyClosed = false; ///<! the user has called CloseOutputFile(), so we shouldn't error out in RecursiveRemove
59
61 virtual Bool_t AddFile(TFile *source, Bool_t own, Bool_t cpProgress);
63
64 virtual Bool_t MergeOne(TDirectory *target, TList *sourcelist, Int_t type,
65 TFileMergeInfo &info, TString &oldkeyname, THashList &allNames, Bool_t &status, Bool_t &onlyListed,
66 const TString &path,
67 TDirectory *current_sourcedir, TFile *current_file,
68 TKey *key, TObject *obj, TIter &nextkey);
69public:
70 /// Type of the partial merge
72 kRegular = 0, ///< Normal merge, overwriting the output file.
73 kIncremental = BIT(1), ///< Merge the input file with the content of the output file (if already existing).
74 kResetable = BIT(2), ///< Only the objects with a MergeAfterReset member function.
75 kNonResetable = BIT(3), ///< Only the objects without a MergeAfterReset member function.
76 kDelayWrite = BIT(4), ///< Delay the TFile write (to reduce the number of write when reusing the file)
77
78 kAll = BIT(2)|BIT(3), ///< Merge all type of objects (default)
79 kAllIncremental = kIncremental | kAll, ///< Merge incrementally all type of objects.
80
81 kOnlyListed = BIT(5), ///< Only the objects specified in fObjectNames list
82 kSkipListed = BIT(6), ///< Skip objects specified in fObjectNames list
83 kKeepCompression= BIT(7) ///< Keep compression level unchanged for each input files
84 };
85
86 TFileMerger(Bool_t isLocal = kTRUE, Bool_t histoOneGo = kTRUE);
87 ~TFileMerger() override;
88
89 Int_t GetPrintLevel() const { return fPrintLevel; }
90 void SetPrintLevel(Int_t level) { fPrintLevel = level; }
92 const char *GetOutputFileName() const { return fOutputFilename; }
94 TFile *GetOutputFile() const { return fOutputFile; }
96 void SetMaxOpenedFiles(Int_t newmax);
97 const char *GetMsgPrefix() const { return fMsgPrefix; }
98 void SetMsgPrefix(const char *prefix);
99 const char *GetMergeOptions() { return fMergeOptions; }
100 void SetMergeOptions(const TString &options) { fMergeOptions = options; }
101 void SetMergeOptions(const std::string_view &options) { fMergeOptions = options; }
102 void SetIOFeatures(ROOT::TIOFeatures &features) { fIOFeatures = &features; }
103 void AddObjectNames(const char *name) {fObjectNames += name; fObjectNames += " ";}
104 const char *GetObjectNames() const {return fObjectNames.Data();}
106 void CloseOutputFile();
107
108 //--- file management interface
109 virtual Bool_t SetCWD(const char * /*path*/) { MayNotUse("SetCWD"); return kFALSE; }
110 virtual const char *GetCWD() { MayNotUse("GetCWD"); return nullptr; }
111
112 //--- file merging interface
113 virtual void Reset();
114 virtual Bool_t AddFile(const char *url, Bool_t cpProgress = kTRUE);
115 virtual Bool_t AddFile(TFile *source, Bool_t cpProgress = kTRUE);
116 virtual Bool_t AddAdoptFile(TFile *source, Bool_t cpProgress = kTRUE);
117 virtual Bool_t OutputFile(const char *url, Bool_t force);
118 virtual Bool_t OutputFile(const char *url, Bool_t force, Int_t compressionLevel);
119 virtual Bool_t OutputFile(const char *url, const char *mode = "RECREATE");
120 virtual Bool_t OutputFile(const char *url, const char *mode, Int_t compressionLevel);
121 virtual Bool_t OutputFile(std::unique_ptr<TFile> file);
122 virtual void PrintFiles(Option_t *options);
123 virtual Bool_t Merge(Bool_t = kTRUE);
125 virtual void SetFastMethod(Bool_t fast=kTRUE) {fFastMethod = fast;}
126 Bool_t GetNotrees() const { return fNoTrees; }
127 virtual void SetNotrees(Bool_t notrees=kFALSE) {fNoTrees = notrees;}
128 void RecursiveRemove(TObject *obj) override;
129
130 ClassDefOverride(TFileMerger, 6) // File copying and merging services
131};
132
133#endif
134
bool Bool_t
Definition RtypesCore.h:63
int Int_t
Definition RtypesCore.h:45
constexpr Bool_t kFALSE
Definition RtypesCore.h:94
constexpr Bool_t kTRUE
Definition RtypesCore.h:93
const char Option_t
Definition RtypesCore.h:66
#define BIT(n)
Definition Rtypes.h:90
#define ClassDefOverride(name, id)
Definition Rtypes.h:346
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h Atom_t Int_t ULong_t ULong_t unsigned char prop_list Atom_t Atom_t target
Option_t Option_t TPoint TPoint const char mode
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h Atom_t Int_t ULong_t ULong_t unsigned char prop_list Atom_t Atom_t Atom_t Time_t type
char name[80]
Definition TGX11.cxx:110
TIOFeatures provides the end-user with the ability to change the IO behavior of data written via a TT...
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)
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
TFile * GetOutputFile() const
Definition TFileMerger.h:94
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:97
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.
void RecursiveRemove(TObject *obj) override
Intercept the case where the output TFile is deleted!
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:93
TString fOutputFilename
The name of the outputfile for merging.
Definition TFileMerger.h:41
const char * GetObjectNames() const
const char * GetOutputFileName() const
Definition TFileMerger.h:92
TString fMsgPrefix
Prefix to be used when printing informational message (default TFileMerger)
Definition TFileMerger.h:49
void ClearObjectNames()
TIOFeatures * fIOFeatures
IO features to use in the output file.
Definition TFileMerger.h:48
TFileMerger(const TFileMerger &)=delete
const char * GetMergeOptions()
Definition TFileMerger.h:99
void SetMsgPrefix(const char *prefix)
Set the prefix to be used when printing informational message.
Int_t GetPrintLevel() const
Definition TFileMerger.h:89
Bool_t fNoTrees
True if Trees should not be merged (default is kFALSE)
Definition TFileMerger.h:43
Bool_t HasCompressionChange() const
Definition TFileMerger.h:91
void SetPrintLevel(Int_t level)
Definition TFileMerger.h:90
bool fOutFileWasExplicitlyClosed
! the user has called CloseOutputFile(), so we shouldn't error out in RecursiveRemove
Definition TFileMerger.h:58
void AddObjectNames(const char *name)
EPartialMergeType
Type of the partial merge.
Definition TFileMerger.h:71
@ kAll
Merge all type of objects (default)
Definition TFileMerger.h:78
@ kIncremental
Merge the input file with the content of the output file (if already existing).
Definition TFileMerger.h:73
@ kKeepCompression
Keep compression level unchanged for each input files.
Definition TFileMerger.h:83
@ kSkipListed
Skip objects specified in fObjectNames list.
Definition TFileMerger.h:82
@ kNonResetable
Only the objects without a MergeAfterReset member function.
Definition TFileMerger.h:75
@ kResetable
Only the objects with a MergeAfterReset member function.
Definition TFileMerger.h:74
@ kOnlyListed
Only the objects specified in fObjectNames list.
Definition TFileMerger.h:81
@ kAllIncremental
Merge incrementally all type of objects.
Definition TFileMerger.h:79
@ kRegular
Normal merge, overwriting the output file.
Definition TFileMerger.h:72
@ kDelayWrite
Delay the TFile write (to reduce the number of write when reusing the file)
Definition TFileMerger.h:76
void SetMergeOptions(const TString &options)
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 void SetNotrees(Bool_t notrees=kFALSE)
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
void CloseOutputFile()
Closes output file.
~TFileMerger() override
Cleanup.
Int_t GetMaxOpenedFiles() const
Definition TFileMerger.h:95
Bool_t OpenExcessFiles()
Open up to fMaxOpenedFiles of the excess files.
void SetIOFeatures(ROOT::TIOFeatures &features)
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()
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)
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 *)
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 an on-disk file, usually with extension .root, that stores objects in a file-system-li...
Definition TFile.h:53
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:38
Mother of all ROOT objects.
Definition TObject.h:41
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:1058
Stopwatch class.
Definition TStopwatch.h:28
Basic string class.
Definition TString.h:139
void Clear()
Clear string without changing its capacity.
Definition TString.cxx:1235
const char * Data() const
Definition TString.h:376
tbb::task_arena is an alias of tbb::interface7::task_arena, which doesn't allow to forward declare tb...