OpenSTA/util/Machine.hh

// OpenSTA, Static Timing Analyzer
// Copyright (c) 2019, Parallax Software, Inc.
// 
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

#ifndef STA_MACHINE_H
#define STA_MACHINE_H

// This header contains global os/port specific definitions.
// It should be included in every source file after any system include
// files and before any STA include files.

// Pragma placeholder for non-gcc compilers.
#ifndef __GNUC__
  #define __attribute__(x)
#endif // __GNUC__

#ifdef __SUNPRO_CC
  // SunCC will not allow numeric limits in array subscript
  // declarations so use define instead.
  #define INT_DIGITS 10
  // Prevent SunCC/Rogue Wave's brain dead STL allocator from
  // pre-allocating excessive memory.
  // Note well:
  //   For this to work it MUST be included before any STL libraries
  //   that may include <memory>.
  //   This def is intentionally NOT guarded by #ifndef's so that compiler
  //   warnings are emitted if this file is included after <memory> is included.
  #undef _RWSTD_CONTAINER_BUFFER_SIZE
  #define _RWSTD_CONTAINER_BUFFER_SIZE 16
#else
  // Requires #include <limits> if referenced.
  #define INT_DIGITS std::numeric_limits<int>::digits10
#endif // __SUNPRO_CC

#ifdef _MSC_VER
  // Microcruft Visual C++
  // Obtuse warning codes enabled by pragma.
  //   4018 = signed, unsigned mismatch
  //   4032 = unexpected type promotions
  //   4100 = unused argument
  //   4132 = uninitialized const
  //   4189 = unused local variable
  //   4201 = unnamed struct
  //   4222 = static class member declared static at file scope
  //   4234 = use of keyword reserved for future use
  //   4245 = negative const converted to unsigned
  //   4355 = use of 'this' in invalid context
  //   4505 = function not used
  //   4611 = setjmp used in C++ function
  //   4701 = variable used but not initialized
  #pragma warning( 3 : 4018 4032 4132 4189 4201 4222 4234 4505 4611 4701 )
  // Disable security warnings for posix functions.
  // _CRT_SECURE_NO_WARNINGS does not seem to work
  #pragma warning( disable : 4996 )
#endif // _MSC_VER

#if defined(_WINDOWS) || defined(_WIN32)
  // Export class definitions to DLLs.
  #define DllExport __declspec(dllexport)
  // intptr_t is defined in stddef.h, included below.
  #include <stdarg.h>
  #define va_copy(d,s) ((d)=(s))
  #define strcasecmp _stricmp
  #define strncasecmp strncmp
  #define strtof(nptr,endptr) static_cast<float>(strtod(nptr,endptr))
  #define strtoull _strtoui64
  // Flex doesn't check for unistd.h.
  #define YY_NO_UNISTD_H
  // Visual c++ version of std::exception destructor missing throw()
  // declaration.
  #define THROW_DCL
  namespace sta {
    int vsnprint(char *str, size_t size, const char *fmt, va_list args);
  }
#else
  #define DllExport
  #include <stdint.h>		// intptr_t
  #define vsnprint vsnprintf
  #define THROW_DCL throw()
#endif // _WINDOWS

#include <stddef.h>

namespace sta {

int
processorCount();

// Init elapsed (wall) time.
void
initElapsedTime();

// Elapsed/wall time (in seconds).
double
elapsedRunTime();

// User run time (in seconds).
double
userRunTime();

// System run time (in seconds).
double
systemRunTime();

// Memory usage in bytes.
size_t
memoryUsage();

#if __WORDSIZE == 64
  #define hashPtr(ptr) (reinterpret_cast<intptr_t>(ptr) >> 3)
#else
  #define hashPtr(ptr) (reinterpret_cast<intptr_t>(ptr) >> 2)
#endif

}

#endif // STA_MACHINE_H