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