v8/src/globals.h

// Copyright 2012 the V8 project authors. All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef V8_GLOBALS_H_
#define V8_GLOBALS_H_

// ----------------------------------------------------------------------------
// Operating system detection (V8_OS_x)
//
//  ANDROID - Android
//  BSD4    - Any BSD 4.4 system
//  CYGWIN  - Cygwin
//  DARWIN  - Darwin / Mac OS X
//  FREEBSD - FreeBSD
//  LINUX   - Linux
//  NACL    - Native Client
//  NETBSD  - NetBSD
//  OPENBSD - OpenBSD
//  SOLARIS - Solaris
//  UNIX    - Any UNIX BSD/SYSV system
//  WIN32   - Win32 (Windows 2000/XP/Vista/7 and Windows Server 2003/2008)

#if defined(ANDROID) || defined(__ANDROID__)
# define V8_OS_ANDROID 1
# define V8_OS_LINUX 1
# define V8_OS_UNIX 1
#elif defined(__APPLE__) && defined(__MACH__)
# define V8_OS_DARWIN 1
# define V8_OS_BSD4 1
# define V8_OS_UNIX 1
#elif defined(__CYGWIN__)
# define V8_OS_CYGWIN 1
# define V8_OS_UNIX 1
#elif defined(WIN64) || defined(_WIN64) || defined(__WIN64__)
# define V8_OS_WIN32 1
# define V8_OS_WIN64 1
#elif defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || \
    (defined(__MWERKS__) && defined(__INTEL__))
# define V8_OS_WIN32 1
#elif defined(__sun) || defined(sun)
# define V8_OS_SOLARIS 1
# define V8_OS_UNIX 1
#elif defined(__native_client__)
# define V8_OS_NACL 1
#elif defined(__linux__) || defined(__linux)
# define V8_OS_LINUX 1
# define V8_OS_UNIX 1
#elif defined(__FreeBSD__) || defined(__DragonFly__)
# define V8_OS_FREEBSD 1
# define V8_OS_BSD4 1
# define V8_OS_UNIX 1
#elif defined(__NetBSD__)
# define V8_OS_NETBSD 1
# define V8_OS_BSD4 1
# define V8_OS_UNIX 1
#elif defined(__OpenBSD__)
# define V8_OS_OPENBSD 1
# define V8_OS_BSD4 1
# define V8_OS_UNIX 1
#else
# error Operating system was not detected as supported by v8
#endif


// ----------------------------------------------------------------------------
// Compiler detection (V8_CC_x)
//
//  CLANG - C++ front-end for the LLVM compiler
//  GNU   - GNU C++ or compatible
//  INTEL - Intel C++ for Linux or Windows
//  MINGW - Minimalistic GNU for Windows Compiler
//  MIPS  - MIPSpro C++
//  MSVC  - Microsoft Visual C/C++ or compatible
//  RVCT  - ARM Realview Compiler Suite

#if defined(_MSC_VER)
# define V8_CC_MSVC 1
# if defined(__INTEL_COMPILER)
#  define V8_CC_INTEL 1
# endif
#elif defined(__GNUC__)
# define V8_CC_GNU 1
# if defined(__MINGW64__)
#  define V8_CC_MINGW 1
#  define V8_CC_MINGW64 1
# elif defined(__MINGW32__)
#  define V8_CC_MINGW 1
#  define V8_CC_MINGW32 1
# elif defined(__ARMCC__) || defined(__CC_ARM)
#  define V8_CC_RVCT 1  // ARM Realview Compiler Suite also masquerades as GCC
# elif defined(__INTEL_COMPILER)
#  define V8_CC_INTEL 1  // Intel C++ also masquerades as GCC 3.2.0
# elif defined(__clang__)
#  define V8_CC_CLANG 1  // Clang also masquerades as GCC 4.2.1
# endif
#elif defined(__ARMCC__) || defined(__CC_ARM)
# define V8_CC_RVCT 1
#elif defined(__INTEL_COMPILER)
# define V8_CC_INTEL 1
#elif defined(__SUNPRO_CC) || defined(__SUNPRO_C)
# define V8_CC_SUN 1
#else
# error Compiler was not detected as supported by v8
#endif

#if V8_CC_GNU
# define V8_GNUC_PREREQ(major, minor) \
    (__GNUC__ > (major) || (__GNUC__ == (major) && __GNUC_MINOR__ >= (minor)))
