#include <JobReport.h>

Inheritance diagram for edm::JobReport:

Classes
class	AtomicLongLong

struct	InputFile

struct	JobReportImpl

struct	OutputFile

struct	RunReport

Public Types
typedef unsigned int	RunNumber

typedef std::size_t	Token

Public Member Functions
void	childAfterFork (std::string const &jobReportFile, unsigned int childIndex, unsigned int numberOfChildren)
	New output file for child. More...

std::string	dumpFiles (void)
	debug/test util More...

void	eventReadFromFile (InputType inputType, Token fileToken)

void	eventWrittenToFile (Token fileToken, RunNumber_t run, EventNumber_t event)

void	inputFileClosed (InputType inputType, Token fileToken)

Token	inputFileOpened (std::string const &physicalFileName, std::string const &logicalFileName, std::string const &catalog, std::string const &inputType, std::string const &inputSourceClassName, std::string const &moduleLabel, std::string const &guid, std::vector< std::string > const &branchNames)

	JobReport ()

	JobReport (std::ostream *outputStream)

	JobReport (JobReport const &)=delete

JobReport &	operator= (JobReport const &)=delete

void	outputFileClosed (Token fileToken)

Token	outputFileOpened (std::string const &physicalFileName, std::string const &logicalFileName, std::string const &catalog, std::string const &outputModuleClassName, std::string const &moduleLabel, std::string const &guid, std::string const &dataType, std::string const &branchHash, std::vector< std::string > const &branchNames)

void	parentAfterFork (std::string const &jobReportFile)

void	parentBeforeFork (std::string const &jobReportFile, unsigned int numberOfChildren)

void	reportAnalysisFile (std::string const &fileName, std::map< std::string, std::string > const &fileData)

void	reportDataType (Token fileToken, std::string const &dataType)

void	reportError (std::string const &shortDesc, std::string const &longDesc, int const &exitCode)

void	reportFallbackAttempt (std::string const &pfn, std::string const &lfn, std::string const &err)

void	reportFastClonedBranches (std::set< std::string > const &fastClonedBranches, long long nEvents)
	Inform the job report that branches have been fast Cloned. More...

void	reportFastCopyingStatus (Token t, std::string const &inputFileName, bool fastCopying)

void	reportInputLumiSection (unsigned int run, unsigned int lumiSectId)

void	reportInputRunNumber (unsigned int run)

void	reportLumiSection (JobReport::Token token, unsigned int run, unsigned int lumiSectId, unsigned long nEvents=0)

void	reportMemoryInfo (std::vector< std::string > const &memoryData)

void	reportMessageInfo (std::map< std::string, double > const &messageData)

void	reportPerformanceForModule (std::string const &metricClass, std::string const &moduleName, std::map< std::string, std::string > const &metrics)

void	reportPerformanceSummary (std::string const &metricClass, std::map< std::string, std::string > const &metrics)

void	reportRandomStateFile (std::string const &name)

void	reportReadBranch (InputType inputType, std::string const &branchName)
	Inform the job report that a branch has been read. More...

void	reportReadBranches ()

void	reportRunNumber (JobReport::Token token, unsigned int run)

void	reportSkippedEvent (RunNumber_t run, EventNumber_t event)

void	reportSkippedFile (std::string const &pfn, std::string const &lfn)

	~JobReport ()

Protected Member Functions
edm::propagate_const < std::unique_ptr < JobReportImpl > > &	impl ()

Private Attributes
edm::propagate_const < std::unique_ptr < JobReportImpl > >	impl_

std::mutex	write_mutex

Detailed Description

Description: A service that collections job handling information.

Usage: The JobReport service collects 'job handling' information (currently file handling) from several sources, collates the information, and at appropriate intervals, reports the information to the job report, through the MessageLogger.

CMS-THREADING Some notes about thread safety:

It is assumed non-experts will turn the job report on and look at the XML output and NOT call the available public functions. Many of the available service functions can be called at times that are not thread safe (causing data races or interleaved output). The following notes are for Framework experts and detail the assumptions made when modifying JobReport to run in the multithreaded Framework.
We assume the primary input source performs its activity serially. There can be multiple secondary input sources running concurrently.
We assume the following sequence of activities where the lines of asterisks indicate synchronization points:

open primary input file nothing else running concurrently Also respondToOpenInputFiles serially

open output files serially nothing else running concurrently

The primary source runs its other tasks concurrently with the secondary sources running their tasks and modules running their tasks.

close primary input file nothing else running concurrently

close output files serially nothing else running concurrently

repeat the above (the output file opens and closes are optional except for the first and last)

