1 /*
   2  * Copyright (c) 1997, 2015, 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_HPP
  26 #define SHARE_VM_UTILITIES_GLOBALDEFINITIONS_HPP
  27 
  28 #ifndef __STDC_FORMAT_MACROS
  29 #define __STDC_FORMAT_MACROS
  30 #endif
  31 
  32 #ifdef TARGET_COMPILER_gcc
  33 # include "utilities/globalDefinitions_gcc.hpp"
  34 #endif
  35 #ifdef TARGET_COMPILER_visCPP
  36 # include "utilities/globalDefinitions_visCPP.hpp"
  37 #endif
  38 #ifdef TARGET_COMPILER_sparcWorks
  39 # include "utilities/globalDefinitions_sparcWorks.hpp"
  40 #endif
  41 #ifdef TARGET_COMPILER_xlc
  42 # include "utilities/globalDefinitions_xlc.hpp"
  43 #endif
  44 
  45 #ifndef PRAGMA_DIAG_PUSH
  46 #define PRAGMA_DIAG_PUSH
  47 #endif
  48 #ifndef PRAGMA_DIAG_POP
  49 #define PRAGMA_DIAG_POP
  50 #endif
  51 #ifndef PRAGMA_FORMAT_NONLITERAL_IGNORED
  52 #define PRAGMA_FORMAT_NONLITERAL_IGNORED
  53 #endif
  54 #ifndef PRAGMA_FORMAT_IGNORED
  55 #define PRAGMA_FORMAT_IGNORED
  56 #endif
  57 #ifndef PRAGMA_FORMAT_NONLITERAL_IGNORED_INTERNAL
  58 #define PRAGMA_FORMAT_NONLITERAL_IGNORED_INTERNAL
  59 #endif
  60 #ifndef PRAGMA_FORMAT_NONLITERAL_IGNORED_EXTERNAL
  61 #define PRAGMA_FORMAT_NONLITERAL_IGNORED_EXTERNAL
  62 #endif
  63 #ifndef PRAGMA_FORMAT_MUTE_WARNINGS_FOR_GCC
  64 #define PRAGMA_FORMAT_MUTE_WARNINGS_FOR_GCC
  65 #endif
  66 #ifndef ATTRIBUTE_PRINTF
  67 #define ATTRIBUTE_PRINTF(fmt, vargs)
  68 #endif
  69 #ifndef ATTRIBUTE_SCANF
  70 #define ATTRIBUTE_SCANF(fmt, vargs)
  71 #endif
  72 
  73 
  74 #include "utilities/macros.hpp"
  75 
  76 // This file holds all globally used constants & types, class (forward)
  77 // declarations and a few frequently used utility functions.
  78 
  79 //----------------------------------------------------------------------------------------------------
  80 // Constants
  81 
  82 const int LogBytesPerShort   = 1;
  83 const int LogBytesPerInt     = 2;
  84 #ifdef _LP64
  85 const int LogBytesPerWord    = 3;
  86 #else
  87 const int LogBytesPerWord    = 2;
  88 #endif
  89 const int LogBytesPerLong    = 3;
  90 
  91 const int BytesPerShort      = 1 << LogBytesPerShort;
  92 const int BytesPerInt        = 1 << LogBytesPerInt;
  93 const int BytesPerWord       = 1 << LogBytesPerWord;
  94 const int BytesPerLong       = 1 << LogBytesPerLong;
  95 
  96 const int LogBitsPerByte     = 3;
  97 const int LogBitsPerShort    = LogBitsPerByte + LogBytesPerShort;
  98 const int LogBitsPerInt      = LogBitsPerByte + LogBytesPerInt;
  99 const int LogBitsPerWord     = LogBitsPerByte + LogBytesPerWord;
 100 const int LogBitsPerLong     = LogBitsPerByte + LogBytesPerLong;
 101 
 102 const int BitsPerByte        = 1 << LogBitsPerByte;
 103 const int BitsPerShort       = 1 << LogBitsPerShort;
 104 const int BitsPerInt         = 1 << LogBitsPerInt;
 105 const int BitsPerWord        = 1 << LogBitsPerWord;
 106 const int BitsPerLong        = 1 << LogBitsPerLong;
 107 
 108 const int WordAlignmentMask  = (1 << LogBytesPerWord) - 1;
 109 const int LongAlignmentMask  = (1 << LogBytesPerLong) - 1;
 110 
 111 const int WordsPerLong       = 2;       // Number of stack entries for longs
 112 
 113 const int oopSize            = sizeof(char*); // Full-width oop
 114 extern int heapOopSize;                       // Oop within a java object
 115 const int wordSize           = sizeof(char*);
 116 const int longSize           = sizeof(jlong);
 117 const int jintSize           = sizeof(jint);
 118 const int size_tSize         = sizeof(size_t);
 119 
 120 const int BytesPerOop        = BytesPerWord;  // Full-width oop
 121 
 122 extern int LogBytesPerHeapOop;                // Oop within a java object
 123 extern int LogBitsPerHeapOop;
 124 extern int BytesPerHeapOop;
 125 extern int BitsPerHeapOop;
 126 
 127 const int BitsPerJavaInteger = 32;
 128 const int BitsPerJavaLong    = 64;
 129 const int BitsPerSize_t      = size_tSize * BitsPerByte;
 130 
 131 // Size of a char[] needed to represent a jint as a string in decimal.
 132 const int jintAsStringSize = 12;
 133 
 134 // In fact this should be
 135 // log2_intptr(sizeof(class JavaThread)) - log2_intptr(64);
 136 // see os::set_memory_serialize_page()
 137 #ifdef _LP64
 138 const int SerializePageShiftCount = 4;
 139 #else
 140 const int SerializePageShiftCount = 3;
 141 #endif
 142 
 143 // An opaque struct of heap-word width, so that HeapWord* can be a generic
 144 // pointer into the heap.  We require that object sizes be measured in
 145 // units of heap words, so that that
 146 //   HeapWord* hw;
 147 //   hw += oop(hw)->foo();
 148 // works, where foo is a method (like size or scavenge) that returns the
 149 // object size.
 150 class HeapWord {
 151   friend class VMStructs;
 152  private:
 153   char* i;
 154 #ifndef PRODUCT
 155  public:
 156   char* value() { return i; }
 157 #endif
 158 };
 159 
 160 // Analogous opaque struct for metadata allocated from
 161 // metaspaces.
 162 class MetaWord {
 163   friend class VMStructs;
 164  private:
 165   char* i;
 166 };
 167 
 168 // HeapWordSize must be 2^LogHeapWordSize.
 169 const int HeapWordSize        = sizeof(HeapWord);
 170 #ifdef _LP64
 171 const int LogHeapWordSize     = 3;
 172 #else
 173 const int LogHeapWordSize     = 2;
 174 #endif
 175 const int HeapWordsPerLong    = BytesPerLong / HeapWordSize;
 176 const int LogHeapWordsPerLong = LogBytesPerLong - LogHeapWordSize;
 177 
 178 // The larger HeapWordSize for 64bit requires larger heaps
 179 // for the same application running in 64bit.  See bug 4967770.
 180 // The minimum alignment to a heap word size is done.  Other
 181 // parts of the memory system may require additional alignment
 182 // and are responsible for those alignments.
 183 #ifdef _LP64
 184 #define ScaleForWordSize(x) align_size_down_((x) * 13 / 10, HeapWordSize)
 185 #else
 186 #define ScaleForWordSize(x) (x)
 187 #endif
 188 
 189 // The minimum number of native machine words necessary to contain "byte_size"
 190 // bytes.
 191 inline size_t heap_word_size(size_t byte_size) {
 192   return (byte_size + (HeapWordSize-1)) >> LogHeapWordSize;
 193 }
 194 
 195 const size_t K                  = 1024;
 196 const size_t M                  = K*K;
 197 const size_t G                  = M*K;
 198 const size_t HWperKB            = K / sizeof(HeapWord);
 199 
 200 const jint min_jint = (jint)1 << (sizeof(jint)*BitsPerByte-1); // 0x80000000 == smallest jint
 201 const jint max_jint = (juint)min_jint - 1;                     // 0x7FFFFFFF == largest jint
 202 
 203 // Constants for converting from a base unit to milli-base units.  For
 204 // example from seconds to milliseconds and microseconds
 205 
 206 const int MILLIUNITS    = 1000;         // milli units per base unit
 207 const int MICROUNITS    = 1000000;      // micro units per base unit
 208 const int NANOUNITS     = 1000000000;   // nano units per base unit
 209 
 210 const jlong NANOSECS_PER_SEC      = CONST64(1000000000);
 211 const jint  NANOSECS_PER_MILLISEC = 1000000;
 212 
 213 inline const char* proper_unit_for_byte_size(size_t s) {
 214 #ifdef _LP64
 215   if (s >= 10*G) {
 216     return "G";
 217   }
 218 #endif
 219   if (s >= 10*M) {
 220     return "M";
 221   } else if (s >= 10*K) {
 222     return "K";
 223   } else {
 224     return "B";
 225   }
 226 }
 227 
 228 template <class T>
 229 inline T byte_size_in_proper_unit(T s) {
 230 #ifdef _LP64
 231   if (s >= 10*G) {
 232     return (T)(s/G);
 233   }
 234 #endif
 235   if (s >= 10*M) {
 236     return (T)(s/M);
 237   } else if (s >= 10*K) {
 238     return (T)(s/K);
 239   } else {
 240     return s;
 241   }
 242 }
 243 
 244 //----------------------------------------------------------------------------------------------------
 245 // VM type definitions
 246 
 247 // intx and uintx are the 'extended' int and 'extended' unsigned int types;
 248 // they are 32bit wide on a 32-bit platform, and 64bit wide on a 64bit platform.
 249 
 250 typedef intptr_t  intx;
 251 typedef uintptr_t uintx;
 252 
 253 const intx  min_intx  = (intx)1 << (sizeof(intx)*BitsPerByte-1);
 254 const intx  max_intx  = (uintx)min_intx - 1;
 255 const uintx max_uintx = (uintx)-1;
 256 
 257 // Table of values:
 258 //      sizeof intx         4               8
 259 // min_intx             0x80000000      0x8000000000000000
 260 // max_intx             0x7FFFFFFF      0x7FFFFFFFFFFFFFFF
 261 // max_uintx            0xFFFFFFFF      0xFFFFFFFFFFFFFFFF
 262 
 263 typedef unsigned int uint;   NEEDS_CLEANUP
 264 
 265 
 266 //----------------------------------------------------------------------------------------------------
 267 // Java type definitions
 268 
 269 // All kinds of 'plain' byte addresses
 270 typedef   signed char s_char;
 271 typedef unsigned char u_char;
 272 typedef u_char*       address;
 273 typedef uintptr_t     address_word; // unsigned integer which will hold a pointer
 274                                     // except for some implementations of a C++
 275                                     // linkage pointer to function. Should never
 276                                     // need one of those to be placed in this
 277                                     // type anyway.
 278 
 279 //  Utility functions to "portably" (?) bit twiddle pointers
 280 //  Where portable means keep ANSI C++ compilers quiet
 281 
 282 inline address       set_address_bits(address x, int m)       { return address(intptr_t(x) | m); }
 283 inline address       clear_address_bits(address x, int m)     { return address(intptr_t(x) & ~m); }
 284 
 285 //  Utility functions to "portably" make cast to/from function pointers.
 286 
 287 inline address_word  mask_address_bits(address x, int m)      { return address_word(x) & m; }
 288 inline address_word  castable_address(address x)              { return address_word(x) ; }
 289 inline address_word  castable_address(void* x)                { return address_word(x) ; }
 290 
 291 // Pointer subtraction.
 292 // The idea here is to avoid ptrdiff_t, which is signed and so doesn't have
 293 // the range we might need to find differences from one end of the heap
 294 // to the other.
 295 // A typical use might be:
 296 //     if (pointer_delta(end(), top()) >= size) {
 297 //       // enough room for an object of size
 298 //       ...
 299 // and then additions like
 300 //       ... top() + size ...
 301 // are safe because we know that top() is at least size below end().
 302 inline size_t pointer_delta(const void* left,
 303                             const void* right,
 304                             size_t element_size) {
 305   return (((uintptr_t) left) - ((uintptr_t) right)) / element_size;
 306 }
 307 // A version specialized for HeapWord*'s.
 308 inline size_t pointer_delta(const HeapWord* left, const HeapWord* right) {
 309   return pointer_delta(left, right, sizeof(HeapWord));
 310 }
 311 // A version specialized for MetaWord*'s.
 312 inline size_t pointer_delta(const MetaWord* left, const MetaWord* right) {
 313   return pointer_delta(left, right, sizeof(MetaWord));
 314 }
 315 
 316 //
 317 // ANSI C++ does not allow casting from one pointer type to a function pointer
 318 // directly without at best a warning. This macro accomplishes it silently
 319 // In every case that is present at this point the value be cast is a pointer
 320 // to a C linkage function. In somecase the type used for the cast reflects
 321 // that linkage and a picky compiler would not complain. In other cases because
 322 // there is no convenient place to place a typedef with extern C linkage (i.e
 323 // a platform dependent header file) it doesn't. At this point no compiler seems
 324 // picky enough to catch these instances (which are few). It is possible that
 325 // using templates could fix these for all cases. This use of templates is likely
 326 // so far from the middle of the road that it is likely to be problematic in
 327 // many C++ compilers.
 328 //
 329 #define CAST_TO_FN_PTR(func_type, value) ((func_type)(castable_address(value)))
 330 #define CAST_FROM_FN_PTR(new_type, func_ptr) ((new_type)((address_word)(func_ptr)))
 331 
 332 // Unsigned byte types for os and stream.hpp
 333 
 334 // Unsigned one, two, four and eigth byte quantities used for describing
 335 // the .class file format. See JVM book chapter 4.
 336 
 337 typedef jubyte  u1;
 338 typedef jushort u2;
 339 typedef juint   u4;
 340 typedef julong  u8;
 341 
 342 const jubyte  max_jubyte  = (jubyte)-1;  // 0xFF       largest jubyte
 343 const jushort max_jushort = (jushort)-1; // 0xFFFF     largest jushort
 344 const juint   max_juint   = (juint)-1;   // 0xFFFFFFFF largest juint
 345 const julong  max_julong  = (julong)-1;  // 0xFF....FF largest julong
 346 
 347 typedef jbyte  s1;
 348 typedef jshort s2;
 349 typedef jint   s4;
 350 typedef jlong  s8;
 351 
 352 //----------------------------------------------------------------------------------------------------
 353 // JVM spec restrictions
 354 
 355 const int max_method_code_size = 64*K - 1;  // JVM spec, 2nd ed. section 4.8.1 (p.134)
 356 
 357 // Default ProtectionDomainCacheSize values
 358 
 359 const int defaultProtectionDomainCacheSize = NOT_LP64(137) LP64_ONLY(2017);
 360 
 361 //----------------------------------------------------------------------------------------------------
 362 // Default and minimum StringTableSize values
 363 
 364 const int defaultStringTableSize = NOT_LP64(1009) LP64_ONLY(60013);
 365 const int minimumStringTableSize = 1009;
 366 
 367 const int defaultSymbolTableSize = 20011;
 368 const int minimumSymbolTableSize = 1009;
 369 
 370 
 371 //----------------------------------------------------------------------------------------------------
 372 // HotSwap - for JVMTI   aka Class File Replacement and PopFrame
 373 //
 374 // Determines whether on-the-fly class replacement and frame popping are enabled.
 375 
 376 #define HOTSWAP
 377 
 378 //----------------------------------------------------------------------------------------------------
 379 // Object alignment, in units of HeapWords.
 380 //
 381 // Minimum is max(BytesPerLong, BytesPerDouble, BytesPerOop) / HeapWordSize, so jlong, jdouble and
 382 // reference fields can be naturally aligned.
 383 
 384 extern int MinObjAlignment;
 385 extern int MinObjAlignmentInBytes;
 386 extern int MinObjAlignmentInBytesMask;
 387 
 388 extern int LogMinObjAlignment;
 389 extern int LogMinObjAlignmentInBytes;
 390 
 391 const int LogKlassAlignmentInBytes = 3;
 392 const int LogKlassAlignment        = LogKlassAlignmentInBytes - LogHeapWordSize;
 393 const int KlassAlignmentInBytes    = 1 << LogKlassAlignmentInBytes;
 394 const int KlassAlignment           = KlassAlignmentInBytes / HeapWordSize;
 395 
 396 // Maximal size of heap where unscaled compression can be used. Also upper bound
 397 // for heap placement: 4GB.
 398 const  uint64_t UnscaledOopHeapMax = (uint64_t(max_juint) + 1);
 399 // Maximal size of heap where compressed oops can be used. Also upper bound for heap
 400 // placement for zero based compression algorithm: UnscaledOopHeapMax << LogMinObjAlignmentInBytes.
 401 extern uint64_t OopEncodingHeapMax;
 402 
 403 // Maximal size of compressed class space. Above this limit compression is not possible.
 404 // Also upper bound for placement of zero based class space. (Class space is further limited
 405 // to be < 3G, see arguments.cpp.)
 406 const  uint64_t KlassEncodingMetaspaceMax = (uint64_t(max_juint) + 1) << LogKlassAlignmentInBytes;
 407 
 408 // Machine dependent stuff
 409 
 410 #if defined(X86) && defined(COMPILER2) && !defined(JAVASE_EMBEDDED)
 411 // Include Restricted Transactional Memory lock eliding optimization
 412 #define INCLUDE_RTM_OPT 1
 413 #define RTM_OPT_ONLY(code) code
 414 #else
 415 #define INCLUDE_RTM_OPT 0
 416 #define RTM_OPT_ONLY(code)
 417 #endif
 418 // States of Restricted Transactional Memory usage.
 419 enum RTMState {
 420   NoRTM      = 0x2, // Don't use RTM
 421   UseRTM     = 0x1, // Use RTM
 422   ProfileRTM = 0x0  // Use RTM with abort ratio calculation
 423 };
 424 
 425 // The maximum size of the code cache.  Can be overridden by targets.
 426 #define CODE_CACHE_SIZE_LIMIT (2*G)
 427 // Allow targets to reduce the default size of the code cache.
 428 #define CODE_CACHE_DEFAULT_LIMIT CODE_CACHE_SIZE_LIMIT
 429 
 430 #ifdef TARGET_ARCH_x86
 431 # include "globalDefinitions_x86.hpp"
 432 #endif
 433 #ifdef TARGET_ARCH_sparc
 434 # include "globalDefinitions_sparc.hpp"
 435 #endif
 436 #ifdef TARGET_ARCH_zero
 437 # include "globalDefinitions_zero.hpp"
 438 #endif
 439 #ifdef TARGET_ARCH_arm
 440 # include "globalDefinitions_arm.hpp"
 441 #endif
 442 #ifdef TARGET_ARCH_ppc
 443 # include "globalDefinitions_ppc.hpp"
 444 #endif
 445 #ifdef TARGET_ARCH_aarch64
 446 # include "globalDefinitions_aarch64.hpp"
 447 #endif
 448 
 449 // To assure the IRIW property on processors that are not multiple copy
 450 // atomic, sync instructions must be issued between volatile reads to
 451 // assure their ordering, instead of after volatile stores.
 452 // (See "A Tutorial Introduction to the ARM and POWER Relaxed Memory Models"
 453 // by Luc Maranget, Susmit Sarkar and Peter Sewell, INRIA/Cambridge)
 454 #ifdef CPU_NOT_MULTIPLE_COPY_ATOMIC
 455 const bool support_IRIW_for_not_multiple_copy_atomic_cpu = true;
 456 #else
 457 const bool support_IRIW_for_not_multiple_copy_atomic_cpu = false;
 458 #endif
 459 
 460 // The byte alignment to be used by Arena::Amalloc.  See bugid 4169348.
 461 // Note: this value must be a power of 2
 462 
 463 #define ARENA_AMALLOC_ALIGNMENT (2*BytesPerWord)
 464 
 465 // Signed variants of alignment helpers.  There are two versions of each, a macro
 466 // for use in places like enum definitions that require compile-time constant
 467 // expressions and a function for all other places so as to get type checking.
 468 
 469 #define align_size_up_(size, alignment) (((size) + ((alignment) - 1)) & ~((alignment) - 1))
 470 
 471 inline bool is_size_aligned(size_t size, size_t alignment) {
 472   return align_size_up_(size, alignment) == size;
 473 }
 474 
 475 inline bool is_ptr_aligned(void* ptr, size_t alignment) {
 476   return align_size_up_((intptr_t)ptr, (intptr_t)alignment) == (intptr_t)ptr;
 477 }
 478 
 479 inline intptr_t align_size_up(intptr_t size, intptr_t alignment) {
 480   return align_size_up_(size, alignment);
 481 }
 482 
 483 #define align_size_down_(size, alignment) ((size) & ~((alignment) - 1))
 484 
 485 inline intptr_t align_size_down(intptr_t size, intptr_t alignment) {
 486   return align_size_down_(size, alignment);
 487 }
 488 
 489 #define is_size_aligned_(size, alignment) ((size) == (align_size_up_(size, alignment)))
 490 
 491 inline void* align_ptr_up(void* ptr, size_t alignment) {
 492   return (void*)align_size_up((intptr_t)ptr, (intptr_t)alignment);
 493 }
 494 
 495 inline void* align_ptr_down(void* ptr, size_t alignment) {
 496   return (void*)align_size_down((intptr_t)ptr, (intptr_t)alignment);
 497 }
 498 
 499 // Align objects by rounding up their size, in HeapWord units.
 500 
 501 #define align_object_size_(size) align_size_up_(size, MinObjAlignment)
 502 
 503 inline intptr_t align_object_size(intptr_t size) {
 504   return align_size_up(size, MinObjAlignment);
 505 }
 506 
 507 inline bool is_object_aligned(intptr_t addr) {
 508   return addr == align_object_size(addr);
 509 }
 510 
 511 // Pad out certain offsets to jlong alignment, in HeapWord units.
 512 
 513 inline intptr_t align_object_offset(intptr_t offset) {
 514   return align_size_up(offset, HeapWordsPerLong);
 515 }
 516 
 517 inline void* align_pointer_up(const void* addr, size_t size) {
 518   return (void*) align_size_up_((uintptr_t)addr, size);
 519 }
 520 
 521 // Align down with a lower bound. If the aligning results in 0, return 'alignment'.
 522 
 523 inline size_t align_size_down_bounded(size_t size, size_t alignment) {
 524   size_t aligned_size = align_size_down_(size, alignment);
 525   return aligned_size > 0 ? aligned_size : alignment;
 526 }
 527 
 528 // Clamp an address to be within a specific page
 529 // 1. If addr is on the page it is returned as is
 530 // 2. If addr is above the page_address the start of the *next* page will be returned
 531 // 3. Otherwise, if addr is below the page_address the start of the page will be returned
 532 inline address clamp_address_in_page(address addr, address page_address, intptr_t page_size) {
 533   if (align_size_down(intptr_t(addr), page_size) == align_size_down(intptr_t(page_address), page_size)) {
 534     // address is in the specified page, just return it as is
 535     return addr;
 536   } else if (addr > page_address) {
 537     // address is above specified page, return start of next page
 538     return (address)align_size_down(intptr_t(page_address), page_size) + page_size;
 539   } else {
 540     // address is below specified page, return start of page
 541     return (address)align_size_down(intptr_t(page_address), page_size);
 542   }
 543 }
 544 
 545 
 546 // The expected size in bytes of a cache line, used to pad data structures.
 547 #ifndef DEFAULT_CACHE_LINE_SIZE
 548   #define DEFAULT_CACHE_LINE_SIZE 64
 549 #endif
 550 
 551 
 552 //----------------------------------------------------------------------------------------------------
 553 // Utility macros for compilers
 554 // used to silence compiler warnings
 555 
 556 #define Unused_Variable(var) var
 557 
 558 
 559 //----------------------------------------------------------------------------------------------------
 560 // Miscellaneous
 561 
 562 // 6302670 Eliminate Hotspot __fabsf dependency
 563 // All fabs() callers should call this function instead, which will implicitly
 564 // convert the operand to double, avoiding a dependency on __fabsf which
 565 // doesn't exist in early versions of Solaris 8.
 566 inline double fabsd(double value) {
 567   return fabs(value);
 568 }
 569 
 570 //----------------------------------------------------------------------------------------------------
 571 // Special casts
 572 // Cast floats into same-size integers and vice-versa w/o changing bit-pattern
 573 typedef union {
 574   jfloat f;
 575   jint i;
 576 } FloatIntConv;
 577 
 578 typedef union {
 579   jdouble d;
 580   jlong l;
 581   julong ul;
 582 } DoubleLongConv;
 583 
 584 inline jint    jint_cast    (jfloat  x)  { return ((FloatIntConv*)&x)->i; }
 585 inline jfloat  jfloat_cast  (jint    x)  { return ((FloatIntConv*)&x)->f; }
 586 
 587 inline jlong   jlong_cast   (jdouble x)  { return ((DoubleLongConv*)&x)->l;  }
 588 inline julong  julong_cast  (jdouble x)  { return ((DoubleLongConv*)&x)->ul; }
 589 inline jdouble jdouble_cast (jlong   x)  { return ((DoubleLongConv*)&x)->d;  }
 590 
 591 inline jint low (jlong value)                    { return jint(value); }
 592 inline jint high(jlong value)                    { return jint(value >> 32); }
 593 
 594 // the fancy casts are a hopefully portable way
 595 // to do unsigned 32 to 64 bit type conversion
 596 inline void set_low (jlong* value, jint low )    { *value &= (jlong)0xffffffff << 32;
 597                                                    *value |= (jlong)(julong)(juint)low; }
 598 
 599 inline void set_high(jlong* value, jint high)    { *value &= (jlong)(julong)(juint)0xffffffff;
 600                                                    *value |= (jlong)high       << 32; }
 601 
 602 inline jlong jlong_from(jint h, jint l) {
 603   jlong result = 0; // initialization to avoid warning
 604   set_high(&result, h);
 605   set_low(&result,  l);
 606   return result;
 607 }
 608 
 609 union jlong_accessor {
 610   jint  words[2];
 611   jlong long_value;
 612 };
 613 
 614 void basic_types_init(); // cannot define here; uses assert
 615 
 616 
 617 // NOTE: replicated in SA in vm/agent/sun/jvm/hotspot/runtime/BasicType.java
 618 enum BasicType {
 619   T_BOOLEAN     =  4,
 620   T_CHAR        =  5,
 621   T_FLOAT       =  6,
 622   T_DOUBLE      =  7,
 623   T_BYTE        =  8,
 624   T_SHORT       =  9,
 625   T_INT         = 10,
 626   T_LONG        = 11,
 627   T_OBJECT      = 12,
 628   T_ARRAY       = 13,
 629   T_VOID        = 14,
 630   T_ADDRESS     = 15,
 631   T_NARROWOOP   = 16,
 632   T_METADATA    = 17,
 633   T_NARROWKLASS = 18,
 634   T_CONFLICT    = 19, // for stack value type with conflicting contents
 635   T_ILLEGAL     = 99
 636 };
 637 
 638 inline bool is_java_primitive(BasicType t) {
 639   return T_BOOLEAN <= t && t <= T_LONG;
 640 }
 641 
 642 inline bool is_subword_type(BasicType t) {
 643   // these guys are processed exactly like T_INT in calling sequences:
 644   return (t == T_BOOLEAN || t == T_CHAR || t == T_BYTE || t == T_SHORT);
 645 }
 646 
 647 inline bool is_signed_subword_type(BasicType t) {
 648   return (t == T_BYTE || t == T_SHORT);
 649 }
 650 
 651 // Convert a char from a classfile signature to a BasicType
 652 inline BasicType char2type(char c) {
 653   switch( c ) {
 654   case 'B': return T_BYTE;
 655   case 'C': return T_CHAR;
 656   case 'D': return T_DOUBLE;
 657   case 'F': return T_FLOAT;
 658   case 'I': return T_INT;
 659   case 'J': return T_LONG;
 660   case 'S': return T_SHORT;
 661   case 'Z': return T_BOOLEAN;
 662   case 'V': return T_VOID;
 663   case 'L': return T_OBJECT;
 664   case '[': return T_ARRAY;
 665   }
 666   return T_ILLEGAL;
 667 }
 668 
 669 extern char type2char_tab[T_CONFLICT+1];     // Map a BasicType to a jchar
 670 inline char type2char(BasicType t) { return (uint)t < T_CONFLICT+1 ? type2char_tab[t] : 0; }
 671 extern int type2size[T_CONFLICT+1];         // Map BasicType to result stack elements
 672 extern const char* type2name_tab[T_CONFLICT+1];     // Map a BasicType to a jchar
 673 inline const char* type2name(BasicType t) { return (uint)t < T_CONFLICT+1 ? type2name_tab[t] : NULL; }
 674 extern BasicType name2type(const char* name);
 675 
 676 // Auxilary math routines
 677 // least common multiple
 678 extern size_t lcm(size_t a, size_t b);
 679 
 680 
 681 // NOTE: replicated in SA in vm/agent/sun/jvm/hotspot/runtime/BasicType.java
 682 enum BasicTypeSize {
 683   T_BOOLEAN_size     = 1,
 684   T_CHAR_size        = 1,
 685   T_FLOAT_size       = 1,
 686   T_DOUBLE_size      = 2,
 687   T_BYTE_size        = 1,
 688   T_SHORT_size       = 1,
 689   T_INT_size         = 1,
 690   T_LONG_size        = 2,
 691   T_OBJECT_size      = 1,
 692   T_ARRAY_size       = 1,
 693   T_NARROWOOP_size   = 1,
 694   T_NARROWKLASS_size = 1,
 695   T_VOID_size        = 0
 696 };
 697 
 698 
 699 // maps a BasicType to its instance field storage type:
 700 // all sub-word integral types are widened to T_INT
 701 extern BasicType type2field[T_CONFLICT+1];
 702 extern BasicType type2wfield[T_CONFLICT+1];
 703 
 704 
 705 // size in bytes
 706 enum ArrayElementSize {
 707   T_BOOLEAN_aelem_bytes     = 1,
 708   T_CHAR_aelem_bytes        = 2,
 709   T_FLOAT_aelem_bytes       = 4,
 710   T_DOUBLE_aelem_bytes      = 8,
 711   T_BYTE_aelem_bytes        = 1,
 712   T_SHORT_aelem_bytes       = 2,
 713   T_INT_aelem_bytes         = 4,
 714   T_LONG_aelem_bytes        = 8,
 715 #ifdef _LP64
 716   T_OBJECT_aelem_bytes      = 8,
 717   T_ARRAY_aelem_bytes       = 8,
 718 #else
 719   T_OBJECT_aelem_bytes      = 4,
 720   T_ARRAY_aelem_bytes       = 4,
 721 #endif
 722   T_NARROWOOP_aelem_bytes   = 4,
 723   T_NARROWKLASS_aelem_bytes = 4,
 724   T_VOID_aelem_bytes        = 0
 725 };
 726 
 727 extern int _type2aelembytes[T_CONFLICT+1]; // maps a BasicType to nof bytes used by its array element
 728 #ifdef ASSERT
 729 extern int type2aelembytes(BasicType t, bool allow_address = false); // asserts
 730 #else
 731 inline int type2aelembytes(BasicType t, bool allow_address = false) { return _type2aelembytes[t]; }
 732 #endif
 733 
 734 
 735 // JavaValue serves as a container for arbitrary Java values.
 736 
 737 class JavaValue {
 738 
 739  public:
 740   typedef union JavaCallValue {
 741     jfloat   f;
 742     jdouble  d;
 743     jint     i;
 744     jlong    l;
 745     jobject  h;
 746   } JavaCallValue;
 747 
 748  private:
 749   BasicType _type;
 750   JavaCallValue _value;
 751 
 752  public:
 753   JavaValue(BasicType t = T_ILLEGAL) { _type = t; }
 754 
 755   JavaValue(jfloat value) {
 756     _type    = T_FLOAT;
 757     _value.f = value;
 758   }
 759 
 760   JavaValue(jdouble value) {
 761     _type    = T_DOUBLE;
 762     _value.d = value;
 763   }
 764 
 765  jfloat get_jfloat() const { return _value.f; }
 766  jdouble get_jdouble() const { return _value.d; }
 767  jint get_jint() const { return _value.i; }
 768  jlong get_jlong() const { return _value.l; }
 769  jobject get_jobject() const { return _value.h; }
 770  JavaCallValue* get_value_addr() { return &_value; }
 771  BasicType get_type() const { return _type; }
 772 
 773  void set_jfloat(jfloat f) { _value.f = f;}
 774  void set_jdouble(jdouble d) { _value.d = d;}
 775  void set_jint(jint i) { _value.i = i;}
 776  void set_jlong(jlong l) { _value.l = l;}
 777  void set_jobject(jobject h) { _value.h = h;}
 778  void set_type(BasicType t) { _type = t; }
 779 
 780  jboolean get_jboolean() const { return (jboolean) (_value.i);}
 781  jbyte get_jbyte() const { return (jbyte) (_value.i);}
 782  jchar get_jchar() const { return (jchar) (_value.i);}
 783  jshort get_jshort() const { return (jshort) (_value.i);}
 784 
 785 };
 786 
 787 
 788 #define STACK_BIAS      0
 789 // V9 Sparc CPU's running in 64 Bit mode use a stack bias of 7ff
 790 // in order to extend the reach of the stack pointer.
 791 #if defined(SPARC) && defined(_LP64)
 792 #undef STACK_BIAS
 793 #define STACK_BIAS      0x7ff
 794 #endif
 795 
 796 
 797 // TosState describes the top-of-stack state before and after the execution of
 798 // a bytecode or method. The top-of-stack value may be cached in one or more CPU
 799 // registers. The TosState corresponds to the 'machine represention' of this cached
 800 // value. There's 4 states corresponding to the JAVA types int, long, float & double
 801 // as well as a 5th state in case the top-of-stack value is actually on the top
 802 // of stack (in memory) and thus not cached. The atos state corresponds to the itos
 803 // state when it comes to machine representation but is used separately for (oop)
 804 // type specific operations (e.g. verification code).
 805 
 806 enum TosState {         // describes the tos cache contents
 807   btos = 0,             // byte, bool tos cached
 808   ctos = 1,             // char tos cached
 809   stos = 2,             // short tos cached
 810   itos = 3,             // int tos cached
 811   ltos = 4,             // long tos cached
 812   ftos = 5,             // float tos cached
 813   dtos = 6,             // double tos cached
 814   atos = 7,             // object cached
 815   vtos = 8,             // tos not cached
 816   number_of_states,
 817   ilgl                  // illegal state: should not occur
 818 };
 819 
 820 
 821 inline TosState as_TosState(BasicType type) {
 822   switch (type) {
 823     case T_BYTE   : return btos;
 824     case T_BOOLEAN: return btos; // FIXME: Add ztos
 825     case T_CHAR   : return ctos;
 826     case T_SHORT  : return stos;
 827     case T_INT    : return itos;
 828     case T_LONG   : return ltos;
 829     case T_FLOAT  : return ftos;
 830     case T_DOUBLE : return dtos;
 831     case T_VOID   : return vtos;
 832     case T_ARRAY  : // fall through
 833     case T_OBJECT : return atos;
 834   }
 835   return ilgl;
 836 }
 837 
 838 inline BasicType as_BasicType(TosState state) {
 839   switch (state) {
 840     //case ztos: return T_BOOLEAN;//FIXME
 841     case btos : return T_BYTE;
 842     case ctos : return T_CHAR;
 843     case stos : return T_SHORT;
 844     case itos : return T_INT;
 845     case ltos : return T_LONG;
 846     case ftos : return T_FLOAT;
 847     case dtos : return T_DOUBLE;
 848     case atos : return T_OBJECT;
 849     case vtos : return T_VOID;
 850   }
 851   return T_ILLEGAL;
 852 }
 853 
 854 
 855 // Helper function to convert BasicType info into TosState
 856 // Note: Cannot define here as it uses global constant at the time being.
 857 TosState as_TosState(BasicType type);
 858 
 859 
 860 // JavaThreadState keeps track of which part of the code a thread is executing in. This
 861 // information is needed by the safepoint code.
 862 //
 863 // There are 4 essential states:
 864 //
 865 //  _thread_new         : Just started, but not executed init. code yet (most likely still in OS init code)
 866 //  _thread_in_native   : In native code. This is a safepoint region, since all oops will be in jobject handles
 867 //  _thread_in_vm       : Executing in the vm
 868 //  _thread_in_Java     : Executing either interpreted or compiled Java code (or could be in a stub)
 869 //
 870 // Each state has an associated xxxx_trans state, which is an intermediate state used when a thread is in
 871 // a transition from one state to another. These extra states makes it possible for the safepoint code to
 872 // handle certain thread_states without having to suspend the thread - making the safepoint code faster.
 873 //
 874 // Given a state, the xxx_trans state can always be found by adding 1.
 875 //
 876 enum JavaThreadState {
 877   _thread_uninitialized     =  0, // should never happen (missing initialization)
 878   _thread_new               =  2, // just starting up, i.e., in process of being initialized
 879   _thread_new_trans         =  3, // corresponding transition state (not used, included for completness)
 880   _thread_in_native         =  4, // running in native code
 881   _thread_in_native_trans   =  5, // corresponding transition state
 882   _thread_in_vm             =  6, // running in VM
 883   _thread_in_vm_trans       =  7, // corresponding transition state
 884   _thread_in_Java           =  8, // running in Java or in stub code
 885   _thread_in_Java_trans     =  9, // corresponding transition state (not used, included for completness)
 886   _thread_blocked           = 10, // blocked in vm
 887   _thread_blocked_trans     = 11, // corresponding transition state
 888   _thread_max_state         = 12  // maximum thread state+1 - used for statistics allocation
 889 };
 890 
 891 
 892 // Handy constants for deciding which compiler mode to use.
 893 enum MethodCompilation {
 894   InvocationEntryBci = -1     // i.e., not a on-stack replacement compilation
 895 };
 896 
 897 // Enumeration to distinguish tiers of compilation
 898 enum CompLevel {
 899   CompLevel_any               = -1,
 900   CompLevel_all               = -1,
 901   CompLevel_none              = 0,         // Interpreter
 902   CompLevel_simple            = 1,         // C1
 903   CompLevel_limited_profile   = 2,         // C1, invocation & backedge counters
 904   CompLevel_full_profile      = 3,         // C1, invocation & backedge counters + mdo
 905   CompLevel_full_optimization = 4,         // C2 or Shark
 906 
 907 #if defined(COMPILER2) || defined(SHARK)
 908   CompLevel_highest_tier      = CompLevel_full_optimization,  // pure C2 and tiered
 909 #elif defined(COMPILER1)
 910   CompLevel_highest_tier      = CompLevel_simple,             // pure C1
 911 #else
 912   CompLevel_highest_tier      = CompLevel_none,
 913 #endif
 914 
 915 #if defined(TIERED)
 916   CompLevel_initial_compile   = CompLevel_full_profile        // tiered
 917 #elif defined(COMPILER1)
 918   CompLevel_initial_compile   = CompLevel_simple              // pure C1
 919 #elif defined(COMPILER2) || defined(SHARK)
 920   CompLevel_initial_compile   = CompLevel_full_optimization   // pure C2
 921 #else
 922   CompLevel_initial_compile   = CompLevel_none
 923 #endif
 924 };
 925 
 926 inline bool is_c1_compile(int comp_level) {
 927   return comp_level > CompLevel_none && comp_level < CompLevel_full_optimization;
 928 }
 929 
 930 inline bool is_c2_compile(int comp_level) {
 931   return comp_level == CompLevel_full_optimization;
 932 }
 933 
 934 inline bool is_highest_tier_compile(int comp_level) {
 935   return comp_level == CompLevel_highest_tier;
 936 }
 937 
 938 inline bool is_compile(int comp_level) {
 939   return is_c1_compile(comp_level) || is_c2_compile(comp_level);
 940 }
 941 
 942 //----------------------------------------------------------------------------------------------------
 943 // 'Forward' declarations of frequently used classes
 944 // (in order to reduce interface dependencies & reduce
 945 // number of unnecessary compilations after changes)
 946 
 947 class symbolTable;
 948 class ClassFileStream;
 949 
 950 class Event;
 951 
 952 class Thread;
 953 class  VMThread;
 954 class  JavaThread;
 955 class Threads;
 956 
 957 class VM_Operation;
 958 class VMOperationQueue;
 959 
 960 class CodeBlob;
 961 class  nmethod;
 962 class  OSRAdapter;
 963 class  I2CAdapter;
 964 class  C2IAdapter;
 965 class CompiledIC;
 966 class relocInfo;
 967 class ScopeDesc;
 968 class PcDesc;
 969 
 970 class Recompiler;
 971 class Recompilee;
 972 class RecompilationPolicy;
 973 class RFrame;
 974 class  CompiledRFrame;
 975 class  InterpretedRFrame;
 976 
 977 class frame;
 978 
 979 class vframe;
 980 class   javaVFrame;
 981 class     interpretedVFrame;
 982 class     compiledVFrame;
 983 class     deoptimizedVFrame;
 984 class   externalVFrame;
 985 class     entryVFrame;
 986 
 987 class RegisterMap;
 988 
 989 class Mutex;
 990 class Monitor;
 991 class BasicLock;
 992 class BasicObjectLock;
 993 
 994 class PeriodicTask;
 995 
 996 class JavaCallWrapper;
 997 
 998 class   oopDesc;
 999 class   metaDataOopDesc;
1000 
1001 class NativeCall;
1002 
1003 class zone;
1004 
1005 class StubQueue;
1006 
1007 class outputStream;
1008 
1009 class ResourceArea;
1010 
1011 class DebugInformationRecorder;
1012 class ScopeValue;
1013 class CompressedStream;
1014 class   DebugInfoReadStream;
1015 class   DebugInfoWriteStream;
1016 class LocationValue;
1017 class ConstantValue;
1018 class IllegalValue;
1019 
1020 class PrivilegedElement;
1021 class MonitorArray;
1022 
1023 class MonitorInfo;
1024 
1025 class OffsetClosure;
1026 class OopMapCache;
1027 class InterpreterOopMap;
1028 class OopMapCacheEntry;
1029 class OSThread;
1030 
1031 typedef int (*OSThreadStartFunc)(void*);
1032 
1033 class Space;
1034 
1035 class JavaValue;
1036 class methodHandle;
1037 class JavaCallArguments;
1038 
1039 // Basic support for errors (general debug facilities not defined at this point fo the include phase)
1040 
1041 extern void basic_fatal(const char* msg);
1042 
1043 
1044 //----------------------------------------------------------------------------------------------------
1045 // Special constants for debugging
1046 
1047 const jint     badInt           = -3;                       // generic "bad int" value
1048 const long     badAddressVal    = -2;                       // generic "bad address" value
1049 const long     badOopVal        = -1;                       // generic "bad oop" value
1050 const intptr_t badHeapOopVal    = (intptr_t) CONST64(0x2BAD4B0BBAADBABE); // value used to zap heap after GC
1051 const int      badHandleValue   = 0xBC;                     // value used to zap vm handle area
1052 const int      badResourceValue = 0xAB;                     // value used to zap resource area
1053 const int      freeBlockPad     = 0xBA;                     // value used to pad freed blocks.
1054 const int      uninitBlockPad   = 0xF1;                     // value used to zap newly malloc'd blocks.
1055 const intptr_t badJNIHandleVal  = (intptr_t) UCONST64(0xFEFEFEFEFEFEFEFE); // value used to zap jni handle area
1056 const juint    badHeapWordVal   = 0xBAADBABE;               // value used to zap heap after GC
1057 const juint    badMetaWordVal   = 0xBAADFADE;               // value used to zap metadata heap after GC
1058 const int      badCodeHeapNewVal= 0xCC;                     // value used to zap Code heap at allocation
1059 const int      badCodeHeapFreeVal = 0xDD;                   // value used to zap Code heap at deallocation
1060 
1061 
1062 // (These must be implemented as #defines because C++ compilers are
1063 // not obligated to inline non-integral constants!)
1064 #define       badAddress        ((address)::badAddressVal)
1065 #define       badOop            (cast_to_oop(::badOopVal))
1066 #define       badHeapWord       (::badHeapWordVal)
1067 #define       badJNIHandle      (cast_to_oop(::badJNIHandleVal))
1068 
1069 // Default TaskQueue size is 16K (32-bit) or 128K (64-bit)
1070 #define TASKQUEUE_SIZE (NOT_LP64(1<<14) LP64_ONLY(1<<17))
1071 
1072 //----------------------------------------------------------------------------------------------------
1073 // Utility functions for bitfield manipulations
1074 
1075 const intptr_t AllBits    = ~0; // all bits set in a word
1076 const intptr_t NoBits     =  0; // no bits set in a word
1077 const jlong    NoLongBits =  0; // no bits set in a long
1078 const intptr_t OneBit     =  1; // only right_most bit set in a word
1079 
1080 // get a word with the n.th or the right-most or left-most n bits set
1081 // (note: #define used only so that they can be used in enum constant definitions)
1082 #define nth_bit(n)        (n >= BitsPerWord ? 0 : OneBit << (n))
1083 #define right_n_bits(n)   (nth_bit(n) - 1)
1084 #define left_n_bits(n)    (right_n_bits(n) << (n >= BitsPerWord ? 0 : (BitsPerWord - n)))
1085 
1086 // bit-operations using a mask m
1087 inline void   set_bits    (intptr_t& x, intptr_t m) { x |= m; }
1088 inline void clear_bits    (intptr_t& x, intptr_t m) { x &= ~m; }
1089 inline intptr_t mask_bits      (intptr_t  x, intptr_t m) { return x & m; }
1090 inline jlong    mask_long_bits (jlong     x, jlong    m) { return x & m; }
1091 inline bool mask_bits_are_true (intptr_t flags, intptr_t mask) { return (flags & mask) == mask; }
1092 
1093 // bit-operations using the n.th bit
1094 inline void    set_nth_bit(intptr_t& x, int n) { set_bits  (x, nth_bit(n)); }
1095 inline void  clear_nth_bit(intptr_t& x, int n) { clear_bits(x, nth_bit(n)); }
1096 inline bool is_set_nth_bit(intptr_t  x, int n) { return mask_bits (x, nth_bit(n)) != NoBits; }
1097 
1098 // returns the bitfield of x starting at start_bit_no with length field_length (no sign-extension!)
1099 inline intptr_t bitfield(intptr_t x, int start_bit_no, int field_length) {
1100   return mask_bits(x >> start_bit_no, right_n_bits(field_length));
1101 }
1102 
1103 
1104 //----------------------------------------------------------------------------------------------------
1105 // Utility functions for integers
1106 
1107 // Avoid use of global min/max macros which may cause unwanted double
1108 // evaluation of arguments.
1109 #ifdef max
1110 #undef max
1111 #endif
1112 
1113 #ifdef min
1114 #undef min
1115 #endif
1116 
1117 #define max(a,b) Do_not_use_max_use_MAX2_instead
1118 #define min(a,b) Do_not_use_min_use_MIN2_instead
1119 
1120 // It is necessary to use templates here. Having normal overloaded
1121 // functions does not work because it is necessary to provide both 32-
1122 // and 64-bit overloaded functions, which does not work, and having
1123 // explicitly-typed versions of these routines (i.e., MAX2I, MAX2L)
1124 // will be even more error-prone than macros.
1125 template<class T> inline T MAX2(T a, T b)           { return (a > b) ? a : b; }
1126 template<class T> inline T MIN2(T a, T b)           { return (a < b) ? a : b; }
1127 template<class T> inline T MAX3(T a, T b, T c)      { return MAX2(MAX2(a, b), c); }
1128 template<class T> inline T MIN3(T a, T b, T c)      { return MIN2(MIN2(a, b), c); }
1129 template<class T> inline T MAX4(T a, T b, T c, T d) { return MAX2(MAX3(a, b, c), d); }
1130 template<class T> inline T MIN4(T a, T b, T c, T d) { return MIN2(MIN3(a, b, c), d); }
1131 
1132 template<class T> inline T ABS(T x)                 { return (x > 0) ? x : -x; }
1133 
1134 // true if x is a power of 2, false otherwise
1135 inline bool is_power_of_2(intptr_t x) {
1136   return ((x != NoBits) && (mask_bits(x, x - 1) == NoBits));
1137 }
1138 
1139 // long version of is_power_of_2
1140 inline bool is_power_of_2_long(jlong x) {
1141   return ((x != NoLongBits) && (mask_long_bits(x, x - 1) == NoLongBits));
1142 }
1143 
1144 // Returns largest i such that 2^i <= x.
1145 // If x < 0, the function returns 31 on a 32-bit machine and 63 on a 64-bit machine.
1146 // If x == 0, the function returns -1.
1147 inline int log2_intptr(intptr_t x) {
1148   int i = -1;
1149   uintptr_t p = 1;
1150   while (p != 0 && p <= (uintptr_t)x) {
1151     // p = 2^(i+1) && p <= x (i.e., 2^(i+1) <= x)
1152     i++; p *= 2;
1153   }
1154   // p = 2^(i+1) && x < p (i.e., 2^i <= x < 2^(i+1))
1155   // If p = 0, overflow has occurred and i = 31 or i = 63 (depending on the machine word size).
1156   return i;
1157 }
1158 
1159 //* largest i such that 2^i <= x
1160 //  A negative value of 'x' will return '63'
1161 inline int log2_long(jlong x) {
1162   int i = -1;
1163   julong p =  1;
1164   while (p != 0 && p <= (julong)x) {
1165     // p = 2^(i+1) && p <= x (i.e., 2^(i+1) <= x)
1166     i++; p *= 2;
1167   }
1168   // p = 2^(i+1) && x < p (i.e., 2^i <= x < 2^(i+1))
1169   // (if p = 0 then overflow occurred and i = 63)
1170   return i;
1171 }
1172 
1173 //* the argument must be exactly a power of 2
1174 inline int exact_log2(intptr_t x) {
1175   #ifdef ASSERT
1176     if (!is_power_of_2(x)) basic_fatal("x must be a power of 2");
1177   #endif
1178   return log2_intptr(x);
1179 }
1180 
1181 //* the argument must be exactly a power of 2
1182 inline int exact_log2_long(jlong x) {
1183   #ifdef ASSERT
1184     if (!is_power_of_2_long(x)) basic_fatal("x must be a power of 2");
1185   #endif
1186   return log2_long(x);
1187 }
1188 
1189 
1190 // returns integer round-up to the nearest multiple of s (s must be a power of two)
1191 inline intptr_t round_to(intptr_t x, uintx s) {
1192   #ifdef ASSERT
1193     if (!is_power_of_2(s)) basic_fatal("s must be a power of 2");
1194   #endif
1195   const uintx m = s - 1;
1196   return mask_bits(x + m, ~m);
1197 }
1198 
1199 // returns integer round-down to the nearest multiple of s (s must be a power of two)
1200 inline intptr_t round_down(intptr_t x, uintx s) {
1201   #ifdef ASSERT
1202     if (!is_power_of_2(s)) basic_fatal("s must be a power of 2");
1203   #endif
1204   const uintx m = s - 1;
1205   return mask_bits(x, ~m);
1206 }
1207 
1208 
1209 inline bool is_odd (intx x) { return x & 1;      }
1210 inline bool is_even(intx x) { return !is_odd(x); }
1211 
1212 // "to" should be greater than "from."
1213 inline intx byte_size(void* from, void* to) {
1214   return (address)to - (address)from;
1215 }
1216 
1217 //----------------------------------------------------------------------------------------------------
1218 // Avoid non-portable casts with these routines (DEPRECATED)
1219 
1220 // NOTE: USE Bytes class INSTEAD WHERE POSSIBLE
1221 //       Bytes is optimized machine-specifically and may be much faster then the portable routines below.
1222 
1223 // Given sequence of four bytes, build into a 32-bit word
1224 // following the conventions used in class files.
1225 // On the 386, this could be realized with a simple address cast.
1226 //
1227 
1228 // This routine takes eight bytes:
1229 inline u8 build_u8_from( u1 c1, u1 c2, u1 c3, u1 c4, u1 c5, u1 c6, u1 c7, u1 c8 ) {
1230   return  (( u8(c1) << 56 )  &  ( u8(0xff) << 56 ))
1231        |  (( u8(c2) << 48 )  &  ( u8(0xff) << 48 ))
1232        |  (( u8(c3) << 40 )  &  ( u8(0xff) << 40 ))
1233        |  (( u8(c4) << 32 )  &  ( u8(0xff) << 32 ))
1234        |  (( u8(c5) << 24 )  &  ( u8(0xff) << 24 ))
1235        |  (( u8(c6) << 16 )  &  ( u8(0xff) << 16 ))
1236        |  (( u8(c7) <<  8 )  &  ( u8(0xff) <<  8 ))
1237        |  (( u8(c8) <<  0 )  &  ( u8(0xff) <<  0 ));
1238 }
1239 
1240 // This routine takes four bytes:
1241 inline u4 build_u4_from( u1 c1, u1 c2, u1 c3, u1 c4 ) {
1242   return  (( u4(c1) << 24 )  &  0xff000000)
1243        |  (( u4(c2) << 16 )  &  0x00ff0000)
1244        |  (( u4(c3) <<  8 )  &  0x0000ff00)
1245        |  (( u4(c4) <<  0 )  &  0x000000ff);
1246 }
1247 
1248 // And this one works if the four bytes are contiguous in memory:
1249 inline u4 build_u4_from( u1* p ) {
1250   return  build_u4_from( p[0], p[1], p[2], p[3] );
1251 }
1252 
1253 // Ditto for two-byte ints:
1254 inline u2 build_u2_from( u1 c1, u1 c2 ) {
1255   return  u2((( u2(c1) <<  8 )  &  0xff00)
1256           |  (( u2(c2) <<  0 )  &  0x00ff));
1257 }
1258 
1259 // And this one works if the two bytes are contiguous in memory:
1260 inline u2 build_u2_from( u1* p ) {
1261   return  build_u2_from( p[0], p[1] );
1262 }
1263 
1264 // Ditto for floats:
1265 inline jfloat build_float_from( u1 c1, u1 c2, u1 c3, u1 c4 ) {
1266   u4 u = build_u4_from( c1, c2, c3, c4 );
1267   return  *(jfloat*)&u;
1268 }
1269 
1270 inline jfloat build_float_from( u1* p ) {
1271   u4 u = build_u4_from( p );
1272   return  *(jfloat*)&u;
1273 }
1274 
1275 
1276 // now (64-bit) longs
1277 
1278 inline jlong build_long_from( u1 c1, u1 c2, u1 c3, u1 c4, u1 c5, u1 c6, u1 c7, u1 c8 ) {
1279   return  (( jlong(c1) << 56 )  &  ( jlong(0xff) << 56 ))
1280        |  (( jlong(c2) << 48 )  &  ( jlong(0xff) << 48 ))
1281        |  (( jlong(c3) << 40 )  &  ( jlong(0xff) << 40 ))
1282        |  (( jlong(c4) << 32 )  &  ( jlong(0xff) << 32 ))
1283        |  (( jlong(c5) << 24 )  &  ( jlong(0xff) << 24 ))
1284        |  (( jlong(c6) << 16 )  &  ( jlong(0xff) << 16 ))
1285        |  (( jlong(c7) <<  8 )  &  ( jlong(0xff) <<  8 ))
1286        |  (( jlong(c8) <<  0 )  &  ( jlong(0xff) <<  0 ));
1287 }
1288 
1289 inline jlong build_long_from( u1* p ) {
1290   return  build_long_from( p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7] );
1291 }
1292 
1293 
1294 // Doubles, too!
1295 inline jdouble build_double_from( u1 c1, u1 c2, u1 c3, u1 c4, u1 c5, u1 c6, u1 c7, u1 c8 ) {
1296   jlong u = build_long_from( c1, c2, c3, c4, c5, c6, c7, c8 );
1297   return  *(jdouble*)&u;
1298 }
1299 
1300 inline jdouble build_double_from( u1* p ) {
1301   jlong u = build_long_from( p );
1302   return  *(jdouble*)&u;
1303 }
1304 
1305 
1306 // Portable routines to go the other way:
1307 
1308 inline void explode_short_to( u2 x, u1& c1, u1& c2 ) {
1309   c1 = u1(x >> 8);
1310   c2 = u1(x);
1311 }
1312 
1313 inline void explode_short_to( u2 x, u1* p ) {
1314   explode_short_to( x, p[0], p[1]);
1315 }
1316 
1317 inline void explode_int_to( u4 x, u1& c1, u1& c2, u1& c3, u1& c4 ) {
1318   c1 = u1(x >> 24);
1319   c2 = u1(x >> 16);
1320   c3 = u1(x >>  8);
1321   c4 = u1(x);
1322 }
1323 
1324 inline void explode_int_to( u4 x, u1* p ) {
1325   explode_int_to( x, p[0], p[1], p[2], p[3]);
1326 }
1327 
1328 
1329 // Pack and extract shorts to/from ints:
1330 
1331 inline int extract_low_short_from_int(jint x) {
1332   return x & 0xffff;
1333 }
1334 
1335 inline int extract_high_short_from_int(jint x) {
1336   return (x >> 16) & 0xffff;
1337 }
1338 
1339 inline int build_int_from_shorts( jushort low, jushort high ) {
1340   return ((int)((unsigned int)high << 16) | (unsigned int)low);
1341 }
1342 
1343 // Convert pointer to intptr_t, for use in printing pointers.
1344 inline intptr_t p2i(const void * p) {
1345   return (intptr_t) p;
1346 }
1347 
1348 // Printf-style formatters for fixed- and variable-width types as pointers and
1349 // integers.  These are derived from the definitions in inttypes.h.  If the platform
1350 // doesn't provide appropriate definitions, they should be provided in
1351 // the compiler-specific definitions file (e.g., globalDefinitions_gcc.hpp)
1352 
1353 #define BOOL_TO_STR(_b_) ((_b_) ? "true" : "false")
1354 
1355 // Format 32-bit quantities.
1356 #define INT32_FORMAT           "%" PRId32
1357 #define UINT32_FORMAT          "%" PRIu32
1358 #define INT32_FORMAT_W(width)  "%" #width PRId32
1359 #define UINT32_FORMAT_W(width) "%" #width PRIu32
1360 
1361 #define PTR32_FORMAT           "0x%08" PRIx32
1362 
1363 // Format 64-bit quantities.
1364 #define INT64_FORMAT           "%" PRId64
1365 #define UINT64_FORMAT          "%" PRIu64
1366 #define UINT64_FORMAT_X        "%" PRIx64
1367 #define INT64_FORMAT_W(width)  "%" #width PRId64
1368 #define UINT64_FORMAT_W(width) "%" #width PRIu64
1369 
1370 #define PTR64_FORMAT           "0x%016" PRIx64
1371 
1372 // Format jlong, if necessary
1373 #ifndef JLONG_FORMAT
1374 #define JLONG_FORMAT           INT64_FORMAT
1375 #endif
1376 #ifndef JULONG_FORMAT
1377 #define JULONG_FORMAT          UINT64_FORMAT
1378 #endif
1379 #ifndef JULONG_FORMAT_X
1380 #define JULONG_FORMAT_X        UINT64_FORMAT_X
1381 #endif
1382 
1383 // Format pointers which change size between 32- and 64-bit.
1384 #ifdef  _LP64
1385 #define INTPTR_FORMAT "0x%016" PRIxPTR
1386 #define PTR_FORMAT    "0x%016" PRIxPTR
1387 #else   // !_LP64
1388 #define INTPTR_FORMAT "0x%08"  PRIxPTR
1389 #define PTR_FORMAT    "0x%08"  PRIxPTR
1390 #endif  // _LP64
1391 
1392 #define INTPTR_FORMAT_W(width)   "%" #width PRIxPTR
1393 
1394 #define SSIZE_FORMAT             "%"   PRIdPTR
1395 #define SIZE_FORMAT              "%"   PRIuPTR
1396 #define SIZE_FORMAT_HEX          "0x%" PRIxPTR
1397 #define SSIZE_FORMAT_W(width)    "%"   #width PRIdPTR
1398 #define SIZE_FORMAT_W(width)     "%"   #width PRIuPTR
1399 #define SIZE_FORMAT_HEX_W(width) "0x%" #width PRIxPTR
1400 
1401 #define INTX_FORMAT           "%" PRIdPTR
1402 #define UINTX_FORMAT          "%" PRIuPTR
1403 #define INTX_FORMAT_W(width)  "%" #width PRIdPTR
1404 #define UINTX_FORMAT_W(width) "%" #width PRIuPTR
1405 
1406 
1407 // Enable zap-a-lot if in debug version.
1408 
1409 # ifdef ASSERT
1410 # ifdef COMPILER2
1411 #   define ENABLE_ZAP_DEAD_LOCALS
1412 #endif /* COMPILER2 */
1413 # endif /* ASSERT */
1414 
1415 #define ARRAY_SIZE(array) (sizeof(array)/sizeof((array)[0]))
1416 
1417 // Dereference vptr
1418 // All C++ compilers that we know of have the vtbl pointer in the first
1419 // word.  If there are exceptions, this function needs to be made compiler
1420 // specific.
1421 static inline void* dereference_vptr(const void* addr) {
1422   return *(void**)addr;
1423 }
1424 
1425 NORETURN_ATTRIBUTE(void noreturn_function());
1426 
1427 #ifndef PRODUCT
1428 
1429 // For unit testing only
1430 class GlobalDefinitions {
1431 public:
1432   static void test_globals();
1433 };
1434 
1435 #endif // PRODUCT
1436 
1437 #endif // SHARE_VM_UTILITIES_GLOBALDEFINITIONS_HPP