cpu.h

Go to the documentation of this file.

/* This file is part of Cloudy and is copyright (C)1978-2023 by Gary J. Ferland and
 * others.  For conditions of distribution and use see copyright notice in license.txt */

#ifndef CPU_H_
#define CPU_H_

#define UNUSED /*@unused@*/
#ifdef __GNUC__
#undef UNUSED
#define UNUSED __attribute__ ((unused)) /*@unused@*/
#endif

#ifndef INT8_MAX
#  define INT8_MAX 127
#endif
#ifndef INT8_MIN
#  define INT8_MIN (-INT8_MAX - 1)
#endif

#if SCHAR_MAX == INT8_MAX
   typedef signed char int8;
#else
#  error "failed to define int8, please report this to gary@uky.edu"
#endif

#ifndef UINT8_MAX
#  define UINT8_MAX 255
#endif

#if UCHAR_MAX == UINT8_MAX
   typedef unsigned char uint8;
#else
#  error "failed to define uint8, please report this to gary@uky.edu"
#endif

#ifndef INT16_MAX
#  define INT16_MAX 32767
#endif
#ifndef INT16_MIN
#  define INT16_MIN (-INT16_MAX - 1)
#endif

#if SHRT_MAX == INT16_MAX
   typedef short int int16;
#elif INT_MAX == INT16_MAX
   typedef int int16;
#else
#  error "failed to define int16, please report this to gary@uky.edu"
#endif

#ifndef UINT16_MAX
#  define UINT16_MAX 65535
#endif

#if USHRT_MAX == UINT16_MAX
   typedef unsigned short int uint16;
#elif UINT_MAX == UINT16_MAX
   typedef unsigned int uint16;
#else
#  error "failed to define uint16, please report this to gary@uky.edu"
#endif

#ifndef INT32_MAX
#  define INT32_MAX 2147483647L
#endif
#ifndef INT32_MIN
#  define INT32_MIN (-INT32_MAX - 1)
#endif

#if INT_MAX == INT32_MAX
   typedef int int32;
#elif LONG_MAX == INT32_MAX
   typedef long int int32;
#else
#  error "failed to define int32, please report this to gary@uky.edu"
#endif

#ifndef UINT32_MAX
#  define UINT32_MAX 4294967295UL
#endif

#if UINT_MAX == UINT32_MAX
   typedef unsigned int uint32;
#elif ULONG_MAX == UINT32_MAX
   typedef unsigned long int uint32;
#else
#  error "failed to define uint32, please report this to gary@uky.edu"
#endif

#ifndef INT64_MAX
#  define INT64_MAX 9223372036854775807LL
#endif
#ifndef INT64_MIN
#  define INT64_MIN (-INT64_MAX - 1)
#endif

#if LONG_MAX == INT64_MAX
   typedef long int int64;
#elif LLONG_MAX == INT64_MAX
   typedef long long int int64;
#else
#  error "failed to define int64, please report this to gary@uky.edu"
#endif

#ifndef UINT64_MAX
#  define UINT64_MAX 18446744073709551615ULL
#endif

#if ULONG_MAX == UINT64_MAX
   typedef unsigned long int uint64;
#elif ULLONG_MAX == UINT64_MAX
   typedef unsigned long long int uint64;
#else
#  error "failed to define uint64, please report this to gary@uky.edu"
#endif

#ifdef __AVX__
#  ifdef __AVX512F__
#    define CD_ALIGN 64
#  else
#    define CD_ALIGN 32
#  endif
#else
#  define CD_ALIGN 16
#endif

#ifdef _MSC_VER
// posix_memalign not defined on windows
inline int posix_memalign(void **p, size_t a, size_t s)
{
        *p = _aligned_malloc(s, a);
        return ( *p == NULL ) ? errno : 0;
}

inline void posix_memalign_free(void *p)
{
        _aligned_free(p);
}
#else
inline void posix_memalign_free(void *p)
{
        free(p);
}
#endif

#ifdef cray
#ifndef __cray
#define __cray 1
#endif
#endif

#ifdef __x86_64
#ifndef __amd64
#define __amd64 1
#endif
#endif

