Classes
struct	Config

Public Types
using	Parameters = ServiceTable< Config >

Public Member Functions
	MemoryTracker (fhicl::ParameterSet const &)

	MemoryTracker (Parameters const &, ActivityRegistry &)

Static Public Attributes
static constexpr bool	service_handle_allowed {false}

Private Types
template<unsigned N>
using	name_array = cet::sqlite::name_array< N >

using	peakUsage_t = cet::sqlite::Ntuple< string, double, string >

using	otherInfo_t = cet::sqlite::Ntuple< string, string, string, double, double >

using	memEvent_t = cet::sqlite::Ntuple< string, uint32_t, uint32_t, uint32_t, double, double >

using	memModule_t = cet::sqlite::Ntuple< string, uint32_t, uint32_t, uint32_t, string, string, string, double, double >

using	memEventHeap_t = cet::sqlite::Ntuple< string, uint32_t, uint32_t, uint32_t, int, int, int, int, int, int, int >

using	memModuleHeap_t = cet::sqlite::Ntuple< string, uint32_t, uint32_t, uint32_t, string, string, string, int, int, int, int, int, int, int >

Private Member Functions
void	prePathProcessing (PathContext const &pc)

void	recordOtherData (ModuleDescription const &md, string const &step)

void	recordOtherData (ModuleContext const &mc, string const &step)

void	recordEventData (Event const &e, string const &step)

void	recordModuleData (ModuleContext const &mc, string const &step)

void	postEndJob ()

bool	checkMallocConfig_ (string const &, bool)

void	recordPeakUsages_ ()

void	flushTables_ ()

bool	using_file_database_ () const

void	summary_ ()

bool	anyTableFull_ () const

Private Attributes
LinuxProcMgr	procInfo_ {}

string const	fileName_

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

bool const	overwriteContents_

bool const	includeMallocInfo_

EventID	currentEventID_ {EventID::invalidEvent()}

name_array< 3u >	peakUsageColumns_ {{"Name", "Value", "Description"}}

name_array< 5u >	otherInfoColumns_

name_array< 6u >	eventColumns_

name_array< 9u >	moduleColumns_

name_array< 11u >	eventHeapColumns_

name_array< 14u >	moduleHeapColumns_

peakUsage_t	peakUsageTable_

otherInfo_t	otherInfoTable_

memEvent_t	eventTable_

memModule_t	moduleTable_

unique_ptr< memEventHeap_t >	eventHeapTable_

unique_ptr< memModuleHeap_t >	moduleHeapTable_

Detailed Description

Definition at line 17 of file MemoryTrackerDarwin_service.cc.

Member Typedef Documentation

using art::MemoryTracker::memEvent_t = cet::sqlite::Ntuple<string, uint32_t, uint32_t, uint32_t, double, double>

private

Definition at line 72 of file MemoryTrackerLinux_service.cc.

using art::MemoryTracker::memEventHeap_t = cet::sqlite::Ntuple<string, uint32_t, uint32_t, uint32_t, int, int, int, int, int, int, int>

private

Definition at line 92 of file MemoryTrackerLinux_service.cc.

using art::MemoryTracker::memModule_t = cet::sqlite::Ntuple<string, uint32_t, uint32_t, uint32_t, string, string, string, double, double>

private

Definition at line 81 of file MemoryTrackerLinux_service.cc.

using art::MemoryTracker::memModuleHeap_t = cet::sqlite::Ntuple<string, uint32_t, uint32_t, uint32_t, string, string, string, int, int, int, int, int, int, int>

private

Definition at line 106 of file MemoryTrackerLinux_service.cc.

template<unsigned N>

using art::MemoryTracker::name_array = cet::sqlite::name_array<N>

private

Definition at line 67 of file MemoryTrackerLinux_service.cc.

using art::MemoryTracker::otherInfo_t = cet::sqlite::Ntuple<string, string, string, double, double>

private

Definition at line 70 of file MemoryTrackerLinux_service.cc.

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

