1/*
2 * Copyright (c) 1998, 2019, 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_UTILITIES_GLOBALDEFINITIONS_GCC_HPP
26#define SHARE_UTILITIES_GLOBALDEFINITIONS_GCC_HPP
27
28#include "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#include <time.h>
48#include <fcntl.h>
49#include <dlfcn.h>
50#include <pthread.h>
51
52#ifdef SOLARIS
53#include <thread.h>
54#endif // SOLARIS
55
56#include <limits.h>
57#include <errno.h>
58
59#ifdef SOLARIS
60#include <sys/trap.h>
61#include <sys/regset.h>
62#include <sys/procset.h>
63#include <ucontext.h>
64#include <setjmp.h>
65#endif // SOLARIS
66
67# ifdef SOLARIS_MUTATOR_LIBTHREAD
68# include <sys/procfs.h>
69# endif
70
71#if defined(LINUX) || defined(_ALLBSD_SOURCE)
72#include <inttypes.h>
73#include <signal.h>
74#ifndef __OpenBSD__
75#include <ucontext.h>
76#endif
77#ifdef __APPLE__
78 #include <AvailabilityMacros.h>
79 #include <mach/mach.h>
80#endif
81#include <sys/time.h>
82#endif // LINUX || _ALLBSD_SOURCE
83
84// 4810578: varargs unsafe on 32-bit integer/64-bit pointer architectures
85// When __cplusplus is defined, NULL is defined as 0 (32-bit constant) in
86// system header files. On 32-bit architectures, there is no problem.
87// On 64-bit architectures, defining NULL as a 32-bit constant can cause
88// problems with varargs functions: C++ integral promotion rules say for
89// varargs, we pass the argument 0 as an int. So, if NULL was passed to a
90// varargs function it will remain 32-bits. Depending on the calling
91// convention of the machine, if the argument is passed on the stack then
92// only 32-bits of the "NULL" pointer may be initialized to zero. The
93// other 32-bits will be garbage. If the varargs function is expecting a
94// pointer when it extracts the argument, then we have a problem.
95//
96// Solution: For 64-bit architectures, redefine NULL as 64-bit constant 0.
97//
98// Note: this fix doesn't work well on Linux because NULL will be overwritten
99// whenever a system header file is included. Linux handles NULL correctly
100// through a special type '__null'.
101#ifdef SOLARIS
102 #ifdef _LP64
103 #undef NULL
104 #define NULL 0L
105 #else
106 #ifndef NULL
107 #define NULL 0
108 #endif
109 #endif
110#endif
111
112// NULL vs NULL_WORD:
113// On Linux NULL is defined as a special type '__null'. Assigning __null to
114// integer variable will cause gcc warning. Use NULL_WORD in places where a
115// pointer is stored as integer value. On some platforms, sizeof(intptr_t) >
116// sizeof(void*), so here we want something which is integer type, but has the
117// same size as a pointer.
118#ifdef __GNUC__
119 #ifdef _LP64
120 #define NULL_WORD 0L
121 #else
122 // Cast 0 to intptr_t rather than int32_t since they are not the same type
123 // on platforms such as Mac OS X.
124 #define NULL_WORD ((intptr_t)0)
125 #endif
126#else
127 #define NULL_WORD NULL
128#endif
129
130#if !defined(LINUX) && !defined(_ALLBSD_SOURCE)
131// Compiler-specific primitive types
132typedef unsigned short uint16_t;
133#ifndef _UINT32_T
134#define _UINT32_T
135typedef unsigned int uint32_t;
136#endif // _UINT32_T
137
138#if !defined(_SYS_INT_TYPES_H)
139#ifndef _UINT64_T
140#define _UINT64_T
141typedef unsigned long long uint64_t;
142#endif // _UINT64_T
143// %%%% how to access definition of intptr_t portably in 5.5 onward?
144typedef int intptr_t;
145typedef unsigned int uintptr_t;
146// If this gets an error, figure out a symbol XXX that implies the
147// prior definition of intptr_t, and add "&& !defined(XXX)" above.
148#endif // _SYS_INT_TYPES_H
149
150#endif // !LINUX && !_ALLBSD_SOURCE
151
152// Additional Java basic types
153
154typedef uint8_t jubyte;
155typedef uint16_t jushort;
156typedef uint32_t juint;
157typedef uint64_t julong;
158
159
160#ifdef SOLARIS
161// ANSI C++ fixes
162// NOTE:In the ANSI committee's continuing attempt to make each version
163// of C++ incompatible with the previous version, you can no longer cast
164// pointers to functions without specifying linkage unless you want to get
165// warnings.
166//
167// This also means that pointers to functions can no longer be "hidden"
168// in opaque types like void * because at the invokation point warnings
169// will be generated. While this makes perfect sense from a type safety
170// point of view it causes a lot of warnings on old code using C header
171// files. Here are some typedefs to make the job of silencing warnings
172// a bit easier.
173//
174// The final kick in the teeth is that you can only have extern "C" linkage
175// specified at file scope. So these typedefs are here rather than in the
176// .hpp for the class (os:Solaris usually) that needs them.
177
178extern "C" {
179 typedef int (*int_fnP_thread_t_iP_uP_stack_tP_gregset_t)(thread_t, int*, unsigned *, stack_t*, gregset_t);
180 typedef int (*int_fnP_thread_t_i_gregset_t)(thread_t, int, gregset_t);
181 typedef int (*int_fnP_thread_t_i)(thread_t, int);
182 typedef int (*int_fnP_thread_t)(thread_t);
183
184 typedef int (*int_fnP_cond_tP_mutex_tP_timestruc_tP)(cond_t *cv, mutex_t *mx, timestruc_t *abst);
185 typedef int (*int_fnP_cond_tP_mutex_tP)(cond_t *cv, mutex_t *mx);
186
187 // typedef for missing API in libc
188 typedef int (*int_fnP_mutex_tP_i_vP)(mutex_t *, int, void *);
189 typedef int (*int_fnP_mutex_tP)(mutex_t *);
190 typedef int (*int_fnP_cond_tP_i_vP)(cond_t *cv, int scope, void *arg);
191 typedef int (*int_fnP_cond_tP)(cond_t *cv);
192};
193#endif // SOLARIS
194
195// checking for nanness
196#ifdef SOLARIS
197#ifdef SPARC
198inline int g_isnan(float f) { return isnanf(f); }
199#else
200// isnanf() broken on Intel Solaris use isnand()
201inline int g_isnan(float f) { return isnand(f); }
202#endif
203inline int g_isnan(double f) { return isnand(f); }
204#elif defined(__APPLE__)
205inline int g_isnan(double f) { return isnan(f); }
206#elif defined(LINUX) || defined(_ALLBSD_SOURCE)
207inline int g_isnan(float f) { return isnanf(f); }
208inline int g_isnan(double f) { return isnan(f); }
209#else
210#error "missing platform-specific definition here"
211#endif
212
213// GCC 4.3 does not allow 0.0/0.0 to produce a NAN value
214#if (__GNUC__ == 4) && (__GNUC_MINOR__ > 2)
215#define CAN_USE_NAN_DEFINE 1
216#endif
217
218
219// Checking for finiteness
220
221inline int g_isfinite(jfloat f) { return isfinite(f); }
222inline int g_isfinite(jdouble f) { return isfinite(f); }
223
224
225// Wide characters
226
227inline int wcslen(const jchar* x) { return wcslen((const wchar_t*)x); }
228
229
230// Formatting.
231#ifdef _LP64
232# ifdef __APPLE__
233# define FORMAT64_MODIFIER "ll"
234# else
235# define FORMAT64_MODIFIER "l"
236# endif
237#else // !_LP64
238#define FORMAT64_MODIFIER "ll"
239#endif // _LP64
240
241// HACK: gcc warns about applying offsetof() to non-POD object or calculating
242// offset directly when base address is NULL. Use 16 to get around the
243// warning. gcc-3.4 has an option -Wno-invalid-offsetof to suppress
244// this warning.
245#define offset_of(klass,field) (size_t)((intx)&(((klass*)16)->field) - 16)
246
247#ifdef offsetof
248# undef offsetof
249#endif
250#define offsetof(klass,field) offset_of(klass,field)
251
252#if defined(_LP64) && defined(__APPLE__)
253#define JLONG_FORMAT "%ld"
254#define JLONG_FORMAT_W(width) "%" #width "ld"
255#endif // _LP64 && __APPLE__
256
257#ifndef USE_LIBRARY_BASED_TLS_ONLY
258#define THREAD_LOCAL_DECL __thread
259#endif
260
261// Inlining support
262#define NOINLINE __attribute__ ((noinline))
263#define ALWAYSINLINE inline __attribute__ ((always_inline))
264
265// Alignment
266//
267// NOTE! The "+0" below is a workaround for a known bug in older GCC versions
268// (known to fail with 4.6.0, fixed in 4.9.0). This bug affects systems such as
269// RedHat/Oracle Linux 7.5, which ships with GCC 4.8.5. For more details, see
270// https://gcc.gnu.org/bugzilla/show_bug.cgi?id=55382 and
271// https://gcc.gnu.org/bugzilla/show_bug.cgi?id=53017
272//
273// GCC versions older than 4.6.4 would fail even with "+0", and needs additional
274// cast to __typeof__(x) to work around the similar bug.
275//
276#define ATTRIBUTE_ALIGNED(x) __attribute__((aligned((__typeof__(x))x+0)))
277
278#endif // SHARE_UTILITIES_GLOBALDEFINITIONS_GCC_HPP
279