#if defined(_ARCH_PPC) || defined(__POWERPC__) || defined(__powerpc__) || defined(PPC)
#ifndef __ppc__
#define __ppc__ 1
#endif
#endif

#if defined(unix) || defined(__unix__)
#ifndef __unix
#define __unix 1
#endif
#endif

#if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__)
#define __AnyBSD__ 1
#endif

#if defined(linux) || defined(__linux)
#ifndef __linux__
#define __linux__ 1
#endif
#endif

#ifdef __ECC
#ifndef __ICC
#define __ICC __ECC
#endif
#endif

#undef __GNUC_EXCL__
#if defined(__GNUC__) && ! ( defined(__ICC) || defined(__PATHSCALE__) || defined(__OPENCC__) || defined(__clang__) )
#define __GNUC_EXCL__ 1
#endif

#undef SIGNAL_HANDLER
#if defined(__linux) || defined(__APPLE__) || (defined(__CYGWIN__) && !defined(__CYGWIN32__))
#define SIGNAL_HANDLER 1
#endif

/* safe, small, numbers for the float and double */
/*FLT_MAX is 3.40e38 on wintel, so BIGFLOAT is 3.40e36 */
const realnum BIGFLOAT = numeric_limits<realnum>::max()/realnum(100.f);
const realnum SMALLFLOAT = numeric_limits<realnum>::min()*realnum(100.f);

const double BIGDOUBLE = DBL_MAX/100.;
const double SMALLDOUBLE = DBL_MIN*100.;

const int STDLEN = 32;

typedef enum { AS_DEFAULT, AS_OPTIONAL, AS_TRY, AS_SILENT_TRY,
               AS_LOCAL_ONLY, AS_LOCAL_ONLY_TRY } access_scheme;

// the C++ openmodes below give the exact equivalent of the C modes "r", "w", "a", etc.
// the "+" sign in the C mode has been replaced by "p", so, e.g., mode_rpb is equivalent to "r+b"
const ios_base::openmode mode_r = ios_base::in;
const ios_base::openmode mode_w = ios_base::out | ios_base::trunc;
const ios_base::openmode mode_a = ios_base::out | ios_base::app;
const ios_base::openmode mode_rp = ios_base::in | ios_base::out;
const ios_base::openmode mode_wp = ios_base::in | ios_base::out | ios_base::trunc;
const ios_base::openmode mode_ap = ios_base::in | ios_base::out | ios_base::app;

const ios_base::openmode UNUSED mode_rb = mode_r | ios_base::binary;
const ios_base::openmode UNUSED mode_wb = mode_w | ios_base::binary;
const ios_base::openmode UNUSED mode_ab = mode_a | ios_base::binary;
const ios_base::openmode UNUSED mode_rpb = mode_rp | ios_base::binary;
const ios_base::openmode UNUSED mode_wpb = mode_wp | ios_base::binary;
const ios_base::openmode UNUSED mode_apb = mode_ap | ios_base::binary;

#include "mpi_utilities.h"

FILE* open_data( const string& fname, const string& mode, access_scheme scheme=AS_DEFAULT, string* rpath=nullptr );
void open_data( fstream& stream, const string& fname, ios_base::openmode mode, access_scheme scheme=AS_DEFAULT,
                                string* rpath=nullptr );
MPI_File open_data( const string& fname, int mode, access_scheme scheme=AS_DEFAULT, string* rpath=nullptr );
void check_data( const string& fpath, const string& fname );

/* this class is deliberately kept global so that the constructor is executed before
 * any of the user code; this assures a correct FP environment right from the start */
class t_cpu_i
{
        union
        {
                char c[4];
                int32 i;
        } endian;

        sys_float test_float;
        double test_double;

        int32 Float_SNaN_Value;
        int64 Double_SNaN_Value;

#       ifdef SIGNAL_HANDLER
        struct sigaction p_action;
        struct sigaction p_default;
#       endif

        long n_avail_CPU;
        long n_use_CPU;
        bool p_lgMPI;
        MPI_state p_MPIMode;
        long n_rank;
        string p_ExecName;
        vector<string> chTraceback;
        char HostName[STDLEN];
        vector<string> chSearchPath;
        string p_chCloudyRoot;
        char p_chDirSeparator;
        int nFileDone;
        int nCSMismatch;
        map<string,string> checksum_expct;
        bool lgPathInitialized;
        void p_assertValidPath();
        bool p_suppressBacktrace;