Definition at line 126 of file MemoryTrackerLinux_service.cc.

using art::MemoryTracker::peakUsage_t = cet::sqlite::Ntuple<string, double, string>

private

Definition at line 68 of file MemoryTrackerLinux_service.cc.

Constructor & Destructor Documentation

art::MemoryTracker::MemoryTracker ( fhicl::ParameterSet const & )

inline

Definition at line 21 of file MemoryTrackerDarwin_service.cc.

References DECLARE_ART_SERVICE, DEFINE_ART_SERVICE, and art::SHARED.

     {
       mf::LogAbsolute("MemoryTracker")
         << '\n'
         << "The MemoryTracker service is not supported for this operating "
            "system.\n"
         << "If desired, please log an issue with:\n\n"
         << "https://cdcvs.fnal.gov/redmine/projects/cet-is/issues/new\n\n";
     }

art::MemoryTracker::MemoryTracker	(	Parameters const &	,
		ActivityRegistry &
	)

Member Function Documentation

bool art::MemoryTracker::anyTableFull_ ( ) const

private

Definition at line 457 of file MemoryTrackerLinux_service.cc.

References DECLARE_ART_SERVICE, DEFINE_ART_SERVICE, eventHeapTable_, eventTable_, moduleHeapTable_, moduleTable_, otherInfoTable_, peakUsageTable_, and art::SHARED.

Referenced by summary_().

   {
     return peakUsageTable_.full() || otherInfoTable_.full() ||
            eventTable_.full() || moduleTable_.full() ||
            (eventHeapTable_ && eventHeapTable_->full()) ||
            (moduleHeapTable_ && moduleHeapTable_->full());
   }

bool art::MemoryTracker::checkMallocConfig_	(	string const &	dbfilename,
		bool	include
	)

private

Definition at line 373 of file MemoryTrackerLinux_service.cc.

References art::errors::Configuration.

   {
     if (include && dbfilename.empty()) {
       string const errmsg =
         "\n'includeMallocInfo : true' is valid only if a nonempty db filename is specified:\n\n"s +
         "   MemoryTracker: {\n"
         "      includeMallocInfo: true\n"
         "      dbOutput: {\n"
         "         filename: \"your_filename.db\"\n"
         "      }\n"
         "   }\n\n";
       throw Exception{errors::Configuration} << errmsg;
     }
     return include;
   }

void art::MemoryTracker::flushTables_ ( )

private

Definition at line 400 of file MemoryTrackerLinux_service.cc.

References eventHeapTable_, eventTable_, moduleHeapTable_, moduleTable_, otherInfoTable_, and peakUsageTable_.

Referenced by postEndJob().

   {
     otherInfoTable_.flush();
     eventTable_.flush();
     moduleTable_.flush();
     peakUsageTable_.flush();
     if (eventHeapTable_) {
       eventHeapTable_->flush();
     }
     if (moduleHeapTable_) {
       moduleHeapTable_->flush();
     }
   }

void art::MemoryTracker::postEndJob ( )

private

Definition at line 365 of file MemoryTrackerLinux_service.cc.

References flushTables_(), recordPeakUsages_(), and summary_().

   {
     recordPeakUsages_();
     flushTables_();
     summary_();
   }

void art::MemoryTracker::prePathProcessing ( PathContext const & pc )

private

void art::MemoryTracker::recordEventData	(	Event const &	e,
		string const &	step
	)

private

Definition at line 306 of file MemoryTrackerLinux_service.cc.

