src/share/vm/oops/oop.hpp

Tue, 24 Jun 2008 16:00:14 -0700

author
never
date
Tue, 24 Jun 2008 16:00:14 -0700
changeset 657
2a1a77d3458f
parent 602
feeb96a45707
child 631
d1605aabd0a1
child 779
6aae2f9d0294
permissions
-rw-r--r--

6718676: putback for 6604014 is incomplete
Reviewed-by: kvn, jrose

duke@435 1 /*
duke@435 2 * Copyright 1997-2007 Sun Microsystems, Inc. All Rights Reserved.
duke@435 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435 4 *
duke@435 5 * This code is free software; you can redistribute it and/or modify it
duke@435 6 * under the terms of the GNU General Public License version 2 only, as
duke@435 7 * published by the Free Software Foundation.
duke@435 8 *
duke@435 9 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@435 12 * version 2 for more details (a copy is included in the LICENSE file that
duke@435 13 * accompanied this code).
duke@435 14 *
duke@435 15 * You should have received a copy of the GNU General Public License version
duke@435 16 * 2 along with this work; if not, write to the Free Software Foundation,
duke@435 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435 18 *
duke@435 19 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@435 20 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@435 21 * have any questions.
duke@435 22 *
duke@435 23 */
duke@435 24
duke@435 25 // oopDesc is the top baseclass for objects classes. The {name}Desc classes describe
duke@435 26 // the format of Java objects so the fields can be accessed from C++.
duke@435 27 // oopDesc is abstract.
duke@435 28 // (see oopHierarchy for complete oop class hierarchy)
duke@435 29 //
duke@435 30 // no virtual functions allowed
duke@435 31
duke@435 32 // store into oop with store check
coleenp@548 33 template <class T> void oop_store(T* p, oop v);
coleenp@548 34 template <class T> void oop_store(volatile T* p, oop v);
duke@435 35
duke@435 36 // store into oop without store check
coleenp@548 37 template <class T> void oop_store_without_check(T* p, oop v);
coleenp@548 38 template <class T> void oop_store_without_check(volatile T* p, oop v);
duke@435 39
duke@435 40
duke@435 41 extern bool always_do_update_barrier;
duke@435 42
duke@435 43 // Forward declarations.
duke@435 44 class OopClosure;
duke@435 45 class ScanClosure;
duke@435 46 class FastScanClosure;
duke@435 47 class FilteringClosure;
duke@435 48 class BarrierSet;
duke@435 49 class CMSIsAliveClosure;
duke@435 50
duke@435 51 class PSPromotionManager;
duke@435 52 class ParCompactionManager;
duke@435 53
duke@435 54 class oopDesc {
duke@435 55 friend class VMStructs;
duke@435 56 private:
duke@435 57 volatile markOop _mark;
coleenp@548 58 union _metadata {
coleenp@548 59 wideKlassOop _klass;
coleenp@548 60 narrowOop _compressed_klass;
coleenp@548 61 } _metadata;
duke@435 62
duke@435 63 // Fast access to barrier set. Must be initialized.
duke@435 64 static BarrierSet* _bs;
duke@435 65
duke@435 66 public:
duke@435 67 markOop mark() const { return _mark; }
duke@435 68 markOop* mark_addr() const { return (markOop*) &_mark; }
duke@435 69
duke@435 70 void set_mark(volatile markOop m) { _mark = m; }
duke@435 71
duke@435 72 void release_set_mark(markOop m);
duke@435 73 markOop cas_set_mark(markOop new_mark, markOop old_mark);
duke@435 74
duke@435 75 // Used only to re-initialize the mark word (e.g., of promoted
duke@435 76 // objects during a GC) -- requires a valid klass pointer
duke@435 77 void init_mark();
duke@435 78
coleenp@548 79 klassOop klass() const;
coleenp@602 80 klassOop klass_or_null() const volatile;
coleenp@548 81 oop* klass_addr();
coleenp@548 82 narrowOop* compressed_klass_addr();
duke@435 83
duke@435 84 void set_klass(klassOop k);
coleenp@602 85
coleenp@602 86 // For klass field compression
coleenp@602 87 int klass_gap() const;
coleenp@602 88 void set_klass_gap(int z);
duke@435 89 // For when the klass pointer is being used as a linked list "next" field.
duke@435 90 void set_klass_to_list_ptr(oop k);
duke@435 91
coleenp@548 92 // size of object header, aligned to platform wordSize
coleenp@548 93 static int header_size() { return sizeof(oopDesc)/HeapWordSize; }
duke@435 94
duke@435 95 Klass* blueprint() const;
duke@435 96
duke@435 97 // Returns whether this is an instance of k or an instance of a subclass of k
duke@435 98 bool is_a(klassOop k) const;
duke@435 99
duke@435 100 // Returns the actual oop size of the object
duke@435 101 int size();
duke@435 102
duke@435 103 // Sometimes (for complicated concurrency-related reasons), it is useful
duke@435 104 // to be able to figure out the size of an object knowing its klass.
duke@435 105 int size_given_klass(Klass* klass);
duke@435 106
duke@435 107 // Some perm gen objects are not parseble immediately after
duke@435 108 // installation of their klass pointer.
duke@435 109 bool is_parsable();
duke@435 110
duke@435 111 // type test operations (inlined in oop.inline.h)
duke@435 112 bool is_instance() const;
duke@435 113 bool is_instanceRef() const;
duke@435 114 bool is_array() const;
duke@435 115 bool is_objArray() const;
duke@435 116 bool is_symbol() const;
duke@435 117 bool is_klass() const;
duke@435 118 bool is_thread() const;
duke@435 119 bool is_method() const;
duke@435 120 bool is_constMethod() const;
duke@435 121 bool is_methodData() const;
duke@435 122 bool is_constantPool() const;
duke@435 123 bool is_constantPoolCache() const;
duke@435 124 bool is_typeArray() const;
duke@435 125 bool is_javaArray() const;
duke@435 126 bool is_compiledICHolder() const;
duke@435 127
duke@435 128 private:
duke@435 129 // field addresses in oop
duke@435 130 void* field_base(int offset) const;
duke@435 131
duke@435 132 jbyte* byte_field_addr(int offset) const;
duke@435 133 jchar* char_field_addr(int offset) const;
duke@435 134 jboolean* bool_field_addr(int offset) const;
duke@435 135 jint* int_field_addr(int offset) const;
duke@435 136 jshort* short_field_addr(int offset) const;
duke@435 137 jlong* long_field_addr(int offset) const;
duke@435 138 jfloat* float_field_addr(int offset) const;
duke@435 139 jdouble* double_field_addr(int offset) const;
coleenp@548 140 address* address_field_addr(int offset) const;
duke@435 141
duke@435 142 public:
coleenp@548 143 // Need this as public for garbage collection.
coleenp@548 144 template <class T> T* obj_field_addr(int offset) const;
duke@435 145
coleenp@570 146 // Oop encoding heap max
coleenp@570 147 static const uint64_t OopEncodingHeapMax =
coleenp@570 148 (uint64_t(max_juint) + 1) << LogMinObjAlignmentInBytes;
coleenp@570 149
coleenp@548 150 static bool is_null(oop obj);
coleenp@548 151 static bool is_null(narrowOop obj);
coleenp@548 152
coleenp@548 153 // Decode an oop pointer from a narrowOop if compressed.
coleenp@548 154 // These are overloaded for oop and narrowOop as are the other functions
coleenp@548 155 // below so that they can be called in template functions.
coleenp@548 156 static oop decode_heap_oop_not_null(oop v);
coleenp@548 157 static oop decode_heap_oop_not_null(narrowOop v);
coleenp@548 158 static oop decode_heap_oop(oop v);
coleenp@548 159 static oop decode_heap_oop(narrowOop v);
coleenp@548 160
coleenp@548 161 // Encode an oop pointer to a narrow oop. The or_null versions accept
coleenp@548 162 // null oop pointer, others do not in order to eliminate the
coleenp@548 163 // null checking branches.
coleenp@548 164 static narrowOop encode_heap_oop_not_null(oop v);
coleenp@548 165 static narrowOop encode_heap_oop(oop v);
coleenp@548 166
coleenp@548 167 // Load an oop out of the Java heap
coleenp@548 168 static narrowOop load_heap_oop(narrowOop* p);
coleenp@548 169 static oop load_heap_oop(oop* p);
coleenp@548 170
coleenp@548 171 // Load an oop out of Java heap and decode it to an uncompressed oop.
coleenp@548 172 static oop load_decode_heap_oop_not_null(narrowOop* p);
coleenp@548 173 static oop load_decode_heap_oop_not_null(oop* p);
coleenp@548 174 static oop load_decode_heap_oop(narrowOop* p);
coleenp@548 175 static oop load_decode_heap_oop(oop* p);
coleenp@548 176
coleenp@548 177 // Store an oop into the heap.
coleenp@548 178 static void store_heap_oop(narrowOop* p, narrowOop v);
coleenp@548 179 static void store_heap_oop(oop* p, oop v);
coleenp@548 180
coleenp@548 181 // Encode oop if UseCompressedOops and store into the heap.
coleenp@548 182 static void encode_store_heap_oop_not_null(narrowOop* p, oop v);
coleenp@548 183 static void encode_store_heap_oop_not_null(oop* p, oop v);
coleenp@548 184 static void encode_store_heap_oop(narrowOop* p, oop v);
coleenp@548 185 static void encode_store_heap_oop(oop* p, oop v);
coleenp@548 186
coleenp@548 187 static void release_store_heap_oop(volatile narrowOop* p, narrowOop v);
coleenp@548 188 static void release_store_heap_oop(volatile oop* p, oop v);
coleenp@548 189
coleenp@548 190 static void release_encode_store_heap_oop_not_null(volatile narrowOop* p, oop v);
coleenp@548 191 static void release_encode_store_heap_oop_not_null(volatile oop* p, oop v);
coleenp@548 192 static void release_encode_store_heap_oop(volatile narrowOop* p, oop v);
coleenp@548 193 static void release_encode_store_heap_oop(volatile oop* p, oop v);
coleenp@548 194
coleenp@548 195 static oop atomic_exchange_oop(oop exchange_value, volatile HeapWord *dest);
coleenp@548 196 static oop atomic_compare_exchange_oop(oop exchange_value,
coleenp@548 197 volatile HeapWord *dest,
coleenp@548 198 oop compare_value);
coleenp@548 199
coleenp@548 200 // Access to fields in a instanceOop through these methods.
duke@435 201 oop obj_field(int offset) const;
duke@435 202 void obj_field_put(int offset, oop value);
coleenp@548 203 void obj_field_raw_put(int offset, oop value);
duke@435 204
duke@435 205 jbyte byte_field(int offset) const;
duke@435 206 void byte_field_put(int offset, jbyte contents);
duke@435 207
duke@435 208 jchar char_field(int offset) const;
duke@435 209 void char_field_put(int offset, jchar contents);
duke@435 210
duke@435 211 jboolean bool_field(int offset) const;
duke@435 212 void bool_field_put(int offset, jboolean contents);
duke@435 213
duke@435 214 jint int_field(int offset) const;
duke@435 215 void int_field_put(int offset, jint contents);
duke@435 216
duke@435 217 jshort short_field(int offset) const;
duke@435 218 void short_field_put(int offset, jshort contents);
duke@435 219
duke@435 220 jlong long_field(int offset) const;
duke@435 221 void long_field_put(int offset, jlong contents);
duke@435 222
duke@435 223 jfloat float_field(int offset) const;
duke@435 224 void float_field_put(int offset, jfloat contents);
duke@435 225
duke@435 226 jdouble double_field(int offset) const;
duke@435 227 void double_field_put(int offset, jdouble contents);
duke@435 228
coleenp@548 229 address address_field(int offset) const;
coleenp@548 230 void address_field_put(int offset, address contents);
coleenp@548 231
duke@435 232 oop obj_field_acquire(int offset) const;
duke@435 233 void release_obj_field_put(int offset, oop value);
duke@435 234
duke@435 235 jbyte byte_field_acquire(int offset) const;
duke@435 236 void release_byte_field_put(int offset, jbyte contents);
duke@435 237
duke@435 238 jchar char_field_acquire(int offset) const;
duke@435 239 void release_char_field_put(int offset, jchar contents);
duke@435 240
duke@435 241 jboolean bool_field_acquire(int offset) const;
duke@435 242 void release_bool_field_put(int offset, jboolean contents);
duke@435 243
duke@435 244 jint int_field_acquire(int offset) const;
duke@435 245 void release_int_field_put(int offset, jint contents);
duke@435 246
duke@435 247 jshort short_field_acquire(int offset) const;
duke@435 248 void release_short_field_put(int offset, jshort contents);
duke@435 249
duke@435 250 jlong long_field_acquire(int offset) const;
duke@435 251 void release_long_field_put(int offset, jlong contents);
duke@435 252
duke@435 253 jfloat float_field_acquire(int offset) const;
duke@435 254 void release_float_field_put(int offset, jfloat contents);
duke@435 255
duke@435 256 jdouble double_field_acquire(int offset) const;
duke@435 257 void release_double_field_put(int offset, jdouble contents);
duke@435 258
duke@435 259 // printing functions for VM debugging
duke@435 260 void print_on(outputStream* st) const; // First level print
duke@435 261 void print_value_on(outputStream* st) const; // Second level print.
duke@435 262 void print_address_on(outputStream* st) const; // Address printing
duke@435 263
duke@435 264 // printing on default output stream
duke@435 265 void print();
duke@435 266 void print_value();
duke@435 267 void print_address();
duke@435 268
duke@435 269 // return the print strings
duke@435 270 char* print_string();
duke@435 271 char* print_value_string();
duke@435 272
duke@435 273 // verification operations
duke@435 274 void verify_on(outputStream* st);
duke@435 275 void verify();
duke@435 276 void verify_old_oop(oop* p, bool allow_dirty);
coleenp@548 277 void verify_old_oop(narrowOop* p, bool allow_dirty);
duke@435 278
duke@435 279 // tells whether this oop is partially constructed (gc during class loading)
duke@435 280 bool partially_loaded();
duke@435 281 void set_partially_loaded();
duke@435 282
duke@435 283 // locking operations
duke@435 284 bool is_locked() const;
duke@435 285 bool is_unlocked() const;
duke@435 286 bool has_bias_pattern() const;
duke@435 287
duke@435 288 // asserts
duke@435 289 bool is_oop(bool ignore_mark_word = false) const;
duke@435 290 bool is_oop_or_null(bool ignore_mark_word = false) const;
duke@435 291 #ifndef PRODUCT
duke@435 292 bool is_unlocked_oop() const;
duke@435 293 #endif
duke@435 294
duke@435 295 // garbage collection
duke@435 296 bool is_gc_marked() const;
duke@435 297 // Apply "MarkSweep::mark_and_push" to (the address of) every non-NULL
duke@435 298 // reference field in "this".
coleenp@548 299 void follow_contents(void);
coleenp@548 300 void follow_header(void);
duke@435 301
duke@435 302 #ifndef SERIALGC
duke@435 303 // Parallel Scavenge
duke@435 304 void copy_contents(PSPromotionManager* pm);
duke@435 305 void push_contents(PSPromotionManager* pm);
duke@435 306
duke@435 307 // Parallel Old
duke@435 308 void update_contents(ParCompactionManager* cm);
duke@435 309 void update_contents(ParCompactionManager* cm,
duke@435 310 HeapWord* begin_limit,
duke@435 311 HeapWord* end_limit);
duke@435 312 void update_contents(ParCompactionManager* cm,
duke@435 313 klassOop old_klass,
duke@435 314 HeapWord* begin_limit,
duke@435 315 HeapWord* end_limit);
duke@435 316
duke@435 317 void follow_contents(ParCompactionManager* cm);
duke@435 318 void follow_header(ParCompactionManager* cm);
duke@435 319 #endif // SERIALGC
duke@435 320
duke@435 321 bool is_perm() const;
duke@435 322 bool is_perm_or_null() const;
duke@435 323 bool is_shared() const;
duke@435 324 bool is_shared_readonly() const;
duke@435 325 bool is_shared_readwrite() const;
duke@435 326
duke@435 327 // Forward pointer operations for scavenge
duke@435 328 bool is_forwarded() const;
duke@435 329
duke@435 330 void forward_to(oop p);
duke@435 331 bool cas_forward_to(oop p, markOop compare);
duke@435 332
duke@435 333 #ifndef SERIALGC
duke@435 334 // Like "forward_to", but inserts the forwarding pointer atomically.
duke@435 335 // Exactly one thread succeeds in inserting the forwarding pointer, and
duke@435 336 // this call returns "NULL" for that thread; any other thread has the
duke@435 337 // value of the forwarding pointer returned and does not modify "this".
duke@435 338 oop forward_to_atomic(oop p);
duke@435 339 #endif // SERIALGC
duke@435 340
duke@435 341 oop forwardee() const;
duke@435 342
duke@435 343 // Age of object during scavenge
duke@435 344 int age() const;
duke@435 345 void incr_age();
duke@435 346
duke@435 347 // Adjust all pointers in this object to point at it's forwarded location and
duke@435 348 // return the size of this oop. This is used by the MarkSweep collector.
duke@435 349 int adjust_pointers();
duke@435 350 void adjust_header();
duke@435 351
duke@435 352 #ifndef SERIALGC
duke@435 353 // Parallel old
duke@435 354 void update_header();
duke@435 355 void update_header(HeapWord* beg_addr, HeapWord* end_addr);
duke@435 356 #endif // SERIALGC
duke@435 357
duke@435 358 // mark-sweep support
duke@435 359 void follow_body(int begin, int end);
duke@435 360
duke@435 361 // Fast access to barrier set
duke@435 362 static BarrierSet* bs() { return _bs; }
duke@435 363 static void set_bs(BarrierSet* bs) { _bs = bs; }
duke@435 364
duke@435 365 // iterators, returns size of object
duke@435 366 #define OOP_ITERATE_DECL(OopClosureType, nv_suffix) \
duke@435 367 int oop_iterate(OopClosureType* blk); \
duke@435 368 int oop_iterate(OopClosureType* blk, MemRegion mr); // Only in mr.
duke@435 369
duke@435 370 ALL_OOP_OOP_ITERATE_CLOSURES_1(OOP_ITERATE_DECL)
duke@435 371 ALL_OOP_OOP_ITERATE_CLOSURES_3(OOP_ITERATE_DECL)
duke@435 372
duke@435 373 void oop_iterate_header(OopClosure* blk);
duke@435 374 void oop_iterate_header(OopClosure* blk, MemRegion mr);
duke@435 375
duke@435 376 // identity hash; returns the identity hash key (computes it if necessary)
duke@435 377 // NOTE with the introduction of UseBiasedLocking that identity_hash() might reach a
duke@435 378 // safepoint if called on a biased object. Calling code must be aware of that.
duke@435 379 intptr_t identity_hash();
duke@435 380 intptr_t slow_identity_hash();
duke@435 381
duke@435 382 // marks are forwarded to stack when object is locked
duke@435 383 bool has_displaced_mark() const;
duke@435 384 markOop displaced_mark() const;
duke@435 385 void set_displaced_mark(markOop m);
duke@435 386
duke@435 387 // for code generation
duke@435 388 static int mark_offset_in_bytes() { return offset_of(oopDesc, _mark); }
coleenp@548 389 static int klass_offset_in_bytes() { return offset_of(oopDesc, _metadata._klass); }
coleenp@548 390 static int klass_gap_offset_in_bytes();
duke@435 391 };

mercurial