#include "TFileService.h"

Inheritance diagram for art::TFileService:

Classes
struct	Config

Public Types
using	Parameters = ServiceTable< Config >

using	Callback_t = TFileDirectory::Callback_t

Public Member Functions
	TFileService (ServiceTable< Config > const &config, art::ActivityRegistry &r)

	~TFileService ()

void	registerFileSwitchCallback (Callback_t c)

template<typename T >
void	registerFileSwitchCallback (T provider, void(T::)())

TFile &	file () const

template<typename T , typename... ARGS>
T *	make (ARGS...args) const

template<typename T , typename... ARGS>
T *	makeAndRegister (char const name, char const title, ARGS...args) const

template<typename T , typename... ARGS>
T *	makeAndRegister (std::string const &name, std::string const &title, ARGS...args) const

TFileDirectory	mkdir (std::string const &dir, std::string const &descr="")

Static Public Attributes
static constexpr const char *	default_tmpDir = "<parent-path-of-filename>"

Protected Member Functions
void	invokeCallbacks ()

void	registerCallback (Callback_t)

std::string	fullPath () const

Protected Attributes
TFile *	file_

std::string	dir_

std::string	descr_

bool	requireCallback_ {false}

Private Member Functions
	TFileService (TFileService const &)=delete

TFileService	operator= (TFileService const &)=delete

void	setDirectoryName_ (art::ModuleDescription const &desc)

void	openFile_ ()

void	closeFile_ ()

void	maybeSwitchFiles_ ()

bool	requestsToCloseFile_ ()

std::string	fileNameAtOpen_ ()

std::string	fileNameAtClose_ (std::string const &)

Private Attributes
bool const	closeFileFast_

FileStatsCollector	fstats_

PostCloseFileRenamer	fRenamer_ {fstats_}

std::string	filePattern_

std::string	uniqueFilename_

std::string	tmpDir_

std::string	lastClosedFile_ {}

Granularity	currentGranularity_ {Granularity::Unset}

std::chrono::steady_clock::time_point	beginTime_ {}

ClosingCriteria	fileSwitchCriteria_ {ClosingCriteria::Config{}}

OutputFileStatus	status_ {OutputFileStatus::Closed}

FileProperties	fp_ {}

Detailed Description

Definition at line 31 of file TFileService.h.

Member Typedef Documentation

using art::TFileService::Callback_t = TFileDirectory::Callback_t

Definition at line 54 of file TFileService.h.

using art::TFileService::Parameters = ServiceTable<Config>

Definition at line 48 of file TFileService.h.

Constructor & Destructor Documentation

art::TFileService::TFileService ( TFileService const & )

privatedelete

TFileService::TFileService	(	ServiceTable< Config > const &	config,
		art::ActivityRegistry &	r
	)

Definition at line 37 of file TFileService_service.cc.

