phoenix_hardware_characteristics.h File Reference

#include <iostream>
#include <string>

Include dependency graph for phoenix_hardware_characteristics.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	phoenix_hardware_hostNameIp (std::string &hostName, std::string &ipAddress)
	Get the host name and the IP address and the current host.
size_t	phoenix_hardware_nbCore ()
	Get the number of cores on the current host.
float	phoenix_hardware_totalRAM ()
	Get the total amount of RAM (in GB) of the current host.
float	phoenix_hardware_usedRAM ()
	Get the ratio of RAM used when this function is called.

Function Documentation

phoenix_hardware_hostNameIp()

void phoenix_hardware_hostNameIp	(	std::string &	hostName,
		std::string &	ipAddress )

Get the host name and the IP address and the current host.

Parameters

[out]	hostName	: name of the current host
[out]	ipAddress	: ip address of the current host

Definition at line 73 of file phoenix_hardware_characteristics.cpp.

                                                                             {
        hostName = "";
        ipAddress = "";
        char hostbuffer[256];
        struct hostent *host_entry;
        int hostNameId;
        
        // To retrieve hostname 
        hostNameId = gethostname(hostbuffer, sizeof(hostbuffer));
        if(hostNameId == -1){return;}
        
        // To retrieve host information 
        host_entry = gethostbyname(hostbuffer);
        if(host_entry == NULL){return;}
        //Set the host name
        hostName = hostbuffer;
        //Convert an Internet network address into ASCII string
        ipAddress = inet_ntoa(*((struct in_addr*) host_entry->h_addr_list[0]));
}

phoenix_hardware_nbCore()

size_t phoenix_hardware_nbCore

(

)

Get the number of cores on the current host.

Returns

number of cores on the current host

Definition at line 96 of file phoenix_hardware_characteristics.cpp.

                                {
        //may return 0 when not able to detect
        unsigned int processor_count = std::thread::hardware_concurrency();
        if(processor_count == 0u){
                //Check an other solution
                int numCPU = sysconf(_SC_NPROCESSORS_ONLN);
                if(numCPU == -1){return 0lu;}   //if there is a failure, return 0 (undefined)
                return numCPU;
        }
        return processor_count;
}

phoenix_hardware_totalRAM()

float phoenix_hardware_totalRAM

(

)

Get the total amount of RAM (in GB) of the current host.

Returns

total amount of RAM (in GB) of the current host

Definition at line 58 of file phoenix_hardware_characteristics.cpp.

                                 {
        struct sysinfo memInfo;
        sysinfo(&memInfo);
        //Get the total RAM amount
        size_t totalPhysMemRAM = memInfo.totalram;
        //Multiply in next statement to avoid int overflow on right hand side...
        totalPhysMemRAM *= memInfo.mem_unit;
        float totalRamGB(totalPhysMemRAM/1e9);
        return totalRamGB;
}

phoenix_hardware_usedRAM()

float phoenix_hardware_usedRAM

(

)

Get the ratio of RAM used when this function is called.

Returns

ratio of the used RAM at this time, between 0 and 1

Definition at line 29 of file phoenix_hardware_characteristics.cpp.

                                {
        struct sysinfo memInfo;
        sysinfo(&memInfo);
//      long long totalVirtualMem = memInfo.totalram;
//      //Add other values in next statement to avoid int overflow on right hand side...
//      totalVirtualMem += memInfo.totalswap;
//      totalVirtualMem *= memInfo.mem_unit;
//      
//      long long virtualMemUsed = memInfo.totalram - memInfo.freeram;
//      //Add other values in next statement to avoid int overflow on right hand side...
//      virtualMemUsed += memInfo.totalswap - memInfo.freeswap;
//      virtualMemUsed *= memInfo.mem_unit;
        
        //Get the total RAM amount
        size_t totalPhysMemRAM = memInfo.totalram;
        //Multiply in next statement to avoid int overflow on right hand side...
        totalPhysMemRAM *= memInfo.mem_unit;
        
        //Physical memory currently used
        size_t physMemUsed = memInfo.totalram - memInfo.freeram;
        //Multiply in next statement to avoid int overflow on right hand side...
        physMemUsed *= memInfo.mem_unit;
        
        return (float)(((double)physMemUsed)/((double)totalPhysMemRAM));
}