src/share/vm/oops/oop.hpp

Wed, 23 Jan 2013 13:02:39 -0500

author
jprovino
date
Wed, 23 Jan 2013 13:02:39 -0500
changeset 4542
db9981fd3124
parent 4129
22b8d3d181d9
child 5528
740e263c80c6
permissions
-rw-r--r--

8005915: Unify SERIALGC and INCLUDE_ALTERNATE_GCS
Summary: Rename INCLUDE_ALTERNATE_GCS to INCLUDE_ALL_GCS and replace SERIALGC with INCLUDE_ALL_GCS.
Reviewed-by: coleenp, stefank

duke@435 1 /*
brutisso@3711 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. 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 *
trims@1907 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907 20 * or visit www.oracle.com if you need additional information or have any
trims@1907 21 * questions.
duke@435 22 *
duke@435 23 */
duke@435 24
stefank@2314 25 #ifndef SHARE_VM_OOPS_OOP_HPP
stefank@2314 26 #define SHARE_VM_OOPS_OOP_HPP
stefank@2314 27
stefank@2314 28 #include "memory/iterator.hpp"
stefank@2314 29 #include "memory/memRegion.hpp"
stefank@2314 30 #include "memory/specialized_oop_closures.hpp"
coleenp@4037 31 #include "oops/metadata.hpp"
jprovino@4542 32 #include "utilities/macros.hpp"
stefank@2314 33 #include "utilities/top.hpp"
stefank@2314 34
duke@435 35 // oopDesc is the top baseclass for objects classes. The {name}Desc classes describe
duke@435 36 // the format of Java objects so the fields can be accessed from C++.
duke@435 37 // oopDesc is abstract.
duke@435 38 // (see oopHierarchy for complete oop class hierarchy)
duke@435 39 //
duke@435 40 // no virtual functions allowed
duke@435 41
duke@435 42 // store into oop with store check
stefank@2314 43 template <class T> void oop_store(T* p, oop v);
stefank@2314 44 template <class T> void oop_store(volatile T* p, oop v);
duke@435 45
duke@435 46 extern bool always_do_update_barrier;
duke@435 47
duke@435 48 // Forward declarations.
duke@435 49 class OopClosure;
duke@435 50 class ScanClosure;
duke@435 51 class FastScanClosure;
duke@435 52 class FilteringClosure;
duke@435 53 class BarrierSet;
duke@435 54 class CMSIsAliveClosure;
duke@435 55
duke@435 56 class PSPromotionManager;
duke@435 57 class ParCompactionManager;
duke@435 58
duke@435 59 class oopDesc {
duke@435 60 friend class VMStructs;
duke@435 61 private:
duke@435 62 volatile markOop _mark;
coleenp@548 63 union _metadata {
coleenp@4037 64 Klass* _klass;
coleenp@548 65 narrowOop _compressed_klass;
coleenp@548 66 } _metadata;
duke@435 67
duke@435 68 // Fast access to barrier set. Must be initialized.
duke@435 69 static BarrierSet* _bs;
duke@435 70
duke@435 71 public:
duke@435 72 markOop mark() const { return _mark; }
duke@435 73 markOop* mark_addr() const { return (markOop*) &_mark; }
duke@435 74
duke@435 75 void set_mark(volatile markOop m) { _mark = m; }
duke@435 76
duke@435 77 void release_set_mark(markOop m);
duke@435 78 markOop cas_set_mark(markOop new_mark, markOop old_mark);
duke@435 79
duke@435 80 // Used only to re-initialize the mark word (e.g., of promoted
duke@435 81 // objects during a GC) -- requires a valid klass pointer
duke@435 82 void init_mark();
duke@435 83
coleenp@4037 84 Klass* klass() const;
coleenp@4037 85 Klass* klass_or_null() const volatile;
coleenp@4037 86 Klass** klass_addr();
coleenp@548 87 narrowOop* compressed_klass_addr();
duke@435 88
coleenp@4037 89 void set_klass(Klass* k);
coleenp@602 90
coleenp@602 91 // For klass field compression
coleenp@602 92 int klass_gap() const;
coleenp@602 93 void set_klass_gap(int z);
duke@435 94 // For when the klass pointer is being used as a linked list "next" field.
duke@435 95 void set_klass_to_list_ptr(oop k);
coleenp@4037 96 oop list_ptr_from_klass();
duke@435 97
coleenp@548 98 // size of object header, aligned to platform wordSize
coleenp@548 99 static int header_size() { return sizeof(oopDesc)/HeapWordSize; }
duke@435 100
duke@435 101 // Returns whether this is an instance of k or an instance of a subclass of k
coleenp@4037 102 bool is_a(Klass* k) const;
duke@435 103
duke@435 104 // Returns the actual oop size of the object
duke@435 105 int size();
duke@435 106
duke@435 107 // Sometimes (for complicated concurrency-related reasons), it is useful
duke@435 108 // to be able to figure out the size of an object knowing its klass.
duke@435 109 int size_given_klass(Klass* klass);
duke@435 110
duke@435 111 // type test operations (inlined in oop.inline.h)
duke@435 112 bool is_instance() const;
never@2658 113 bool is_instanceMirror() const;
duke@435 114 bool is_instanceRef() const;
duke@435 115 bool is_array() const;
duke@435 116 bool is_objArray() const;
duke@435 117 bool is_typeArray() const;
duke@435 118
duke@435 119 private:
duke@435 120 // field addresses in oop
duke@435 121 void* field_base(int offset) const;
duke@435 122
duke@435 123 jbyte* byte_field_addr(int offset) const;
duke@435 124 jchar* char_field_addr(int offset) const;
duke@435 125 jboolean* bool_field_addr(int offset) const;
duke@435 126 jint* int_field_addr(int offset) const;
duke@435 127 jshort* short_field_addr(int offset) const;
duke@435 128 jlong* long_field_addr(int offset) const;
duke@435 129 jfloat* float_field_addr(int offset) const;
duke@435 130 jdouble* double_field_addr(int offset) const;
coleenp@4037 131 Metadata** metadata_field_addr(int offset) const;
duke@435 132
duke@435 133 public:
coleenp@548 134 // Need this as public for garbage collection.
coleenp@548 135 template <class T> T* obj_field_addr(int offset) const;
duke@435 136
coleenp@4037 137 // Needed for javaClasses
coleenp@4037 138 address* address_field_addr(int offset) const;
coleenp@4037 139
coleenp@548 140 static bool is_null(oop obj);
coleenp@548 141 static bool is_null(narrowOop obj);
coleenp@4037 142 static bool is_null(Klass* obj);
coleenp@548 143
coleenp@548 144 // Decode an oop pointer from a narrowOop if compressed.
coleenp@548 145 // These are overloaded for oop and narrowOop as are the other functions
coleenp@548 146 // below so that they can be called in template functions.
coleenp@548 147 static oop decode_heap_oop_not_null(oop v);
coleenp@548 148 static oop decode_heap_oop_not_null(narrowOop v);
coleenp@548 149 static oop decode_heap_oop(oop v);
coleenp@548 150 static oop decode_heap_oop(narrowOop v);
coleenp@548 151
coleenp@548 152 // Encode an oop pointer to a narrow oop. The or_null versions accept
coleenp@548 153 // null oop pointer, others do not in order to eliminate the
coleenp@548 154 // null checking branches.
coleenp@548 155 static narrowOop encode_heap_oop_not_null(oop v);
coleenp@548 156 static narrowOop encode_heap_oop(oop v);
coleenp@548 157
coleenp@548 158 // Load an oop out of the Java heap
coleenp@548 159 static narrowOop load_heap_oop(narrowOop* p);
coleenp@548 160 static oop load_heap_oop(oop* p);
coleenp@548 161
coleenp@548 162 // Load an oop out of Java heap and decode it to an uncompressed oop.
coleenp@548 163 static oop load_decode_heap_oop_not_null(narrowOop* p);
coleenp@548 164 static oop load_decode_heap_oop_not_null(oop* p);
coleenp@548 165 static oop load_decode_heap_oop(narrowOop* p);
coleenp@548 166 static oop load_decode_heap_oop(oop* p);
coleenp@548 167
coleenp@548 168 // Store an oop into the heap.
coleenp@548 169 static void store_heap_oop(narrowOop* p, narrowOop v);
coleenp@548 170 static void store_heap_oop(oop* p, oop v);
coleenp@548 171
coleenp@548 172 // Encode oop if UseCompressedOops and store into the heap.
coleenp@548 173 static void encode_store_heap_oop_not_null(narrowOop* p, oop v);
coleenp@548 174 static void encode_store_heap_oop_not_null(oop* p, oop v);
coleenp@548 175 static void encode_store_heap_oop(narrowOop* p, oop v);
coleenp@548 176 static void encode_store_heap_oop(oop* p, oop v);
coleenp@548 177
coleenp@548 178 static void release_store_heap_oop(volatile narrowOop* p, narrowOop v);
coleenp@548 179 static void release_store_heap_oop(volatile oop* p, oop v);
coleenp@548 180
coleenp@548 181 static void release_encode_store_heap_oop_not_null(volatile narrowOop* p, oop v);
coleenp@548 182 static void release_encode_store_heap_oop_not_null(volatile oop* p, oop v);
coleenp@548 183 static void release_encode_store_heap_oop(volatile narrowOop* p, oop v);
coleenp@548 184 static void release_encode_store_heap_oop(volatile oop* p, oop v);
coleenp@548 185
coleenp@548 186 static oop atomic_exchange_oop(oop exchange_value, volatile HeapWord *dest);
coleenp@548 187 static oop atomic_compare_exchange_oop(oop exchange_value,
coleenp@548 188 volatile HeapWord *dest,
coleenp@4037 189 oop compare_value,
coleenp@4037 190 bool prebarrier = false);
coleenp@4037 191
coleenp@4037 192 // klass encoding for klass pointer in objects.
coleenp@4037 193 static narrowOop encode_klass_not_null(Klass* v);
coleenp@4037 194 static narrowOop encode_klass(Klass* v);
coleenp@4037 195
coleenp@4037 196 static Klass* decode_klass_not_null(narrowOop v);
coleenp@4037 197 static Klass* decode_klass(narrowOop v);
coleenp@548 198
coleenp@548 199 // Access to fields in a instanceOop through these methods.
duke@435 200 oop obj_field(int offset) const;
twisti@3131 201 volatile oop obj_field_volatile(int offset) const;
duke@435 202 void obj_field_put(int offset, oop value);
twisti@3131 203 void obj_field_put_raw(int offset, oop value);
twisti@3131 204 void obj_field_put_volatile(int offset, oop value);
duke@435 205
coleenp@4037 206 Metadata* metadata_field(int offset) const;
coleenp@4037 207 void metadata_field_put(int offset, Metadata* value);
coleenp@4037 208
duke@435 209 jbyte byte_field(int offset) const;
duke@435 210 void byte_field_put(int offset, jbyte contents);
duke@435 211
duke@435 212 jchar char_field(int offset) const;
duke@435 213 void char_field_put(int offset, jchar contents);
duke@435 214
duke@435 215 jboolean bool_field(int offset) const;
duke@435 216 void bool_field_put(int offset, jboolean contents);
duke@435 217
duke@435 218 jint int_field(int offset) const;
duke@435 219 void int_field_put(int offset, jint contents);
duke@435 220
duke@435 221 jshort short_field(int offset) const;
duke@435 222 void short_field_put(int offset, jshort contents);
duke@435 223
duke@435 224 jlong long_field(int offset) const;
duke@435 225 void long_field_put(int offset, jlong contents);
duke@435 226
duke@435 227 jfloat float_field(int offset) const;
duke@435 228 void float_field_put(int offset, jfloat contents);
duke@435 229
duke@435 230 jdouble double_field(int offset) const;
duke@435 231 void double_field_put(int offset, jdouble contents);
duke@435 232
coleenp@548 233 address address_field(int offset) const;
coleenp@548 234 void address_field_put(int offset, address contents);
coleenp@548 235
duke@435 236 oop obj_field_acquire(int offset) const;
duke@435 237 void release_obj_field_put(int offset, oop value);
duke@435 238
duke@435 239 jbyte byte_field_acquire(int offset) const;
duke@435 240 void release_byte_field_put(int offset, jbyte contents);
duke@435 241
duke@435 242 jchar char_field_acquire(int offset) const;
duke@435 243 void release_char_field_put(int offset, jchar contents);
duke@435 244
duke@435 245 jboolean bool_field_acquire(int offset) const;
duke@435 246 void release_bool_field_put(int offset, jboolean contents);
duke@435 247
duke@435 248 jint int_field_acquire(int offset) const;
duke@435 249 void release_int_field_put(int offset, jint contents);
duke@435 250
duke@435 251 jshort short_field_acquire(int offset) const;
duke@435 252 void release_short_field_put(int offset, jshort contents);
duke@435 253
duke@435 254 jlong long_field_acquire(int offset) const;
duke@435 255 void release_long_field_put(int offset, jlong contents);
duke@435 256
duke@435 257 jfloat float_field_acquire(int offset) const;
duke@435 258 void release_float_field_put(int offset, jfloat contents);
duke@435 259
duke@435 260 jdouble double_field_acquire(int offset) const;
duke@435 261 void release_double_field_put(int offset, jdouble contents);
duke@435 262
jrose@1145 263 address address_field_acquire(int offset) const;
jrose@1145 264 void release_address_field_put(int offset, address contents);
jrose@1145 265
duke@435 266 // printing functions for VM debugging
duke@435 267 void print_on(outputStream* st) const; // First level print
duke@435 268 void print_value_on(outputStream* st) const; // Second level print.
duke@435 269 void print_address_on(outputStream* st) const; // Address printing
duke@435 270
duke@435 271 // printing on default output stream
duke@435 272 void print();
duke@435 273 void print_value();
duke@435 274 void print_address();
duke@435 275
duke@435 276 // return the print strings
duke@435 277 char* print_string();
duke@435 278 char* print_value_string();
duke@435 279
duke@435 280 // verification operations
duke@435 281 void verify_on(outputStream* st);
duke@435 282 void verify();
duke@435 283
duke@435 284 // locking operations
duke@435 285 bool is_locked() const;
duke@435 286 bool is_unlocked() const;
duke@435 287 bool has_bias_pattern() const;
duke@435 288
duke@435 289 // asserts
duke@435 290 bool is_oop(bool ignore_mark_word = false) const;
duke@435 291 bool is_oop_or_null(bool ignore_mark_word = false) const;
duke@435 292 #ifndef PRODUCT
duke@435 293 bool is_unlocked_oop() const;
duke@435 294 #endif
duke@435 295
duke@435 296 // garbage collection
duke@435 297 bool is_gc_marked() const;
duke@435 298 // Apply "MarkSweep::mark_and_push" to (the address of) every non-NULL
duke@435 299 // reference field in "this".
coleenp@548 300 void follow_contents(void);
duke@435 301
jprovino@4542 302 #if INCLUDE_ALL_GCS
duke@435 303 // Parallel Scavenge
duke@435 304 void push_contents(PSPromotionManager* pm);
duke@435 305
duke@435 306 // Parallel Old
duke@435 307 void update_contents(ParCompactionManager* cm);
duke@435 308
duke@435 309 void follow_contents(ParCompactionManager* cm);
jprovino@4542 310 #endif // INCLUDE_ALL_GCS
duke@435 311
jrose@1424 312 bool is_scavengable() const;
duke@435 313
duke@435 314 // Forward pointer operations for scavenge
duke@435 315 bool is_forwarded() const;
duke@435 316
duke@435 317 void forward_to(oop p);
duke@435 318 bool cas_forward_to(oop p, markOop compare);
duke@435 319
jprovino@4542 320 #if INCLUDE_ALL_GCS
duke@435 321 // Like "forward_to", but inserts the forwarding pointer atomically.
duke@435 322 // Exactly one thread succeeds in inserting the forwarding pointer, and
duke@435 323 // this call returns "NULL" for that thread; any other thread has the
duke@435 324 // value of the forwarding pointer returned and does not modify "this".
duke@435 325 oop forward_to_atomic(oop p);
jprovino@4542 326 #endif // INCLUDE_ALL_GCS
duke@435 327
duke@435 328 oop forwardee() const;
duke@435 329
duke@435 330 // Age of object during scavenge
jwilhelm@4129 331 uint age() const;
duke@435 332 void incr_age();
duke@435 333
duke@435 334 // Adjust all pointers in this object to point at it's forwarded location and
duke@435 335 // return the size of this oop. This is used by the MarkSweep collector.
duke@435 336 int adjust_pointers();
duke@435 337
jprovino@4542 338 #if INCLUDE_ALL_GCS
duke@435 339 // Parallel old
coleenp@4037 340 void update_header(ParCompactionManager* cm);
jprovino@4542 341 #endif // INCLUDE_ALL_GCS
duke@435 342
duke@435 343 // mark-sweep support
duke@435 344 void follow_body(int begin, int end);
duke@435 345
duke@435 346 // Fast access to barrier set
duke@435 347 static BarrierSet* bs() { return _bs; }
duke@435 348 static void set_bs(BarrierSet* bs) { _bs = bs; }
duke@435 349
duke@435 350 // iterators, returns size of object
ysr@777 351 #define OOP_ITERATE_DECL(OopClosureType, nv_suffix) \
duke@435 352 int oop_iterate(OopClosureType* blk); \
duke@435 353 int oop_iterate(OopClosureType* blk, MemRegion mr); // Only in mr.
duke@435 354
duke@435 355 ALL_OOP_OOP_ITERATE_CLOSURES_1(OOP_ITERATE_DECL)
ysr@777 356 ALL_OOP_OOP_ITERATE_CLOSURES_2(OOP_ITERATE_DECL)
ysr@777 357
jprovino@4542 358 #if INCLUDE_ALL_GCS
ysr@777 359
ysr@777 360 #define OOP_ITERATE_BACKWARDS_DECL(OopClosureType, nv_suffix) \
ysr@777 361 int oop_iterate_backwards(OopClosureType* blk);
ysr@777 362
ysr@777 363 ALL_OOP_OOP_ITERATE_CLOSURES_1(OOP_ITERATE_BACKWARDS_DECL)
ysr@777 364 ALL_OOP_OOP_ITERATE_CLOSURES_2(OOP_ITERATE_BACKWARDS_DECL)
ysr@777 365 #endif
duke@435 366
coleenp@4037 367 int oop_iterate_no_header(OopClosure* bk);
coleenp@4037 368 int oop_iterate_no_header(OopClosure* bk, MemRegion mr);
duke@435 369
duke@435 370 // identity hash; returns the identity hash key (computes it if necessary)
duke@435 371 // NOTE with the introduction of UseBiasedLocking that identity_hash() might reach a
duke@435 372 // safepoint if called on a biased object. Calling code must be aware of that.
duke@435 373 intptr_t identity_hash();
duke@435 374 intptr_t slow_identity_hash();
duke@435 375
coleenp@4037 376 // Alternate hashing code if string table is rehashed
coleenp@4037 377 unsigned int new_hash(jint seed);
coleenp@4037 378
duke@435 379 // marks are forwarded to stack when object is locked
duke@435 380 bool has_displaced_mark() const;
duke@435 381 markOop displaced_mark() const;
duke@435 382 void set_displaced_mark(markOop m);
duke@435 383
duke@435 384 // for code generation
duke@435 385 static int mark_offset_in_bytes() { return offset_of(oopDesc, _mark); }
coleenp@548 386 static int klass_offset_in_bytes() { return offset_of(oopDesc, _metadata._klass); }
coleenp@548 387 static int klass_gap_offset_in_bytes();
duke@435 388 };
stefank@2314 389
stefank@2314 390 #endif // SHARE_VM_OOPS_OOP_HPP

mercurial