Skip to content

Commit

Permalink
PERF: Remove SystemInformation data from ResourceProbe, fix issue #350
Browse files Browse the repository at this point in the history 
ITK 4.9 added system info to `itk::ResourceProbe` (the base class of
`itk::TimeProbe` and `itk::MemoryProbe`), by calling `GetSystemInformation()`
in its constructor. This function call appeared very time consuming.
Using Visual Studio 2017 (Release configuration), it was observed that a single
`GetSystemInformation()` function call took more than 0.1 second.

This commit removes the `this->GetSystemInformation()` function call from
ResourceProbe, deprecates the member function, removes the related data
members, and only retrieves the system info when and where it is actually being
used: in `PrintSystemInformation` and `PrintJSONSystemInformation`.

Fixes issue #350, "Major performance issue TimeProbe, ResourceProbe
constructor", which was based on the analysis of an `elastix` example
case by Theo van Walsum (@tvanwalsum).
  • Loading branch information
@N-Dekker @thewtex
N-Dekker authored and thewtex committed Jan 5, 2019
1 parent 4a6e8c8 commit b13f6a8
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 79 deletions.
20 changes: 2 additions & 18 deletions Modules/Core/Common/include/itkResourceProbe.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -151,8 +151,8 @@ class ITK_TEMPLATE_EXPORT ResourceProbe
void PrintJSONvar(std::ostream & os, const char* varName, T varValue,
unsigned indent = 4, bool comma = true);

/** Get System information */
virtual void GetSystemInformation();
/** Obsolete member function from ITK 4.8 - 4.13. Does not do anything anymore. */
itkLegacyMacro(virtual void GetSystemInformation());

private:

Expand All @@ -174,22 +174,6 @@ class ITK_TEMPLATE_EXPORT ResourceProbe
std::string m_TypeString;
std::string m_UnitString;

std::string m_SystemName;
std::string m_ProcessorName;
int m_ProcessorCacheSize;
float m_ProcessorClockFrequency;
unsigned int m_NumberOfPhysicalCPU;
unsigned int m_NumberOfLogicalCPU;
std::string m_OSName;
std::string m_OSRelease;
std::string m_OSVersion;
std::string m_OSPlatform;
bool m_Is64Bits;
std::string m_ITKVersion;
size_t m_TotalVirtualMemory;
size_t m_AvailableVirtualMemory;
size_t m_TotalPhysicalMemory;
size_t m_AvailablePhysicalMemory;

static ITK_CONSTEXPR_VAR unsigned int tabwidth = 15;
};
Expand Down
112 changes: 51 additions & 61 deletions Modules/Core/Common/include/itkResourceProbe.hxx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ ResourceProbe< ValueType, MeanType >
::ResourceProbe(const std::string & type, const std::string & unit):
m_TypeString(type), m_UnitString(unit)
{
this->GetSystemInformation();
this->Reset();
}

Expand Down Expand Up @@ -261,30 +260,35 @@ void
ResourceProbe< ValueType, MeanType >
::PrintSystemInformation(std::ostream & os)
{
os << "System: " << m_SystemName << std::endl;
os << "Processor: " << m_ProcessorName << std::endl;
os << " Cache: " << m_ProcessorCacheSize << std::endl;
os << " Clock: " << m_ProcessorClockFrequency << std::endl;
os << " Physical CPUs: " << m_NumberOfPhysicalCPU << std::endl;
os << " Logical CPUs: " << m_NumberOfLogicalCPU << std::endl;
// Retrieve memory information in megabyte.
itksys::SystemInformation systeminfo;
systeminfo.RunCPUCheck();
systeminfo.RunMemoryCheck();
systeminfo.RunOSCheck();

os << "System: " << systeminfo.GetHostname() << std::endl;
os << "Processor: " << systeminfo.GetExtendedProcessorName() << std::endl;
os << " Cache: " << systeminfo.GetProcessorCacheSize() << std::endl;
os << " Clock: " << systeminfo.GetProcessorClockFrequency() << std::endl;
os << " Physical CPUs: " << systeminfo.GetNumberOfPhysicalCPU() << std::endl;
os << " Logical CPUs: " << systeminfo.GetNumberOfLogicalCPU() << std::endl;
// Retrieve memory information in mebibytes.
os << " Virtual Memory: Total: "
<< std::left << std::setw( tabwidth ) << m_TotalVirtualMemory
<<" Available: "<< m_AvailableVirtualMemory << std::endl;
<< std::left << std::setw( tabwidth ) << systeminfo.GetTotalVirtualMemory()
<<" Available: "<< systeminfo.GetAvailableVirtualMemory() << std::endl;
os << " Physical Memory: Total: "
<< std::left << std::setw( tabwidth ) << m_TotalPhysicalMemory
<<" Available: "<< m_AvailablePhysicalMemory << std::endl;
<< std::left << std::setw( tabwidth ) << systeminfo.GetTotalPhysicalMemory()
<<" Available: "<< systeminfo.GetAvailablePhysicalMemory() << std::endl;

os << "OSName: "<< m_OSName << std::endl;
os << " Release: "<< m_OSRelease << std::endl;
os << " Version: "<< m_OSVersion << std::endl;
os << " Platform: "<< m_OSPlatform << std::endl;
os << "OSName: "<< systeminfo.GetOSName() << std::endl;
os << " Release: "<< systeminfo.GetOSRelease() << std::endl;
os << " Version: "<< systeminfo.GetOSVersion() << std::endl;
os << " Platform: "<< systeminfo.GetOSPlatform() << std::endl;

os << " Operating System is "
<< (m_Is64Bits?"64 bit":"32 bit") << std::endl;
<< (systeminfo.Is64Bits()?"64 bit":"32 bit") << std::endl;

os << "ITK Version: "
<< m_ITKVersion << std::endl;
<< ITK_VERSION_STRING << "." << ITK_VERSION_PATCH << std::endl;
}