        void enable_traps() const;
        static void signal_handler(int sig, siginfo_t*, void* ptr);

        vector<string> p_exit_status;

        void getPathList( const string& fname, vector<string>& PathList, access_scheme scheme, bool lgRead ) const;
        void getchecksums( const string& fname );
public:
        t_cpu_i();

        bool big_endian() const { return ( endian.i == 0x12345678 ); }
        bool little_endian() const { return ( endian.i == 0x78563412 ); }

        sys_float min_float() const { return test_float; }
        double min_double() const { return test_double; }

#       ifdef SIGNAL_HANDLER
        const struct sigaction* action() const { return &p_action; }
        const struct sigaction* deflt() const { return &p_default; }
#       endif

        void set_signal_handlers();

        void set_nCPU(long n) { n_avail_CPU = n; }
        long nCPU() const { return n_avail_CPU; }
        void set_used_nCPU(long n) { n_use_CPU = n; }
        long used_nCPU() const { return n_use_CPU; }
        bool lgMPI() const { return p_lgMPI; }
        void set_MPIMode( MPI_state mode ) { p_MPIMode = mode; }
        MPI_state MPIMode() const { return p_MPIMode; }
        void set_nRANK(long n) { n_rank = n; }
        long nRANK() const { return n_rank; }
        bool lgMaster() const { return ( n_rank == 0 ); }
        bool lgMPI_talk() const { return lgMaster() || p_MPIMode == MS_GRID; }
        void set_ExecName(const string& name) { p_ExecName = name; }
        void disableBacktrace() { p_suppressBacktrace = true; }
        void enableBacktrace() { p_suppressBacktrace = false; }
        void GenerateBacktrace(void* ptr);
        void PrintBacktrace(const string& s, bool lgPrintSeed = true);
        const string& ExecName() const { return p_ExecName; }
        const char *host_name() const { return HostName; }
        void printDataPath() const;
        string chDirSeparator() const { return string(1,p_chDirSeparator); }
        void appendDirSeparator(char *path) const
        {
                size_t i = strlen(path);
                path[i++] = p_chDirSeparator;
                path[i] = '\0';
        }
        bool firstOpen() const { return ( nFileDone == 0 ); }
        bool foundCSMismatch() const { return ( nCSMismatch > 0 ); }
        const string& chExitStatus(exit_type s) const { return p_exit_status[s]; }

        void initPath();
        friend FILE* open_data( const string& fname, const string& mode, access_scheme scheme, string* rpath );
        friend void open_data( fstream& stream, const string& fname, ios_base::openmode mode, access_scheme scheme,
                                                   string* rpath );
        friend MPI_File open_data( const string& fname, int mode, access_scheme scheme, string* rpath );
        friend void check_data( const string& fpath, const string& fname );

        friend void set_NaN(sys_float &x);
        friend void set_NaN(sys_float x[], long n);
        friend void set_NaN(double &x);
        friend void set_NaN(double x[], long n);
};
class t_cpu
{
        static t_cpu_i *m_i;
public:
        t_cpu_i &i()
        {
                return *m_i;
        }
        t_cpu();
        ~t_cpu();
};
// Generate a (static) instance of this variable in *every* file.
static t_cpu cpu;

// The static (class) pointer is set in the first of these.  Obviously 
// this is not thread safe...

// Better engineered variants are available in Alexandrescu's book; 
// better yet to reduce the number of globals and file-statics so 
// this can just be initialized at the start of main().

void set_NaN(sys_float &x);
void set_NaN(sys_float x[], /* x[n] */
             long n);
void set_NaN(double &x);
void set_NaN(double x[], /* x[n] */
             long n);

bool MyIsnan(const sys_float &x);
bool MyIsnan(const double &x);

// class for detecting if two types are the same, can also be used in static_assert():
// static_assert( SameType<decltype(var), bool>::value, "type of var must be bool" );
template<class T1, class T2> struct SameType
{
        static const bool value = false;
};
template<class T> struct SameType<T,T>
{
        static const bool value = true;
};

