1 /*
   2  * Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #ifndef SHARE_VM_UTILITIES_GLOBALDEFINITIONS_GCC_HPP
  26 #define SHARE_VM_UTILITIES_GLOBALDEFINITIONS_GCC_HPP
  27 
  28 #include "prims/jni.h"
  29 
  30 // This file holds compiler-dependent includes,
  31 // globally used constants & types, class (forward)
  32 // declarations and a few frequently used utility functions.
  33 
  34 #include <ctype.h>
  35 #include <string.h>
  36 #include <stdarg.h>
  37 #include <stddef.h>
  38 #include <stdio.h>
  39 #include <stdlib.h>
  40 #include <wchar.h>
  41 
  42 #ifdef SOLARIS
  43 #include <ieeefp.h>
  44 #endif // SOLARIS
  45 
  46 #include <math.h>
  47 #ifndef FP_PZERO
  48 // Linux doesn't have positive/negative zero
  49 #define FP_PZERO FP_ZERO
  50 #endif
  51 #if (!defined fpclass) && ((!defined SPARC) || (!defined SOLARIS))
  52 #define fpclass fpclassify
  53 #endif
  54 
  55 #include <time.h>
  56 #include <fcntl.h>
  57 #include <dlfcn.h>
  58 #include <pthread.h>
  59 
  60 #ifdef SOLARIS
  61 #include <thread.h>
  62 #endif // SOLARIS
  63 
  64 #include <limits.h>
  65 #include <errno.h>
  66 
  67 #ifdef SOLARIS
  68 #include <sys/trap.h>
  69 #include <sys/regset.h>
  70 #include <sys/procset.h>
  71 #include <ucontext.h>
  72 #include <setjmp.h>
  73 #endif // SOLARIS
  74 
  75 # ifdef SOLARIS_MUTATOR_LIBTHREAD
  76 # include <sys/procfs.h>
  77 # endif
  78 
  79 #if defined(LINUX) || defined(_ALLBSD_SOURCE)
  80 #ifndef __STDC_LIMIT_MACROS
  81 #define __STDC_LIMIT_MACROS
  82 #endif // __STDC_LIMIT_MACROS
  83 #include <inttypes.h>
  84 #include <signal.h>
  85 #ifndef __OpenBSD__
  86 #include <ucontext.h>
  87 #endif
  88 #ifdef __APPLE__
  89   #include <AvailabilityMacros.h>
  90   #if (MAC_OS_X_VERSION_MAX_ALLOWED <= MAC_OS_X_VERSION_10_4)
  91     // Mac OS X 10.4 defines EFL_AC and EFL_ID,
  92     // which conflict with hotspot variable names.
  93     //
  94     // This has been fixed in Mac OS X 10.5.
  95     #undef EFL_AC
  96     #undef EFL_ID
  97   #endif
  98 #endif
  99 #include <sys/time.h>
 100 #endif // LINUX || _ALLBSD_SOURCE
 101 
 102 // 4810578: varargs unsafe on 32-bit integer/64-bit pointer architectures
 103 // When __cplusplus is defined, NULL is defined as 0 (32-bit constant) in
 104 // system header files.  On 32-bit architectures, there is no problem.
 105 // On 64-bit architectures, defining NULL as a 32-bit constant can cause
 106 // problems with varargs functions: C++ integral promotion rules say for
 107 // varargs, we pass the argument 0 as an int.  So, if NULL was passed to a
 108 // varargs function it will remain 32-bits.  Depending on the calling
 109 // convention of the machine, if the argument is passed on the stack then
 110 // only 32-bits of the "NULL" pointer may be initialized to zero.  The
 111 // other 32-bits will be garbage.  If the varargs function is expecting a
 112 // pointer when it extracts the argument, then we have a problem.
 113 //
 114 // Solution: For 64-bit architectures, redefine NULL as 64-bit constant 0.
 115 //
 116 // Note: this fix doesn't work well on Linux because NULL will be overwritten
 117 // whenever a system header file is included. Linux handles NULL correctly
 118 // through a special type '__null'.
 119 #ifdef SOLARIS
 120   #ifdef _LP64
 121     #undef NULL
 122     #define NULL 0L
 123   #else
 124     #ifndef NULL
 125       #define NULL 0
 126     #endif
 127   #endif
 128 #endif
 129 
 130 // NULL vs NULL_WORD:
 131 // On Linux NULL is defined as a special type '__null'. Assigning __null to
 132 // integer variable will cause gcc warning. Use NULL_WORD in places where a
 133 // pointer is stored as integer value.  On some platforms, sizeof(intptr_t) >
 134 // sizeof(void*), so here we want something which is integer type, but has the
 135 // same size as a pointer.
 136 #ifdef __GNUC__
 137   #ifdef _LP64
 138     #define NULL_WORD  0L
 139   #else
 140     // Cast 0 to intptr_t rather than int32_t since they are not the same type
 141     // on platforms such as Mac OS X.
 142     #define NULL_WORD  ((intptr_t)0)
 143   #endif
 144 #else
 145   #define NULL_WORD  NULL
 146 #endif
 147 
 148 #if !defined(LINUX) && !defined(_ALLBSD_SOURCE)
 149 // Compiler-specific primitive types
 150 typedef unsigned short     uint16_t;
 151 #ifndef _UINT32_T
 152 #define _UINT32_T
 153 typedef unsigned int       uint32_t;
 154 #endif // _UINT32_T
 155 
 156 #if !defined(_SYS_INT_TYPES_H)
 157 #ifndef _UINT64_T
 158 #define _UINT64_T
 159 typedef unsigned long long uint64_t;
 160 #endif // _UINT64_T
 161 // %%%% how to access definition of intptr_t portably in 5.5 onward?
 162 typedef int                     intptr_t;
 163 typedef unsigned int            uintptr_t;
 164 // If this gets an error, figure out a symbol XXX that implies the
 165 // prior definition of intptr_t, and add "&& !defined(XXX)" above.
 166 #endif // _SYS_INT_TYPES_H
 167 
 168 #endif // !LINUX && !_ALLBSD_SOURCE
 169 
 170 // Additional Java basic types
 171 
 172 typedef uint8_t  jubyte;
 173 typedef uint16_t jushort;
 174 typedef uint32_t juint;
 175 typedef uint64_t julong;
 176 
 177 //----------------------------------------------------------------------------------------------------
 178 // Special (possibly not-portable) casts
 179 // Cast floats into same-size integers and vice-versa w/o changing bit-pattern
 180 // %%%%%% These seem like standard C++ to me--how about factoring them out? - Ungar
 181 
 182 inline jint    jint_cast   (jfloat  x)           { return *(jint*   )&x; }
 183 inline jlong   jlong_cast  (jdouble x)           { return *(jlong*  )&x; }
 184 
 185 inline jfloat  jfloat_cast (jint    x)           { return *(jfloat* )&x; }
 186 inline jdouble jdouble_cast(jlong   x)           { return *(jdouble*)&x; }
 187 
 188 //----------------------------------------------------------------------------------------------------
 189 // Constant for jlong (specifying an long long canstant is C++ compiler specific)
 190 
 191 // Build a 64bit integer constant
 192 #define CONST64(x)  (x ## LL)
 193 #define UCONST64(x) (x ## ULL)
 194 
 195 const jlong min_jlong = CONST64(0x8000000000000000);
 196 const jlong max_jlong = CONST64(0x7fffffffffffffff);
 197 
 198 
 199 #ifdef SOLARIS
 200 //----------------------------------------------------------------------------------------------------
 201 // ANSI C++ fixes
 202 // NOTE:In the ANSI committee's continuing attempt to make each version
 203 // of C++ incompatible with the previous version, you can no longer cast
 204 // pointers to functions without specifying linkage unless you want to get
 205 // warnings.
 206 //
 207 // This also means that pointers to functions can no longer be "hidden"
 208 // in opaque types like void * because at the invokation point warnings
 209 // will be generated. While this makes perfect sense from a type safety
 210 // point of view it causes a lot of warnings on old code using C header
 211 // files. Here are some typedefs to make the job of silencing warnings
 212 // a bit easier.
 213 //
 214 // The final kick in the teeth is that you can only have extern "C" linkage
 215 // specified at file scope. So these typedefs are here rather than in the
 216 // .hpp for the class (os:Solaris usually) that needs them.
 217 
 218 extern "C" {
 219    typedef int (*int_fnP_thread_t_iP_uP_stack_tP_gregset_t)(thread_t, int*, unsigned *, stack_t*, gregset_t);
 220    typedef int (*int_fnP_thread_t_i_gregset_t)(thread_t, int, gregset_t);
 221    typedef int (*int_fnP_thread_t_i)(thread_t, int);
 222    typedef int (*int_fnP_thread_t)(thread_t);
 223 
 224    typedef int (*int_fnP_cond_tP_mutex_tP_timestruc_tP)(cond_t *cv, mutex_t *mx, timestruc_t *abst);
 225    typedef int (*int_fnP_cond_tP_mutex_tP)(cond_t *cv, mutex_t *mx);
 226 
 227    // typedef for missing API in libc
 228    typedef int (*int_fnP_mutex_tP_i_vP)(mutex_t *, int, void *);
 229    typedef int (*int_fnP_mutex_tP)(mutex_t *);
 230    typedef int (*int_fnP_cond_tP_i_vP)(cond_t *cv, int scope, void *arg);
 231    typedef int (*int_fnP_cond_tP)(cond_t *cv);
 232 };
 233 #endif // SOLARIS
 234 
 235 //----------------------------------------------------------------------------------------------------
 236 // Debugging
 237 
 238 #define DEBUG_EXCEPTION ::abort();
 239 
 240 #ifdef ARM
 241 #ifdef SOLARIS
 242 #define BREAKPOINT __asm__ volatile (".long 0xe1200070")
 243 #else
 244 #define BREAKPOINT __asm__ volatile (".long 0xe7f001f0")
 245 #endif
 246 #else
 247 extern "C" void breakpoint();
 248 #define BREAKPOINT ::breakpoint()
 249 #endif
 250 
 251 // checking for nanness
 252 #ifdef SOLARIS
 253 #ifdef SPARC
 254 inline int g_isnan(float  f) { return isnanf(f); }
 255 #else
 256 // isnanf() broken on Intel Solaris use isnand()
 257 inline int g_isnan(float  f) { return isnand(f); }
 258 #endif
 259 inline int g_isnan(double f) { return isnand(f); }
 260 #elif defined(__APPLE__)
 261 inline int g_isnan(double f) { return isnan(f); }
 262 #elif defined(LINUX) || defined(_ALLBSD_SOURCE)
 263 inline int g_isnan(float  f) { return isnanf(f); }
 264 inline int g_isnan(double f) { return isnan(f); }
 265 #else
 266 #error "missing platform-specific definition here"
 267 #endif
 268 
 269 // GCC 4.3 does not allow 0.0/0.0 to produce a NAN value
 270 #if (__GNUC__ == 4) && (__GNUC_MINOR__ > 2)
 271 #define CAN_USE_NAN_DEFINE 1
 272 #endif
 273 
 274 
 275 // Checking for finiteness
 276 
 277 inline int g_isfinite(jfloat  f)                 { return finite(f); }
 278 inline int g_isfinite(jdouble f)                 { return finite(f); }
 279 
 280 
 281 // Wide characters
 282 
 283 inline int wcslen(const jchar* x) { return wcslen((const wchar_t*)x); }
 284 
 285 
 286 // Portability macros
 287 #define PRAGMA_INTERFACE             #pragma interface
 288 #define PRAGMA_IMPLEMENTATION        #pragma implementation
 289 #define VALUE_OBJ_CLASS_SPEC
 290 
 291 #if (__GNUC__ == 2) && (__GNUC_MINOR__ < 95)
 292 #define TEMPLATE_TABLE_BUG
 293 #endif
 294 #if (__GNUC__ == 2) && (__GNUC_MINOR__ >= 96)
 295 #define CONST_SDM_BUG
 296 #endif
 297 
 298 // Formatting.
 299 #ifdef _LP64
 300 #define FORMAT64_MODIFIER "l"
 301 #else // !_LP64
 302 #define FORMAT64_MODIFIER "ll"
 303 #endif // _LP64
 304 
 305 // HACK: gcc warns about applying offsetof() to non-POD object or calculating
 306 //       offset directly when base address is NULL. Use 16 to get around the
 307 //       warning. gcc-3.4 has an option -Wno-invalid-offsetof to suppress
 308 //       this warning.
 309 #define offset_of(klass,field) (size_t)((intx)&(((klass*)16)->field) - 16)
 310 
 311 #ifdef offsetof
 312 # undef offsetof
 313 #endif
 314 #define offsetof(klass,field) offset_of(klass,field)
 315 
 316 #endif // SHARE_VM_UTILITIES_GLOBALDEFINITIONS_GCC_HPP