jdk8-mips64-public/hotspot: src/share/vm/oops/oop.hpp@db9981fd3124

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

     1 /*

     2  * Copyright (c) 1997, 2012, 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  */

    25 #ifndef SHARE_VM_OOPS_OOP_HPP

    26 #define SHARE_VM_OOPS_OOP_HPP

    28 #include "memory/iterator.hpp"

    29 #include "memory/memRegion.hpp"

    30 #include "memory/specialized_oop_closures.hpp"

    31 #include "oops/metadata.hpp"

    32 #include "utilities/macros.hpp"

    33 #include "utilities/top.hpp"

    35 // oopDesc is the top baseclass for objects classes.  The {name}Desc classes describe

    36 // the format of Java objects so the fields can be accessed from C++.

    37 // oopDesc is abstract.

    38 // (see oopHierarchy for complete oop class hierarchy)

    39 //

    40 // no virtual functions allowed

    42 // store into oop with store check

    43 template <class T> void oop_store(T* p, oop v);

    44 template <class T> void oop_store(volatile T* p, oop v);

    46 extern bool always_do_update_barrier;

    48 // Forward declarations.

    49 class OopClosure;

    50 class ScanClosure;

    51 class FastScanClosure;

    52 class FilteringClosure;

    53 class BarrierSet;

    54 class CMSIsAliveClosure;

    56 class PSPromotionManager;

    57 class ParCompactionManager;

    59 class oopDesc {

    60   friend class VMStructs;

    61  private:

    62   volatile markOop  _mark;

    63   union _metadata {

    64     Klass*      _klass;

    65     narrowOop       _compressed_klass;

    66   } _metadata;

    68   // Fast access to barrier set.  Must be initialized.

    69   static BarrierSet* _bs;

    71  public:

    72   markOop  mark() const         { return _mark; }

    73   markOop* mark_addr() const    { return (markOop*) &_mark; }

    75   void set_mark(volatile markOop m)      { _mark = m;   }

    77   void    release_set_mark(markOop m);

    78   markOop cas_set_mark(markOop new_mark, markOop old_mark);

    80   // Used only to re-initialize the mark word (e.g., of promoted

    81   // objects during a GC) -- requires a valid klass pointer

    82   void init_mark();

    84   Klass* klass() const;

    85   Klass* klass_or_null() const volatile;

    86   Klass** klass_addr();

    87   narrowOop* compressed_klass_addr();

    89   void set_klass(Klass* k);

    91   // For klass field compression

    92   int klass_gap() const;

    93   void set_klass_gap(int z);

    94   // For when the klass pointer is being used as a linked list "next" field.

    95   void set_klass_to_list_ptr(oop k);

    96   oop list_ptr_from_klass();

    98   // size of object header, aligned to platform wordSize

    99   static int header_size()          { return sizeof(oopDesc)/HeapWordSize; }

   101   // Returns whether this is an instance of k or an instance of a subclass of k

   102   bool is_a(Klass* k)  const;

   104   // Returns the actual oop size of the object

   105   int size();

   107   // Sometimes (for complicated concurrency-related reasons), it is useful

   108   // to be able to figure out the size of an object knowing its klass.

   109   int size_given_klass(Klass* klass);

   111   // type test operations (inlined in oop.inline.h)

   112   bool is_instance()           const;

   113   bool is_instanceMirror()     const;

   114   bool is_instanceRef()        const;

   115   bool is_array()              const;

   116   bool is_objArray()           const;

   117   bool is_typeArray()          const;

   119  private:

   120   // field addresses in oop

   121   void*     field_base(int offset)        const;

   123   jbyte*    byte_field_addr(int offset)   const;

   124   jchar*    char_field_addr(int offset)   const;

   125   jboolean* bool_field_addr(int offset)   const;

   126   jint*     int_field_addr(int offset)    const;

   127   jshort*   short_field_addr(int offset)  const;

   128   jlong*    long_field_addr(int offset)   const;

   129   jfloat*   float_field_addr(int offset)  const;

   130   jdouble*  double_field_addr(int offset) const;

   131   Metadata** metadata_field_addr(int offset) const;

   133  public:

   134   // Need this as public for garbage collection.

   135   template <class T> T* obj_field_addr(int offset) const;

   137   // Needed for javaClasses

   138   address*  address_field_addr(int offset) const;

   140   static bool is_null(oop obj);

   141   static bool is_null(narrowOop obj);

   142   static bool is_null(Klass* obj);

   144   // Decode an oop pointer from a narrowOop if compressed.

   145   // These are overloaded for oop and narrowOop as are the other functions

   146   // below so that they can be called in template functions.

   147   static oop decode_heap_oop_not_null(oop v);

   148   static oop decode_heap_oop_not_null(narrowOop v);

   149   static oop decode_heap_oop(oop v);

   150   static oop decode_heap_oop(narrowOop v);

   152   // Encode an oop pointer to a narrow oop.  The or_null versions accept

   153   // null oop pointer, others do not in order to eliminate the

   154   // null checking branches.

   155   static narrowOop encode_heap_oop_not_null(oop v);

   156   static narrowOop encode_heap_oop(oop v);

   158   // Load an oop out of the Java heap

   159   static narrowOop load_heap_oop(narrowOop* p);

   160   static oop       load_heap_oop(oop* p);

   162   // Load an oop out of Java heap and decode it to an uncompressed oop.

   163   static oop load_decode_heap_oop_not_null(narrowOop* p);

   164   static oop load_decode_heap_oop_not_null(oop* p);

   165   static oop load_decode_heap_oop(narrowOop* p);

   166   static oop load_decode_heap_oop(oop* p);

   168   // Store an oop into the heap.

   169   static void store_heap_oop(narrowOop* p, narrowOop v);

   170   static void store_heap_oop(oop* p, oop v);

   172   // Encode oop if UseCompressedOops and store into the heap.

   173   static void encode_store_heap_oop_not_null(narrowOop* p, oop v);

   174   static void encode_store_heap_oop_not_null(oop* p, oop v);

   175   static void encode_store_heap_oop(narrowOop* p, oop v);

   176   static void encode_store_heap_oop(oop* p, oop v);

   178   static void release_store_heap_oop(volatile narrowOop* p, narrowOop v);

   179   static void release_store_heap_oop(volatile oop* p, oop v);

   181   static void release_encode_store_heap_oop_not_null(volatile narrowOop* p, oop v);

   182   static void release_encode_store_heap_oop_not_null(volatile oop* p, oop v);

   183   static void release_encode_store_heap_oop(volatile narrowOop* p, oop v);

   184   static void release_encode_store_heap_oop(volatile oop* p, oop v);

   186   static oop atomic_exchange_oop(oop exchange_value, volatile HeapWord *dest);

   187   static oop atomic_compare_exchange_oop(oop exchange_value,

   188                                          volatile HeapWord *dest,

   189                                          oop compare_value,

   190                                          bool prebarrier = false);

   192   // klass encoding for klass pointer in objects.

   193   static narrowOop encode_klass_not_null(Klass* v);

   194   static narrowOop encode_klass(Klass* v);

   196   static Klass* decode_klass_not_null(narrowOop v);

   197   static Klass* decode_klass(narrowOop v);

   199   // Access to fields in a instanceOop through these methods.

   200   oop obj_field(int offset) const;

   201   volatile oop obj_field_volatile(int offset) const;

   202   void obj_field_put(int offset, oop value);

   203   void obj_field_put_raw(int offset, oop value);

   204   void obj_field_put_volatile(int offset, oop value);

   206   Metadata* metadata_field(int offset) const;

   207   void metadata_field_put(int offset, Metadata* value);

   209   jbyte byte_field(int offset) const;

   210   void byte_field_put(int offset, jbyte contents);

   212   jchar char_field(int offset) const;

   213   void char_field_put(int offset, jchar contents);

   215   jboolean bool_field(int offset) const;

   216   void bool_field_put(int offset, jboolean contents);

   218   jint int_field(int offset) const;

   219   void int_field_put(int offset, jint contents);

   221   jshort short_field(int offset) const;

   222   void short_field_put(int offset, jshort contents);

   224   jlong long_field(int offset) const;

   225   void long_field_put(int offset, jlong contents);

   227   jfloat float_field(int offset) const;

   228   void float_field_put(int offset, jfloat contents);

   230   jdouble double_field(int offset) const;

   231   void double_field_put(int offset, jdouble contents);

   233   address address_field(int offset) const;

   234   void address_field_put(int offset, address contents);

   236   oop obj_field_acquire(int offset) const;

   237   void release_obj_field_put(int offset, oop value);

   239   jbyte byte_field_acquire(int offset) const;

   240   void release_byte_field_put(int offset, jbyte contents);

   242   jchar char_field_acquire(int offset) const;

   243   void release_char_field_put(int offset, jchar contents);

   245   jboolean bool_field_acquire(int offset) const;

   246   void release_bool_field_put(int offset, jboolean contents);

   248   jint int_field_acquire(int offset) const;

   249   void release_int_field_put(int offset, jint contents);

   251   jshort short_field_acquire(int offset) const;

   252   void release_short_field_put(int offset, jshort contents);

   254   jlong long_field_acquire(int offset) const;

   255   void release_long_field_put(int offset, jlong contents);

   257   jfloat float_field_acquire(int offset) const;

   258   void release_float_field_put(int offset, jfloat contents);

   260   jdouble double_field_acquire(int offset) const;

   261   void release_double_field_put(int offset, jdouble contents);

   263   address address_field_acquire(int offset) const;

   264   void release_address_field_put(int offset, address contents);

   266   // printing functions for VM debugging

   267   void print_on(outputStream* st) const;         // First level print

   268   void print_value_on(outputStream* st) const;   // Second level print.

   269   void print_address_on(outputStream* st) const; // Address printing

   271   // printing on default output stream

   272   void print();

   273   void print_value();

   274   void print_address();

   276   // return the print strings

   277   char* print_string();

   278   char* print_value_string();

   280   // verification operations

   281   void verify_on(outputStream* st);

   282   void verify();

   284   // locking operations

   285   bool is_locked()   const;

   286   bool is_unlocked() const;

   287   bool has_bias_pattern() const;

   289   // asserts

   290   bool is_oop(bool ignore_mark_word = false) const;

   291   bool is_oop_or_null(bool ignore_mark_word = false) const;

   292 #ifndef PRODUCT

   293   bool is_unlocked_oop() const;

   294 #endif

   296   // garbage collection

   297   bool is_gc_marked() const;

   298   // Apply "MarkSweep::mark_and_push" to (the address of) every non-NULL

   299   // reference field in "this".

   300   void follow_contents(void);

   302 #if INCLUDE_ALL_GCS

   303   // Parallel Scavenge

   304   void push_contents(PSPromotionManager* pm);

   306   // Parallel Old

   307   void update_contents(ParCompactionManager* cm);

   309   void follow_contents(ParCompactionManager* cm);

   310 #endif // INCLUDE_ALL_GCS

   312   bool is_scavengable() const;

   314   // Forward pointer operations for scavenge

   315   bool is_forwarded() const;

   317   void forward_to(oop p);

   318   bool cas_forward_to(oop p, markOop compare);

   320 #if INCLUDE_ALL_GCS

   321   // Like "forward_to", but inserts the forwarding pointer atomically.

   322   // Exactly one thread succeeds in inserting the forwarding pointer, and

   323   // this call returns "NULL" for that thread; any other thread has the

   324   // value of the forwarding pointer returned and does not modify "this".

   325   oop forward_to_atomic(oop p);

   326 #endif // INCLUDE_ALL_GCS

   328   oop forwardee() const;

   330   // Age of object during scavenge

   331   uint age() const;

   332   void incr_age();

   334   // Adjust all pointers in this object to point at it's forwarded location and

   335   // return the size of this oop.  This is used by the MarkSweep collector.

   336   int adjust_pointers();

   338 #if INCLUDE_ALL_GCS

   339   // Parallel old

   340   void update_header(ParCompactionManager* cm);

   341 #endif // INCLUDE_ALL_GCS

   343   // mark-sweep support

   344   void follow_body(int begin, int end);

   346   // Fast access to barrier set

   347   static BarrierSet* bs()            { return _bs; }

   348   static void set_bs(BarrierSet* bs) { _bs = bs; }

   350   // iterators, returns size of object

   351 #define OOP_ITERATE_DECL(OopClosureType, nv_suffix)                      \

   352   int oop_iterate(OopClosureType* blk);                                  \

   353   int oop_iterate(OopClosureType* blk, MemRegion mr);  // Only in mr.

   355   ALL_OOP_OOP_ITERATE_CLOSURES_1(OOP_ITERATE_DECL)

   356   ALL_OOP_OOP_ITERATE_CLOSURES_2(OOP_ITERATE_DECL)

   358 #if INCLUDE_ALL_GCS

   360 #define OOP_ITERATE_BACKWARDS_DECL(OopClosureType, nv_suffix)            \

   361   int oop_iterate_backwards(OopClosureType* blk);

   363   ALL_OOP_OOP_ITERATE_CLOSURES_1(OOP_ITERATE_BACKWARDS_DECL)

   364   ALL_OOP_OOP_ITERATE_CLOSURES_2(OOP_ITERATE_BACKWARDS_DECL)

   365 #endif

   367   int oop_iterate_no_header(OopClosure* bk);

   368   int oop_iterate_no_header(OopClosure* bk, MemRegion mr);

   370   // identity hash; returns the identity hash key (computes it if necessary)

   371   // NOTE with the introduction of UseBiasedLocking that identity_hash() might reach a

   372   // safepoint if called on a biased object. Calling code must be aware of that.

   373   intptr_t identity_hash();

   374   intptr_t slow_identity_hash();

   376   // Alternate hashing code if string table is rehashed

   377   unsigned int new_hash(jint seed);

   379   // marks are forwarded to stack when object is locked

   380   bool     has_displaced_mark() const;

   381   markOop  displaced_mark() const;

   382   void     set_displaced_mark(markOop m);

   384   // for code generation

   385   static int mark_offset_in_bytes()    { return offset_of(oopDesc, _mark); }

   386   static int klass_offset_in_bytes()   { return offset_of(oopDesc, _metadata._klass); }

   387   static int klass_gap_offset_in_bytes();

   388 };

   390 #endif // SHARE_VM_OOPS_OOP_HPP

Mercurial > jdk8-mips64-public > hotspot / file revision

src/share/vm/oops/oop.hpp@db9981fd3124

src/share/vm/oops/oop.hpp