References closeFileFast_, currentGranularity_, e, art::Granularity::Event, filePattern_, fileSwitchCriteria_, fp_, fstats_, art::Run::id(), art::SubRun::id(), art::Event::id(), art::Granularity::InputFile, maybeSwitchFiles_(), openFile_(), art::FileStatsCollector::recordEvent(), art::FileStatsCollector::recordInputFile(), art::FileStatsCollector::recordRun(), art::FileStatsCollector::recordSubRun(), requestsToCloseFile_(), art::TFileDirectory::requireCallback_, art::Granularity::Run, setDirectoryName_(), status_, art::Granularity::SubRun, tmpDir_, art::FileProperties::update(), and art::detail::validateFileNamePattern().

   : TFileDirectory{"", "", nullptr, ""}
   , closeFileFast_{config().closeFileFast()}
   , fstats_{config.get_PSet().get<std::string>("service_type"),
             ServiceHandle<TriggerNamesService const>{}->getProcessName()}
   , filePattern_{config().fileName()}
   , tmpDir_{config().tmpDir()}
 {
   ClosingCriteria::Config fpConfig;
   requireCallback_ = config().fileProperties(fpConfig);
   if (requireCallback_) {
     detail::validateFileNamePattern(requireCallback_, filePattern_);
     fileSwitchCriteria_ = ClosingCriteria{fpConfig};
   }
   openFile_();
 
   // Activities to monitor in order to set the proper directory.
   r.sPostOpenFile.watch(
     [this](std::string const& fileName) { fstats_.recordInputFile(fileName); });
 
   r.sPreModuleBeginJob.watch(this, &TFileService::setDirectoryName_);
   r.sPreModuleEndJob.watch(this, &TFileService::setDirectoryName_);
 
   r.sPreModuleConstruction.watch(this, &TFileService::setDirectoryName_);
   r.sPreModuleRespondToOpenInputFile.watch(this,
                                            &TFileService::setDirectoryName_);
   r.sPreModuleRespondToCloseInputFile.watch(this,
                                             &TFileService::setDirectoryName_);
   r.sPreModuleRespondToOpenOutputFiles.watch(this,
                                              &TFileService::setDirectoryName_);
   r.sPreModuleRespondToCloseOutputFiles.watch(this,
                                               &TFileService::setDirectoryName_);
 
   r.sPreModuleBeginRun.watch(this, &TFileService::setDirectoryName_);
   r.sPreModuleEndRun.watch(this, &TFileService::setDirectoryName_);
 
   r.sPreModuleBeginSubRun.watch(this, &TFileService::setDirectoryName_);
   r.sPreModuleEndSubRun.watch(this, &TFileService::setDirectoryName_);
 
   r.sPreModule.watch(this, &TFileService::setDirectoryName_);
 
   // Activities to monitor to keep track of events, subruns and runs seen.
   r.sPostProcessEvent.watch([this](Event const& e) {
     currentGranularity_ = Granularity::Event;
     fp_.update<Granularity::Event>(status_);
     fstats_.recordEvent(e.id());
     if (requestsToCloseFile_()) {
       maybeSwitchFiles_();
     }
   });
   r.sPostEndSubRun.watch([this](SubRun const& sr) {
     currentGranularity_ = Granularity::SubRun;
     fp_.update<Granularity::SubRun>(status_);
     fstats_.recordSubRun(sr.id());
     if (requestsToCloseFile_()) {
       maybeSwitchFiles_();
     }
   });
   r.sPostEndRun.watch([this](Run const& r) {
     currentGranularity_ = Granularity::Run;
     fp_.update<Granularity::Run>(status_);
     fstats_.recordRun(r.id());
     if (requestsToCloseFile_()) {
       maybeSwitchFiles_();
     }
   });
   r.sPostCloseFile.watch([this] {
     currentGranularity_ = Granularity::InputFile;
     fp_.update<Granularity::InputFile>();
     if (requestsToCloseFile_()) {
       maybeSwitchFiles_();
     }
   });
 }

TFileService::~TFileService ( )

Definition at line 113 of file TFileService_service.cc.

References closeFile_().

 {
   closeFile_();
 }

Member Function Documentation

void TFileService::closeFile_ ( )

private

Definition at line 165 of file TFileService_service.cc.

References art::Closed, closeFileFast_, art::TFileDirectory::file_, fileNameAtClose_(), fstats_, lastClosedFile_, art::FileStatsCollector::recordFileClose(), status_, and uniqueFilename_.

Referenced by maybeSwitchFiles_(), and ~TFileService().

 {
   file_->Write();
   if (closeFileFast_) {
     gROOT->GetListOfFiles()->Remove(file_);
   }
   file_->Close();
   delete file_;
   file_ = nullptr;
   status_ = OutputFileStatus::Closed;
   fstats_.recordFileClose();
   lastClosedFile_ = fileNameAtClose_(uniqueFilename_);
 }

TFile& art::TFileService::file ( ) const

inline

Definition at line 63 of file TFileService.h.

   {
     return *file_;
   }

std::string TFileService::fileNameAtClose_ ( std::string const & filename )

private

Definition at line 146 of file TFileService_service.cc.

References filePattern_, fRenamer_, and art::PostCloseFileRenamer::maybeRenameFile().

Referenced by closeFile_().

 {
   return filePattern_ == dev_null ?
            dev_null :
            fRenamer_.maybeRenameFile(filename, filePattern_);
 }

std::string TFileService::fileNameAtOpen_ ( )

private

Definition at line 136 of file TFileService_service.cc.

References default_tmpDir, filePattern_, art::parent_path(), tmpDir_, and art::unique_filename().

Referenced by openFile_().

 {
   if (filePattern_ == dev_null)
     return dev_null;
   return unique_filename(
     (tmpDir_ == default_tmpDir ? parent_path(filePattern_) : tmpDir_) +
     "/TFileService");
 }

