1 /*
  2  * Copyright (c) 1997, 2017, 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_MACROS_HPP
 26 #define SHARE_VM_UTILITIES_MACROS_HPP
 27 
 28 // Use this to mark code that needs to be cleaned up (for development only)
 29 #define NEEDS_CLEANUP
 30 
 31 // Makes a string of the argument (which is not macro-expanded)
 32 #define STR(a)  #a
 33 
 34 // Makes a string of the macro expansion of a
 35 #define XSTR(a) STR(a)
 36 
 37 // Allow commas in macro arguments.
 38 #define COMMA ,
 39 
 40 // Apply pre-processor token pasting to the expansions of x and y.
 41 // The token pasting operator (##) prevents its arguments from being
 42 // expanded.  This macro allows expansion of its arguments before the
 43 // concatenation is performed.  Note: One auxilliary level ought to be
 44 // sufficient, but two are used because of bugs in some preprocesors.
 45 #define PASTE_TOKENS(x, y) PASTE_TOKENS_AUX(x, y)
 46 #define PASTE_TOKENS_AUX(x, y) PASTE_TOKENS_AUX2(x, y)
 47 #define PASTE_TOKENS_AUX2(x, y) x ## y
 48 
 49 // -DINCLUDE_<something>=0 | 1 can be specified on the command line to include
 50 // or exclude functionality.
 51 
 52 #ifndef INCLUDE_JVMTI
 53 #define INCLUDE_JVMTI 1
 54 #endif  // INCLUDE_JVMTI
 55 
 56 #if INCLUDE_JVMTI
 57 #define JVMTI_ONLY(x) x
 58 #define NOT_JVMTI(x)
 59 #define NOT_JVMTI_RETURN
 60 #define NOT_JVMTI_RETURN_(code) /* next token must be ; */
 61 #else
 62 #define JVMTI_ONLY(x)
 63 #define NOT_JVMTI(x) x
 64 #define NOT_JVMTI_RETURN { return; }
 65 #define NOT_JVMTI_RETURN_(code) { return code; }
 66 #endif // INCLUDE_JVMTI
 67 
 68 #ifndef INCLUDE_VM_STRUCTS
 69 #define INCLUDE_VM_STRUCTS 1
 70 #endif
 71 
 72 #if INCLUDE_VM_STRUCTS
 73 #define NOT_VM_STRUCTS_RETURN        /* next token must be ; */
 74 #define NOT_VM_STRUCTS_RETURN_(code) /* next token must be ; */
 75 #else
 76 #define NOT_VM_STRUCTS_RETURN           {}
 77 #define NOT_VM_STRUCTS_RETURN_(code) { return code; }
 78 #endif // INCLUDE_VM_STRUCTS
 79 
 80 #ifndef INCLUDE_JNI_CHECK
 81 #define INCLUDE_JNI_CHECK 1
 82 #endif
 83 
 84 #if INCLUDE_JNI_CHECK
 85 #define NOT_JNI_CHECK_RETURN        /* next token must be ; */
 86 #define NOT_JNI_CHECK_RETURN_(code) /* next token must be ; */
 87 #else
 88 #define NOT_JNI_CHECK_RETURN            {}
 89 #define NOT_JNI_CHECK_RETURN_(code) { return code; }
 90 #endif // INCLUDE_JNI_CHECK
 91 
 92 #ifndef INCLUDE_SERVICES
 93 #define INCLUDE_SERVICES 1
 94 #endif
 95 
 96 #if INCLUDE_SERVICES
 97 #define NOT_SERVICES_RETURN        /* next token must be ; */
 98 #define NOT_SERVICES_RETURN_(code) /* next token must be ; */
 99 #else