#else
# define V8_GNUC_PREREQ(major, minor) 0
#endif  // V8_CC_GNU


// ----------------------------------------------------------------------------
// Compiler features

// C++11 deleted functions
#if __cplusplus >= 201103L
# define V8_CXX_DELETED_FUNCTIONS 1
#elif V8_CC_CLANG
# define V8_CXX_DELETED_FUNCTIONS __has_feature(cxx_deleted_functions)
#else
# define V8_CXX_DELETED_FUNCTIONS (defined(__GXX_EXPERIMENTAL_CXX0X__) && \
                                   V8_GNUC_PREREQ(4, 4))
#endif

// C++11 static_assert()
#if __cplusplus >= 201103L
# define V8_CXX_STATIC_ASSERT 1
#elif V8_CC_CLANG
# define V8_CXX_STATIC_ASSERT (__has_extension(cxx_static_assert) || \
                               __has_feature(cxx_static_assert))
#else
# define V8_CXX_STATIC_ASSERT (defined(__GXX_EXPERIMENTAL_CXX0X__) && \
                               V8_GNUC_PREREQ(4, 3))
#endif


// ----------------------------------------------------------------------------
// Host architecture detection.  For more info on what's defined, see:
//   http://msdn.microsoft.com/en-us/library/b0084kay.aspx
//   http://www.agner.org/optimize/calling_conventions.pdf
//   or with gcc, run: "echo | gcc -E -dM -"

#if defined(_M_X64) || defined(__x86_64__)
# if V8_OS_NACL
// For Native Client builds of V8, use V8_TARGET_ARCH_ARM, so that V8
// generates ARM machine code, together with a portable ARM simulator
// compiled for the host architecture in question.
//
// Since Native Client is ILP-32 on all architectures we use
// V8_HOST_ARCH_IA32 on both 32- and 64-bit x86.
#  define V8_HOST_ARCH_IA32 1
#  define V8_HOST_ARCH_32_BIT 1
#  define V8_HOST_CAN_READ_UNALIGNED 1
# else
#  define V8_HOST_ARCH_X64 1
#  define V8_HOST_ARCH_64_BIT 1
#  define V8_HOST_CAN_READ_UNALIGNED 1
# endif  // V8_OS_NACL
#elif defined(_M_IX86) || defined(__i386__)
# define V8_HOST_ARCH_IA32 1
# define V8_HOST_ARCH_32_BIT 1
# define V8_HOST_CAN_READ_UNALIGNED 1
#elif defined(__ARMEL__)
# define V8_HOST_ARCH_ARM 1
# define V8_HOST_ARCH_32_BIT 1
#elif defined(__MIPSEL__)
# define V8_HOST_ARCH_MIPS 1
# define V8_HOST_ARCH_32_BIT 1
#else
# error Host architecture was not detected as supported by v8
#endif

#if defined(__ARM_ARCH_7A__) || \
    defined(__ARM_ARCH_7R__) || \
    defined(__ARM_ARCH_7__)
# define CAN_USE_ARMV7_INSTRUCTIONS 1
# ifndef CAN_USE_VFP3_INSTRUCTIONS
#  define CAN_USE_VFP3_INSTRUCTIONS 1
# endif
#endif


// ----------------------------------------------------------------------------
// Target architecture detection. This may be set externally. If not, detect
// in the same way as the host architecture, that is, target the native
// environment as presented by the compiler.

#if !V8_TARGET_ARCH_X64 && !V8_TARGET_ARCH_IA32 && \
    !V8_TARGET_ARCH_ARM && !V8_TARGET_ARCH_MIPS
# if V8_HOST_ARCH_X64
#  define V8_TARGET_ARCH_X64 1
# elif V8_HOST_ARCH_IA32
#  define V8_TARGET_ARCH_IA32 1
# elif V8_HOST_ARCH_ARM
#  define V8_TARGET_ARCH_ARM 1
# elif V8_HOST_ARCH_MIPS
#  define V8_TARGET_ARCH_MIPS 1
# else
#  error Target architecture was not detected as supported by v8
# endif
#endif