References currentEventID_, art::EventID::event(), eventHeapTable_, eventTable_, art::Event::id(), includeMallocInfo_, procInfo_, art::EventID::run(), and art::EventID::subRun().

   {
     currentEventID_ = e.id();
     auto const currentMemory = procInfo_.getCurrentData();
     eventTable_.insert(step,
                        currentEventID_.run(),
                        currentEventID_.subRun(),
                        currentEventID_.event(),
                        LinuxProcData::getValueInMB<vsize_t>(currentMemory),
                        LinuxProcData::getValueInMB<rss_t>(currentMemory));
     if (includeMallocInfo_) {
       auto minfo = LinuxMallInfo{}.get();
       eventHeapTable_->insert(step,
                               currentEventID_.run(),
                               currentEventID_.subRun(),
                               currentEventID_.event(),
                               minfo.arena,
                               minfo.ordblks,
                               minfo.keepcost,
                               minfo.hblkhd,
                               minfo.hblks,
                               minfo.uordblks,
                               minfo.fordblks);
     }
   }

void art::MemoryTracker::recordModuleData	(	ModuleContext const &	mc,
		string const &	step
	)

private

Definition at line 333 of file MemoryTrackerLinux_service.cc.

References currentEventID_, art::EventID::event(), includeMallocInfo_, moduleHeapTable_, art::ModuleContext::moduleLabel(), art::ModuleContext::moduleName(), moduleTable_, art::ModuleContext::pathName(), procInfo_, art::EventID::run(), and art::EventID::subRun().

   {
     auto const currentMemory = procInfo_.getCurrentData();
     moduleTable_.insert(step,
                         currentEventID_.run(),
                         currentEventID_.subRun(),
                         currentEventID_.event(),
                         mc.pathName(),
                         mc.moduleLabel(),
                         mc.moduleName(),
                         LinuxProcData::getValueInMB<vsize_t>(currentMemory),
                         LinuxProcData::getValueInMB<rss_t>(currentMemory));
     if (includeMallocInfo_) {
       auto minfo = LinuxMallInfo{}.get();
       moduleHeapTable_->insert(step,
                                currentEventID_.run(),
                                currentEventID_.subRun(),
                                currentEventID_.event(),
                                mc.pathName(),
                                mc.moduleLabel(),
                                mc.moduleName(),
                                minfo.arena,
                                minfo.ordblks,
                                minfo.keepcost,
                                minfo.hblkhd,
                                minfo.hblks,
                                minfo.uordblks,
                                minfo.fordblks);
     }
   }

void art::MemoryTracker::recordOtherData	(	ModuleDescription const &	md,
		string const &	step
	)

private

Definition at line 294 of file MemoryTrackerLinux_service.cc.

References art::ModuleDescription::moduleLabel(), art::ModuleDescription::moduleName(), otherInfoTable_, and procInfo_.

Referenced by recordOtherData().

   {
     auto const data = procInfo_.getCurrentData();
     otherInfoTable_.insert(step,
                            md.moduleLabel(),
                            md.moduleName(),
                            LinuxProcData::getValueInMB<vsize_t>(data),
                            LinuxProcData::getValueInMB<rss_t>(data));
   }

void art::MemoryTracker::recordOtherData	(	ModuleContext const &	mc,
		string const &	step
	)

private

Definition at line 288 of file MemoryTrackerLinux_service.cc.

References art::ModuleContext::moduleDescription(), and recordOtherData().

   {
     recordOtherData(mc.moduleDescription(), step);
   }

void art::MemoryTracker::recordPeakUsages_ ( )

private

Definition at line 391 of file MemoryTrackerLinux_service.cc.

References peakUsageTable_, and procInfo_.

Referenced by postEndJob().

   {
     peakUsageTable_.insert(
       "VmPeak", procInfo_.getVmPeak(), "Peak virtual memory (MB)");
     peakUsageTable_.insert(
       "VmHWM", procInfo_.getVmHWM(), "Peak resident set size (MB)");
   }

void art::MemoryTracker::summary_ ( )

private

Definition at line 421 of file MemoryTrackerLinux_service.cc.

References anyTableFull_(), db_, fileName_, art::left(), peakUsageTable_, and using_file_database_().