100 #define NOT_SERVICES_RETURN             {}
101 #define NOT_SERVICES_RETURN_(code) { return code; }
102 #endif // INCLUDE_SERVICES
103 
104 #ifndef INCLUDE_CDS
105 #define INCLUDE_CDS 1
106 #endif
107 
108 #if INCLUDE_CDS
109 #define CDS_ONLY(x) x
110 #define NOT_CDS(x)
111 #define NOT_CDS_RETURN        /* next token must be ; */
112 #define NOT_CDS_RETURN0       /* next token must be ; */
113 #define NOT_CDS_RETURN_(code) /* next token must be ; */
114 #else
115 #define CDS_ONLY(x)
116 #define NOT_CDS(x) x
117 #define NOT_CDS_RETURN        {}
118 #define NOT_CDS_RETURN0       { return 0; }
119 #define NOT_CDS_RETURN_(code) { return code; }
120 #endif // INCLUDE_CDS
121 
122 #ifndef INCLUDE_MANAGEMENT
123 #define INCLUDE_MANAGEMENT 1
124 #endif // INCLUDE_MANAGEMENT
125 
126 #if INCLUDE_MANAGEMENT
127 #define NOT_MANAGEMENT_RETURN        /* next token must be ; */
128 #define NOT_MANAGEMENT_RETURN_(code) /* next token must be ; */
129 #else
130 #define NOT_MANAGEMENT_RETURN        {}
131 #define NOT_MANAGEMENT_RETURN_(code) { return code; }
132 #endif // INCLUDE_MANAGEMENT
133 
134 /*
135  * When INCLUDE_ALL_GCS is false the only garbage collectors
136  * included in the JVM are defaultNewGeneration and markCompact.
137  *
138  * When INCLUDE_ALL_GCS is true all garbage collectors are
139  * included in the JVM.
140  */
141 #ifndef INCLUDE_ALL_GCS
142 #define INCLUDE_ALL_GCS 1
143 #endif // INCLUDE_ALL_GCS
144 
145 #if INCLUDE_ALL_GCS
146 #define ALL_GCS_ONLY(x) x
147 #define NOT_ALL_GCS_RETURN        /* next token must be ; */
148 #define NOT_ALL_GCS_RETURN_(code) /* next token must be ; */
149 #else
150 #define ALL_GCS_ONLY(x)
151 #define NOT_ALL_GCS_RETURN        {}
152 #define NOT_ALL_GCS_RETURN_(code) { return code; }
153 #endif // INCLUDE_ALL_GCS
154 
155 #ifndef INCLUDE_NMT
156 #define INCLUDE_NMT 1
157 #endif // INCLUDE_NMT
158 
159 #if INCLUDE_NMT
160 #define NOT_NMT_RETURN        /* next token must be ; */
161 #define NOT_NMT_RETURN_(code) /* next token must be ; */
162 #else
163 #define NOT_NMT_RETURN        {}
164 #define NOT_NMT_RETURN_(code) { return code; }
165 #endif // INCLUDE_NMT
166 
167 #ifndef INCLUDE_TRACE
168 #define INCLUDE_TRACE 1
169 #endif // INCLUDE_TRACE
170 
171 #ifndef INCLUDE_JVMCI
172 #define INCLUDE_JVMCI 1
173 #endif
174 
175 #ifdef INCLUDE_AOT
176 # if INCLUDE_AOT && !(INCLUDE_JVMCI)
177 #   error "Must have JVMCI for AOT"
178 # endif
179 #else
180 # define INCLUDE_AOT 0
181 #endif
182 
183 #if INCLUDE_JVMCI
184 #define JVMCI_ONLY(code) code
185 #define NOT_JVMCI(code)
186 #define NOT_JVMCI_RETURN /* next token must be ; */
187 #else
188 #define JVMCI_ONLY(code)
189 #define NOT_JVMCI(code) code
190 #define NOT_JVMCI_RETURN {}
191 #endif // INCLUDE_JVMCI
192 
193 #if INCLUDE_AOT
194 #define AOT_ONLY(code) code
195 #define NOT_AOT(code)
196 #define NOT_AOT_RETURN /* next token must be ; */
197 #else
198 #define AOT_ONLY(code)
199 #define NOT_AOT(code) code
200 #define NOT_AOT_RETURN {}
201 #endif // INCLUDE_AOT
202 
203 // COMPILER1 variant
204 #ifdef COMPILER1
205 #ifdef COMPILER2
206   #define TIERED
207 #endif
208 #define COMPILER1_PRESENT(code) code
209 #define NOT_COMPILER1(code)
210 #else // COMPILER1
211 #define COMPILER1_PRESENT(code)
212 #define NOT_COMPILER1(code) code
213 #endif // COMPILER1
214 
215 // COMPILER2 variant
216 #ifdef COMPILER2
217 #define COMPILER2_PRESENT(code) code
218 #define NOT_COMPILER2(code)
219 #else // COMPILER2
220 #define COMPILER2_PRESENT(code)
221 #define NOT_COMPILER2(code) code
222 #endif // COMPILER2
223 
224 // COMPILER2 or JVMCI
225 #if defined(COMPILER2) || INCLUDE_JVMCI
226 #define COMPILER2_OR_JVMCI 1
227 #define COMPILER2_OR_JVMCI_PRESENT(code) code
228 #define NOT_COMPILER2_OR_JVMCI(code)
229 #else
230 #define COMPILER2_OR_JVMCI 0
231 #define COMPILER2_OR_JVMCI_PRESENT(code)
232 #define NOT_COMPILER2_OR_JVMCI(code) code
233 #endif
234 
235 #ifdef TIERED
236 #define TIERED_ONLY(code) code
237 #define NOT_TIERED(code)
238 #else // TIERED
239 #define TIERED_ONLY(code)
240 #define NOT_TIERED(code) code
241 #endif // TIERED
242 
243 
244 // PRODUCT variant
245 #ifdef PRODUCT
246 #define PRODUCT_ONLY(code) code
247 #define NOT_PRODUCT(code)
248 #define NOT_PRODUCT_ARG(arg)
249 #define PRODUCT_RETURN  {}
250 #define PRODUCT_RETURN0 { return 0; }
251 #define PRODUCT_RETURN_(code) { code }
252 #else // PRODUCT
253 #define PRODUCT_ONLY(code)
254 #define NOT_PRODUCT(code) code
255 #define NOT_PRODUCT_ARG(arg) arg,
256 #define PRODUCT_RETURN  /*next token must be ;*/
257 #define PRODUCT_RETURN0 /*next token must be ;*/
258 #define PRODUCT_RETURN_(code)  /*next token must be ;*/
259 #endif // PRODUCT
260 
261 #ifdef CHECK_UNHANDLED_OOPS
262 #define CHECK_UNHANDLED_OOPS_ONLY(code) code
263 #define NOT_CHECK_UNHANDLED_OOPS(code)
264 #else
265 #define CHECK_UNHANDLED_OOPS_ONLY(code)
266 #define NOT_CHECK_UNHANDLED_OOPS(code)  code
267 #endif // CHECK_UNHANDLED_OOPS
268 
269 #ifdef CC_INTERP
270 #define CC_INTERP_ONLY(code) code
271 #define NOT_CC_INTERP(code)
272 #else
273 #define CC_INTERP_ONLY(code)
274 #define NOT_CC_INTERP(code) code
275 #endif // CC_INTERP
276 
277 #ifdef ASSERT
278 #define DEBUG_ONLY(code) code
279 #define NOT_DEBUG(code)
280 #define NOT_DEBUG_RETURN  /*next token must be ;*/
281 // Historical.
282 #define debug_only(code) code
283 #else // ASSERT
284 #define DEBUG_ONLY(code)
285 #define NOT_DEBUG(code) code
286 #define NOT_DEBUG_RETURN {}
287 #define debug_only(code)
288 #endif // ASSERT
289 
290 #ifdef  _LP64
291 #define LP64_ONLY(code) code
292 #define NOT_LP64(code)
293 #else  // !_LP64
294 #define LP64_ONLY(code)
295 #define NOT_LP64(code) code
296 #endif // _LP64
297 
298 #ifdef LINUX
299 #define LINUX_ONLY(code) code
300 #define NOT_LINUX(code)
301 #else
302 #define LINUX_ONLY(code)
303 #define NOT_LINUX(code) code
304 #endif
305 
306 #ifdef AIX
307 #define AIX_ONLY(code) code
308 #define NOT_AIX(code)
309 #else
310 #define AIX_ONLY(code)
311 #define NOT_AIX(code) code
312 #endif
313 
314 #ifdef SOLARIS
315 #define SOLARIS_ONLY(code) code
316 #define NOT_SOLARIS(code)
317 #else
318 #define SOLARIS_ONLY(code)
319 #define NOT_SOLARIS(code) code
320 #endif
321 
322 #ifdef _WINDOWS
323 #define WINDOWS_ONLY(code) code
324 #define NOT_WINDOWS(code)
325 #else
326 #define WINDOWS_ONLY(code)
327 #define NOT_WINDOWS(code) code
328 #endif
329 
330 #if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__APPLE__)
331 #ifndef BSD
332 #define BSD
333 #endif // BSD defined in <sys/param.h>
334 #define BSD_ONLY(code) code
335 #define NOT_BSD(code)
336 #else
337 #define BSD_ONLY(code)
338 #define NOT_BSD(code) code
339 #endif
340 
341 #ifdef _WIN64
342 #define WIN64_ONLY(code) code
343 #define NOT_WIN64(code)
344 #else
345 #define WIN64_ONLY(code)
346 #define NOT_WIN64(code) code
347 #endif
348 
349 #if defined(ZERO)
350 #define ZERO_ONLY(code) code
351 #define NOT_ZERO(code)
352 #else
353 #define ZERO_ONLY(code)
354 #define NOT_ZERO(code) code
355 #endif
356 
357 #if defined(IA32) || defined(AMD64)
358 #define X86
359 #define X86_ONLY(code) code
360 #define NOT_X86(code)
361 #else
362 #undef X86
363 #define X86_ONLY(code)
364 #define NOT_X86(code) code
365 #endif
366 
367 #ifdef IA32
368 #define IA32_ONLY(code) code
369 #define NOT_IA32(code)
370 #else
371 #define IA32_ONLY(code)
372 #define NOT_IA32(code) code
373 #endif
374 
375 // This is a REALLY BIG HACK, but on AIX <sys/systemcfg.h> unconditionally defines IA64.
376 // At least on AIX 7.1 this is a real problem because 'systemcfg.h' is indirectly included
377 // by 'pthread.h' and other common system headers.
378 
379 #if defined(IA64) && !defined(AIX)
380 #define IA64_ONLY(code) code
381 #define NOT_IA64(code)
382 #else
383 #define IA64_ONLY(code)
384 #define NOT_IA64(code) code
385 #endif
386 
387 #ifdef AMD64
388 #define AMD64_ONLY(code) code
389 #define NOT_AMD64(code)
390 #else
391 #define AMD64_ONLY(code)
392 #define NOT_AMD64(code) code
393 #endif
394 
395 #ifdef S390
396 #define S390_ONLY(code) code
397 #define NOT_S390(code)
398 #else
399 #define S390_ONLY(code)
400 #define NOT_S390(code) code
401 #endif
402 
403 #ifdef SPARC
404 #define SPARC_ONLY(code) code
405 #define NOT_SPARC(code)
406 #else
407 #define SPARC_ONLY(code)
408 #define NOT_SPARC(code) code
409 #endif
410 
411 #if defined(PPC32) || defined(PPC64)
412 #ifndef PPC
413 #define PPC
414 #endif
415 #define PPC_ONLY(code) code
416 #define NOT_PPC(code)
417 #else
418 #undef PPC
419 #define PPC_ONLY(code)
420 #define NOT_PPC(code) code
421 #endif
422 
423 #ifdef PPC32
424 #define PPC32_ONLY(code) code
425 #define NOT_PPC32(code)
426 #else
427 #define PPC32_ONLY(code)
428 #define NOT_PPC32(code) code
429 #endif
430 
431 #ifdef PPC64
432 #define PPC64_ONLY(code) code
433 #define NOT_PPC64(code)
434 #else
435 #define PPC64_ONLY(code)
436 #define NOT_PPC64(code) code
437 #endif
438 
439 #ifdef E500V2
440 #define E500V2_ONLY(code) code
441 #define NOT_E500V2(code)
442 #else
443 #define E500V2_ONLY(code)
444 #define NOT_E500V2(code) code
445 #endif
446 
447 // Note: There are three ARM ports. They set the following in the makefiles:
448 // 1. Closed 32-bit port:   -DARM -DARM32           -DTARGET_ARCH_arm
449 // 2. Closed 64-bit port:   -DARM -DAARCH64 -D_LP64 -DTARGET_ARCH_arm
450 // 3. Open   64-bit port:         -DAARCH64 -D_LP64 -DTARGET_ARCH_aaarch64
451 #ifdef ARM
452 #define ARM_ONLY(code) code
453 #define NOT_ARM(code)
454 #else
455 #define ARM_ONLY(code)
456 #define NOT_ARM(code) code
457 #endif
458 
459 #ifdef ARM32
460 #define ARM32_ONLY(code) code
461 #define NOT_ARM32(code)
462 #else
463 #define ARM32_ONLY(code)
464 #define NOT_ARM32(code) code
465 #endif
466 
467 #ifdef AARCH64
468 #define AARCH64_ONLY(code) code
469 #define NOT_AARCH64(code)
470 #else
471 #define AARCH64_ONLY(code)
472 #define NOT_AARCH64(code) code
473 #endif
474 
475 #define define_pd_global(type, name, value) const type pd_##name = value;
476 
477 // Helper macros for constructing file names for includes.
478 #define CPU_HEADER_STEM(basename) PASTE_TOKENS(basename, INCLUDE_SUFFIX_CPU)
479 #define OS_HEADER_STEM(basename) PASTE_TOKENS(basename, INCLUDE_SUFFIX_OS)
480 #define OS_CPU_HEADER_STEM(basename) PASTE_TOKENS(basename, PASTE_TOKENS(INCLUDE_SUFFIX_OS, INCLUDE_SUFFIX_CPU))
481 #define COMPILER_HEADER_STEM(basename) PASTE_TOKENS(basename, INCLUDE_SUFFIX_COMPILER)
482 
483 // Include platform dependent files.
484 //
485 // This macro constructs from basename and INCLUDE_SUFFIX_OS /
486 // INCLUDE_SUFFIX_CPU / INCLUDE_SUFFIX_COMPILER, which are set on
487 // the command line, the name of platform dependent files to be included.
488 // Example: INCLUDE_SUFFIX_OS=_linux / INCLUDE_SUFFIX_CPU=_sparc
489 //   CPU_HEADER_INLINE(macroAssembler) --> macroAssembler_sparc.inline.hpp
490 //   OS_CPU_HEADER(vmStructs)          --> vmStructs_linux_sparc.hpp
491 //
492 // basename<cpu>.hpp / basename<cpu>.inline.hpp
493 #define CPU_HEADER_H(basename)         XSTR(CPU_HEADER_STEM(basename).h)
494 #define CPU_HEADER(basename)           XSTR(CPU_HEADER_STEM(basename).hpp)
495 #define CPU_HEADER_INLINE(basename)    XSTR(CPU_HEADER_STEM(basename).inline.hpp)
496 // basename<os>.hpp / basename<os>.inline.hpp
497 #define OS_HEADER_H(basename)          XSTR(OS_HEADER_STEM(basename).h)
498 #define OS_HEADER(basename)            XSTR(OS_HEADER_STEM(basename).hpp)
499 #define OS_HEADER_INLINE(basename)     XSTR(OS_HEADER_STEM(basename).inline.hpp)
500 // basename<os><cpu>.hpp / basename<os><cpu>.inline.hpp
501 #define OS_CPU_HEADER(basename)        XSTR(OS_CPU_HEADER_STEM(basename).hpp)
502 #define OS_CPU_HEADER_INLINE(basename) XSTR(OS_CPU_HEADER_STEM(basename).inline.hpp)
503 // basename<compiler>.hpp / basename<compiler>.inline.hpp
504 #define COMPILER_HEADER(basename)        XSTR(COMPILER_HEADER_STEM(basename).hpp)
505 #define COMPILER_HEADER_INLINE(basename) XSTR(COMPILER_HEADER_STEM(basename).inline.hpp)
506 
507 // To use Atomic::inc(jshort* dest) and Atomic::dec(jshort* dest), the address must be specially
508 // aligned, such that (*dest) occupies the upper 16 bits of an aligned 32-bit word. The best way to
509 // achieve is to place your short value next to another short value, which doesn't need atomic ops.
510 //
511 // Example
512 //  ATOMIC_SHORT_PAIR(
513 //    volatile short _refcount,  // needs atomic operation
514 //    unsigned short _length     // number of UTF8 characters in the symbol (does not need atomic op)
515 //  );
516 
517 #ifdef VM_LITTLE_ENDIAN
518   #define ATOMIC_SHORT_PAIR(atomic_decl, non_atomic_decl)  \
519     non_atomic_decl;                                       \
520     atomic_decl
521 #else
522   #define ATOMIC_SHORT_PAIR(atomic_decl, non_atomic_decl)  \
523     atomic_decl;                                           \
524     non_atomic_decl
525 #endif
526 
527 #if INCLUDE_CDS && INCLUDE_ALL_GCS && defined(_LP64) && !defined(_WINDOWS)
528 #define INCLUDE_CDS_JAVA_HEAP 1
529 #define CDS_JAVA_HEAP_ONLY(x) x
530 #define NOT_CDS_JAVA_HEAP(x)
531 #define NOT_CDS_JAVA_HEAP_RETURN
532 #define NOT_CDS_JAVA_HEAP_RETURN_(code)
533 #else
534 #define INCLUDE_CDS_JAVA_HEAP 0
535 #define CDS_JAVA_HEAP_ONLY(x)
536 #define NOT_CDS_JAVA_HEAP(x) x
537 #define NOT_CDS_JAVA_HEAP_RETURN        {}
538 #define NOT_CDS_JAVA_HEAP_RETURN_(code) { return code; }
539 #endif
540 
541 #endif // SHARE_VM_UTILITIES_MACROS_HPP