art::TimeTracker Class Reference

Classes
struct	Config
struct	PerScheduleData

Public Types
using	Parameters = ServiceTable< Config >

Public Member Functions
	TimeTracker (ServiceTable< Config > const &, ActivityRegistry &)

Private Types
template<unsigned SIZE>
using	name_array = cet::sqlite::name_array< SIZE >
using	timeSource_t = cet::sqlite::Ntuple< uint32_t, uint32_t, uint32_t, string, double >
using	timeEvent_t = cet::sqlite::Ntuple< uint32_t, uint32_t, uint32_t, double >
using	timeModule_t = cet::sqlite::Ntuple< uint32_t, uint32_t, uint32_t, string, string, string, double >

Private Member Functions
void	prePathProcessing (string const &)
void	postSourceConstruction (ModuleDescription const &)
void	postEndJob ()
void	preEventReading ()
void	postEventReading (Event const &)
void	preEventProcessing (Event const &)
void	postEventProcessing (Event const &)
void	startTime (ModuleDescription const &)
void	recordTime (ModuleDescription const &md, string const &suffix)
void	logToDatabase_ (Statistics const &evt, std::vector< Statistics > const &modules)
void	logToDestination_ (Statistics const &evt, std::vector< Statistics > const &modules)

Private Attributes
std::vector< PerScheduleData >	data_
bool	printSummary_
cet::sqlite::Connection	db_
bool	overwriteContents_
string	sourceType_ {}
name_array< 5u >	timeSourceTuple_
name_array< 4u >	timeEventTuple_
name_array< 7u >	timeModuleTuple_
timeSource_t	timeSourceTable_
timeEvent_t	timeEventTable_
timeModule_t	timeModuleTable_

Detailed Description

Definition at line 102 of file TimeTracker_service.cc.

Member Typedef Documentation

template<unsigned SIZE>

using art::TimeTracker::name_array = cet::sqlite::name_array<SIZE>

private

Definition at line 151 of file TimeTracker_service.cc.

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

Definition at line 114 of file TimeTracker_service.cc.

using art::TimeTracker::timeEvent_t = cet::sqlite::Ntuple<uint32_t, uint32_t, uint32_t, double>

private

Definition at line 158 of file TimeTracker_service.cc.

using art::TimeTracker::timeModule_t = cet::sqlite:: Ntuple<uint32_t, uint32_t, uint32_t, string, string, string, double>

private

Definition at line 160 of file TimeTracker_service.cc.

using art::TimeTracker::timeSource_t = cet::sqlite::Ntuple<uint32_t, uint32_t, uint32_t, string, double>

private

Definition at line 157 of file TimeTracker_service.cc.

Constructor & Destructor Documentation

art::TimeTracker::TimeTracker ( ServiceTable< Config > const &  config, ActivityRegistry &  iRegistry  )

explicit

Definition at line 170 of file TimeTracker_service.cc.

References data_, db_, art::ServiceHandle< T, SCOPE >::get(), overwriteContents_, postEndJob(), postEventProcessing(), postEventReading(), postSourceConstruction(), preEventProcessing(), preEventReading(), prePathProcessing(), recordTime(), s, startTime(), timeEventTable_, timeEventTuple_, timeModuleTable_, timeModuleTuple_, timeSourceTable_, and timeSourceTuple_.

  : printSummary_{config().printSummary()}
  , db_{ServiceHandle<DatabaseConnection>{}->get(
      config().dbOutput().filename())}
  , overwriteContents_{config().dbOutput().overwrite()} // table headers
  , timeSourceTuple_{{"Run", "SubRun", "Event", "Source", "Time"}}
  , timeEventTuple_{{"Run", "SubRun", "Event", "Time"}}
  , timeModuleTuple_{{"Run",
                      "SubRun",
                      "Event",
                      "Path",
                      "ModuleLabel",
                      "ModuleType",
                      "Time"}} // tables
  , timeSourceTable_{db_, "TimeSource", timeSourceTuple_, overwriteContents_}
  , timeEventTable_{db_, "TimeEvent", timeEventTuple_, overwriteContents_}
  , timeModuleTable_{db_, "TimeModule", timeModuleTuple_, overwriteContents_}
{
  // MT-TODO: Placeholder until we are multi-threaded
  unsigned const nSchedules{1u};
  data_.resize(nSchedules);

  iRegistry.sPostSourceConstruction.watch(this,
                                          &TimeTracker::postSourceConstruction);
  iRegistry.sPreProcessPath.watch(this, &TimeTracker::prePathProcessing);
  iRegistry.sPostEndJob.watch(this, &TimeTracker::postEndJob);

  // Event reading
  iRegistry.sPreSourceEvent.watch(this, &TimeTracker::preEventReading);
  iRegistry.sPostSourceEvent.watch(this, &TimeTracker::postEventReading);

  // Event execution
  iRegistry.sPreProcessEvent.watch(this, &TimeTracker::preEventProcessing);
  iRegistry.sPostProcessEvent.watch(this, &TimeTracker::postEventProcessing);

  // Module execution
  iRegistry.sPreModule.watch(this, &TimeTracker::startTime);
  iRegistry.sPostModule.watch(
    [this](auto const& md) { this->recordTime(md, ""s); });
  iRegistry.sPreWriteEvent.watch(this, &TimeTracker::startTime);
  iRegistry.sPostWriteEvent.watch(
    [this](auto const& md) { this->recordTime(md, "(write)"s); });
}

Member Function Documentation

void art::TimeTracker::logToDatabase_ ( Statistics const &  evt, std::vector< Statistics > const &  modules  )

private

void art::TimeTracker::logToDestination_ ( Statistics const &  evt, std::vector< Statistics > const &  modules  )

private

Definition at line 389 of file TimeTracker_service.cc.

References DECLARE_ART_SERVICE, DEFINE_ART_SERVICE, art::left(), art::LEGACY, max, and s.

Referenced by postEndJob().

{
  std::size_t width{30};
  auto identifier_size = [](Statistics const& s) {
    return s.path.size() + s.mod_label.size() + s.mod_type.size() +
           2; // Don't forget the two ':'s.
  };
  cet::for_all(modules, [&identifier_size, &width](auto const& mod) {
    width = std::max(width, identifier_size(mod));
  });

  std::ostringstream msgOss;
  HorizontalRule const rule{width + 4 + 5 * 14 + 12};
  msgOss << '\n'
         << rule('=') << '\n'
         << std::setw(width + 2) << std::left << "TimeTracker printout (sec)"
         << boost::format(" %=12s ") % "Min" << boost::format(" %=12s ") % "Avg"
         << boost::format(" %=12s ") % "Max"
         << boost::format(" %=12s ") % "Median"
         << boost::format(" %=12s ") % "RMS"
         << boost::format(" %=10s ") % "nEvts"
         << "\n";

  msgOss << rule('=') << '\n';

  if (evt.n == 0u) {
    msgOss << "[ No processed events ]\n";
  } else {
    // N.B. setw(width) applies to the first field in
    //      ostream& art::operator<<(ostream&, Statistics const&).
    msgOss << setw(width) << evt << '\n' << rule('-') << '\n';
    for (auto const& mod : modules) {
      msgOss << setw(width) << mod << '\n';
    }
  }

  msgOss << rule('=');
  mf::LogAbsolute("TimeTracker") << msgOss.str();
}

void art::TimeTracker::postEndJob ( )

private

Definition at line 226 of file TimeTracker_service.cc.

References db_, logToDestination_(), printSummary_, s, sourceType_, timeEventTable_, timeModuleTable_, and timeSourceTable_.

Referenced by TimeTracker().

{
  timeSourceTable_.flush();
  timeEventTable_.flush();
  timeModuleTable_.flush();

  if (!printSummary_)
    return;

  using namespace cet::sqlite;
  query_result<std::size_t> rEvents;
  rEvents << select("count(*)").from(db_, timeEventTable_.name());

  query_result<std::size_t> rModules;
  rModules << select("count(*)").from(db_, timeModuleTable_.name());

  auto const nEventRows = unique_value(rEvents);
  auto const nModuleRows = unique_value(rModules);

  if (nEventRows == 0 && nModuleRows == 0) {
    logToDestination_(Statistics{}, std::vector<Statistics>{});
    return;
  }

  if (nEventRows == 0 && nModuleRows != 0) {
    std::string const errMsg{
      "Malformed TimeTracker database.  The TimeEvent table is empty, but\n"
      "the TimeModule table is not.  This can happen if an exception has\n"
      "been thrown from a module while processing the first event.  Any saved\n"
      "database file is suspect and should not be used."};
    mf::LogAbsolute("TimeTracker") << errMsg;
    return;
  }

  using namespace std;
  // Gather statistics for full Event
  // -- Unfortunately, this is not a simple query since the (e.g.)
  //    'RootOutput(write)' times and the source time are not
  //    recorded in the TimeEvent rows.  They must be added in.

  string const fullEventTime_ddl =
    "CREATE TABLE temp.fullEventTime AS "
    "SELECT Run,Subrun,Event,SUM(Time) AS FullEventTime FROM ("
    "       SELECT Run,Subrun,Event,Time FROM TimeEvent"
    "       UNION"
    "       SELECT Run,Subrun,Event,Time FROM TimeModule WHERE ModuleType LIKE "
    "'%(write)'"
    "       UNION"
    "       SELECT Run,Subrun,Event,Time FROM TimeSource"
    ") GROUP BY Run,Subrun,Event";

  using namespace cet::sqlite;
  exec(db_, fullEventTime_ddl);
  Statistics const evtStats{
    "Full event", "", "", db_, "temp.fullEventTime", "FullEventTime"};
  drop_table(db_, "temp.fullEventTime");

  query_result<string, string, string> r;
  r << select_distinct("Path", "ModuleLabel", "ModuleType")
         .from(db_, timeModuleTable_.name());

  std::vector<Statistics> modStats;
  modStats.emplace_back(
    "source", sourceType_ + "(read)", "", db_, "TimeSource", "Time");

  for (auto const& row : r) {
    string path, mod_label, mod_type;
    tie(path, mod_label, mod_type) = row;
    create_table_as("temp.tmpModTable",
                    select("*")
                      .from(db_, "TimeModule")
                      .where("Path='"s + path + "'"s + " AND ModuleLabel='"s +
                             mod_label + "'"s + " AND ModuleType='"s +
                             mod_type + "'"s));
    modStats.emplace_back(
      path, mod_label, mod_type, db_, "temp.tmpModTable", "Time");
    drop_table(db_, "temp.tmpModTable");
  }

  logToDestination_(evtStats, modStats);
}

void art::TimeTracker::postEventProcessing ( Event const &  )

private

Definition at line 350 of file TimeTracker_service.cc.

References d, data_, art::ScheduleID::first(), art::ScheduleID::id(), and timeEventTable_.

Referenced by TimeTracker().

{
  // MT-TODO: Placeholder until we're multi-threaded
  auto const sid = ScheduleID::first().id();
  auto const& d = data_[sid];
  auto const t = std::chrono::duration<double>{now() - d.eventStart}.count();
  timeEventTable_.insert(
    d.eventID.run(), d.eventID.subRun(), d.eventID.event(), t);
}

void art::TimeTracker::postEventReading ( Event const &  e )

private

Definition at line 327 of file TimeTracker_service.cc.

References d, data_, art::ScheduleID::first(), art::ScheduleID::id(), art::Event::id(), sourceType_, and timeSourceTable_.

Referenced by TimeTracker().

{
  // MT-TODO: Placeholder until we're multi-threaded
  auto const sid = ScheduleID::first().id();
  auto& d = data_[sid];
  d.eventID = e.id();
  auto const t = std::chrono::duration<double>{now() - d.eventStart}.count();
  timeSourceTable_.insert(
    d.eventID.run(), d.eventID.subRun(), d.eventID.event(), sourceType_, t);
}

void art::TimeTracker::postSourceConstruction ( ModuleDescription const &  md )

private

Definition at line 310 of file TimeTracker_service.cc.

References art::ModuleDescription::moduleName(), and sourceType_.

Referenced by TimeTracker().

{
  sourceType_ = md.moduleName();
}

void art::TimeTracker::preEventProcessing ( Event const &  )

private

Definition at line 340 of file TimeTracker_service.cc.

References d, data_, e, art::ScheduleID::first(), and art::ScheduleID::id().

Referenced by TimeTracker().

{
  // MT-TODO: Placeholder until we're multi-threaded
  auto const sid = ScheduleID::first().id();
  auto& d = data_[sid];
  assert(d.eventID == e.id());
  d.eventStart = now();
}

void art::TimeTracker::preEventReading ( )

private

Definition at line 317 of file TimeTracker_service.cc.

References d, data_, art::ScheduleID::first(), art::ScheduleID::id(), and art::EventID::invalidEvent().

Referenced by TimeTracker().

{
  // MT-TODO: Placeholder until we're multi-threaded
  auto const sid = ScheduleID::first().id();
  auto& d = data_[sid];
  d.eventID = EventID::invalidEvent();
  d.eventStart = now();
}

void art::TimeTracker::prePathProcessing ( string const &  pathname )

private

Definition at line 217 of file TimeTracker_service.cc.

References data_, art::ScheduleID::first(), and art::ScheduleID::id().

Referenced by TimeTracker().

{
  // MT-TODO: Placeholder until we're multi-threaded
  auto const sid = ScheduleID::first().id();
  data_[sid].pathName = pathname;
}

void art::TimeTracker::recordTime ( ModuleDescription const &  md, string const &  suffix  )

private

Definition at line 371 of file TimeTracker_service.cc.

References d, data_, art::ScheduleID::first(), art::ScheduleID::id(), art::ModuleDescription::moduleLabel(), art::ModuleDescription::moduleName(), and timeModuleTable_.

Referenced by TimeTracker().

{
  // MT-TODO: Placeholder until we're multi-threaded
  auto const sid = ScheduleID::first().id();
  auto const& d = data_[sid];
  auto const t = std::chrono::duration<double>{now() - d.moduleStart}.count();
  timeModuleTable_.insert(d.eventID.run(),
                          d.eventID.subRun(),
                          d.eventID.event(),
                          d.pathName,
                          desc.moduleLabel(),
                          desc.moduleName() + suffix,
                          t);
}

void art::TimeTracker::startTime ( ModuleDescription const &  )

private

Definition at line 362 of file TimeTracker_service.cc.

References d, data_, art::ScheduleID::first(), and art::ScheduleID::id().

Referenced by TimeTracker().

{
  // MT-TODO: Placeholder until we're multi-threaded
  auto const sid = ScheduleID::first().id();
  auto& d = data_[sid];
  d.moduleStart = now();
}

Member Data Documentation

std::vector<PerScheduleData> art::TimeTracker::data_

private

Definition at line 143 of file TimeTracker_service.cc.

Referenced by postEventProcessing(), postEventReading(), preEventProcessing(), preEventReading(), prePathProcessing(), recordTime(), startTime(), and TimeTracker().

cet::sqlite::Connection art::TimeTracker::db_

private

Definition at line 146 of file TimeTracker_service.cc.

Referenced by postEndJob(), and TimeTracker().

bool art::TimeTracker::overwriteContents_

private

Definition at line 147 of file TimeTracker_service.cc.

Referenced by TimeTracker().

bool art::TimeTracker::printSummary_

private

Definition at line 145 of file TimeTracker_service.cc.

Referenced by postEndJob().

string art::TimeTracker::sourceType_ {}

private

Definition at line 148 of file TimeTracker_service.cc.

Referenced by postEndJob(), postEventReading(), and postSourceConstruction().

timeEvent_t art::TimeTracker::timeEventTable_

private

Definition at line 163 of file TimeTracker_service.cc.

Referenced by postEndJob(), postEventProcessing(), and TimeTracker().

name_array<4u> art::TimeTracker::timeEventTuple_

private

Definition at line 153 of file TimeTracker_service.cc.

Referenced by TimeTracker().

timeModule_t art::TimeTracker::timeModuleTable_

private

Definition at line 164 of file TimeTracker_service.cc.

Referenced by postEndJob(), recordTime(), and TimeTracker().

name_array<7u> art::TimeTracker::timeModuleTuple_

private

Definition at line 154 of file TimeTracker_service.cc.

Referenced by TimeTracker().

timeSource_t art::TimeTracker::timeSourceTable_

private

Definition at line 162 of file TimeTracker_service.cc.

Referenced by postEndJob(), postEventReading(), and TimeTracker().

name_array<5u> art::TimeTracker::timeSourceTuple_

private

Definition at line 152 of file TimeTracker_service.cc.

Referenced by TimeTracker().

---

The documentation for this class was generated from the following file:

• art/Framework/Services/Optional/TimeTracker_service.cc