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 #endif
  91 #include <sys/time.h>
  92 #endif // LINUX || _ALLBSD_SOURCE
  93 
  94 // 4810578: varargs unsafe on 32-bit integer/64-bit pointer architectures
  95 // When __cplusplus is defined, NULL is defined as 0 (32-bit constant) in
  96 // system header files.  On 32-bit architectures, there is no problem.
  97 // On 64-bit architectures, defining NULL as a 32-bit constant can cause
  98 // problems with varargs functions: C++ integral promotion rules say for
  99 // varargs, we pass the argument 0 as an int.  So, if NULL was passed to a
 100 // varargs function it will remain 32-bits.  Depending on the calling
 101 // convention of the machine, if the argument is passed on the stack then
 102 // only 32-bits of the "NULL" pointer may be initialized to zero.  The
 103 // other 32-bits will be garbage.  If the varargs function is expecting a
 104 // pointer when it extracts the argument, then we have a problem.
 105 //
 106 // Solution: For 64-bit architectures, redefine NULL as 64-bit constant 0.
 107 //
 108 // Note: this fix doesn't work well on Linux because NULL will be overwritten
 109 // whenever a system header file is included. Linux handles NULL correctly
 110 // through a special type '__null'.
 111 #ifdef SOLARIS
 112   #ifdef _LP64
 113     #undef NULL
 114     #define NULL 0L
 115   #else
 116     #ifndef NULL
 117       #define NULL 0
 118     #endif
 119   #endif
 120 #endif
 121 
 122 // NULL vs NULL_WORD:
 123 // On Linux NULL is defined as a special type '__null'. Assigning __null to
 124 // integer variable will cause gcc warning. Use NULL_WORD in places where a
 125 // pointer is stored as integer value.  On some platforms, sizeof(intptr_t) >
 126 // sizeof(void*), so here we want something which is integer type, but has the
 127 // same size as a pointer.
 128 #ifdef __GNUC__
 129   #ifdef _LP64
 130     #define NULL_WORD  0L
 131   #else
 132     // Cast 0 to intptr_t rather than int32_t since they are not the same type
 133     // on platforms such as Mac OS X.
 134     #define NULL_WORD  ((intptr_t)0)
 135   #endif
 136 #else
 137   #define NULL_WORD  NULL
 138 #endif
 139 
 140 #if !defined(LINUX) && !defined(_ALLBSD_SOURCE)
 141 // Compiler-specific primitive types
 142 typedef unsigned short     uint16_t;
 143 #ifndef _UINT32_T
 144 #define _UINT32_T
 145 typedef unsigned int       uint32_t;
 146 #endif // _UINT32_T
 147 
 148 #if !defined(_SYS_INT_TYPES_H)
 149 #ifndef _UINT64_T
 150 #define _UINT64_T
 151 typedef unsigned long long uint64_t;
 152 #endif // _UINT64_T
 153 // %%%% how to access definition of intptr_t portably in 5.5 onward?
 154 typedef int                     intptr_t;
 155 typedef unsigned int            uintptr_t;
 156 // If this gets an error, figure out a symbol XXX that implies the
 157 // prior definition of intptr_t, and add "&& !defined(XXX)" above.
 158 #endif // _SYS_INT_TYPES_H
 159 
 160 #endif // !LINUX && !_ALLBSD_SOURCE
 161 
 162 // Additional Java basic types
 163 
 164 typedef uint8_t  jubyte;
 165 typedef uint16_t jushort;
 166 typedef uint32_t juint;
 167 typedef uint64_t julong;
 168 
 169 //----------------------------------------------------------------------------------------------------
 170 // Special (possibly not-portable) casts
 171 // Cast floats into same-size integers and vice-versa w/o changing bit-pattern
 172 // %%%%%% These seem like standard C++ to me--how about factoring them out? - Ungar
 173 
 174 inline jint    jint_cast   (jfloat  x)           { return *(jint*   )&x; }
 175 inline jlong   jlong_cast  (jdouble x)           { return *(jlong*  )&x; }
 176 
 177 inline jfloat  jfloat_cast (jint    x)           { return *(jfloat* )&x; }
 178 inline jdouble jdouble_cast(jlong   x)           { return *(jdouble*)&x; }
 179 
 180 //----------------------------------------------------------------------------------------------------
 181 // Constant for jlong (specifying an long long canstant is C++ compiler specific)
 182 
 183 // Build a 64bit integer constant
 184 #define CONST64(x)  (x ## LL)
 185 #define UCONST64(x) (x ## ULL)
 186 
 187 const jlong min_jlong = CONST64(0x8000000000000000);
 188 const jlong max_jlong = CONST64(0x7fffffffffffffff);
 189 
 190 
 191 #ifdef SOLARIS
 192 //----------------------------------------------------------------------------------------------------
 193 // ANSI C++ fixes
 194 // NOTE:In the ANSI committee's continuing attempt to make each version
 195 // of C++ incompatible with the previous version, you can no longer cast
 196 // pointers to functions without specifying linkage unless you want to get
 197 // warnings.
 198 //
 199 // This also means that pointers to functions can no longer be "hidden"
 200 // in opaque types like void * because at the invokation point warnings
 201 // will be generated. While this makes perfect sense from a type safety
 202 // point of view it causes a lot of warnings on old code using C header
 203 // files. Here are some typedefs to make the job of silencing warnings
 204 // a bit easier.
 205 //
 206 // The final kick in the teeth is that you can only have extern "C" linkage
 207 // specified at file scope. So these typedefs are here rather than in the
 208 // .hpp for the class (os:Solaris usually) that needs them.
 209 
 210 extern "C" {
 211    typedef int (*int_fnP_thread_t_iP_uP_stack_tP_gregset_t)(thread_t, int*, unsigned *, stack_t*, gregset_t);
 212    typedef int (*int_fnP_thread_t_i_gregset_t)(thread_t, int, gregset_t);
 213    typedef int (*int_fnP_thread_t_i)(thread_t, int);
 214    typedef int (*int_fnP_thread_t)(thread_t);
 215 
 216    typedef int (*int_fnP_cond_tP_mutex_tP_timestruc_tP)(cond_t *cv, mutex_t *mx, timestruc_t *abst);
 217    typedef int (*int_fnP_cond_tP_mutex_tP)(cond_t *cv, mutex_t *mx);
 218 
 219    // typedef for missing API in libc
 220    typedef int (*int_fnP_mutex_tP_i_vP)(mutex_t *, int, void *);
 221    typedef int (*int_fnP_mutex_tP)(mutex_t *);
 222    typedef int (*int_fnP_cond_tP_i_vP)(cond_t *cv, int scope, void *arg);
 223    typedef int (*int_fnP_cond_tP)(cond_t *cv);
 224 };
 225 #endif // SOLARIS
 226 
 227 //----------------------------------------------------------------------------------------------------
 228 // Debugging
 229 
 230 #define DEBUG_EXCEPTION ::abort();
 231 
 232 #ifdef ARM
 233 #ifdef SOLARIS
 234 #define BREAKPOINT __asm__ volatile (".long 0xe1200070")
 235 #else
 236 #define BREAKPOINT __asm__ volatile (".long 0xe7f001f0")
 237 #endif
 238 #else
 239 extern "C" void breakpoint();
 240 #define BREAKPOINT ::breakpoint()
 241 #endif
 242 
 243 // checking for nanness
 244 #ifdef SOLARIS
 245 #ifdef SPARC
 246 inline int g_isnan(float  f) { return isnanf(f); }
 247 #else
 248 // isnanf() broken on Intel Solaris use isnand()
 249 inline int g_isnan(float  f) { return isnand(f); }
 250 #endif
 251 inline int g_isnan(double f) { return isnand(f); }
 252 #elif defined(__APPLE__)
 253 inline int g_isnan(double f) { return isnan(f); }
 254 #elif defined(LINUX) || defined(_ALLBSD_SOURCE)
 255 inline int g_isnan(float  f) { return isnanf(f); }
 256 inline int g_isnan(double f) { return isnan(f); }
 257 #else
 258 #error "missing platform-specific definition here"
 259 #endif
 260 
 261 // GCC 4.3 does not allow 0.0/0.0 to produce a NAN value
 262 #if (__GNUC__ == 4) && (__GNUC_MINOR__ > 2)
 263 #define CAN_USE_NAN_DEFINE 1
 264 #endif
 265 
 266 
 267 // Checking for finiteness
 268 
 269 inline int g_isfinite(jfloat  f)                 { return finite(f); }
 270 inline int g_isfinite(jdouble f)                 { return finite(f); }
 271 
 272 
 273 // Wide characters
 274 
 275 inline int wcslen(const jchar* x) { return wcslen((const wchar_t*)x); }
 276 
 277 
 278 // Portability macros
 279 #define PRAGMA_INTERFACE             #pragma interface
 280 #define PRAGMA_IMPLEMENTATION        #pragma implementation
 281 #define VALUE_OBJ_CLASS_SPEC
 282 
 283 #if (__GNUC__ == 2) && (__GNUC_MINOR__ < 95)
 284 #define TEMPLATE_TABLE_BUG
 285 #endif
 286 #if (__GNUC__ == 2) && (__GNUC_MINOR__ >= 96)
 287 #define CONST_SDM_BUG
 288 #endif
 289 
 290 // Formatting.
 291 #ifdef _LP64
 292 #define FORMAT64_MODIFIER "l"
 293 #else // !_LP64
 294 #define FORMAT64_MODIFIER "ll"
 295 #endif // _LP64
 296 
 297 // HACK: gcc warns about applying offsetof() to non-POD object or calculating
 298 //       offset directly when base address is NULL. Use 16 to get around the
 299 //       warning. gcc-3.4 has an option -Wno-invalid-offsetof to suppress
 300 //       this warning.
 301 #define offset_of(klass,field) (size_t)((intx)&(((klass*)16)->field) - 16)
 302 
 303 #ifdef offsetof
 304 # undef offsetof
 305 #endif
 306 #define offsetof(klass,field) offset_of(klass,field)
 307 
 308 #endif // SHARE_VM_UTILITIES_GLOBALDEFINITIONS_GCC_HPP