Referenced by postEndJob().

   {
     using namespace cet::sqlite;
     using namespace std;
     query_result<double> rVMax;
     query_result<double> rRMax;
     rVMax << select("Value")
                .from(*db_, peakUsageTable_.name())
                .where("Name='VmPeak'");
     rRMax << select("Value")
                .from(*db_, peakUsageTable_.name())
                .where("Name='VmHWM'");
     mf::LogAbsolute log{"MemoryTracker"};
     HorizontalRule const rule{100};
     log << '\n' << rule('=') << '\n';
 
     if (anyTableFull_() && using_file_database_()) {
       log << "The SQLite database connected to the MemoryTracker exceeded the "
              "available resources.\n";
       log << "No memory usage summary is available.\n";
       log << "The database at " << fileName_
           << " will contain an incomplete record of this job's memory usage.\n";
     } else {
       log << std::left << "MemoryTracker summary (base-10 MB units used)\n\n";
       log << "  Peak virtual memory usage (VmPeak)  : " << unique_value(rVMax)
           << " MB\n"
           << "  Peak resident set size usage (VmHWM): " << unique_value(rRMax)
           << " MB\n";
       if (using_file_database_()) {
         log << "  Details saved in: '" << fileName_ << "'\n";
       }
     }
     log << rule('=');
   }

bool art::MemoryTracker::using_file_database_ ( ) const

private

Definition at line 415 of file MemoryTrackerLinux_service.cc.

References fileName_.

Referenced by summary_().

   {
     return !fileName_.empty() && fileName_ != ":memory:";
   }

Member Data Documentation

EventID art::MemoryTracker::currentEventID_ {EventID::invalidEvent()}

private

Definition at line 152 of file MemoryTrackerLinux_service.cc.

Referenced by recordEventData(), and recordModuleData().

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

private

Definition at line 145 of file MemoryTrackerLinux_service.cc.

Referenced by summary_().

name_array<6u> art::MemoryTracker::eventColumns_

private

Initial value:

{

{"Step", "Run", "SubRun", "Event", "Vsize", "RSS"}}

Definition at line 156 of file MemoryTrackerLinux_service.cc.

name_array<11u> art::MemoryTracker::eventHeapColumns_

private

Initial value:

{{"Step",
                                       "Run",
                                       "SubRun",
                                       "Event",
                                       "arena",
                                       "ordblks",
                                       "keepcost",
                                       "hblkhd",
                                       "hblks",
                                       "uordblks",
                                       "fordblks"}}

Definition at line 167 of file MemoryTrackerLinux_service.cc.

unique_ptr<memEventHeap_t> art::MemoryTracker::eventHeapTable_

private

Definition at line 196 of file MemoryTrackerLinux_service.cc.

Referenced by anyTableFull_(), flushTables_(), and recordEventData().

memEvent_t art::MemoryTracker::eventTable_

private

Definition at line 194 of file MemoryTrackerLinux_service.cc.

Referenced by anyTableFull_(), flushTables_(), and recordEventData().

string const art::MemoryTracker::fileName_

private

Definition at line 144 of file MemoryTrackerLinux_service.cc.

Referenced by summary_(), and using_file_database_().

bool const art::MemoryTracker::includeMallocInfo_

private

Definition at line 147 of file MemoryTrackerLinux_service.cc.

Referenced by recordEventData(), and recordModuleData().

name_array<9u> art::MemoryTracker::moduleColumns_

private

Initial value:

{{"Step",
                                   "Run",
                                   "SubRun",
                                   "Event",
                                   "Path",
                                   "ModuleLabel",
                                   "ModuleType",
                                   "Vsize",
                                   "RSS"}}

Definition at line 158 of file MemoryTrackerLinux_service.cc.

name_array<14u> art::MemoryTracker::moduleHeapColumns_

private

Initial value:

{{"Step",
                                        "Run",
                                        "SubRun",
                                        "Event",
                                        "Path",
                                        "ModuleLabel",
                                        "ModuleType",
                                        "arena",
                                        "ordblks",
                                        "keepcost",
                                        "hblkhd",
                                        "hblks",
                                        "uordblks",
                                        "fordblks"}}