1 /*
   2  * Copyright (c) 1997, 2018, 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 #ifndef INCLUDE_CMSGC
 135 #define INCLUDE_CMSGC 1
 136 #endif // INCLUDE_CMSGC
 137 
 138 #if INCLUDE_CMSGC
 139 #define CMSGC_ONLY(x) x
 140 #define CMSGC_ONLY_ARG(arg) arg,
 141 #define NOT_CMSGC(x)
 142 #define NOT_CMSGC_RETURN        /* next token must be ; */
 143 #define NOT_CMSGC_RETURN_(code) /* next token must be ; */
 144 #else
 145 #define CMSGC_ONLY(x)
 146 #define CMSGC_ONLY_ARG(x)
 147 #define NOT_CMSGC(x) x
 148 #define NOT_CMSGC_RETURN        {}
 149 #define NOT_CMSGC_RETURN_(code) { return code; }
 150 #endif // INCLUDE_CMSGC
 151 
 152 #ifndef INCLUDE_EPSILONGC
 153 #define INCLUDE_EPSILONGC 1
 154 #endif // INCLUDE_EPSILONGC
 155 
 156 #if INCLUDE_EPSILONGC
 157 #define EPSILONGC_ONLY(x) x
 158 #define EPSILONGC_ONLY_ARG(arg) arg,
 159 #define NOT_EPSILONGC(x)
 160 #define NOT_EPSILONGC_RETURN        /* next token must be ; */
 161 #define NOT_EPSILONGC_RETURN_(code) /* next token must be ; */
 162 #else
 163 #define EPSILONGC_ONLY(x)
 164 #define EPSILONGC_ONLY_ARG(arg)
 165 #define NOT_EPSILONGC(x) x
 166 #define NOT_EPSILONGC_RETURN        {}
 167 #define NOT_EPSILONGC_RETURN_(code) { return code; }
 168 #endif // INCLUDE_EPSILONGC
 169 
 170 #ifndef INCLUDE_G1GC
 171 #define INCLUDE_G1GC 1
 172 #endif // INCLUDE_G1GC
 173 
 174 #if INCLUDE_G1GC
 175 #define G1GC_ONLY(x) x
 176 #define G1GC_ONLY_ARG(arg) arg,
 177 #define NOT_G1GC(x)
 178 #define NOT_G1GC_RETURN        /* next token must be ; */
 179 #define NOT_G1GC_RETURN_(code) /* next token must be ; */
 180 #else
 181 #define G1GC_ONLY(x)
 182 #define G1GC_ONLY_ARG(arg)
 183 #define NOT_G1GC(x) x
 184 #define NOT_G1GC_RETURN        {}
 185 #define NOT_G1GC_RETURN_(code) { return code; }
 186 #endif // INCLUDE_G1GC
 187 
 188 #ifndef INCLUDE_PARALLELGC
 189 #define INCLUDE_PARALLELGC 1
 190 #endif // INCLUDE_PARALLELGC
 191 
 192 #if INCLUDE_PARALLELGC
 193 #define PARALLELGC_ONLY(x) x
 194 #define PARALLELGC_ONLY_ARG(arg) arg,
 195 #define NOT_PARALLELGC(x)
 196 #define NOT_PARALLELGC_RETURN        /* next token must be ; */
 197 #define NOT_PARALLELGC_RETURN_(code) /* next token must be ; */
 198 #else
 199 #define PARALLELGC_ONLY(x)
 200 #define PARALLELGC_ONLY_ARG(arg)
 201 #define NOT_PARALLELGC(x) x
 202 #define NOT_PARALLELGC_RETURN        {}
 203 #define NOT_PARALLELGC_RETURN_(code) { return code; }
 204 #endif // INCLUDE_PARALLELGC
 205 
 206 #ifndef INCLUDE_SERIALGC
 207 #define INCLUDE_SERIALGC 1
 208 #endif // INCLUDE_SERIALGC
 209 
 210 #if INCLUDE_SERIALGC
 211 #define SERIALGC_ONLY(x) x
 212 #define SERIALGC_ONLY_ARG(arg) arg,
 213 #define NOT_SERIALGC(x)
 214 #define NOT_SERIALGC_RETURN        /* next token must be ; */
 215 #define NOT_SERIALGC_RETURN_(code) /* next token must be ; */
 216 #else
 217 #define SERIALGC_ONLY(x)
 218 #define SERIALGC_ONLY_ARG(arg)
 219 #define NOT_SERIALGC(x) x
 220 #define NOT_SERIALGC_RETURN        {}
 221 #define NOT_SERIALGC_RETURN_(code) { return code; }
 222 #endif // INCLUDE_SERIALGC
 223 
 224 #ifndef INCLUDE_ZGC
 225 #define INCLUDE_ZGC 1
 226 #endif // INCLUDE_ZGC
 227 
 228 #if INCLUDE_ZGC
 229 #define ZGC_ONLY(x) x
 230 #define ZGC_ONLY_ARG(arg) arg,
 231 #define NOT_ZGC(x)
 232 #define NOT_ZGC_RETURN        /* next token must be ; */
 233 #define NOT_ZGC_RETURN_(code) /* next token must be ; */
 234 #else
 235 #define ZGC_ONLY(x)
 236 #define ZGC_ONLY_ARG(arg)
 237 #define NOT_ZGC(x) x
 238 #define NOT_ZGC_RETURN        {}
 239 #define NOT_ZGC_RETURN_(code) { return code; }
 240 #endif // INCLUDE_ZGC
 241 
 242 #ifndef INCLUDE_NMT
 243 #define INCLUDE_NMT 1
 244 #endif // INCLUDE_NMT
 245 
 246 #if INCLUDE_NMT
 247 #define NOT_NMT_RETURN        /* next token must be ; */
 248 #define NOT_NMT_RETURN_(code) /* next token must be ; */
 249 #define NMT_ONLY(x) x
 250 #define NOT_NMT(x)
 251 #else
 252 #define NOT_NMT_RETURN        {}
 253 #define NOT_NMT_RETURN_(code) { return code; }
 254 #define NMT_ONLY(x)
 255 #define NOT_NMT(x) x
 256 #endif // INCLUDE_NMT
 257 
 258 #ifndef INCLUDE_JFR
 259 #define INCLUDE_JFR 1
 260 #endif
 261 
 262 #if INCLUDE_JFR
 263 #define JFR_ONLY(code) code
 264 #else
 265 #define JFR_ONLY(code)
 266 #endif
 267 
 268 #ifndef INCLUDE_JVMCI
 269 #define INCLUDE_JVMCI 1
 270 #endif
 271 
 272 #ifndef INCLUDE_AOT
 273 #define INCLUDE_AOT 1
 274 #endif
 275 
 276 #if INCLUDE_AOT && !INCLUDE_JVMCI
 277 #  error "Must have JVMCI for AOT"
 278 #endif
 279 
 280 #if INCLUDE_JVMCI
 281 #define JVMCI_ONLY(code) code
 282 #define NOT_JVMCI(code)
 283 #define NOT_JVMCI_RETURN /* next token must be ; */
 284 #else
 285 #define JVMCI_ONLY(code)
 286 #define NOT_JVMCI(code) code
 287 #define NOT_JVMCI_RETURN {}
 288 #endif // INCLUDE_JVMCI
 289 
 290 #if INCLUDE_AOT
 291 #define AOT_ONLY(code) code
 292 #define NOT_AOT(code)
 293 #define NOT_AOT_RETURN /* next token must be ; */
 294 #else
 295 #define AOT_ONLY(code)
 296 #define NOT_AOT(code) code
 297 #define NOT_AOT_RETURN {}
 298 #endif // INCLUDE_AOT
 299 
 300 // COMPILER1 variant
 301 #ifdef COMPILER1
 302 #ifdef COMPILER2
 303   #define TIERED
 304 #endif
 305 #define COMPILER1_PRESENT(code) code
 306 #define NOT_COMPILER1(code)
 307 #else // COMPILER1
 308 #define COMPILER1_PRESENT(code)
 309 #define NOT_COMPILER1(code) code
 310 #endif // COMPILER1
 311 
 312 // COMPILER2 variant
 313 #ifdef COMPILER2
 314 #define COMPILER2_PRESENT(code) code
 315 #define NOT_COMPILER2(code)
 316 #else // COMPILER2
 317 #define COMPILER2_PRESENT(code)
 318 #define NOT_COMPILER2(code) code
 319 #endif // COMPILER2
 320 
 321 // COMPILER2 or JVMCI
 322 #if defined(COMPILER2) || INCLUDE_JVMCI
 323 #define COMPILER2_OR_JVMCI 1
 324 #define COMPILER2_OR_JVMCI_PRESENT(code) code
 325 #define NOT_COMPILER2_OR_JVMCI(code)
 326 #else
 327 #define COMPILER2_OR_JVMCI 0
 328 #define COMPILER2_OR_JVMCI_PRESENT(code)
 329 #define NOT_COMPILER2_OR_JVMCI(code) code
 330 #endif
 331 
 332 #ifdef TIERED
 333 #define TIERED_ONLY(code) code
 334 #define NOT_TIERED(code)
 335 #else // TIERED
 336 #define TIERED_ONLY(code)
 337 #define NOT_TIERED(code) code
 338 #endif // TIERED
 339 
 340 
 341 // PRODUCT variant
 342 #ifdef PRODUCT
 343 #define PRODUCT_ONLY(code) code
 344 #define NOT_PRODUCT(code)
 345 #define NOT_PRODUCT_ARG(arg)
 346 #define PRODUCT_RETURN  {}
 347 #define PRODUCT_RETURN0 { return 0; }
 348 #define PRODUCT_RETURN_(code) { code }
 349 #else // PRODUCT
 350 #define PRODUCT_ONLY(code)
 351 #define NOT_PRODUCT(code) code
 352 #define NOT_PRODUCT_ARG(arg) arg,
 353 #define PRODUCT_RETURN  /*next token must be ;*/
 354 #define PRODUCT_RETURN0 /*next token must be ;*/
 355 #define PRODUCT_RETURN_(code)  /*next token must be ;*/
 356 #endif // PRODUCT
 357 
 358 #ifdef CHECK_UNHANDLED_OOPS
 359 #define CHECK_UNHANDLED_OOPS_ONLY(code) code
 360 #define NOT_CHECK_UNHANDLED_OOPS(code)
 361 #else
 362 #define CHECK_UNHANDLED_OOPS_ONLY(code)
 363 #define NOT_CHECK_UNHANDLED_OOPS(code)  code
 364 #endif // CHECK_UNHANDLED_OOPS
 365 
 366 #ifdef CC_INTERP
 367 #define CC_INTERP_ONLY(code) code
 368 #define NOT_CC_INTERP(code)
 369 #else
 370 #define CC_INTERP_ONLY(code)
 371 #define NOT_CC_INTERP(code) code
 372 #endif // CC_INTERP
 373 
 374 #ifdef ASSERT
 375 #define DEBUG_ONLY(code) code
 376 #define NOT_DEBUG(code)
 377 #define NOT_DEBUG_RETURN  /*next token must be ;*/
 378 // Historical.
 379 #define debug_only(code) code
 380 #else // ASSERT
 381 #define DEBUG_ONLY(code)
 382 #define NOT_DEBUG(code) code
 383 #define NOT_DEBUG_RETURN {}
 384 #define debug_only(code)
 385 #endif // ASSERT
 386 
 387 #ifdef  _LP64
 388 #define LP64_ONLY(code) code
 389 #define NOT_LP64(code)
 390 #else  // !_LP64
 391 #define LP64_ONLY(code)
 392 #define NOT_LP64(code) code
 393 #endif // _LP64
 394 
 395 #ifdef LINUX
 396 #define LINUX_ONLY(code) code
 397 #define NOT_LINUX(code)
 398 #else
 399 #define LINUX_ONLY(code)
 400 #define NOT_LINUX(code) code
 401 #endif
 402 
 403 #ifdef AIX
 404 #define AIX_ONLY(code) code
 405 #define NOT_AIX(code)
 406 #else
 407 #define AIX_ONLY(code)
 408 #define NOT_AIX(code) code
 409 #endif
 410 
 411 #ifdef SOLARIS
 412 #define SOLARIS_ONLY(code) code
 413 #define NOT_SOLARIS(code)
 414 #else
 415 #define SOLARIS_ONLY(code)
 416 #define NOT_SOLARIS(code) code
 417 #endif
 418 
 419 #ifdef _WINDOWS
 420 #define WINDOWS_ONLY(code) code
 421 #define NOT_WINDOWS(code)
 422 #else
 423 #define WINDOWS_ONLY(code)
 424 #define NOT_WINDOWS(code) code
 425 #endif
 426 
 427 #if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__APPLE__)
 428 #ifndef BSD
 429 #define BSD
 430 #endif // BSD defined in <sys/param.h>
 431 #define BSD_ONLY(code) code
 432 #define NOT_BSD(code)
 433 #else
 434 #define BSD_ONLY(code)
 435 #define NOT_BSD(code) code
 436 #endif
 437 
 438 #ifdef _WIN64
 439 #define WIN64_ONLY(code) code
 440 #define NOT_WIN64(code)
 441 #else
 442 #define WIN64_ONLY(code)
 443 #define NOT_WIN64(code) code
 444 #endif
 445 
 446 #if defined(ZERO)
 447 #define ZERO_ONLY(code) code
 448 #define NOT_ZERO(code)
 449 #else
 450 #define ZERO_ONLY(code)
 451 #define NOT_ZERO(code) code
 452 #endif
 453 
 454 #if defined(IA32) || defined(AMD64)
 455 #define X86
 456 #define X86_ONLY(code) code
 457 #define NOT_X86(code)
 458 #else
 459 #undef X86
 460 #define X86_ONLY(code)
 461 #define NOT_X86(code) code
 462 #endif
 463 
 464 #ifdef IA32
 465 #define IA32_ONLY(code) code
 466 #define NOT_IA32(code)
 467 #else
 468 #define IA32_ONLY(code)
 469 #define NOT_IA32(code) code
 470 #endif
 471 
 472 // This is a REALLY BIG HACK, but on AIX <sys/systemcfg.h> unconditionally defines IA64.
 473 // At least on AIX 7.1 this is a real problem because 'systemcfg.h' is indirectly included
 474 // by 'pthread.h' and other common system headers.
 475 
 476 #if defined(IA64) && !defined(AIX)
 477 #define IA64_ONLY(code) code
 478 #define NOT_IA64(code)
 479 #else
 480 #define IA64_ONLY(code)
 481 #define NOT_IA64(code) code
 482 #endif
 483 
 484 #ifdef AMD64
 485 #define AMD64_ONLY(code) code
 486 #define NOT_AMD64(code)
 487 #else
 488 #define AMD64_ONLY(code)
 489 #define NOT_AMD64(code) code
 490 #endif
 491 
 492 #ifdef S390
 493 #define S390_ONLY(code) code
 494 #define NOT_S390(code)
 495 #else
 496 #define S390_ONLY(code)
 497 #define NOT_S390(code) code
 498 #endif
 499 
 500 #ifdef SPARC
 501 #define SPARC_ONLY(code) code
 502 #define NOT_SPARC(code)
 503 #else
 504 #define SPARC_ONLY(code)
 505 #define NOT_SPARC(code) code
 506 #endif
 507 
 508 #if defined(PPC32) || defined(PPC64)
 509 #ifndef PPC
 510 #define PPC
 511 #endif
 512 #define PPC_ONLY(code) code
 513 #define NOT_PPC(code)
 514 #else
 515 #undef PPC
 516 #define PPC_ONLY(code)
 517 #define NOT_PPC(code) code
 518 #endif
 519 
 520 #ifdef PPC32
 521 #define PPC32_ONLY(code) code
 522 #define NOT_PPC32(code)
 523 #else
 524 #define PPC32_ONLY(code)
 525 #define NOT_PPC32(code) code
 526 #endif
 527 
 528 #ifdef PPC64
 529 #define PPC64_ONLY(code) code
 530 #define NOT_PPC64(code)
 531 #else
 532 #define PPC64_ONLY(code)
 533 #define NOT_PPC64(code) code
 534 #endif
 535 
 536 #ifdef E500V2
 537 #define E500V2_ONLY(code) code
 538 #define NOT_E500V2(code)
 539 #else
 540 #define E500V2_ONLY(code)
 541 #define NOT_E500V2(code) code
 542 #endif
 543 
 544 // Note: There are three ARM ports. They set the following in the makefiles:
 545 // 1. Closed 32-bit port:   -DARM -DARM32           -DTARGET_ARCH_arm
 546 // 2. Closed 64-bit port:   -DARM -DAARCH64 -D_LP64 -DTARGET_ARCH_arm
 547 // 3. Open   64-bit port:         -DAARCH64 -D_LP64 -DTARGET_ARCH_aaarch64
 548 #ifdef ARM
 549 #define ARM_ONLY(code) code
 550 #define NOT_ARM(code)
 551 #else
 552 #define ARM_ONLY(code)
 553 #define NOT_ARM(code) code
 554 #endif
 555 
 556 #ifdef ARM32
 557 #define ARM32_ONLY(code) code
 558 #define NOT_ARM32(code)
 559 #else
 560 #define ARM32_ONLY(code)
 561 #define NOT_ARM32(code) code
 562 #endif
 563 
 564 #ifdef AARCH64
 565 #define AARCH64_ONLY(code) code
 566 #define NOT_AARCH64(code)
 567 #else
 568 #define AARCH64_ONLY(code)
 569 #define NOT_AARCH64(code) code
 570 #endif
 571 
 572 #ifdef VM_LITTLE_ENDIAN
 573 #define LITTLE_ENDIAN_ONLY(code) code
 574 #define BIG_ENDIAN_ONLY(code)
 575 #else
 576 #define LITTLE_ENDIAN_ONLY(code)
 577 #define BIG_ENDIAN_ONLY(code) code
 578 #endif
 579 
 580 #define define_pd_global(type, name, value) const type pd_##name = value;
 581 
 582 // Helper macros for constructing file names for includes.
 583 #define CPU_HEADER_STEM(basename) PASTE_TOKENS(basename, INCLUDE_SUFFIX_CPU)
 584 #define OS_HEADER_STEM(basename) PASTE_TOKENS(basename, INCLUDE_SUFFIX_OS)
 585 #define OS_CPU_HEADER_STEM(basename) PASTE_TOKENS(basename, PASTE_TOKENS(INCLUDE_SUFFIX_OS, INCLUDE_SUFFIX_CPU))
 586 #define COMPILER_HEADER_STEM(basename) PASTE_TOKENS(basename, INCLUDE_SUFFIX_COMPILER)
 587 
 588 // Include platform dependent files.
 589 //
 590 // This macro constructs from basename and INCLUDE_SUFFIX_OS /
 591 // INCLUDE_SUFFIX_CPU / INCLUDE_SUFFIX_COMPILER, which are set on
 592 // the command line, the name of platform dependent files to be included.
 593 // Example: INCLUDE_SUFFIX_OS=_linux / INCLUDE_SUFFIX_CPU=_sparc
 594 //   CPU_HEADER_INLINE(macroAssembler) --> macroAssembler_sparc.inline.hpp
 595 //   OS_CPU_HEADER(vmStructs)          --> vmStructs_linux_sparc.hpp
 596 //
 597 // basename<cpu>.hpp / basename<cpu>.inline.hpp
 598 #define CPU_HEADER_H(basename)         XSTR(CPU_HEADER_STEM(basename).h)
 599 #define CPU_HEADER(basename)           XSTR(CPU_HEADER_STEM(basename).hpp)
 600 #define CPU_HEADER_INLINE(basename)    XSTR(CPU_HEADER_STEM(basename).inline.hpp)
 601 // basename<os>.hpp / basename<os>.inline.hpp
 602 #define OS_HEADER_H(basename)          XSTR(OS_HEADER_STEM(basename).h)
 603 #define OS_HEADER(basename)            XSTR(OS_HEADER_STEM(basename).hpp)
 604 #define OS_HEADER_INLINE(basename)     XSTR(OS_HEADER_STEM(basename).inline.hpp)
 605 // basename<os><cpu>.hpp / basename<os><cpu>.inline.hpp
 606 #define OS_CPU_HEADER(basename)        XSTR(OS_CPU_HEADER_STEM(basename).hpp)
 607 #define OS_CPU_HEADER_INLINE(basename) XSTR(OS_CPU_HEADER_STEM(basename).inline.hpp)
 608 // basename<compiler>.hpp / basename<compiler>.inline.hpp
 609 #define COMPILER_HEADER(basename)        XSTR(COMPILER_HEADER_STEM(basename).hpp)
 610 #define COMPILER_HEADER_INLINE(basename) XSTR(COMPILER_HEADER_STEM(basename).inline.hpp)
 611 
 612 // To use Atomic::inc(jshort* dest) and Atomic::dec(jshort* dest), the address must be specially
 613 // aligned, such that (*dest) occupies the upper 16 bits of an aligned 32-bit word. The best way to
 614 // achieve is to place your short value next to another short value, which doesn't need atomic ops.
 615 //
 616 // Example
 617 //  ATOMIC_SHORT_PAIR(
 618 //    volatile short _refcount,  // needs atomic operation
 619 //    unsigned short _length     // number of UTF8 characters in the symbol (does not need atomic op)
 620 //  );
 621 
 622 #ifdef VM_LITTLE_ENDIAN
 623   #define ATOMIC_SHORT_PAIR(atomic_decl, non_atomic_decl)  \
 624     non_atomic_decl;                                       \
 625     atomic_decl
 626 #else
 627   #define ATOMIC_SHORT_PAIR(atomic_decl, non_atomic_decl)  \
 628     atomic_decl;                                           \
 629     non_atomic_decl
 630 #endif
 631 
 632 #if INCLUDE_CDS && INCLUDE_G1GC && defined(_LP64) && !defined(_WINDOWS)
 633 #define INCLUDE_CDS_JAVA_HEAP 1
 634 #define CDS_JAVA_HEAP_ONLY(x) x
 635 #define NOT_CDS_JAVA_HEAP(x)
 636 #define NOT_CDS_JAVA_HEAP_RETURN
 637 #define NOT_CDS_JAVA_HEAP_RETURN_(code)
 638 #else
 639 #define INCLUDE_CDS_JAVA_HEAP 0
 640 #define CDS_JAVA_HEAP_ONLY(x)
 641 #define NOT_CDS_JAVA_HEAP(x) x
 642 #define NOT_CDS_JAVA_HEAP_RETURN        {}
 643 #define NOT_CDS_JAVA_HEAP_RETURN_(code) { return code; }
 644 #endif
 645 
 646 #endif // SHARE_VM_UTILITIES_MACROS_HPP