std::string art::TFileDirectory::fullPath ( ) const

protectedinherited

Return the full pathname of the current directory, formed from appending 'dir' to the end of 'path'.

Definition at line 80 of file TFileDirectory.cc.

References art::TFileDirectory::dir_, and art::TFileDirectory::path_.

Referenced by art::TFileDirectory::cd(), and art::TFileDirectory::mkdir().

 {
   return path_.empty() ? dir_ : path_ + "/" + dir_;
 }

void art::TFileDirectory::invokeCallbacks ( )

protectedinherited

Definition at line 19 of file TFileDirectory.cc.

References art::TFileDirectory::callbacks_, art::TFileDirectory::dir_, and f.

Referenced by maybeSwitchFiles_().

 {
   for (auto const& pr : callbacks_) {
     dir_ = pr.first;
     for (auto f : pr.second) {
       f();
     }
   }
 }

template<typename T , typename... ARGS>

T * art::TFileDirectory::make ( ARGS... args ) const

inherited

make new ROOT object of type T, using constructor parameters args. It will be made in the 'current directory', as established with a call to 'cd'.

Definition at line 82 of file TFileDirectory.h.

References art::TFileDirectory::cd().

Referenced by opdet::OpHitAna::analyze(), opdet::OpDigiAna::analyze(), opdet::OpFlashAna::analyze(), mvapid::MVAPID::beginJob(), lar_pandora::PFParticleTrackAna::beginJob(), lar_pandora::PFParticleCosmicAna::beginJob(), lar_pandora::PFParticleHitDumper::beginJob(), lar_pandora::PFParticleMonitoring::beginJob(), lar_pandora::PFParticleAnalysis::beginJob(), pid::PIDAAnalyzer::beginJob(), opdet::OpFlashSimpleAna::beginJob(), phot::PhotonLibraryAnalyzer::beginJob(), filt::FinalStateParticleFilter::beginJob(), opreco::OpticalRecoAna::beginJob(), filt::FinalStateSelectFilter::beginJob(), spacecharge::ShiftEdepSCE::beginJob(), opdet::FlashHypothesisAna::beginJob(), cluster::ClusterPCA::beginJob(), larg4::ISCalculationAna::beginJob(), DUNE::NeutrinoShowerEff::beginJob(), cluster::TrajCluster::beginJob(), vertex::AggregateVertexAna::beginJob(), evgen::CosmicsGen::beginJob(), ShowerQuality::beginJob(), hit::HitAnaModule::beginJob(), filt::EmptyFilter::beginJob(), cluster::DBcluster::beginJob(), rwgt::ReweightAna::beginJob(), caldata::CalWireAna::beginJob(), cluster::fuzzyCluster::beginJob(), detsim::SimWireAna::beginJob(), microboone::CosmicRemovalAna::beginJob(), evgen::NUANCEGen::beginJob(), larg4::LArG4Ana::beginJob(), trkf::TrackKalmanCheater::beginJob(), DUNE::NeutrinoTrackingEff::beginJob(), vertex::PrimaryVertexFinder::beginJob(), pfpf::PFPAna::beginJob(), cluster::ClusterAna::beginJob(), reco3d::SpacePointSolver::beginJob(), DUNE::MuonTrackingEff::beginJob(), vertex::HarrisVertexFinder::beginJob(), detsim::WienerFilterAna::beginJob(), evgen::NDKGen::beginJob(), cluster::DBclusterAna::beginJob(), hit::HitFinderAna::beginJob(), hit::GausHitFinderAna::beginJob(), hit::GausHitFinder::beginJob(), trkf::Track3DKalmanHit::beginJob(), cluster::HoughLineFinderAna::beginJob(), vertex::VertexFinder2D::beginJob(), evgen::GaisserParam::beginJob(), opdet::SimPhotonCounter::beginJob(), detsim::SimWire::beginJob(), hit::DPRawHitFinder::beginJob(), shwf::ShowerReco::beginJob(), detsim::SimWireT962::beginJob(), vertex::FeatureVertexFinderAna::beginJob(), trkf::Track3DKalman::beginJob(), evgen::GENIEGen::beginJob(), lbne::PhotonCounterT0Matching::beginJob(), trkf::Track3DKalmanSPS::beginJob(), t0::MCTruthT0Matching::beginJob(), evgen::MUSUN::beginJob(), ems::MultiEMShowers::beginJob(), lar::example::AnalysisExample::beginJob(), ems::MergeEMShower3D::beginJob(), cheat::RecoCheckAna::beginRun(), trkf::SpacePointAna::bookHistograms(), reco_tool::CandHitDerivative::configure(), reco_tool::CandHitMorphological::configure(), detsim::SimWire::ConvoluteResponseFunctions(), detsim::SimWireT962::ConvoluteResponseFunctions(), tca::HistStuff::CreateHists(), DUNE::NeutrinoShowerEff::doEfficiencies(), DUNE::NeutrinoTrackingEff::doEfficiencies(), shower::EMShowerAlg::EMShowerAlg(), opdet::LEDCalibrationAna::endJob(), larg::LArSimChannelAna::ensureHists(), hit::MagDriftAna::ensureHists(), reco_tool::CandHitDerivative::findHitCandidates(), reco_tool::CandHitMorphological::findHitCandidates(), lar_cluster3d::Cluster3D::InitializeMonitoring(), larg4::IonizationAndScintillation::IonizationAndScintillation(), opdet::LEDCalibrationAna::LEDCalibrationAna(), evgen::LightSource::LightSource(), evgen::MarleyTimeGen::make_nu_emission_histograms(), evgen::MarleyGen::MarleyGen(), evgen::MarleyTimeGen::MarleyTimeGen(), trkf::SeedAna::MCHists::MCHists(), trkf::TrackAna::MCHists::MCHists(), cluster::MergeClusterAlg::MergeClusterAlg(), opdet::OpFlashAna::OpFlashAna(), opdet::OpHitAna::OpHitAna(), trkf::PMAlgTrackMaker::PMAlgTrackMaker(), cluster::ClusterMatchAlg::PrepareTTree(), trkf::SeedAna::RecoHists::RecoHists(), trkf::TrackAna::RecoHists::RecoHists(), detsim::SimWire::SetElectResponse(), detsim::SimWireT962::SetElectResponse(), detsim::SimWire::SetFieldResponse(), detsim::SimWireT962::SetFieldResponse(), phot::PhotonLibrary::StoreLibraryToFile(), trk::TrackContainmentAnalyzer::TrackContainmentAnalyzer(), and trk::TrackContainmentTagger::TrackContainmentTagger().

   {
     detail::RootDirectorySentry sentry;
     cd();
     return new T(args...);
   }