All endJob and postEndJob activities occur serially not concurrently

We assume that a single instance of an OutputModule will only be running on one thread at a time. Other instances of that type of OutputModule may be running concurrently. There are several functions where this is an issue. We have discussed that in the future we might decide to run the OutputModule for multiple events concurrently. That would require further modifications of either the JobReport or the OutputModule.
For Primary and SecondaryFile input sources (not SecondarySource) the calls to reportBranchName from the delayed reader need to be serialized.

Definition at line 103 of file JobReport.h.

Member Typedef Documentation

typedef unsigned int edm::JobReport::RunNumber

Definition at line 106 of file JobReport.h.

typedef std::size_t edm::JobReport::Token

Definition at line 107 of file JobReport.h.

Constructor & Destructor Documentation

edm::JobReport::JobReport ( )

Definition at line 331 of file JobReport.cc.

edm::JobReport::JobReport ( std::ostream * outputStream )

Definition at line 335 of file JobReport.cc.

edm::JobReport::JobReport ( JobReport const & )

delete

edm::JobReport::~JobReport ( )

Definition at line 324 of file JobReport.cc.

Member Function Documentation

void edm::JobReport::childAfterFork	(	std::string const &	jobReportFile,
		unsigned int	childIndex,
		unsigned int	numberOfChildren
	)

New output file for child.

Definition at line 388 of file JobReport.cc.

std::string edm::JobReport::dumpFiles ( void )

debug/test util

Definition at line 782 of file JobReport.cc.

void edm::JobReport::eventReadFromFile	(	InputType	inputType,
		JobReport::Token	fileToken
	)

Report that an event has been read from the file identified by the given Token.

Definition at line 446 of file JobReport.cc.

void edm::JobReport::eventWrittenToFile	(	JobReport::Token	fileToken,
		RunNumber_t	run,
		EventNumber_t	event
	)

Report that the event with the given id has been written to the file identified by the given Token.

Definition at line 512 of file JobReport.cc.

edm::propagate_const<std::unique_ptr<JobReportImpl> >& edm::JobReport::impl ( )

inlineprotected

Definition at line 438 of file JobReport.h.

Referenced by edm::service::JobReportService::frameworkShutdownOnFailure(), and edm::service::JobReportService::postEndJob().

void edm::JobReport::inputFileClosed	(	InputType	inputType,
		JobReport::Token	fileToken
	)

Report that the input file identified by the given Token has been closed. An exception will be thrown if the given Token was not obtained from inputFileOpened.

Definition at line 458 of file JobReport.cc.

JobReport::Token edm::JobReport::inputFileOpened	(	std::string const &	physicalFileName,
		std::string const &	logicalFileName,
		std::string const &	catalog,
		std::string const &	inputType,
		std::string const &	inputSourceClassName,
		std::string const &	moduleLabel,
		std::string const &	guid,
		std::vector< std::string > const &	branchNames
	)

Report that an input file has been opened. The returned Token should be used for later identification of this file.

Definition at line 398 of file JobReport.cc.

JobReport& edm::JobReport::operator= ( JobReport const & )

delete

void edm::JobReport::outputFileClosed ( JobReport::Token fileToken )

Report that the output file identified by the given Token has been closed. An exception will be thrown if the given Token was not obtained from outputFileOpened.

Definition at line 518 of file JobReport.cc.

JobReport::Token edm::JobReport::outputFileOpened	(	std::string const &	physicalFileName,
		std::string const &	logicalFileName,
		std::string const &	catalog,
		std::string const &	outputModuleClassName,
		std::string const &	moduleLabel,
		std::string const &	guid,
		std::string const &	dataType,
		std::string const &	branchHash,
		std::vector< std::string > const &	branchNames
	)

Report that an output file has been opened. The returned Token should be used for later identification of this file.

Definition at line 472 of file JobReport.cc.

void edm::JobReport::parentAfterFork ( std::string const & jobReportFile )

Definition at line 384 of file JobReport.cc.

void edm::JobReport::parentBeforeFork	(	std::string const &	jobReportFile,
		unsigned int	numberOfChildren
	)

Definition at line 366 of file JobReport.cc.

void edm::JobReport::reportAnalysisFile	(	std::string const &	fileName,
		std::map< std::string, std::string > const &	fileData
	)

Definition at line 564 of file JobReport.cc.

Referenced by TFileService::afterBeginJob(), PCLMetadataWriter::endRun(), and dqm::DQMFileSaverBase::saveJobReport().

void edm::JobReport::reportDataType	(	Token	fileToken,
		std::string const &	dataType
	)

