SoCpuDevice.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2017 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
 
#if !defined SOCPUDEVICE_H
#define SOCPUDEVICE_H
 
#include <Inventor/devices/SoDevice.h>
 
#include <Inventor/STL/vector>
#include <Inventor/STL/string>
#include <Inventor/STL/map>
 
#include <Inventor/threads/SbThreadMutex.h>
 
#include <Inventor/SbString.h>
#include <Inventor/errors/SoDebugError.h>
 
class  SoCpuDevice : public SoDevice
{
  friend class SoDevice;
 
  // ----------------------- Public usage --------------------------------------
 
public:
 
  virtual SbString getDeviceName() const;
 
  enum ProcessorArchitecture
  {
    X86_64,
    X86_32,
    IA64,
    PPC_32,
    PPC_64,
    UNKNOWN
  };
 
  virtual unsigned long long getTotalMemory() const;
 
  virtual unsigned long long getAvailableMemory() const;
 
  virtual SbString getDriverVersion() const { return SbString("0.0"); };
 
  ProcessorArchitecture getArchitecture() const;
 
  bool isActive() const;
 
  bool hasMMX() const;
 
  bool hasSSE() const;
 
  int getSSELevel() const;
 
  virtual unsigned int getLogicalUnits() const;
 
  unsigned int getCacheSize( int cacheLevel ) const;
 
  static SoCpuDevice* getDevice( int index = 0 );
 
  static unsigned int getDevicesCount();
 
  static SoCpuDevice* findFirstAvailableDevice();
 
  static void initClass();
 
  static void exitClass();
 
  friend std::ostream& operator << ( std::ostream& os, const SoCpuDevice& dev )
  {
    unsigned long long allocatedMem,  freeMem;
    dev.getMemoryInfo( allocatedMem, freeMem );
 
    return os << "[CPU name]: " << dev.m_name.toLatin1() << "\n" << \
                 "[RAM Size]: " << (dev.m_totalMemory)/(1024*1024) << "MB" << "\n" << // memory size returned in Mbytes.
                 "[Available RAM size]: " << freeMem /(1024*1024) << "MB" << "\n" << // memory size returned in Mbytes.
                 "[Cores number]: " << dev.m_coresCount << "\n" << \
                 "[L1 cache size]: " << dev.m_cacheSize[0]/1024 << "KB\n" << \
                 "[L2 cache size]: " << dev.m_cacheSize[1]/1024 << "KB\n" << \
                 "[L3 cache size]: " << dev.m_cacheSize[2]/1024 << "KB\n" << \
                 "[MMX]: " << (dev.m_hasMMX?"available":"not available") << "\n" << \
                 "[SSE level]: " << dev.m_sseLevel;
  }
 
  // ----------------------- Protected usage --------------------------------------
 
  private:
  static unsigned int s_sse_alignement;
 
  // return the total memory used by the caller process
  virtual unsigned long long getProcessMemory() const;
 
  // return the peak memory used by the caller process
  virtual unsigned long long getPeakProcessMemory() const;
 
private:
 
  SoCpuDevice();
 
  virtual ~SoCpuDevice();
 
  static bool findFirstDeviceFunc( SoDevice* device );
 
  static bool findDevicesCount( SoDevice* device );
 
  // ----------------------- Private usage --------------------------------------
 
private:
  void getMemoryInfo( unsigned long long& allocatedMem, unsigned long long& freeMem ) const;
 
  typedef std::map<std::string, unsigned long long> MemInfoMap;
 
  static void fetchMemInfos( MemInfoMap& memInfo );
 
  static bool getTotalAndFreeMem( unsigned long long& totalMem, unsigned long long& freeMem );
 
  unsigned long long m_totalMemory;
 
  // CPU name
  SbString m_name;
 
  ProcessorArchitecture m_architecture;
 
  bool m_isActive;
 
  bool m_hasMMX;
 
  bool m_hasSSE;
 
  int m_sseLevel;
 
  unsigned int m_coresCount;
 
  unsigned int m_cacheSize[3];
 
  static SbThreadMutex s_initThreadMutex;
 
  static unsigned int s_processorsCount;
 
  static int s_initRefCount;
};
 
// ----------------------- Inline functions --------------------------------------
 
inline unsigned long long
SoCpuDevice::getTotalMemory() const
{
  return m_totalMemory;
}
 
//------------------------------------------------------------------------------
inline SoCpuDevice::ProcessorArchitecture
SoCpuDevice::getArchitecture() const
{
  return m_architecture;
}
 
 
//------------------------------------------------------------------------------
inline bool
SoCpuDevice::isActive() const
{
  return m_isActive;
}
 
 
//------------------------------------------------------------------------------
inline bool
SoCpuDevice::hasSSE() const
{
  return m_hasSSE;
}
 
 
//------------------------------------------------------------------------------
inline int
SoCpuDevice::getSSELevel() const
{
  return m_sseLevel;
}
 
//------------------------------------------------------------------------------
inline bool
SoCpuDevice::hasMMX() const
{
  return m_hasMMX;
}
 
 
//------------------------------------------------------------------------------
 
#endif // SOCPUDEVICE_H