Expand Down Expand Up @@ -574,66 +578,52 @@ void
ResourceProbe< ValueType, MeanType >
::PrintJSONSystemInformation(std::ostream & os)
{
itksys::SystemInformation systeminfo;
systeminfo.RunCPUCheck();
systeminfo.RunMemoryCheck();
systeminfo.RunOSCheck();

os << "{\n";
PrintJSONvar(os, "System", m_SystemName);
PrintJSONvar(os, "System", systeminfo.GetHostname());

os << " \"Processor\" :{\n";
PrintJSONvar(os, "Name", m_ProcessorName, 6);
PrintJSONvar(os, "Cache", m_ProcessorCacheSize, 6);
PrintJSONvar(os, "Clock", m_ProcessorClockFrequency, 6);
PrintJSONvar(os, "Physical CPUs", m_NumberOfPhysicalCPU, 6);
PrintJSONvar(os, "Logical CPUs", m_NumberOfLogicalCPU, 6);
PrintJSONvar(os, "Virtual Memory Total", m_TotalVirtualMemory, 6);
PrintJSONvar(os, "Virtual Memory Available", m_AvailableVirtualMemory, 6);
PrintJSONvar(os, "Physical Memory Total", m_TotalPhysicalMemory, 6);
PrintJSONvar(os, "Physical Memory Available", m_AvailablePhysicalMemory, 6, false);
PrintJSONvar(os, "Name", systeminfo.GetExtendedProcessorName(), 6);
PrintJSONvar(os, "Cache", systeminfo.GetProcessorCacheSize(), 6);
PrintJSONvar(os, "Clock", systeminfo.GetProcessorClockFrequency(), 6);
PrintJSONvar(os, "Physical CPUs", systeminfo.GetNumberOfPhysicalCPU(), 6);
PrintJSONvar(os, "Logical CPUs", systeminfo.GetNumberOfLogicalCPU(), 6);
PrintJSONvar(os, "Virtual Memory Total", systeminfo.GetTotalVirtualMemory(), 6);
PrintJSONvar(os, "Virtual Memory Available", systeminfo.GetAvailableVirtualMemory(), 6);
PrintJSONvar(os, "Physical Memory Total", systeminfo.GetTotalPhysicalMemory(), 6);
PrintJSONvar(os, "Physical Memory Available", systeminfo.GetAvailablePhysicalMemory(), 6, false);
os << " },\n";

os << " \"OperatingSystem\" :{\n";
PrintJSONvar(os, "Name", m_OSName, 6);
PrintJSONvar(os, "Release", m_OSRelease, 6);
PrintJSONvar(os, "Version", m_OSVersion, 6);
PrintJSONvar(os, "Platform", m_OSPlatform, 6);
PrintJSONvar(os, "Bitness", (m_Is64Bits ? "64 bit" : "32 bit"), 6, false);
PrintJSONvar(os, "Name", systeminfo.GetOSName(), 6);
PrintJSONvar(os, "Release", systeminfo.GetOSRelease(), 6);
PrintJSONvar(os, "Version", systeminfo.GetOSVersion(), 6);
PrintJSONvar(os, "Platform", systeminfo.GetOSPlatform(), 6);
PrintJSONvar(os, "Bitness", (systeminfo.Is64Bits() ? "64 bit" : "32 bit"), 6, false);
os << " },\n";

PrintJSONvar(os, "ITKVersion", m_ITKVersion, 4, false);
std::ostringstream itkVersionStringStream;
itkVersionStringStream << ITK_VERSION_STRING << "." << ITK_VERSION_PATCH;

PrintJSONvar(os, "ITKVersion", itkVersionStringStream.str(), 4, false);
os << " }";
}


// This protected member function that was introduced with ITK 4.8 has been deprecated
// as of ITK 5.0. Please do not call or override this member function.
#if !defined(ITK_LEGACY_REMOVE)
template< typename ValueType, typename MeanType >
void
ResourceProbe< ValueType, MeanType >
::GetSystemInformation()
{
itksys::SystemInformation systeminfo;
systeminfo.RunCPUCheck();
systeminfo.RunMemoryCheck();
systeminfo.RunOSCheck();

m_SystemName = systeminfo.GetHostname();
m_ProcessorName = systeminfo.GetExtendedProcessorName();
m_ProcessorCacheSize = systeminfo.GetProcessorCacheSize();
m_ProcessorClockFrequency = systeminfo.GetProcessorClockFrequency();
m_NumberOfPhysicalCPU = systeminfo.GetNumberOfPhysicalCPU();
m_NumberOfLogicalCPU = systeminfo.GetNumberOfLogicalCPU();

m_OSName = systeminfo.GetOSName();
m_OSRelease = systeminfo.GetOSRelease();
m_OSVersion = systeminfo.GetOSVersion();
m_OSPlatform = systeminfo.GetOSPlatform();

m_Is64Bits = systeminfo.Is64Bits();
std::ostringstream itkversion;
itkversion << ITK_VERSION_MAJOR << "." << ITK_VERSION_MINOR << "." << ITK_VERSION_PATCH;
m_ITKVersion = itkversion.str();

// Retrieve memory information in megabyte.
m_TotalVirtualMemory = systeminfo.GetTotalVirtualMemory();
m_AvailableVirtualMemory = systeminfo.GetAvailableVirtualMemory();
m_TotalPhysicalMemory = systeminfo.GetTotalPhysicalMemory();
m_AvailablePhysicalMemory = systeminfo.GetAvailablePhysicalMemory();
}
#endif

} // end namespace itk

Expand Down

0 comments on commit b13f6a8

Please sign in to comment.