src/share/vm/utilities/globalDefinitions.hpp

Fri, 27 Feb 2009 13:27:09 -0800

author
twisti
date
Fri, 27 Feb 2009 13:27:09 -0800
changeset 1040
98cb887364d3
parent 1005
dca06e7f503d
child 1145
e5b0439ef4ae
permissions
-rw-r--r--

6810672: Comment typos
Summary: I have collected some typos I have found while looking at the code.
Reviewed-by: kvn, never

     1 /*
     2  * Copyright 1997-2009 Sun Microsystems, Inc.  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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
    20  * CA 95054 USA or visit www.sun.com if you need additional information or
    21  * have any questions.
    22  *
    23  */
    25 // This file holds all globally used constants & types, class (forward)
    26 // declarations and a few frequently used utility functions.
    28 //----------------------------------------------------------------------------------------------------
    29 // Constants
    31 const int LogBytesPerShort   = 1;
    32 const int LogBytesPerInt     = 2;
    33 #ifdef _LP64
    34 const int LogBytesPerWord    = 3;
    35 #else
    36 const int LogBytesPerWord    = 2;
    37 #endif
    38 const int LogBytesPerLong    = 3;
    40 const int BytesPerShort      = 1 << LogBytesPerShort;
    41 const int BytesPerInt        = 1 << LogBytesPerInt;
    42 const int BytesPerWord       = 1 << LogBytesPerWord;
    43 const int BytesPerLong       = 1 << LogBytesPerLong;
    45 const int LogBitsPerByte     = 3;
    46 const int LogBitsPerShort    = LogBitsPerByte + LogBytesPerShort;
    47 const int LogBitsPerInt      = LogBitsPerByte + LogBytesPerInt;
    48 const int LogBitsPerWord     = LogBitsPerByte + LogBytesPerWord;
    49 const int LogBitsPerLong     = LogBitsPerByte + LogBytesPerLong;
    51 const int BitsPerByte        = 1 << LogBitsPerByte;
    52 const int BitsPerShort       = 1 << LogBitsPerShort;
    53 const int BitsPerInt         = 1 << LogBitsPerInt;
    54 const int BitsPerWord        = 1 << LogBitsPerWord;
    55 const int BitsPerLong        = 1 << LogBitsPerLong;
    57 const int WordAlignmentMask  = (1 << LogBytesPerWord) - 1;
    58 const int LongAlignmentMask  = (1 << LogBytesPerLong) - 1;
    60 const int WordsPerLong       = 2;       // Number of stack entries for longs
    62 const int oopSize            = sizeof(char*); // Full-width oop
    63 extern int heapOopSize;                       // Oop within a java object
    64 const int wordSize           = sizeof(char*);
    65 const int longSize           = sizeof(jlong);
    66 const int jintSize           = sizeof(jint);
    67 const int size_tSize         = sizeof(size_t);
    69 const int BytesPerOop        = BytesPerWord;  // Full-width oop
    71 extern int LogBytesPerHeapOop;                // Oop within a java object
    72 extern int LogBitsPerHeapOop;
    73 extern int BytesPerHeapOop;
    74 extern int BitsPerHeapOop;
    76 const int BitsPerJavaInteger = 32;
    77 const int BitsPerJavaLong    = 64;
    78 const int BitsPerSize_t      = size_tSize * BitsPerByte;
    80 // Size of a char[] needed to represent a jint as a string in decimal.
    81 const int jintAsStringSize = 12;
    83 // In fact this should be
    84 // log2_intptr(sizeof(class JavaThread)) - log2_intptr(64);
    85 // see os::set_memory_serialize_page()
    86 #ifdef _LP64
    87 const int SerializePageShiftCount = 4;
    88 #else
    89 const int SerializePageShiftCount = 3;
    90 #endif
    92 // An opaque struct of heap-word width, so that HeapWord* can be a generic
    93 // pointer into the heap.  We require that object sizes be measured in
    94 // units of heap words, so that that
    95 //   HeapWord* hw;
    96 //   hw += oop(hw)->foo();
    97 // works, where foo is a method (like size or scavenge) that returns the
    98 // object size.
    99 class HeapWord {
   100   friend class VMStructs;
   101  private:
   102   char* i;
   103 #ifndef PRODUCT
   104  public:
   105   char* value() { return i; }
   106 #endif
   107 };
   109 // HeapWordSize must be 2^LogHeapWordSize.
   110 const int HeapWordSize        = sizeof(HeapWord);
   111 #ifdef _LP64
   112 const int LogHeapWordSize     = 3;
   113 #else
   114 const int LogHeapWordSize     = 2;
   115 #endif
   116 const int HeapWordsPerLong    = BytesPerLong / HeapWordSize;
   117 const int LogHeapWordsPerLong = LogBytesPerLong - LogHeapWordSize;
   119 // The larger HeapWordSize for 64bit requires larger heaps
   120 // for the same application running in 64bit.  See bug 4967770.
   121 // The minimum alignment to a heap word size is done.  Other
   122 // parts of the memory system may required additional alignment
   123 // and are responsible for those alignments.
   124 #ifdef _LP64
   125 #define ScaleForWordSize(x) align_size_down_((x) * 13 / 10, HeapWordSize)
   126 #else
   127 #define ScaleForWordSize(x) (x)
   128 #endif
   130 // The minimum number of native machine words necessary to contain "byte_size"
   131 // bytes.
   132 inline size_t heap_word_size(size_t byte_size) {
   133   return (byte_size + (HeapWordSize-1)) >> LogHeapWordSize;
   134 }
   137 const size_t K                  = 1024;
   138 const size_t M                  = K*K;
   139 const size_t G                  = M*K;
   140 const size_t HWperKB            = K / sizeof(HeapWord);
   142 const jint min_jint = (jint)1 << (sizeof(jint)*BitsPerByte-1); // 0x80000000 == smallest jint
   143 const jint max_jint = (juint)min_jint - 1;                     // 0x7FFFFFFF == largest jint
   145 // Constants for converting from a base unit to milli-base units.  For
   146 // example from seconds to milliseconds and microseconds
   148 const int MILLIUNITS    = 1000;         // milli units per base unit
   149 const int MICROUNITS    = 1000000;      // micro units per base unit
   150 const int NANOUNITS     = 1000000000;   // nano units per base unit
   152 inline const char* proper_unit_for_byte_size(size_t s) {
   153   if (s >= 10*M) {
   154     return "M";
   155   } else if (s >= 10*K) {
   156     return "K";
   157   } else {
   158     return "B";
   159   }
   160 }
   162 inline size_t byte_size_in_proper_unit(size_t s) {
   163   if (s >= 10*M) {
   164     return s/M;
   165   } else if (s >= 10*K) {
   166     return s/K;
   167   } else {
   168     return s;
   169   }
   170 }
   173 //----------------------------------------------------------------------------------------------------
   174 // VM type definitions
   176 // intx and uintx are the 'extended' int and 'extended' unsigned int types;
   177 // they are 32bit wide on a 32-bit platform, and 64bit wide on a 64bit platform.
   179 typedef intptr_t  intx;
   180 typedef uintptr_t uintx;
   182 const intx  min_intx  = (intx)1 << (sizeof(intx)*BitsPerByte-1);
   183 const intx  max_intx  = (uintx)min_intx - 1;
   184 const uintx max_uintx = (uintx)-1;
   186 // Table of values:
   187 //      sizeof intx         4               8
   188 // min_intx             0x80000000      0x8000000000000000
   189 // max_intx             0x7FFFFFFF      0x7FFFFFFFFFFFFFFF
   190 // max_uintx            0xFFFFFFFF      0xFFFFFFFFFFFFFFFF
   192 typedef unsigned int uint;   NEEDS_CLEANUP
   195 //----------------------------------------------------------------------------------------------------
   196 // Java type definitions
   198 // All kinds of 'plain' byte addresses
   199 typedef   signed char s_char;
   200 typedef unsigned char u_char;
   201 typedef u_char*       address;
   202 typedef uintptr_t     address_word; // unsigned integer which will hold a pointer
   203                                     // except for some implementations of a C++
   204                                     // linkage pointer to function. Should never
   205                                     // need one of those to be placed in this
   206                                     // type anyway.
   208 //  Utility functions to "portably" (?) bit twiddle pointers
   209 //  Where portable means keep ANSI C++ compilers quiet
   211 inline address       set_address_bits(address x, int m)       { return address(intptr_t(x) | m); }
   212 inline address       clear_address_bits(address x, int m)     { return address(intptr_t(x) & ~m); }
   214 //  Utility functions to "portably" make cast to/from function pointers.
   216 inline address_word  mask_address_bits(address x, int m)      { return address_word(x) & m; }
   217 inline address_word  castable_address(address x)              { return address_word(x) ; }
   218 inline address_word  castable_address(void* x)                { return address_word(x) ; }
   220 // Pointer subtraction.
   221 // The idea here is to avoid ptrdiff_t, which is signed and so doesn't have
   222 // the range we might need to find differences from one end of the heap
   223 // to the other.
   224 // A typical use might be:
   225 //     if (pointer_delta(end(), top()) >= size) {
   226 //       // enough room for an object of size
   227 //       ...
   228 // and then additions like
   229 //       ... top() + size ...
   230 // are safe because we know that top() is at least size below end().
   231 inline size_t pointer_delta(const void* left,
   232                             const void* right,
   233                             size_t element_size) {
   234   return (((uintptr_t) left) - ((uintptr_t) right)) / element_size;
   235 }
   236 // A version specialized for HeapWord*'s.
   237 inline size_t pointer_delta(const HeapWord* left, const HeapWord* right) {
   238   return pointer_delta(left, right, sizeof(HeapWord));
   239 }
   241 //
   242 // ANSI C++ does not allow casting from one pointer type to a function pointer
   243 // directly without at best a warning. This macro accomplishes it silently
   244 // In every case that is present at this point the value be cast is a pointer
   245 // to a C linkage function. In somecase the type used for the cast reflects
   246 // that linkage and a picky compiler would not complain. In other cases because
   247 // there is no convenient place to place a typedef with extern C linkage (i.e
   248 // a platform dependent header file) it doesn't. At this point no compiler seems
   249 // picky enough to catch these instances (which are few). It is possible that
   250 // using templates could fix these for all cases. This use of templates is likely
   251 // so far from the middle of the road that it is likely to be problematic in
   252 // many C++ compilers.
   253 //
   254 #define CAST_TO_FN_PTR(func_type, value) ((func_type)(castable_address(value)))
   255 #define CAST_FROM_FN_PTR(new_type, func_ptr) ((new_type)((address_word)(func_ptr)))
   257 // Unsigned byte types for os and stream.hpp
   259 // Unsigned one, two, four and eigth byte quantities used for describing
   260 // the .class file format. See JVM book chapter 4.
   262 typedef jubyte  u1;
   263 typedef jushort u2;
   264 typedef juint   u4;
   265 typedef julong  u8;
   267 const jubyte  max_jubyte  = (jubyte)-1;  // 0xFF       largest jubyte
   268 const jushort max_jushort = (jushort)-1; // 0xFFFF     largest jushort
   269 const juint   max_juint   = (juint)-1;   // 0xFFFFFFFF largest juint
   270 const julong  max_julong  = (julong)-1;  // 0xFF....FF largest julong
   272 //----------------------------------------------------------------------------------------------------
   273 // JVM spec restrictions
   275 const int max_method_code_size = 64*K - 1;  // JVM spec, 2nd ed. section 4.8.1 (p.134)
   278 //----------------------------------------------------------------------------------------------------
   279 // HotSwap - for JVMTI   aka Class File Replacement and PopFrame
   280 //
   281 // Determines whether on-the-fly class replacement and frame popping are enabled.
   283 #define HOTSWAP
   285 //----------------------------------------------------------------------------------------------------
   286 // Object alignment, in units of HeapWords.
   287 //
   288 // Minimum is max(BytesPerLong, BytesPerDouble, BytesPerOop) / HeapWordSize, so jlong, jdouble and
   289 // reference fields can be naturally aligned.
   291 const int MinObjAlignment            = HeapWordsPerLong;
   292 const int MinObjAlignmentInBytes     = MinObjAlignment * HeapWordSize;
   293 const int MinObjAlignmentInBytesMask = MinObjAlignmentInBytes - 1;
   295 const int LogMinObjAlignment         = LogHeapWordsPerLong;
   296 const int LogMinObjAlignmentInBytes  = LogMinObjAlignment + LogHeapWordSize;
   298 // Machine dependent stuff
   300 #include "incls/_globalDefinitions_pd.hpp.incl"
   302 // The byte alignment to be used by Arena::Amalloc.  See bugid 4169348.
   303 // Note: this value must be a power of 2
   305 #define ARENA_AMALLOC_ALIGNMENT (2*BytesPerWord)
   307 // Signed variants of alignment helpers.  There are two versions of each, a macro
   308 // for use in places like enum definitions that require compile-time constant
   309 // expressions and a function for all other places so as to get type checking.
   311 #define align_size_up_(size, alignment) (((size) + ((alignment) - 1)) & ~((alignment) - 1))
   313 inline intptr_t align_size_up(intptr_t size, intptr_t alignment) {
   314   return align_size_up_(size, alignment);
   315 }
   317 #define align_size_down_(size, alignment) ((size) & ~((alignment) - 1))
   319 inline intptr_t align_size_down(intptr_t size, intptr_t alignment) {
   320   return align_size_down_(size, alignment);
   321 }
   323 // Align objects by rounding up their size, in HeapWord units.
   325 #define align_object_size_(size) align_size_up_(size, MinObjAlignment)
   327 inline intptr_t align_object_size(intptr_t size) {
   328   return align_size_up(size, MinObjAlignment);
   329 }
   331 // Pad out certain offsets to jlong alignment, in HeapWord units.
   333 #define align_object_offset_(offset) align_size_up_(offset, HeapWordsPerLong)
   335 inline intptr_t align_object_offset(intptr_t offset) {
   336   return align_size_up(offset, HeapWordsPerLong);
   337 }
   339 inline bool is_object_aligned(intptr_t offset) {
   340   return offset == align_object_offset(offset);
   341 }
   344 //----------------------------------------------------------------------------------------------------
   345 // Utility macros for compilers
   346 // used to silence compiler warnings
   348 #define Unused_Variable(var) var
   351 //----------------------------------------------------------------------------------------------------
   352 // Miscellaneous
   354 // 6302670 Eliminate Hotspot __fabsf dependency
   355 // All fabs() callers should call this function instead, which will implicitly
   356 // convert the operand to double, avoiding a dependency on __fabsf which
   357 // doesn't exist in early versions of Solaris 8.
   358 inline double fabsd(double value) {
   359   return fabs(value);
   360 }
   362 inline jint low (jlong value)                    { return jint(value); }
   363 inline jint high(jlong value)                    { return jint(value >> 32); }
   365 // the fancy casts are a hopefully portable way
   366 // to do unsigned 32 to 64 bit type conversion
   367 inline void set_low (jlong* value, jint low )    { *value &= (jlong)0xffffffff << 32;
   368                                                    *value |= (jlong)(julong)(juint)low; }
   370 inline void set_high(jlong* value, jint high)    { *value &= (jlong)(julong)(juint)0xffffffff;
   371                                                    *value |= (jlong)high       << 32; }
   373 inline jlong jlong_from(jint h, jint l) {
   374   jlong result = 0; // initialization to avoid warning
   375   set_high(&result, h);
   376   set_low(&result,  l);
   377   return result;
   378 }
   380 union jlong_accessor {
   381   jint  words[2];
   382   jlong long_value;
   383 };
   385 void basic_types_init(); // cannot define here; uses assert
   388 // NOTE: replicated in SA in vm/agent/sun/jvm/hotspot/runtime/BasicType.java
   389 enum BasicType {
   390   T_BOOLEAN  =  4,
   391   T_CHAR     =  5,
   392   T_FLOAT    =  6,
   393   T_DOUBLE   =  7,
   394   T_BYTE     =  8,
   395   T_SHORT    =  9,
   396   T_INT      = 10,
   397   T_LONG     = 11,
   398   T_OBJECT   = 12,
   399   T_ARRAY    = 13,
   400   T_VOID     = 14,
   401   T_ADDRESS  = 15,
   402   T_NARROWOOP= 16,
   403   T_CONFLICT = 17, // for stack value type with conflicting contents
   404   T_ILLEGAL  = 99
   405 };
   407 inline bool is_java_primitive(BasicType t) {
   408   return T_BOOLEAN <= t && t <= T_LONG;
   409 }
   411 // Convert a char from a classfile signature to a BasicType
   412 inline BasicType char2type(char c) {
   413   switch( c ) {
   414   case 'B': return T_BYTE;
   415   case 'C': return T_CHAR;
   416   case 'D': return T_DOUBLE;
   417   case 'F': return T_FLOAT;
   418   case 'I': return T_INT;
   419   case 'J': return T_LONG;
   420   case 'S': return T_SHORT;
   421   case 'Z': return T_BOOLEAN;
   422   case 'V': return T_VOID;
   423   case 'L': return T_OBJECT;
   424   case '[': return T_ARRAY;
   425   }
   426   return T_ILLEGAL;
   427 }
   429 extern char type2char_tab[T_CONFLICT+1];     // Map a BasicType to a jchar
   430 inline char type2char(BasicType t) { return (uint)t < T_CONFLICT+1 ? type2char_tab[t] : 0; }
   431 extern int type2size[T_CONFLICT+1];         // Map BasicType to result stack elements
   432 extern const char* type2name_tab[T_CONFLICT+1];     // Map a BasicType to a jchar
   433 inline const char* type2name(BasicType t) { return (uint)t < T_CONFLICT+1 ? type2name_tab[t] : NULL; }
   434 extern BasicType name2type(const char* name);
   436 // Auxilary math routines
   437 // least common multiple
   438 extern size_t lcm(size_t a, size_t b);
   441 // NOTE: replicated in SA in vm/agent/sun/jvm/hotspot/runtime/BasicType.java
   442 enum BasicTypeSize {
   443   T_BOOLEAN_size = 1,
   444   T_CHAR_size    = 1,
   445   T_FLOAT_size   = 1,
   446   T_DOUBLE_size  = 2,
   447   T_BYTE_size    = 1,
   448   T_SHORT_size   = 1,
   449   T_INT_size     = 1,
   450   T_LONG_size    = 2,
   451   T_OBJECT_size  = 1,
   452   T_ARRAY_size   = 1,
   453   T_NARROWOOP_size = 1,
   454   T_VOID_size    = 0
   455 };
   458 // maps a BasicType to its instance field storage type:
   459 // all sub-word integral types are widened to T_INT
   460 extern BasicType type2field[T_CONFLICT+1];
   461 extern BasicType type2wfield[T_CONFLICT+1];
   464 // size in bytes
   465 enum ArrayElementSize {
   466   T_BOOLEAN_aelem_bytes = 1,
   467   T_CHAR_aelem_bytes    = 2,
   468   T_FLOAT_aelem_bytes   = 4,
   469   T_DOUBLE_aelem_bytes  = 8,
   470   T_BYTE_aelem_bytes    = 1,
   471   T_SHORT_aelem_bytes   = 2,
   472   T_INT_aelem_bytes     = 4,
   473   T_LONG_aelem_bytes    = 8,
   474 #ifdef _LP64
   475   T_OBJECT_aelem_bytes  = 8,
   476   T_ARRAY_aelem_bytes   = 8,
   477 #else
   478   T_OBJECT_aelem_bytes  = 4,
   479   T_ARRAY_aelem_bytes   = 4,
   480 #endif
   481   T_NARROWOOP_aelem_bytes = 4,
   482   T_VOID_aelem_bytes    = 0
   483 };
   485 extern int _type2aelembytes[T_CONFLICT+1]; // maps a BasicType to nof bytes used by its array element
   486 #ifdef ASSERT
   487 extern int type2aelembytes(BasicType t, bool allow_address = false); // asserts
   488 #else
   489 inline int type2aelembytes(BasicType t) { return _type2aelembytes[t]; }
   490 #endif
   493 // JavaValue serves as a container for arbitrary Java values.
   495 class JavaValue {
   497  public:
   498   typedef union JavaCallValue {
   499     jfloat   f;
   500     jdouble  d;
   501     jint     i;
   502     jlong    l;
   503     jobject  h;
   504   } JavaCallValue;
   506  private:
   507   BasicType _type;
   508   JavaCallValue _value;
   510  public:
   511   JavaValue(BasicType t = T_ILLEGAL) { _type = t; }
   513   JavaValue(jfloat value) {
   514     _type    = T_FLOAT;
   515     _value.f = value;
   516   }
   518   JavaValue(jdouble value) {
   519     _type    = T_DOUBLE;
   520     _value.d = value;
   521   }
   523  jfloat get_jfloat() const { return _value.f; }
   524  jdouble get_jdouble() const { return _value.d; }
   525  jint get_jint() const { return _value.i; }
   526  jlong get_jlong() const { return _value.l; }
   527  jobject get_jobject() const { return _value.h; }
   528  JavaCallValue* get_value_addr() { return &_value; }
   529  BasicType get_type() const { return _type; }
   531  void set_jfloat(jfloat f) { _value.f = f;}
   532  void set_jdouble(jdouble d) { _value.d = d;}
   533  void set_jint(jint i) { _value.i = i;}
   534  void set_jlong(jlong l) { _value.l = l;}
   535  void set_jobject(jobject h) { _value.h = h;}
   536  void set_type(BasicType t) { _type = t; }
   538  jboolean get_jboolean() const { return (jboolean) (_value.i);}
   539  jbyte get_jbyte() const { return (jbyte) (_value.i);}
   540  jchar get_jchar() const { return (jchar) (_value.i);}
   541  jshort get_jshort() const { return (jshort) (_value.i);}
   543 };
   546 #define STACK_BIAS      0
   547 // V9 Sparc CPU's running in 64 Bit mode use a stack bias of 7ff
   548 // in order to extend the reach of the stack pointer.
   549 #if defined(SPARC) && defined(_LP64)
   550 #undef STACK_BIAS
   551 #define STACK_BIAS      0x7ff
   552 #endif
   555 // TosState describes the top-of-stack state before and after the execution of
   556 // a bytecode or method. The top-of-stack value may be cached in one or more CPU
   557 // registers. The TosState corresponds to the 'machine represention' of this cached
   558 // value. There's 4 states corresponding to the JAVA types int, long, float & double
   559 // as well as a 5th state in case the top-of-stack value is actually on the top
   560 // of stack (in memory) and thus not cached. The atos state corresponds to the itos
   561 // state when it comes to machine representation but is used separately for (oop)
   562 // type specific operations (e.g. verification code).
   564 enum TosState {         // describes the tos cache contents
   565   btos = 0,             // byte, bool tos cached
   566   ctos = 1,             // short, char tos cached
   567   stos = 2,             // short, char tos cached
   568   itos = 3,             // int tos cached
   569   ltos = 4,             // long tos cached
   570   ftos = 5,             // float tos cached
   571   dtos = 6,             // double tos cached
   572   atos = 7,             // object cached
   573   vtos = 8,             // tos not cached
   574   number_of_states,
   575   ilgl                  // illegal state: should not occur
   576 };
   579 inline TosState as_TosState(BasicType type) {
   580   switch (type) {
   581     case T_BYTE   : return btos;
   582     case T_BOOLEAN: return btos;
   583     case T_CHAR   : return ctos;
   584     case T_SHORT  : return stos;
   585     case T_INT    : return itos;
   586     case T_LONG   : return ltos;
   587     case T_FLOAT  : return ftos;
   588     case T_DOUBLE : return dtos;
   589     case T_VOID   : return vtos;
   590     case T_ARRAY  : // fall through
   591     case T_OBJECT : return atos;
   592   }
   593   return ilgl;
   594 }
   597 // Helper function to convert BasicType info into TosState
   598 // Note: Cannot define here as it uses global constant at the time being.
   599 TosState as_TosState(BasicType type);
   602 // ReferenceType is used to distinguish between java/lang/ref/Reference subclasses
   604 enum ReferenceType {
   605  REF_NONE,      // Regular class
   606  REF_OTHER,     // Subclass of java/lang/ref/Reference, but not subclass of one of the classes below
   607  REF_SOFT,      // Subclass of java/lang/ref/SoftReference
   608  REF_WEAK,      // Subclass of java/lang/ref/WeakReference
   609  REF_FINAL,     // Subclass of java/lang/ref/FinalReference
   610  REF_PHANTOM    // Subclass of java/lang/ref/PhantomReference
   611 };
   614 // JavaThreadState keeps track of which part of the code a thread is executing in. This
   615 // information is needed by the safepoint code.
   616 //
   617 // There are 4 essential states:
   618 //
   619 //  _thread_new         : Just started, but not executed init. code yet (most likely still in OS init code)
   620 //  _thread_in_native   : In native code. This is a safepoint region, since all oops will be in jobject handles
   621 //  _thread_in_vm       : Executing in the vm
   622 //  _thread_in_Java     : Executing either interpreted or compiled Java code (or could be in a stub)
   623 //
   624 // Each state has an associated xxxx_trans state, which is an intermediate state used when a thread is in
   625 // a transition from one state to another. These extra states makes it possible for the safepoint code to
   626 // handle certain thread_states without having to suspend the thread - making the safepoint code faster.
   627 //
   628 // Given a state, the xxx_trans state can always be found by adding 1.
   629 //
   630 enum JavaThreadState {
   631   _thread_uninitialized     =  0, // should never happen (missing initialization)
   632   _thread_new               =  2, // just starting up, i.e., in process of being initialized
   633   _thread_new_trans         =  3, // corresponding transition state (not used, included for completness)
   634   _thread_in_native         =  4, // running in native code
   635   _thread_in_native_trans   =  5, // corresponding transition state
   636   _thread_in_vm             =  6, // running in VM
   637   _thread_in_vm_trans       =  7, // corresponding transition state
   638   _thread_in_Java           =  8, // running in Java or in stub code
   639   _thread_in_Java_trans     =  9, // corresponding transition state (not used, included for completness)
   640   _thread_blocked           = 10, // blocked in vm
   641   _thread_blocked_trans     = 11, // corresponding transition state
   642   _thread_max_state         = 12  // maximum thread state+1 - used for statistics allocation
   643 };
   646 // Handy constants for deciding which compiler mode to use.
   647 enum MethodCompilation {
   648   InvocationEntryBci = -1,     // i.e., not a on-stack replacement compilation
   649   InvalidOSREntryBci = -2
   650 };
   652 // Enumeration to distinguish tiers of compilation
   653 enum CompLevel {
   654   CompLevel_none              = 0,
   655   CompLevel_fast_compile      = 1,
   656   CompLevel_full_optimization = 2,
   658   CompLevel_highest_tier      = CompLevel_full_optimization,
   659 #ifdef TIERED
   660   CompLevel_initial_compile   = CompLevel_fast_compile
   661 #else
   662   CompLevel_initial_compile   = CompLevel_full_optimization
   663 #endif // TIERED
   664 };
   666 inline bool is_tier1_compile(int comp_level) {
   667   return comp_level == CompLevel_fast_compile;
   668 }
   669 inline bool is_tier2_compile(int comp_level) {
   670   return comp_level == CompLevel_full_optimization;
   671 }
   672 inline bool is_highest_tier_compile(int comp_level) {
   673   return comp_level == CompLevel_highest_tier;
   674 }
   676 //----------------------------------------------------------------------------------------------------
   677 // 'Forward' declarations of frequently used classes
   678 // (in order to reduce interface dependencies & reduce
   679 // number of unnecessary compilations after changes)
   681 class symbolTable;
   682 class ClassFileStream;
   684 class Event;
   686 class Thread;
   687 class  VMThread;
   688 class  JavaThread;
   689 class Threads;
   691 class VM_Operation;
   692 class VMOperationQueue;
   694 class CodeBlob;
   695 class  nmethod;
   696 class  OSRAdapter;
   697 class  I2CAdapter;
   698 class  C2IAdapter;
   699 class CompiledIC;
   700 class relocInfo;
   701 class ScopeDesc;
   702 class PcDesc;
   704 class Recompiler;
   705 class Recompilee;
   706 class RecompilationPolicy;
   707 class RFrame;
   708 class  CompiledRFrame;
   709 class  InterpretedRFrame;
   711 class frame;
   713 class vframe;
   714 class   javaVFrame;
   715 class     interpretedVFrame;
   716 class     compiledVFrame;
   717 class     deoptimizedVFrame;
   718 class   externalVFrame;
   719 class     entryVFrame;
   721 class RegisterMap;
   723 class Mutex;
   724 class Monitor;
   725 class BasicLock;
   726 class BasicObjectLock;
   728 class PeriodicTask;
   730 class JavaCallWrapper;
   732 class   oopDesc;
   734 class NativeCall;
   736 class zone;
   738 class StubQueue;
   740 class outputStream;
   742 class ResourceArea;
   744 class DebugInformationRecorder;
   745 class ScopeValue;
   746 class CompressedStream;
   747 class   DebugInfoReadStream;
   748 class   DebugInfoWriteStream;
   749 class LocationValue;
   750 class ConstantValue;
   751 class IllegalValue;
   753 class PrivilegedElement;
   754 class MonitorArray;
   756 class MonitorInfo;
   758 class OffsetClosure;
   759 class OopMapCache;
   760 class InterpreterOopMap;
   761 class OopMapCacheEntry;
   762 class OSThread;
   764 typedef int (*OSThreadStartFunc)(void*);
   766 class Space;
   768 class JavaValue;
   769 class methodHandle;
   770 class JavaCallArguments;
   772 // Basic support for errors (general debug facilities not defined at this point fo the include phase)
   774 extern void basic_fatal(const char* msg);
   777 //----------------------------------------------------------------------------------------------------
   778 // Special constants for debugging
   780 const jint     badInt           = -3;                       // generic "bad int" value
   781 const long     badAddressVal    = -2;                       // generic "bad address" value
   782 const long     badOopVal        = -1;                       // generic "bad oop" value
   783 const intptr_t badHeapOopVal    = (intptr_t) CONST64(0x2BAD4B0BBAADBABE); // value used to zap heap after GC
   784 const int      badHandleValue   = 0xBC;                     // value used to zap vm handle area
   785 const int      badResourceValue = 0xAB;                     // value used to zap resource area
   786 const int      freeBlockPad     = 0xBA;                     // value used to pad freed blocks.
   787 const int      uninitBlockPad   = 0xF1;                     // value used to zap newly malloc'd blocks.
   788 const intptr_t badJNIHandleVal  = (intptr_t) CONST64(0xFEFEFEFEFEFEFEFE); // value used to zap jni handle area
   789 const juint    badHeapWordVal   = 0xBAADBABE;               // value used to zap heap after GC
   790 const int      badCodeHeapNewVal= 0xCC;                     // value used to zap Code heap at allocation
   791 const int      badCodeHeapFreeVal = 0xDD;                   // value used to zap Code heap at deallocation
   794 // (These must be implemented as #defines because C++ compilers are
   795 // not obligated to inline non-integral constants!)
   796 #define       badAddress        ((address)::badAddressVal)
   797 #define       badOop            ((oop)::badOopVal)
   798 #define       badHeapWord       (::badHeapWordVal)
   799 #define       badJNIHandle      ((oop)::badJNIHandleVal)
   802 //----------------------------------------------------------------------------------------------------
   803 // Utility functions for bitfield manipulations
   805 const intptr_t AllBits    = ~0; // all bits set in a word
   806 const intptr_t NoBits     =  0; // no bits set in a word
   807 const jlong    NoLongBits =  0; // no bits set in a long
   808 const intptr_t OneBit     =  1; // only right_most bit set in a word
   810 // get a word with the n.th or the right-most or left-most n bits set
   811 // (note: #define used only so that they can be used in enum constant definitions)
   812 #define nth_bit(n)        (n >= BitsPerWord ? 0 : OneBit << (n))
   813 #define right_n_bits(n)   (nth_bit(n) - 1)
   814 #define left_n_bits(n)    (right_n_bits(n) << (n >= BitsPerWord ? 0 : (BitsPerWord - n)))
   816 // bit-operations using a mask m
   817 inline void   set_bits    (intptr_t& x, intptr_t m) { x |= m; }
   818 inline void clear_bits    (intptr_t& x, intptr_t m) { x &= ~m; }
   819 inline intptr_t mask_bits      (intptr_t  x, intptr_t m) { return x & m; }
   820 inline jlong    mask_long_bits (jlong     x, jlong    m) { return x & m; }
   821 inline bool mask_bits_are_true (intptr_t flags, intptr_t mask) { return (flags & mask) == mask; }
   823 // bit-operations using the n.th bit
   824 inline void    set_nth_bit(intptr_t& x, int n) { set_bits  (x, nth_bit(n)); }
   825 inline void  clear_nth_bit(intptr_t& x, int n) { clear_bits(x, nth_bit(n)); }
   826 inline bool is_set_nth_bit(intptr_t  x, int n) { return mask_bits (x, nth_bit(n)) != NoBits; }
   828 // returns the bitfield of x starting at start_bit_no with length field_length (no sign-extension!)
   829 inline intptr_t bitfield(intptr_t x, int start_bit_no, int field_length) {
   830   return mask_bits(x >> start_bit_no, right_n_bits(field_length));
   831 }
   834 //----------------------------------------------------------------------------------------------------
   835 // Utility functions for integers
   837 // Avoid use of global min/max macros which may cause unwanted double
   838 // evaluation of arguments.
   839 #ifdef max
   840 #undef max
   841 #endif
   843 #ifdef min
   844 #undef min
   845 #endif
   847 #define max(a,b) Do_not_use_max_use_MAX2_instead
   848 #define min(a,b) Do_not_use_min_use_MIN2_instead
   850 // It is necessary to use templates here. Having normal overloaded
   851 // functions does not work because it is necessary to provide both 32-
   852 // and 64-bit overloaded functions, which does not work, and having
   853 // explicitly-typed versions of these routines (i.e., MAX2I, MAX2L)
   854 // will be even more error-prone than macros.
   855 template<class T> inline T MAX2(T a, T b)           { return (a > b) ? a : b; }
   856 template<class T> inline T MIN2(T a, T b)           { return (a < b) ? a : b; }
   857 template<class T> inline T MAX3(T a, T b, T c)      { return MAX2(MAX2(a, b), c); }
   858 template<class T> inline T MIN3(T a, T b, T c)      { return MIN2(MIN2(a, b), c); }
   859 template<class T> inline T MAX4(T a, T b, T c, T d) { return MAX2(MAX3(a, b, c), d); }
   860 template<class T> inline T MIN4(T a, T b, T c, T d) { return MIN2(MIN3(a, b, c), d); }
   862 template<class T> inline T ABS(T x)                 { return (x > 0) ? x : -x; }
   864 // true if x is a power of 2, false otherwise
   865 inline bool is_power_of_2(intptr_t x) {
   866   return ((x != NoBits) && (mask_bits(x, x - 1) == NoBits));
   867 }
   869 // long version of is_power_of_2
   870 inline bool is_power_of_2_long(jlong x) {
   871   return ((x != NoLongBits) && (mask_long_bits(x, x - 1) == NoLongBits));
   872 }
   874 //* largest i such that 2^i <= x
   875 //  A negative value of 'x' will return '31'
   876 inline int log2_intptr(intptr_t x) {
   877   int i = -1;
   878   uintptr_t p =  1;
   879   while (p != 0 && p <= (uintptr_t)x) {
   880     // p = 2^(i+1) && p <= x (i.e., 2^(i+1) <= x)
   881     i++; p *= 2;
   882   }
   883   // p = 2^(i+1) && x < p (i.e., 2^i <= x < 2^(i+1))
   884   // (if p = 0 then overflow occurred and i = 31)
   885   return i;
   886 }
   888 //* largest i such that 2^i <= x
   889 //  A negative value of 'x' will return '63'
   890 inline int log2_long(jlong x) {
   891   int i = -1;
   892   julong p =  1;
   893   while (p != 0 && p <= (julong)x) {
   894     // p = 2^(i+1) && p <= x (i.e., 2^(i+1) <= x)
   895     i++; p *= 2;
   896   }
   897   // p = 2^(i+1) && x < p (i.e., 2^i <= x < 2^(i+1))
   898   // (if p = 0 then overflow occurred and i = 63)
   899   return i;
   900 }
   902 //* the argument must be exactly a power of 2
   903 inline int exact_log2(intptr_t x) {
   904   #ifdef ASSERT
   905     if (!is_power_of_2(x)) basic_fatal("x must be a power of 2");
   906   #endif
   907   return log2_intptr(x);
   908 }
   910 //* the argument must be exactly a power of 2
   911 inline int exact_log2_long(jlong x) {
   912   #ifdef ASSERT
   913     if (!is_power_of_2_long(x)) basic_fatal("x must be a power of 2");
   914   #endif
   915   return log2_long(x);
   916 }
   919 // returns integer round-up to the nearest multiple of s (s must be a power of two)
   920 inline intptr_t round_to(intptr_t x, uintx s) {
   921   #ifdef ASSERT
   922     if (!is_power_of_2(s)) basic_fatal("s must be a power of 2");
   923   #endif
   924   const uintx m = s - 1;
   925   return mask_bits(x + m, ~m);
   926 }
   928 // returns integer round-down to the nearest multiple of s (s must be a power of two)
   929 inline intptr_t round_down(intptr_t x, uintx s) {
   930   #ifdef ASSERT
   931     if (!is_power_of_2(s)) basic_fatal("s must be a power of 2");
   932   #endif
   933   const uintx m = s - 1;
   934   return mask_bits(x, ~m);
   935 }
   938 inline bool is_odd (intx x) { return x & 1;      }
   939 inline bool is_even(intx x) { return !is_odd(x); }
   941 // "to" should be greater than "from."
   942 inline intx byte_size(void* from, void* to) {
   943   return (address)to - (address)from;
   944 }
   946 //----------------------------------------------------------------------------------------------------
   947 // Avoid non-portable casts with these routines (DEPRECATED)
   949 // NOTE: USE Bytes class INSTEAD WHERE POSSIBLE
   950 //       Bytes is optimized machine-specifically and may be much faster then the portable routines below.
   952 // Given sequence of four bytes, build into a 32-bit word
   953 // following the conventions used in class files.
   954 // On the 386, this could be realized with a simple address cast.
   955 //
   957 // This routine takes eight bytes:
   958 inline u8 build_u8_from( u1 c1, u1 c2, u1 c3, u1 c4, u1 c5, u1 c6, u1 c7, u1 c8 ) {
   959   return  ( u8(c1) << 56 )  &  ( u8(0xff) << 56 )
   960        |  ( u8(c2) << 48 )  &  ( u8(0xff) << 48 )
   961        |  ( u8(c3) << 40 )  &  ( u8(0xff) << 40 )
   962        |  ( u8(c4) << 32 )  &  ( u8(0xff) << 32 )
   963        |  ( u8(c5) << 24 )  &  ( u8(0xff) << 24 )
   964        |  ( u8(c6) << 16 )  &  ( u8(0xff) << 16 )
   965        |  ( u8(c7) <<  8 )  &  ( u8(0xff) <<  8 )
   966        |  ( u8(c8) <<  0 )  &  ( u8(0xff) <<  0 );
   967 }
   969 // This routine takes four bytes:
   970 inline u4 build_u4_from( u1 c1, u1 c2, u1 c3, u1 c4 ) {
   971   return  ( u4(c1) << 24 )  &  0xff000000
   972        |  ( u4(c2) << 16 )  &  0x00ff0000
   973        |  ( u4(c3) <<  8 )  &  0x0000ff00
   974        |  ( u4(c4) <<  0 )  &  0x000000ff;
   975 }
   977 // And this one works if the four bytes are contiguous in memory:
   978 inline u4 build_u4_from( u1* p ) {
   979   return  build_u4_from( p[0], p[1], p[2], p[3] );
   980 }
   982 // Ditto for two-byte ints:
   983 inline u2 build_u2_from( u1 c1, u1 c2 ) {
   984   return  u2(( u2(c1) <<  8 )  &  0xff00
   985           |  ( u2(c2) <<  0 )  &  0x00ff);
   986 }
   988 // And this one works if the two bytes are contiguous in memory:
   989 inline u2 build_u2_from( u1* p ) {
   990   return  build_u2_from( p[0], p[1] );
   991 }
   993 // Ditto for floats:
   994 inline jfloat build_float_from( u1 c1, u1 c2, u1 c3, u1 c4 ) {
   995   u4 u = build_u4_from( c1, c2, c3, c4 );
   996   return  *(jfloat*)&u;
   997 }
   999 inline jfloat build_float_from( u1* p ) {
  1000   u4 u = build_u4_from( p );
  1001   return  *(jfloat*)&u;
  1005 // now (64-bit) longs
  1007 inline jlong build_long_from( u1 c1, u1 c2, u1 c3, u1 c4, u1 c5, u1 c6, u1 c7, u1 c8 ) {
  1008   return  ( jlong(c1) << 56 )  &  ( jlong(0xff) << 56 )
  1009        |  ( jlong(c2) << 48 )  &  ( jlong(0xff) << 48 )
  1010        |  ( jlong(c3) << 40 )  &  ( jlong(0xff) << 40 )
  1011        |  ( jlong(c4) << 32 )  &  ( jlong(0xff) << 32 )
  1012        |  ( jlong(c5) << 24 )  &  ( jlong(0xff) << 24 )
  1013        |  ( jlong(c6) << 16 )  &  ( jlong(0xff) << 16 )
  1014        |  ( jlong(c7) <<  8 )  &  ( jlong(0xff) <<  8 )
  1015        |  ( jlong(c8) <<  0 )  &  ( jlong(0xff) <<  0 );
  1018 inline jlong build_long_from( u1* p ) {
  1019   return  build_long_from( p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7] );
  1023 // Doubles, too!
  1024 inline jdouble build_double_from( u1 c1, u1 c2, u1 c3, u1 c4, u1 c5, u1 c6, u1 c7, u1 c8 ) {
  1025   jlong u = build_long_from( c1, c2, c3, c4, c5, c6, c7, c8 );
  1026   return  *(jdouble*)&u;
  1029 inline jdouble build_double_from( u1* p ) {
  1030   jlong u = build_long_from( p );
  1031   return  *(jdouble*)&u;
  1035 // Portable routines to go the other way:
  1037 inline void explode_short_to( u2 x, u1& c1, u1& c2 ) {
  1038   c1 = u1(x >> 8);
  1039   c2 = u1(x);
  1042 inline void explode_short_to( u2 x, u1* p ) {
  1043   explode_short_to( x, p[0], p[1]);
  1046 inline void explode_int_to( u4 x, u1& c1, u1& c2, u1& c3, u1& c4 ) {
  1047   c1 = u1(x >> 24);
  1048   c2 = u1(x >> 16);
  1049   c3 = u1(x >>  8);
  1050   c4 = u1(x);
  1053 inline void explode_int_to( u4 x, u1* p ) {
  1054   explode_int_to( x, p[0], p[1], p[2], p[3]);
  1058 // Pack and extract shorts to/from ints:
  1060 inline int extract_low_short_from_int(jint x) {
  1061   return x & 0xffff;
  1064 inline int extract_high_short_from_int(jint x) {
  1065   return (x >> 16) & 0xffff;
  1068 inline int build_int_from_shorts( jushort low, jushort high ) {
  1069   return ((int)((unsigned int)high << 16) | (unsigned int)low);
  1072 // Printf-style formatters for fixed- and variable-width types as pointers and
  1073 // integers.
  1074 //
  1075 // Each compiler-specific definitions file (e.g., globalDefinitions_gcc.hpp)
  1076 // must define the macro FORMAT64_MODIFIER, which is the modifier for '%x' or
  1077 // '%d' formats to indicate a 64-bit quantity; commonly "l" (in LP64) or "ll"
  1078 // (in ILP32).
  1080 // Format 32-bit quantities.
  1081 #define INT32_FORMAT  "%d"
  1082 #define UINT32_FORMAT "%u"
  1083 #define INT32_FORMAT_W(width)   "%" #width "d"
  1084 #define UINT32_FORMAT_W(width)  "%" #width "u"
  1086 #define PTR32_FORMAT  "0x%08x"
  1088 // Format 64-bit quantities.
  1089 #define INT64_FORMAT  "%" FORMAT64_MODIFIER "d"
  1090 #define UINT64_FORMAT "%" FORMAT64_MODIFIER "u"
  1091 #define PTR64_FORMAT  "0x%016" FORMAT64_MODIFIER "x"
  1093 #define INT64_FORMAT_W(width)  "%" #width FORMAT64_MODIFIER "d"
  1094 #define UINT64_FORMAT_W(width) "%" #width FORMAT64_MODIFIER "u"
  1096 // Format macros that allow the field width to be specified.  The width must be
  1097 // a string literal (e.g., "8") or a macro that evaluates to one.
  1098 #ifdef _LP64
  1099 #define UINTX_FORMAT_W(width)   UINT64_FORMAT_W(width)
  1100 #define SSIZE_FORMAT_W(width)   INT64_FORMAT_W(width)
  1101 #define SIZE_FORMAT_W(width)    UINT64_FORMAT_W(width)
  1102 #else
  1103 #define UINTX_FORMAT_W(width)   UINT32_FORMAT_W(width)
  1104 #define SSIZE_FORMAT_W(width)   INT32_FORMAT_W(width)
  1105 #define SIZE_FORMAT_W(width)    UINT32_FORMAT_W(width)
  1106 #endif // _LP64
  1108 // Format pointers and size_t (or size_t-like integer types) which change size
  1109 // between 32- and 64-bit. The pointer format theoretically should be "%p",
  1110 // however, it has different output on different platforms. On Windows, the data
  1111 // will be padded with zeros automatically. On Solaris, we can use "%016p" &
  1112 // "%08p" on 64 bit & 32 bit platforms to make the data padded with extra zeros.
  1113 // On Linux, "%016p" or "%08p" is not be allowed, at least on the latest GCC
  1114 // 4.3.2. So we have to use "%016x" or "%08x" to simulate the printing format.
  1115 // GCC 4.3.2, however requires the data to be converted to "intptr_t" when
  1116 // using "%x".
  1117 #ifdef  _LP64
  1118 #define PTR_FORMAT    PTR64_FORMAT
  1119 #define UINTX_FORMAT  UINT64_FORMAT
  1120 #define INTX_FORMAT   INT64_FORMAT
  1121 #define SIZE_FORMAT   UINT64_FORMAT
  1122 #define SSIZE_FORMAT  INT64_FORMAT
  1123 #else   // !_LP64
  1124 #define PTR_FORMAT    PTR32_FORMAT
  1125 #define UINTX_FORMAT  UINT32_FORMAT
  1126 #define INTX_FORMAT   INT32_FORMAT
  1127 #define SIZE_FORMAT   UINT32_FORMAT
  1128 #define SSIZE_FORMAT  INT32_FORMAT
  1129 #endif  // _LP64
  1131 #define INTPTR_FORMAT PTR_FORMAT
  1133 // Enable zap-a-lot if in debug version.
  1135 # ifdef ASSERT
  1136 # ifdef COMPILER2
  1137 #   define ENABLE_ZAP_DEAD_LOCALS
  1138 #endif /* COMPILER2 */
  1139 # endif /* ASSERT */
  1141 #define ARRAY_SIZE(array) (sizeof(array)/sizeof((array)[0]))

mercurial