/* Apply compiler directive saying that current routine does not
         return as modifier, as in "NORETURN void MyExit() { ... }"  */
#ifdef _MSC_VER
#define NORETURN __declspec(noreturn) /*@noreturn@*/
#elif defined(__GNUC__) || ( defined(__INTEL_COMPILER) && defined(__linux__) || defined(__SUNPRO_CC) )
#define NORETURN __attribute__ ((noreturn)) /*@noreturn@*/
#else
#define NORETURN /*@noreturn@*/
#endif

#define FALLTHROUGH (void)0
#ifdef __GNUC_EXCL__
#if (__GNUC__ >= 7)
#undef  FALLTHROUGH
#define FALLTHROUGH __attribute__ ((fallthrough))
#endif
#endif

#ifdef _MSC_VER
#define ALIGNED(X) __declspec(align(X))
#else
#define ALIGNED(X) __attribute__ ((aligned(X)))
#endif

#define RESTRICT
#define LIKELY(x) (x)
#ifdef __GNUC__
#if (__GNUC__ >= 3)
#undef LIKELY
#define LIKELY(x) __builtin_expect((x),1)
#endif
#undef RESTRICT
#define RESTRICT __restrict
#else
#endif

#define UNLIKELY(x) (x)
#ifdef __GNUC__
#if (__GNUC__ >= 3)
#undef UNLIKELY
#define UNLIKELY(x) __builtin_expect((x),0)
#endif
#endif

/* Some hackery needed to test if a preprocessor macro is empty. Use as follows:
 *  #if EXPAND(SOME_DODGY_MACRO) == 1
 *      get here if SOME_DODGY_MACRO expands to empty string
 *  #endif */
#define DO_EXPAND(VAL)  VAL ## 1
#define EXPAND(VAL)     DO_EXPAND(VAL)

/* Define __COMP and __COMP_VER macros for all systems */
/* the Intel compiler */
/* this needs to be before g++ since icc also sets __GNUC__ */
#if defined __INTEL_COMPILER
#       define  __COMP  "icc"
#       define  __COMP_VER      __INTEL_COMPILER 

/* PathScale EKOPath compiler */
/* this needs to be before g++ since pathCC also sets __GNUC__ */
#elif defined __PATHSCALE__
#       define  __COMP  "pathCC"
#       define  __COMP_VER      __PATHCC__ * 100 + __PATHCC_MINOR__ * 10 + __PATHCC_PATCHLEVEL__

/* Open64 compiler */
/* this needs to be before g++ since openCC also sets __GNUC__ */
#elif defined __OPENCC__
#       define  __COMP  "Open64"
#       if EXPAND(__OPENCC_PATCHLEVEL__) == 1
#               define  __COMP_VER      __OPENCC__ * 100 + __OPENCC_MINOR__ * 10
#       else
#               define  __COMP_VER      __OPENCC__ * 100 + __OPENCC_MINOR__ * 10 + __OPENCC_PATCHLEVEL__
#       endif

/* LLVM clang++ */
/* this needs to be before g++ since clang++ also sets __GNUC__ */
#elif defined __clang__
#       define  __COMP  "clang++"
#       define  __COMP_VER      __clang_major__ * 100 + __clang_minor__ * 10 + __clang_patchlevel__

/* g++ */
#elif defined __GNUC__
#       define  __COMP  "g++"
#       if defined(__GNUC_PATCHLEVEL__)
#               define __COMP_VER (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
#       else
#               define __COMP_VER (__GNUC__ * 10000 + __GNUC_MINOR__ * 100)
#       endif

#elif defined __PGI
#       define  __COMP  "Portland Group"
#       if defined(__PGIC__)
#               define __COMP_VER (__PGIC__ * 100 + __PGIC_MINOR__ * 10 + __PGIC_PATCHLEVEL__)
#       else
#               define __COMP_VER 0
#       endif

/* SGI MIPSpro */
/* this needs to be after g++, since g++ under IRIX also sets _COMPILER_VERSION */
#elif defined(__sgi) && defined(_COMPILER_VERSION)
#       define  __COMP  "MIPSpro"
#       define  __COMP_VER      _COMPILER_VERSION

