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