Report the data type of a file after it has been opened Needed since the data type isn't known until an event has been read

Definition at line 452 of file JobReport.cc.

void edm::JobReport::reportError	(	std::string const &	shortDesc,
		std::string const &	longDesc,
		int const &	exitCode
	)

Report an exception, providing details of the problem as a short description (Eg "XXXError") and a long description (Eg "XXX crashed because...") Also overload this method to accept an optional standard exit code

Definition at line 585 of file JobReport.cc.

Referenced by edm::printCmsException().

void edm::JobReport::reportFallbackAttempt	(	std::string const &	pfn,
		std::string const &	lfn,
		std::string const &	err
	)

Definition at line 618 of file JobReport.cc.

void edm::JobReport::reportFastClonedBranches	(	std::set< std::string > const &	fastClonedBranches,
		long long	nEvents
	)

Inform the job report that branches have been fast Cloned.

Definition at line 714 of file JobReport.cc.

void edm::JobReport::reportFastCopyingStatus	(	JobReport::Token	fileToken,
		std::string const &	inputFileName,
		bool	fastCopying
	)

Definition at line 538 of file JobReport.cc.

void edm::JobReport::reportInputLumiSection	(	unsigned int	run,
		unsigned int	lumiSectId
	)

API for reporting a Lumi Section to the job report. for input files, call only if lumi section is physically read from the input file

Definition at line 549 of file JobReport.cc.

void edm::JobReport::reportInputRunNumber ( unsigned int run )

API to report a run read from input

Definition at line 559 of file JobReport.cc.

void edm::JobReport::reportLumiSection	(	JobReport::Token	token,
		unsigned int	run,
		unsigned int	lumiSectId,
		unsigned long	nEvents = `0`
	)

API for reporting a Lumi Section to the job report. for output files, call only if lumi section is written to the output file

Definition at line 544 of file JobReport.cc.

void edm::JobReport::reportMemoryInfo ( std::vector< std::string > const & memoryData )

Report Memory statistics ALTERNATE FORM - USING THIS MAY NECESSITATE CHANGES IN PARSING XML! Invoked by the Memory service to send an end of job summary about memory usage for inclusion in the job report

Definition at line 634 of file JobReport.cc.

void edm::JobReport::reportMessageInfo ( std::map< std::string, double > const & messageData )

Report Message statistics Invoked by the MessageLogger service to send an end of job summary about numbers of various categories messages issued for inclusion in the job report

Definition at line 649 of file JobReport.cc.

void edm::JobReport::reportPerformanceForModule	(	std::string const &	metricClass,
		std::string const &	moduleName,
		std::map< std::string, std::string > const &	metrics
	)

Definition at line 759 of file JobReport.cc.

Referenced by XrdAdaptor::XrdStatisticsService::postEndJob().

void edm::JobReport::reportPerformanceSummary	(	std::string const &	metricClass,
		std::map< std::string, std::string > const &	metrics
	)

Performance Reports

Two categories: Summary for entire job and module for a specific module Each one requires a performance metric class such as Timing, Memory, CPU, Trigger etc.

Definition at line 738 of file JobReport.cc.

void edm::JobReport::reportRandomStateFile ( std::string const & name )

Report the name of the random engine persistency file

Definition at line 724 of file JobReport.cc.

void edm::JobReport::reportReadBranch	(	InputType	inputType,
		std::string const &	branchName
	)

Inform the job report that a branch has been read.

Definition at line 699 of file JobReport.cc.

void edm::JobReport::reportReadBranches ( )

Report read branches Invoked by the source that reads ROOT/EDM files at the end of a job to report which product branches in the Events tree have been read, with a count of the number of events for which the branch was read.

Definition at line 665 of file JobReport.cc.

void edm::JobReport::reportRunNumber	(	JobReport::Token	token,
		unsigned int	run
	)

API for reporting a Run to the job report. for output files, call only if Run is written to the output file

Definition at line 554 of file JobReport.cc.

void edm::JobReport::reportSkippedEvent	(	RunNumber_t	run,
		EventNumber_t	event
	)

Definition at line 525 of file JobReport.cc.

void edm::JobReport::reportSkippedFile	(	std::string const &	pfn,
		std::string const &	lfn
	)

Report Skipped File

Report that a file has been skipped due to it not being found.

Definition at line 602 of file JobReport.cc.

Member Data Documentation

edm::propagate_const<std::unique_ptr<JobReportImpl> > edm::JobReport::impl_

private

Definition at line 441 of file JobReport.h.

std::mutex edm::JobReport::write_mutex

private

Definition at line 442 of file JobReport.h.

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation