art::TimeTracker Class Reference

Classes
struct	Config
struct	PerScheduleData

Public Types
using	Parameters = ServiceTable< Config >

Public Member Functions
	TimeTracker (Parameters const &, ActivityRegistry &)

Static Public Attributes
static constexpr bool	service_handle_allowed {false}

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	postSourceConstruction (ModuleDescription const &)
void	postEndJob ()
void	preEventReading (ScheduleContext)
void	postEventReading (Event const &, ScheduleContext)
void	preEventProcessing (Event const &, ScheduleContext)
void	postEventProcessing (Event const &, ScheduleContext)
void	startTime (ModuleContext const &mc)
void	recordTime (ModuleContext const &mc, string const &suffix)
void	logToDestination_ (Statistics const &evt, vector< Statistics > const &modules)
bool	anyTableFull_ () const

Private Attributes
tbb::concurrent_unordered_map< ConcurrentKey, PerScheduleData, ConcurrentKeyHasher >	data_
bool const	printSummary_
unique_ptr< cet::sqlite::Connection > const	db_
bool const	overwriteContents_
string	sourceType_ {}
name_array< 5u > const	timeSourceColumnNames_
name_array< 4u > const	timeEventColumnNames_
name_array< 7u > const	timeModuleColumnNames_
timeSource_t	timeSourceTable_
timeEvent_t	timeEventTable_
timeModule_t	timeModuleTable_

Detailed Description

Definition at line 124 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 146 of file TimeTracker_service.cc.

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

Definition at line 136 of file TimeTracker_service.cc.

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

private

Definition at line 150 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 152 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 148 of file TimeTracker_service.cc.

Constructor & Destructor Documentation

art::TimeTracker::TimeTracker ( Parameters const &  config, ActivityRegistry &  areg  )

explicit

Definition at line 182 of file TimeTracker_service.cc.

References db_, overwriteContents_, postEndJob(), postEventProcessing(), postEventReading(), postSourceConstruction(), preEventProcessing(), preEventReading(), recordTime(), startTime(), timeEventColumnNames_, timeEventTable_, timeModuleColumnNames_, timeModuleTable_, timeSourceColumnNames_, and timeSourceTable_.

    : printSummary_{config().printSummary()}
    , db_{ServiceHandle<DatabaseConnection>{}
          -> get(config().dbOutput().filename())}
    , overwriteContents_{config().dbOutput().overwrite()}
    , timeSourceColumnNames_{{"Run", "SubRun", "Event", "Source", "Time"}}
    , timeEventColumnNames_{{"Run", "SubRun", "Event", "Time"}}
    , timeModuleColumnNames_{{"Run",
                              "SubRun",
                              "Event",
                              "Path",
                              "ModuleLabel",
                              "ModuleType",
                              "Time"}}
    , timeSourceTable_{*db_,
                       "TimeSource",
                       timeSourceColumnNames_,
                       overwriteContents_}
    , timeEventTable_{*db_,
                      "TimeEvent",
                      timeEventColumnNames_,
                      overwriteContents_}
    , timeModuleTable_{*db_,
                       "TimeModule",
                       timeModuleColumnNames_,
                       overwriteContents_}
  {
    areg.sPostSourceConstruction.watch(this,
                                       &TimeTracker::postSourceConstruction);
    areg.sPostEndJob.watch(this, &TimeTracker::postEndJob);
    // Event reading
    areg.sPreSourceEvent.watch(this, &TimeTracker::preEventReading);
    areg.sPostSourceEvent.watch(this, &TimeTracker::postEventReading);
    // Event execution
    areg.sPreProcessEvent.watch(this, &TimeTracker::preEventProcessing);
    areg.sPostProcessEvent.watch(this, &TimeTracker::postEventProcessing);
    // Module execution
    areg.sPreModule.watch(this, &TimeTracker::startTime);
    areg.sPostModule.watch(
      [this](auto const& mc) { this->recordTime(mc, ""s); });
    areg.sPreWriteEvent.watch(this, &TimeTracker::startTime);
    areg.sPostWriteEvent.watch(
      [this](auto const& mc) { this->recordTime(mc, "(write)"s); });
  }

Member Function Documentation

bool art::TimeTracker::anyTableFull_ ( ) const

private

Definition at line 412 of file TimeTracker_service.cc.

References DECLARE_ART_SERVICE, DEFINE_ART_SERVICE, art::SHARED, timeEventTable_, timeModuleTable_, and timeSourceTable_.

Referenced by postEndJob().

  {
    return timeSourceTable_.full() || timeEventTable_.full() ||
           timeModuleTable_.full();
  }

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

private

Definition at line 374 of file TimeTracker_service.cc.

References art::left().

Referenced by postEndJob().

  {
    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 = max(width, identifier_size(mod));
    });
    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& 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 228 of file TimeTracker_service.cc.

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

Referenced by TimeTracker().

  {
    timeSourceTable_.flush();
    timeEventTable_.flush();
    timeModuleTable_.flush();
    if (!printSummary_) {
      return;
    }
    using namespace cet::sqlite;
    query_result<size_t> rEvents;
    rEvents << select("count(*)").from(*db_, timeEventTable_.name());
    query_result<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{}, vector<Statistics>{});
      return;
    }
    if (nEventRows == 0 && nModuleRows != 0) {
      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\n"
        "saved database file is suspect and should not be used."};
      mf::LogAbsolute("TimeTracker") << errMsg;
      return;
    }
    // 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());
    vector<Statistics> modStats;
    modStats.emplace_back(
      "source", sourceType_ + "(read)", "", *db_, "TimeSource", "Time");
    for (auto const& row : r) {
      auto const& [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");
    }
    if (anyTableFull_()) {
      ostringstream msgOss;
      HorizontalRule const rule{40};
      msgOss << rule('=');
      msgOss << '\n'
             << "The SQLite database connected to the TimeTracker exceeded the "
                "available resources.\n"
             << "No timing information summary is available.\n"
             << "The database will contain an incomplete record of this job's "
                "timing information.\n";
      msgOss << rule('=');
      mf::LogAbsolute("TimeTracker") << msgOss.str();
    }

    logToDestination_(evtStats, modStats);
  }

void art::TimeTracker::postEventProcessing ( Event const &  , ScheduleContext  sc  )

private

Definition at line 344 of file TimeTracker_service.cc.

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

Referenced by TimeTracker().

  {
    auto const& d = data_[key(sc.id())];
    auto const t = 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, ScheduleContext  sc  )

private

Definition at line 325 of file TimeTracker_service.cc.

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

Referenced by TimeTracker().

  {
    auto& d = data_[key(sc.id())];
    d.eventID = e.id();
    auto const t = 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 311 of file TimeTracker_service.cc.

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

Referenced by TimeTracker().

  {
    sourceType_ = md.moduleName();
  }

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

private

Definition at line 335 of file TimeTracker_service.cc.

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

Referenced by TimeTracker().

  {
    auto& d = data_[key(sc.id())];
    assert(d.eventID == e.id());
    d.eventStart = now();
  }

void art::TimeTracker::preEventReading ( ScheduleContext  sc )

private

Definition at line 317 of file TimeTracker_service.cc.

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

Referenced by TimeTracker().

  {
    auto& d = data_[key(sc.id())];
    d.eventID = EventID::invalidEvent();
    d.eventStart = now();
  }

void art::TimeTracker::recordTime ( ModuleContext const &  mc, string const &  suffix  )

private

Definition at line 360 of file TimeTracker_service.cc.

References d, data_, art::ModuleContext::moduleLabel(), art::ModuleContext::moduleName(), art::ModuleContext::pathName(), and timeModuleTable_.

Referenced by TimeTracker().

  {
    auto const& d = data_[key(mc)];
    auto const t = chrono::duration<double>{now() - d.moduleStart}.count();
    timeModuleTable_.insert(d.eventID.run(),
                            d.eventID.subRun(),
                            d.eventID.event(),
                            mc.pathName(),
                            mc.moduleLabel(),
                            mc.moduleName() + suffix,
                            t);
  }

void art::TimeTracker::startTime ( ModuleContext const &  mc )

private

Definition at line 353 of file TimeTracker_service.cc.

References data_, and art::ModuleContext::scheduleID().

Referenced by TimeTracker().

  {
    data_[key(mc)].eventID = data_[key(mc.scheduleID())].eventID;
    data_[key(mc)].moduleStart = now();
  }

Member Data Documentation

tbb::concurrent_unordered_map<ConcurrentKey, PerScheduleData, ConcurrentKeyHasher> art::TimeTracker::data_

private

Definition at line 169 of file TimeTracker_service.cc.

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

unique_ptr<cet::sqlite::Connection> const art::TimeTracker::db_

private

Definition at line 171 of file TimeTracker_service.cc.

Referenced by postEndJob(), and TimeTracker().

bool const art::TimeTracker::overwriteContents_

private

Definition at line 172 of file TimeTracker_service.cc.

Referenced by TimeTracker().

bool const art::TimeTracker::printSummary_

private

Definition at line 170 of file TimeTracker_service.cc.

Referenced by postEndJob().

constexpr bool art::TimeTracker::service_handle_allowed {false}

static

Definition at line 126 of file TimeTracker_service.cc.

string art::TimeTracker::sourceType_ {}

private

Definition at line 173 of file TimeTracker_service.cc.

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

name_array<4u> const art::TimeTracker::timeEventColumnNames_

private

Definition at line 175 of file TimeTracker_service.cc.

Referenced by TimeTracker().

timeEvent_t art::TimeTracker::timeEventTable_

private

Definition at line 178 of file TimeTracker_service.cc.

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

name_array<7u> const art::TimeTracker::timeModuleColumnNames_

private

Definition at line 176 of file TimeTracker_service.cc.

Referenced by TimeTracker().

timeModule_t art::TimeTracker::timeModuleTable_

private

Definition at line 179 of file TimeTracker_service.cc.

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

name_array<5u> const art::TimeTracker::timeSourceColumnNames_

private

Definition at line 174 of file TimeTracker_service.cc.

Referenced by TimeTracker().

timeSource_t art::TimeTracker::timeSourceTable_

private

Definition at line 177 of file TimeTracker_service.cc.

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

---

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

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