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