// Check for supported combinations of host and target architectures.
#if V8_TARGET_ARCH_IA32 && !V8_HOST_ARCH_IA32
# error Target architecture ia32 is only supported on ia32 host
#elif V8_TARGET_ARCH_X64 && !V8_HOST_ARCH_X64
# error Target architecture x64 is only supported on x64 host
#elif V8_TARGET_ARCH_ARM && !(V8_HOST_ARCH_IA32 || V8_HOST_ARCH_ARM)
# error Target architecture arm is only supported on arm and ia32 host
#elif V8_TARGET_ARCH_MIPS && !(V8_HOST_ARCH_IA32 || V8_HOST_ARCH_MIPS)
# error Target architecture mips is only supported on mips and ia32 host
#endif

// Determine whether we are running in a simulated environment.
// Setting USE_SIMULATOR explicitly from the build script will force
// the use of a simulated environment.
#if !defined(USE_SIMULATOR)
# if V8_TARGET_ARCH_ARM && !V8_HOST_ARCH_ARM
#  define USE_SIMULATOR 1
# elif V8_TARGET_ARCH_MIPS && !V8_HOST_ARCH_MIPS
#  define USE_SIMULATOR 1
# endif
#endif

// Determine architecture endiannes (we only support little-endian).
#if V8_TARGET_ARCH_IA32 || V8_TARGET_ARCH_X64 || \
    V8_TARGET_ARCH_ARM || V8_TARGET_ARCH_MIPS
# define V8_TARGET_LITTLE_ENDIAN 1
#else
# error Unknown target architecture endiannes
#endif


// ----------------------------------------------------------------------------
// Define our own macros for writing 64-bit constants.  This is less fragile
// than defining __STDC_CONSTANT_MACROS before including <stdint.h>, and it
// works on compilers that don't have it (like MSVC).
#if V8_HOST_ARCH_64_BIT
# if V8_CC_MSVC
#  define V8_UINT64_C(x)  (x ## UI64)
#  define V8_INT64_C(x)   (x ## I64)
#  define V8_INTPTR_C(x)  (x ## I64)
#  define V8_PTR_PREFIX "ll"
# elif V8_CC_MINGW
#  define V8_UINT64_C(x)  (x ## ULL)
#  define V8_INT64_C(x)   (x ## LL)
#  define V8_INTPTR_C(x)  (x ## LL)
#  define V8_PTR_PREFIX "I64"
# else
#  define V8_UINT64_C(x)  (x ## UL)
#  define V8_INT64_C(x)   (x ## L)
#  define V8_INTPTR_C(x)  (x ## L)
#  define V8_PTR_PREFIX "l"
# endif
#else  // V8_HOST_ARCH_64_BIT
# define V8_INTPTR_C(x)  (x)
# define V8_PTR_PREFIX ""
#endif  // V8_HOST_ARCH_64_BIT

// The following macro works on both 32 and 64-bit platforms.
// Usage: instead of writing 0x1234567890123456
//      write V8_2PART_UINT64_C(0x12345678,90123456);
#define V8_2PART_UINT64_C(a, b) (((static_cast<uint64_t>(a) << 32) + 0x##b##u))

#if V8_OS_DARWIN
// Fix for Mac OS X defining uintptr_t as "unsigned long":
# define V8PRIxPTR "lx"
#else
# define V8PRIxPTR V8_PTR_PREFIX "x"
#endif  // V8_OS_DARWIN
#define V8PRIdPTR V8_PTR_PREFIX "d"
#define V8PRIuPTR V8_PTR_PREFIX "u"


// ----------------------------------------------------------------------------
// Define V8_INFINITY
#if V8_GNUC_PREREQ(2, 96) && !V8_GNUC_PREREQ(4, 1)
// Unfortunately, the INFINITY macro cannot be used with the '-pedantic'
// warning flag and certain versions of GCC due to a bug:
// http://gcc.gnu.org/bugzilla/show_bug.cgi?id=11931
// For now, we use the more involved template-based version from <limits>, but
// only when compiling with GCC versions affected by the bug (2.96.x - 4.0.x)
# include <limits>
# define V8_INFINITY std::numeric_limits<double>::infinity()
#elif V8_CC_MSVC
# define V8_INFINITY HUGE_VAL
#else
# define V8_INFINITY INFINITY
#endif


#include "../include/v8stdint.h"