template<typename T , typename... ARGS>

T * art::TFileDirectory::makeAndRegister	(	char const *	name,
		char const *	title,
		ARGS...	args
	)		const

inherited

make and register a new ROOT object of type T, giving it the specified name and title, using constructor parameters 'args'. The type must be registerable, and must support naming and titling.

Definition at line 91 of file TFileDirectory.h.

References art::TFileDirectory::cd().

Referenced by art::TFileDirectory::makeAndRegister().

   {
     detail::RootDirectorySentry sentry;
     cd();
     T* p = new T(args...);
     p->SetName(name);
     p->SetTitle(title);
     gDirectory->Append(p);
     return p;
   }

template<typename T , typename... ARGS>

T * art::TFileDirectory::makeAndRegister	(	std::string const &	name,
		std::string const &	title,
		ARGS...	args
	)		const

inherited

Definition at line 106 of file TFileDirectory.h.

References art::TFileDirectory::makeAndRegister().

   {
     return makeAndRegister(name.c_str(), title.c_str(), args...);
   }

void TFileService::maybeSwitchFiles_ ( )

private

Definition at line 180 of file TFileService_service.cc.

References closeFile_(), currentGranularity_, filePattern_, fileSwitchCriteria_, fp_, art::ClosingCriteria::granularity(), art::TFileDirectory::invokeCallbacks(), lastClosedFile_, art::detail::logFileAction(), openFile_(), status_, and art::Switching.

Referenced by TFileService().

 {
   // FIXME: Should maybe include the granularity check in
   // requestsToCloseFile_().
   if (fileSwitchCriteria_.granularity() > currentGranularity_)
     return;
 
   status_ = OutputFileStatus::Switching;
   closeFile_();
   detail::logFileAction("Closed TFileService file ", lastClosedFile_);
   detail::logFileAction("Switching to new TFileService file with pattern ",
                         filePattern_);
   fp_ = FileProperties{};
   openFile_();
   invokeCallbacks();
 }

