System.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#pragma once
 
#include <GaudiKernel/Kernel.h>
#include <GaudiKernel/ModuleInfo.h>
#include <GaudiKernel/Timing.h>
#include <string>
#include <typeinfo>
#include <vector>
 
#ifdef __linux
#  include <pthread.h>
#  ifndef __APPLE__
#    include <execinfo.h>
#  endif
#endif

namespace System {
  typedef void* ImageHandle;
  typedef void* ProcessHandle;
  typedef unsigned long ( *EntryPoint )( const unsigned long iid, void** ppvObject );
  typedef void* ( *Creator )();
  GAUDI_API unsigned long loadDynamicLib( const std::string& name, ImageHandle* handle );
  GAUDI_API unsigned long unloadDynamicLib( ImageHandle handle );
  GAUDI_API unsigned long getProcedureByName( ImageHandle handle, const std::string& name, EntryPoint* pFunction );
  GAUDI_API unsigned long getProcedureByName( ImageHandle handle, const std::string& name, Creator* pFunction );
  GAUDI_API unsigned long getLastError();
  GAUDI_API const std::string getLastErrorString();
  GAUDI_API const std::string getErrorString( unsigned long error );
  GAUDI_API const std::string typeinfoName( const std::type_info& );
  GAUDI_API const std::string typeinfoName( const char* );
  GAUDI_API const std::string& hostName();
  GAUDI_API const std::string& osName();
  GAUDI_API const std::string& osVersion();
  GAUDI_API const std::string& machineType();
  //    0           = 80386 instruction set
  //    1  or above = SSE (XMM) supported by CPU (not testing for O.S. support)
  //    2  or above = SSE2
  //    3  or above = SSE3
  //    4  or above = Supplementary SSE3 (SSSE3)
  //    5  or above = SSE4.1
  //    6  or above = SSE4.2
  //    7  or above = AVX supported by CPU and operating system
  //    8  or above = AVX2
  //    9  or above = AVX512F
  [[deprecated]] GAUDI_API int instructionsetLevel();
  GAUDI_API const std::string& accountName();
  GAUDI_API long numCmdLineArgs();
  GAUDI_API long argc();
  GAUDI_API const std::vector<std::string> cmdLineArgs();
  GAUDI_API char** argv();
  GAUDI_API std::string getEnv( const char* var );
  GAUDI_API bool getEnv( const char* var, std::string& value );
  inline bool    getEnv( const std::string& var, std::string& value ) { return getEnv( var.c_str(), value ); }
  GAUDI_API std::vector<std::string> getEnv();
  GAUDI_API int setEnv( const std::string& name, const std::string& value, int overwrite = 1 );
  GAUDI_API bool isEnvSet( const char* var );
#ifdef __linux
  typedef pthread_t ThreadHandle;
  inline ThreadHandle threadSelf() { return pthread_self(); }
#else
  typedef void* ThreadHandle;
  inline ThreadHandle threadSelf() { return (void*)0; }
#endif
  GAUDI_API int  backTrace( void** addresses, const int depth );
  GAUDI_API bool backTrace( std::string& btrace, const int depth, const int offset = 0 );
  GAUDI_API bool getStackLevel( void* addresses, void*& addr, std::string& fnc, std::string& lib );
} // namespace System