namespace v8 {
namespace internal {

// Support for alternative bool type. This is only enabled if the code is
// compiled with USE_MYBOOL defined. This catches some nasty type bugs.
// For instance, 'bool b = "false";' results in b == true! This is a hidden
// source of bugs.
// However, redefining the bool type does have some negative impact on some
// platforms. It gives rise to compiler warnings (i.e. with
// MSVC) in the API header files when mixing code that uses the standard
// bool with code that uses the redefined version.
// This does not actually belong in the platform code, but needs to be
// defined here because the platform code uses bool, and platform.h is
// include very early in the main include file.

#ifdef USE_MYBOOL
typedef unsigned int __my_bool__;
#define bool __my_bool__  // use 'indirection' to avoid name clashes
#endif

typedef uint8_t byte;
typedef byte* Address;

// -----------------------------------------------------------------------------
// Constants

const int KB = 1024;
const int MB = KB * KB;
const int GB = KB * KB * KB;
const int kMaxInt = 0x7FFFFFFF;
const int kMinInt = -kMaxInt - 1;

const uint32_t kMaxUInt32 = 0xFFFFFFFFu;

const int kCharSize      = sizeof(char);      // NOLINT
const int kShortSize     = sizeof(short);     // NOLINT
const int kIntSize       = sizeof(int);       // NOLINT
const int kDoubleSize    = sizeof(double);    // NOLINT
const int kIntptrSize    = sizeof(intptr_t);  // NOLINT
const int kPointerSize   = sizeof(void*);     // NOLINT
const int kRegisterSize  = kPointerSize;
const int kPCOnStackSize = kRegisterSize;
const int kFPOnStackSize = kRegisterSize;

const int kDoubleSizeLog2 = 3;

// Size of the state of a the random number generator.
const int kRandomStateSize = 2 * kIntSize;

#if V8_HOST_ARCH_64_BIT
const int kPointerSizeLog2 = 3;
const intptr_t kIntptrSignBit = V8_INT64_C(0x8000000000000000);
const uintptr_t kUintptrAllBitsSet = V8_UINT64_C(0xFFFFFFFFFFFFFFFF);
#else
const int kPointerSizeLog2 = 2;
const intptr_t kIntptrSignBit = 0x80000000;
const uintptr_t kUintptrAllBitsSet = 0xFFFFFFFFu;
#endif

const int kBitsPerByte = 8;
const int kBitsPerByteLog2 = 3;
const int kBitsPerPointer = kPointerSize * kBitsPerByte;
const int kBitsPerInt = kIntSize * kBitsPerByte;

// IEEE 754 single precision floating point number bit layout.
const uint32_t kBinary32SignMask = 0x80000000u;
const uint32_t kBinary32ExponentMask = 0x7f800000u;
const uint32_t kBinary32MantissaMask = 0x007fffffu;
const int kBinary32ExponentBias = 127;
const int kBinary32MaxExponent  = 0xFE;
const int kBinary32MinExponent  = 0x01;
const int kBinary32MantissaBits = 23;
const int kBinary32ExponentShift = 23;

// Quiet NaNs have bits 51 to 62 set, possibly the sign bit, and no
// other bits set.
const uint64_t kQuietNaNMask = static_cast<uint64_t>(0xfff) << 51;

// Latin1/UTF-16 constants
// Code-point values in Unicode 4.0 are 21 bits wide.
// Code units in UTF-16 are 16 bits wide.
typedef uint16_t uc16;
typedef int32_t uc32;
const int kOneByteSize    = kCharSize;
const int kUC16Size     = sizeof(uc16);      // NOLINT


// The expression OFFSET_OF(type, field) computes the byte-offset
// of the specified field relative to the containing type. This
// corresponds to 'offsetof' (in stddef.h), except that it doesn't
// use 0 or NULL, which causes a problem with the compiler warnings
// we have enabled (which is also why 'offsetof' doesn't seem to work).
// Here we simply use the non-zero value 4, which seems to work.
#define OFFSET_OF(type, field)                                          \
  (reinterpret_cast<intptr_t>(&(reinterpret_cast<type*>(4)->field)) - 4)


// The expression ARRAY_SIZE(a) is a compile-time constant of type
// size_t which represents the number of elements of the given
// array. You should only use ARRAY_SIZE on statically allocated
// arrays.
#define ARRAY_SIZE(a)                                   \
  ((sizeof(a) / sizeof(*(a))) /                         \
  static_cast<size_t>(!(sizeof(a) % sizeof(*(a)))))


// The USE(x) template is used to silence C++ compiler warnings
// issued for (yet) unused variables (typically parameters).
template <typename T>
inline void USE(T) { }


// FUNCTION_ADDR(f) gets the address of a C function f.
#define FUNCTION_ADDR(f)                                        \
  (reinterpret_cast<v8::internal::Address>(reinterpret_cast<intptr_t>(f)))


// FUNCTION_CAST<F>(addr) casts an address into a function
// of type F. Used to invoke generated code from within C.
template <typename F>
F FUNCTION_CAST(Address addr) {
  return reinterpret_cast<F>(reinterpret_cast<intptr_t>(addr));
}


#if V8_CXX_DELETED_FUNCTIONS
# define DISALLOW_BY_DELETE = delete
#else
# define DISALLOW_BY_DELETE
#endif


// A macro to disallow the evil copy constructor and operator= functions
// This should be used in the private: declarations for a class
#define DISALLOW_COPY_AND_ASSIGN(TypeName)           \
  TypeName(const TypeName&) DISALLOW_BY_DELETE;      \
  void operator=(const TypeName&) DISALLOW_BY_DELETE


// A macro to disallow all the implicit constructors, namely the
// default constructor, copy constructor and operator= functions.
//
// This should be used in the private: declarations for a class
// that wants to prevent anyone from instantiating it. This is
// especially useful for classes containing only static methods.
#define DISALLOW_IMPLICIT_CONSTRUCTORS(TypeName) \
  TypeName() DISALLOW_BY_DELETE;                 \
  DISALLOW_COPY_AND_ASSIGN(TypeName)


// Define used for helping GCC to make better inlining. Don't bother for debug
// builds. On GCC 3.4.5 using __attribute__((always_inline)) causes compilation
// errors in debug build.
#if V8_GNUC_PREREQ(4, 0) && !defined(DEBUG)
# define INLINE(header) inline header  __attribute__((always_inline))
# define NO_INLINE(header) header __attribute__((noinline))
#elif V8_CC_GNU && !defined(DEBUG)
# define INLINE(header) inline __attribute__((always_inline)) header
# define NO_INLINE(header) __attribute__((noinline)) header
#elif V8_CC_MSVC && !defined(DEBUG)
# define INLINE(header) __forceinline header
# define NO_INLINE(header) header
#else
# define INLINE(header) inline header
# define NO_INLINE(header) header
#endif


#if V8_GNUC_PREREQ(4, 0)
#define MUST_USE_RESULT __attribute__ ((warn_unused_result))
#else
#define MUST_USE_RESULT
#endif


// Define DISABLE_ASAN macros.
#if defined(__has_feature)
#if __has_feature(address_sanitizer)
#define DISABLE_ASAN __attribute__((no_address_safety_analysis))
#endif
#endif


#ifndef DISABLE_ASAN
#define DISABLE_ASAN
#endif


// -----------------------------------------------------------------------------
// Forward declarations for frequently used classes
// (sorted alphabetically)

class FreeStoreAllocationPolicy;
template <typename T, class P = FreeStoreAllocationPolicy> class List;

// -----------------------------------------------------------------------------
// Declarations for use in both the preparser and the rest of V8.

// The different language modes that V8 implements. ES5 defines two language
// modes: an unrestricted mode respectively a strict mode which are indicated by
// CLASSIC_MODE respectively STRICT_MODE in the enum. The harmony spec drafts
// for the next ES standard specify a new third mode which is called 'extended
// mode'. The extended mode is only available if the harmony flag is set. It is
// based on the 'strict mode' and adds new functionality to it. This means that
// most of the semantics of these two modes coincide.
//
// In the current draft the term 'base code' is used to refer to code that is
// neither in strict nor extended mode. However, the more distinguishing term
// 'classic mode' is used in V8 instead to avoid mix-ups.

enum LanguageMode {
  CLASSIC_MODE,
  STRICT_MODE,
  EXTENDED_MODE
};


// A simple Maybe type, that can be passed by value.
template<class T>
struct Maybe {
  Maybe() : has_value(false) {}
  explicit Maybe(T t) : has_value(true), value(t) {}
  Maybe(bool has, T t) : has_value(has), value(t) {}

  bool has_value;
  T value;
};


// The Strict Mode (ECMA-262 5th edition, 4.2.2).
//
// This flag is used in the backend to represent the language mode. So far
// there is no semantic difference between the strict and the extended mode in
// the backend, so both modes are represented by the kStrictMode value.
enum StrictModeFlag {
  kNonStrictMode,
  kStrictMode
};


} }  // namespace v8::internal

#endif  // V8_GLOBALS_H_