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