art::TFileDirectory art::TFileDirectory::mkdir	(	std::string const &	dir,
		std::string const &	descr = `""`
	)

inherited

Create a new TFileDirectory, sharing the same TFile as this one, but with an additional 'dir', and with 'path' being the fullPath() of this one.

Definition at line 86 of file TFileDirectory.cc.

References art::TFileDirectory::cd(), dir, art::TFileDirectory::file_, and art::TFileDirectory::fullPath().

Referenced by opdet::FIFOHistogramAna::analyze(), trkf::TrackKalmanCheater::beginJob(), trkf::Track3DKalmanHit::beginJob(), trkf::SpacePointAna::bookHistograms(), reco_tool::CandHitMorphological::configure(), reco_tool::CandHitDerivative::configure(), reco_tool::CandHitDerivative::findHitCandidates(), reco_tool::CandHitMorphological::findHitCandidates(), trkf::SeedAna::MCHists::MCHists(), trkf::TrackAna::MCHists::MCHists(), trkf::SeedAna::RecoHists::RecoHists(), and trkf::TrackAna::RecoHists::RecoHists().

 {
   detail::RootDirectorySentry sentry;
   cd();
   return TFileDirectory{dir, descr, file_, fullPath()};
 }

void TFileService::openFile_ ( )

private

Definition at line 154 of file TFileService_service.cc.

References beginTime_, art::TFileDirectory::file_, fileNameAtOpen_(), fstats_, art::Open, art::FileStatsCollector::recordFileOpen(), status_, and uniqueFilename_.

Referenced by maybeSwitchFiles_(), and TFileService().

 {
   uniqueFilename_ = fileNameAtOpen_();
   assert(file_ == nullptr && "TFile pointer should always be zero here!");
   beginTime_ = std::chrono::steady_clock::now();
   file_ = new TFile{uniqueFilename_.c_str(), "RECREATE"};
   status_ = OutputFileStatus::Open;
   fstats_.recordFileOpen();
 }

TFileService art::TFileService::operator= ( TFileService const & )

privatedelete

void art::TFileDirectory::registerCallback ( Callback_t cb )

protectedinherited

Definition at line 30 of file TFileDirectory.cc.

References art::TFileDirectory::callbacks_, and art::TFileDirectory::dir_.

Referenced by registerFileSwitchCallback().

 {
   callbacks_[dir_].push_back(cb);
 }

void TFileService::registerFileSwitchCallback ( Callback_t c )

Definition at line 119 of file TFileService_service.cc.

References art::TFileDirectory::registerCallback().

 {
   registerCallback(cb);
 }

template<typename T >

void art::TFileService::registerFileSwitchCallback	(	T *	provider,
		void(T::*)()	f
	)

Definition at line 102 of file TFileService.h.

References DECLARE_ART_SERVICE, f, and art::LEGACY.

 {
   auto cb = [provider, f] { return (provider->*f)(); };
   registerFileSwitchCallback(cb);
 }

bool TFileService::requestsToCloseFile_ ( )

private

Definition at line 198 of file TFileService_service.cc.

References beginTime_, DEFINE_ART_SERVICE, art::TFileDirectory::file_, fileSwitchCriteria_, fp_, art::ClosingCriteria::should_close(), art::FileProperties::updateAge(), and art::FileProperties::updateSize().

Referenced by TFileService().

 {
   using namespace std::chrono;
   unsigned int constexpr oneK{1024u};
   fp_.updateSize(file_->GetSize() / oneK);
   fp_.updateAge(duration_cast<seconds>(steady_clock::now() - beginTime_));
   return fileSwitchCriteria_.should_close(fp_);
 }

void TFileService::setDirectoryName_ ( art::ModuleDescription const & desc )

private

Definition at line 125 of file TFileService_service.cc.

References art::TFileDirectory::descr_, art::TFileDirectory::dir_, art::ModuleDescription::moduleLabel(), and art::ModuleDescription::moduleName().

Referenced by TFileService().

 {
   CET_ASSERT_ONLY_ONE_THREAD();
   dir_ = desc.moduleLabel();
   descr_ = dir_;
   descr_ += " (";
   descr_ += desc.moduleName();
   descr_ += ") folder";
 }