You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
140 lines
4.6 KiB
140 lines
4.6 KiB
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing#kwsys for details. */
|
|
#ifndef @KWSYS_NAMESPACE@_SystemInformation_h
|
|
#define @KWSYS_NAMESPACE@_SystemInformation_h
|
|
|
|
#include <@KWSYS_NAMESPACE@/Configure.hxx>
|
|
|
|
#include <stddef.h> /* size_t */
|
|
#include <string>
|
|
|
|
namespace @KWSYS_NAMESPACE@ {
|
|
|
|
// forward declare the implementation class
|
|
class SystemInformationImplementation;
|
|
|
|
class @KWSYS_NAMESPACE@_EXPORT SystemInformation
|
|
{
|
|
#if @KWSYS_USE_LONG_LONG@
|
|
typedef long long LongLong;
|
|
#elif @KWSYS_USE___INT64@
|
|
typedef __int64 LongLong;
|
|
#else
|
|
#error "No Long Long"
|
|
#endif
|
|
friend class SystemInformationImplementation;
|
|
SystemInformationImplementation* Implementation;
|
|
|
|
public:
|
|
SystemInformation();
|
|
~SystemInformation();
|
|
|
|
const char* GetVendorString();
|
|
const char* GetVendorID();
|
|
std::string GetTypeID();
|
|
std::string GetFamilyID();
|
|
std::string GetModelID();
|
|
std::string GetModelName();
|
|
std::string GetSteppingCode();
|
|
const char* GetExtendedProcessorName();
|
|
const char* GetProcessorSerialNumber();
|
|
int GetProcessorCacheSize();
|
|
unsigned int GetLogicalProcessorsPerPhysical();
|
|
float GetProcessorClockFrequency();
|
|
int GetProcessorAPICID();
|
|
int GetProcessorCacheXSize(long int);
|
|
bool DoesCPUSupportFeature(long int);
|
|
|
|
// returns an informative general description of the cpu
|
|
// on this system.
|
|
std::string GetCPUDescription();
|
|
|
|
const char* GetHostname();
|
|
std::string GetFullyQualifiedDomainName();
|
|
|
|
const char* GetOSName();
|
|
const char* GetOSRelease();
|
|
const char* GetOSVersion();
|
|
const char* GetOSPlatform();
|
|
|
|
int GetOSIsWindows();
|
|
int GetOSIsLinux();
|
|
int GetOSIsApple();
|
|
|
|
// returns an informative general description of the os
|
|
// on this system.
|
|
std::string GetOSDescription();
|
|
|
|
bool Is64Bits();
|
|
|
|
unsigned int GetNumberOfLogicalCPU(); // per physical cpu
|
|
unsigned int GetNumberOfPhysicalCPU();
|
|
|
|
bool DoesCPUSupportCPUID();
|
|
|
|
// Retrieve id of the current running process
|
|
LongLong GetProcessId();
|
|
|
|
// Retrieve memory information in megabyte.
|
|
size_t GetTotalVirtualMemory();
|
|
size_t GetAvailableVirtualMemory();
|
|
size_t GetTotalPhysicalMemory();
|
|
size_t GetAvailablePhysicalMemory();
|
|
|
|
// returns an informative general description if the installed and
|
|
// available ram on this system. See the GetHostMmeoryTotal, and
|
|
// Get{Host,Proc}MemoryAvailable methods for more information.
|
|
std::string GetMemoryDescription(const char* hostLimitEnvVarName = NULL,
|
|
const char* procLimitEnvVarName = NULL);
|
|
|
|
// Retrieve amount of physical memory installed on the system in KiB
|
|
// units.
|
|
LongLong GetHostMemoryTotal();
|
|
|
|
// Get total system RAM in units of KiB available colectivley to all
|
|
// processes in a process group. An example of a process group
|
|
// are the processes comprising an mpi program which is running in
|
|
// parallel. The amount of memory reported may differ from the host
|
|
// total if a host wide resource limit is applied. Such reource limits
|
|
// are reported to us via an applicaiton specified environment variable.
|
|
LongLong GetHostMemoryAvailable(const char* hostLimitEnvVarName = NULL);
|
|
|
|
// Get total system RAM in units of KiB available to this process.
|
|
// This may differ from the host available if a per-process resource
|
|
// limit is applied. per-process memory limits are applied on unix
|
|
// system via rlimit API. Resource limits that are not imposed via
|
|
// rlimit API may be reported to us via an application specified
|
|
// environment variable.
|
|
LongLong GetProcMemoryAvailable(const char* hostLimitEnvVarName = NULL,
|
|
const char* procLimitEnvVarName = NULL);
|
|
|
|
// Get the system RAM used by all processes on the host, in units of KiB.
|
|
LongLong GetHostMemoryUsed();
|
|
|
|
// Get system RAM used by this process id in units of KiB.
|
|
LongLong GetProcMemoryUsed();
|
|
|
|
// Return the load average of the machine or -0.0 if it cannot
|
|
// be determined.
|
|
double GetLoadAverage();
|
|
|
|
// enable/disable stack trace signal handler. In order to
|
|
// produce an informative stack trace the application should
|
|
// be dynamically linked and compiled with debug symbols.
|
|
static void SetStackTraceOnError(int enable);
|
|
|
|
// format and return the current program stack in a string. In
|
|
// order to produce an informative stack trace the application
|
|
// should be dynamically linked and compiled with debug symbols.
|
|
static std::string GetProgramStack(int firstFrame, int wholePath);
|
|
|
|
/** Run the different checks */
|
|
void RunCPUCheck();
|
|
void RunOSCheck();
|
|
void RunMemoryCheck();
|
|
};
|
|
|
|
} // namespace @KWSYS_NAMESPACE@
|
|
|
|
#endif
|