1 /*
   2  * Copyright (c) 1998, 2014, 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   #include <mach/mach.h>
  91 #endif
  92 #include <sys/time.h>
  93 #endif // LINUX || _ALLBSD_SOURCE
  94 
  95 // 4810578: varargs unsafe on 32-bit integer/64-bit pointer architectures
  96 // When __cplusplus is defined, NULL is defined as 0 (32-bit constant) in
  97 // system header files.  On 32-bit architectures, there is no problem.
  98 // On 64-bit architectures, defining NULL as a 32-bit constant can cause
  99 // problems with varargs functions: C++ integral promotion rules say for
 100 // varargs, we pass the argument 0 as an int.  So, if NULL was passed to a
 101 // varargs function it will remain 32-bits.  Depending on the calling
 102 // convention of the machine, if the argument is passed on the stack then
 103 // only 32-bits of the "NULL" pointer may be initialized to zero.  The
 104 // other 32-bits will be garbage.  If the varargs function is expecting a
 105 // pointer when it extracts the argument, then we have a problem.
 106 //
 107 // Solution: For 64-bit architectures, redefine NULL as 64-bit constant 0.
 108 //
 109 // Note: this fix doesn't work well on Linux because NULL will be overwritten
 110 // whenever a system header file is included. Linux handles NULL correctly
 111 // through a special type '__null'.
 112 #ifdef SOLARIS
 113   #ifdef _LP64
 114     #undef NULL
 115     #define NULL 0L
 116   #else
 117     #ifndef NULL
 118       #define NULL 0
 119     #endif
 120   #endif
 121 #endif
 122 
 123 // NULL vs NULL_WORD:
 124 // On Linux NULL is defined as a special type '__null'. Assigning __null to
 125 // integer variable will cause gcc warning. Use NULL_WORD in places where a
 126 // pointer is stored as integer value.  On some platforms, sizeof(intptr_t) >
 127 // sizeof(void*), so here we want something which is integer type, but has the
 128 // same size as a pointer.
 129 #ifdef __GNUC__
 130   #ifdef _LP64
 131     #define NULL_WORD  0L
 132   #else
 133     // Cast 0 to intptr_t rather than int32_t since they are not the same type
 134     // on platforms such as Mac OS X.
 135     #define NULL_WORD  ((intptr_t)0)
 136   #endif
 137 #else
 138   #define NULL_WORD  NULL
 139 #endif
 140 
 141 #if !defined(LINUX) && !defined(_ALLBSD_SOURCE)
 142 // Compiler-specific primitive types
 143 typedef unsigned short     uint16_t;
 144 #ifndef _UINT32_T
 145 #define _UINT32_T
 146 typedef unsigned int       uint32_t;
 147 #endif // _UINT32_T
 148 
 149 #if !defined(_SYS_INT_TYPES_H)
 150 #ifndef _UINT64_T
 151 #define _UINT64_T
 152 typedef unsigned long long uint64_t;
 153 #endif // _UINT64_T
 154 // %%%% how to access definition of intptr_t portably in 5.5 onward?
 155 typedef int                     intptr_t;
 156 typedef unsigned int            uintptr_t;
 157 // If this gets an error, figure out a symbol XXX that implies the
 158 // prior definition of intptr_t, and add "&& !defined(XXX)" above.
 159 #endif // _SYS_INT_TYPES_H
 160 
 161 #endif // !LINUX && !_ALLBSD_SOURCE
 162 
 163 // Additional Java basic types
 164 
 165 typedef uint8_t  jubyte;
 166 typedef uint16_t jushort;
 167 typedef uint32_t juint;
 168 typedef uint64_t julong;
 169 
 170 
 171 //----------------------------------------------------------------------------------------------------
 172 // Constant for jlong (specifying an long long canstant is C++ compiler specific)
 173 
 174 // Build a 64bit integer constant
 175 #define CONST64(x)  (x ## LL)
 176 #define UCONST64(x) (x ## ULL)
 177 
 178 const jlong min_jlong = CONST64(0x8000000000000000);
 179 const jlong max_jlong = CONST64(0x7fffffffffffffff);
 180 
 181 
 182 #ifdef SOLARIS
 183 //----------------------------------------------------------------------------------------------------
 184 // ANSI C++ fixes
 185 // NOTE:In the ANSI committee's continuing attempt to make each version
 186 // of C++ incompatible with the previous version, you can no longer cast
 187 // pointers to functions without specifying linkage unless you want to get
 188 // warnings.
 189 //
 190 // This also means that pointers to functions can no longer be "hidden"
 191 // in opaque types like void * because at the invokation point warnings
 192 // will be generated. While this makes perfect sense from a type safety
 193 // point of view it causes a lot of warnings on old code using C header
 194 // files. Here are some typedefs to make the job of silencing warnings
 195 // a bit easier.
 196 //
 197 // The final kick in the teeth is that you can only have extern "C" linkage
 198 // specified at file scope. So these typedefs are here rather than in the
 199 // .hpp for the class (os:Solaris usually) that needs them.
 200 
 201 extern "C" {
 202    typedef int (*int_fnP_thread_t_iP_uP_stack_tP_gregset_t)(thread_t, int*, unsigned *, stack_t*, gregset_t);
 203    typedef int (*int_fnP_thread_t_i_gregset_t)(thread_t, int, gregset_t);
 204    typedef int (*int_fnP_thread_t_i)(thread_t, int);
 205    typedef int (*int_fnP_thread_t)(thread_t);
 206 
 207    typedef int (*int_fnP_cond_tP_mutex_tP_timestruc_tP)(cond_t *cv, mutex_t *mx, timestruc_t *abst);
 208    typedef int (*int_fnP_cond_tP_mutex_tP)(cond_t *cv, mutex_t *mx);
 209 
 210    // typedef for missing API in libc
 211    typedef int (*int_fnP_mutex_tP_i_vP)(mutex_t *, int, void *);
 212    typedef int (*int_fnP_mutex_tP)(mutex_t *);
 213    typedef int (*int_fnP_cond_tP_i_vP)(cond_t *cv, int scope, void *arg);
 214    typedef int (*int_fnP_cond_tP)(cond_t *cv);
 215 };
 216 #endif // SOLARIS
 217 
 218 //----------------------------------------------------------------------------------------------------
 219 // Debugging
 220 
 221 #define DEBUG_EXCEPTION ::abort();
 222 
 223 #ifdef ARM32
 224 #ifdef SOLARIS
 225 #define BREAKPOINT __asm__ volatile (".long 0xe1200070")
 226 #else
 227 #define BREAKPOINT __asm__ volatile (".long 0xe7f001f0")
 228 #endif
 229 #else
 230 extern "C" void breakpoint();
 231 #define BREAKPOINT ::breakpoint()
 232 #endif
 233 
 234 // checking for nanness
 235 #ifdef SOLARIS
 236 #ifdef SPARC
 237 inline int g_isnan(float  f) { return isnanf(f); }
 238 #else
 239 // isnanf() broken on Intel Solaris use isnand()
 240 inline int g_isnan(float  f) { return isnand(f); }
 241 #endif
 242 inline int g_isnan(double f) { return isnand(f); }
 243 #elif defined(__APPLE__)
 244 inline int g_isnan(double f) { return isnan(f); }
 245 #elif defined(LINUX) || defined(_ALLBSD_SOURCE)
 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 // Diagnostic pragmas like the ones defined below in PRAGMA_FORMAT_NONLITERAL_IGNORED
 275 // were only introduced in GCC 4.2. Because we have no other possibility to ignore
 276 // these warnings for older versions of GCC, we simply don't decorate our printf-style
 277 // functions with __attribute__(format) in that case.
 278 #if ((__GNUC__ == 4) && (__GNUC_MINOR__ >= 2)) || (__GNUC__ > 4)
 279 #ifndef ATTRIBUTE_PRINTF
 280 #define ATTRIBUTE_PRINTF(fmt,vargs)  __attribute__((format(printf, fmt, vargs)))
 281 #endif
 282 #ifndef ATTRIBUTE_SCANF
 283 #define ATTRIBUTE_SCANF(fmt,vargs)  __attribute__((format(scanf, fmt, vargs)))
 284 #endif
 285 #endif
 286 
 287 #define PRAGMA_FORMAT_NONLITERAL_IGNORED _Pragma("GCC diagnostic ignored \"-Wformat-nonliteral\"") \
 288                                          _Pragma("GCC diagnostic ignored \"-Wformat-security\"")
 289 #define PRAGMA_FORMAT_IGNORED _Pragma("GCC diagnostic ignored \"-Wformat\"")
 290 
 291 #if defined(__clang_major__) && \
 292       (__clang_major__ >= 4 || \
 293       (__clang_major__ >= 3 && __clang_minor__ >= 1)) || \
 294     ((__GNUC__ == 4) && (__GNUC_MINOR__ >= 6)) || (__GNUC__ > 4)
 295 // Tested to work with clang version 3.1 and better.
 296 #define PRAGMA_DIAG_PUSH             _Pragma("GCC diagnostic push")
 297 #define PRAGMA_DIAG_POP              _Pragma("GCC diagnostic pop")
 298 #define PRAGMA_FORMAT_NONLITERAL_IGNORED_EXTERNAL
 299 #define PRAGMA_FORMAT_NONLITERAL_IGNORED_INTERNAL PRAGMA_FORMAT_NONLITERAL_IGNORED
 300 
 301 // Hack to deal with gcc yammering about non-security format stuff
 302 #else
 303 // Old versions of gcc don't do push/pop, also do not cope with this pragma within a function
 304 // One method does so much varied printing that it is decorated with both internal and external
 305 // versions of the macro-pragma to obtain better checking with newer compilers.
 306 #define PRAGMA_DIAG_PUSH
 307 #define PRAGMA_DIAG_POP
 308 #define PRAGMA_FORMAT_NONLITERAL_IGNORED_EXTERNAL PRAGMA_FORMAT_NONLITERAL_IGNORED
 309 #define PRAGMA_FORMAT_NONLITERAL_IGNORED_INTERNAL
 310 #endif
 311 
 312 #ifndef __clang_major__
 313 #define PRAGMA_FORMAT_MUTE_WARNINGS_FOR_GCC _Pragma("GCC diagnostic ignored \"-Wformat\"") _Pragma("GCC diagnostic error \"-Wformat-nonliteral\"") _Pragma("GCC diagnostic error \"-Wformat-security\"")
 314 #endif
 315 
 316 #if (__GNUC__ == 2) && (__GNUC_MINOR__ < 95)
 317 #define TEMPLATE_TABLE_BUG
 318 #endif
 319 #if (__GNUC__ == 2) && (__GNUC_MINOR__ >= 96)
 320 #define CONST_SDM_BUG
 321 #endif
 322 
 323 // Formatting.
 324 #ifdef _LP64
 325 #define FORMAT64_MODIFIER "l"
 326 #else // !_LP64
 327 #define FORMAT64_MODIFIER "ll"
 328 #endif // _LP64
 329 
 330 // HACK: gcc warns about applying offsetof() to non-POD object or calculating
 331 //       offset directly when base address is NULL. Use 16 to get around the
 332 //       warning. gcc-3.4 has an option -Wno-invalid-offsetof to suppress
 333 //       this warning.
 334 #define offset_of(klass,field) (size_t)((intx)&(((klass*)16)->field) - 16)
 335 
 336 #ifdef offsetof
 337 # undef offsetof
 338 #endif
 339 #define offsetof(klass,field) offset_of(klass,field)
 340 
 341 #if defined(_LP64) && defined(__APPLE__)
 342 #define JLONG_FORMAT           "%ld"
 343 #endif // _LP64 && __APPLE__
 344 
 345 #endif // SHARE_VM_UTILITIES_GLOBALDEFINITIONS_GCC_HPP