/* HP */
#elif defined __HP_aCC 
#       define  __COMP  "HP aCC"
#       define  __COMP_VER      __HP_aCC  

/* DEC - this one may be broken for C++, no way to test it... */
#elif defined __DECC 
#       define  __COMP  "DEC CC"
#       define  __COMP_VER      __DECC_VER   

/* MS VS */
#elif defined   _MSC_VER
#       define  __COMP  "vs"
#       define  __COMP_VER      _MSC_VER  

/* Oracle Solaris Studio */
#elif defined   __SUNPRO_CC
#       define  __COMP  "Solaris Studio"
#       define  __COMP_VER      __SUNPRO_CC

/* unknown */
#else
#       define  __COMP  "unknown"
#       define  __COMP_VER      0 
#endif

/* ----------------------------  OS ---------------------------- */
/* linux */
#if defined     __linux__
#       if defined __i386
#               define  __OS    "Linux (IA32)"
#       elif defined __amd64
#               define  __OS    "Linux (AMD64)"
#       elif defined __ia64
#               define  __OS    "Linux (IA64)"
#       elif defined __ppc__
#               define  __OS    "Linux (PowerPC)"
#       else
#               define  __OS    "Linux (other)"
#       endif

/* macintosh */
#elif defined   macintosh
#       define  __OS    "Mac OS 9"

/* macintosh */
#elif defined   __MACOSX__
#       define  __OS    "Mac OS X"

/* apple mac, ... */
#elif defined   __APPLE__
#       define  __OS    "Apple MacOS"

/* HP */
#elif defined   hpux
#       define  __OS    "HP-UX"

/* Oracle Solaris */
#elif defined   __sun
#       define  __OS    "Solaris"

/* IBM AIX */
#elif defined   _AIX
#       define  __OS    "AIX"

/* Compaq alpha */
#elif defined   ultrix
#       define  __OS    "Ultrix"

/* the BSD variants */
#elif defined   __FreeBSD__
#       define  __OS    "FreeBSD"

#elif defined   __NetBSD__
#       define  __OS    "NetBSD"

#elif defined   __OpenBSD__
#       define  __OS    "OpenBSD"

/* Windows64 */
/* this needs to be before _WIN32 since Windows64 also sets _WIN32 */
#elif defined   _WIN64
#       define  __OS    "Win64"

/* Windows */
#elif defined   _WIN32
#       define  __OS    "Win32"

/* Cygwin */
#elif defined   __CYGWIN__
#       define  __OS    "Cygwin"

/* SGI */
#elif defined   __sgi
#       define  __OS    "IRIX"

/* unknown */
#else
#       define  __OS    "unknown"
#endif

/* don't perform this check when we are generating dependencies */
#ifndef MM
/* bomb out if the compiler does not support C++11.... */
#  if defined(__GNUC_EXCL__) && ((__GNUC__ < 4 ) || \
                                 (__GNUC__ == 4 && __GNUC_MINOR__ < 8) || \
                                 (__GNUC__ == 4 && __GNUC_MINOR__ == 8 && __GNUC_PATCHLEVEL__ == 0))
#  error "This version of g++ cannot compile Cloudy! Version 4.8.1 or later is required. See http://wiki.nublado.org/wiki/CompileCode for more details."
#  endif

#  if defined(__clang_major__) && ((__clang_major__ < 3 ) || \
                                   (__clang_major__ == 3 && __clang_minor__ < 3))
#  error "This version of clang++ cannot compile Cloudy! Version 3.3 or later is required. See http://wiki.nublado.org/wiki/CompileCode for more details."
#  endif

#  if defined(__INTEL_COMPILER) && __INTEL_COMPILER < 1500
#  error "This version of icc cannot compile Cloudy! Version 15.0 or later is required. See http://wiki.nublado.org/wiki/CompileCode for more details."
#  endif

#  if defined(__SUNPRO_CC) && __SUNPRO_CC < 0x5140
#  error "This version of CC cannot compile Cloudy! Version 12.5 or later is required. See http://wiki.nublado.org/wiki/CompileCode for more details."
#  endif
#endif

#endif /* CPU_H_ */