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

     1 /*

     2  * Copyright (c) 1997, 2014, 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     narrowKlass _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)      {

    76 #ifdef MIPS64

    77     if (Use3A2000) release_set_mark(m);

    78     else

    79 #endif

    80     _mark = m;

    81   }

    83   void    release_set_mark(markOop m);

    84   markOop cas_set_mark(markOop new_mark, markOop old_mark);

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

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

    88   void init_mark();

    90   Klass* klass() const;

    91   Klass* klass_or_null() const volatile;

    92   Klass** klass_addr();

    93   narrowKlass* compressed_klass_addr();

    95   void set_klass(Klass* k);

    97   // For klass field compression

    98   int klass_gap() const;

    99   void set_klass_gap(int z);

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

   101   void set_klass_to_list_ptr(oop k);

   102   oop list_ptr_from_klass();

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

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

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

   108   bool is_a(Klass* k)  const;

   110   // Returns the actual oop size of the object

   111   int size();

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

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

   115   int size_given_klass(Klass* klass);

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

   118   bool is_instance()           const;

   119   bool is_instanceMirror()     const;

   120   bool is_instanceRef()        const;

   121   bool is_array()              const;

   122   bool is_objArray()           const;

   123   bool is_typeArray()          const;

   125  private:

   126   // field addresses in oop

   127   void*     field_base(int offset)        const;

   129   jbyte*    byte_field_addr(int offset)   const;

   130   jchar*    char_field_addr(int offset)   const;

   131   jboolean* bool_field_addr(int offset)   const;

   132   jint*     int_field_addr(int offset)    const;

   133   jshort*   short_field_addr(int offset)  const;

   134   jlong*    long_field_addr(int offset)   const;

   135   jfloat*   float_field_addr(int offset)  const;

   136   jdouble*  double_field_addr(int offset) const;

   137   Metadata** metadata_field_addr(int offset) const;

   139  public:

   140   // Need this as public for garbage collection.

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

   143   // Needed for javaClasses

   144   address*  address_field_addr(int offset) const;

   146   static bool is_null(oop obj);

   147   static bool is_null(narrowOop obj);

   148   static bool is_null(Klass* obj);

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

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

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

   153   static oop decode_heap_oop_not_null(oop v);

   154   static oop decode_heap_oop_not_null(narrowOop v);

   155   static oop decode_heap_oop(oop v);

   156   static oop decode_heap_oop(narrowOop v);

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

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

   160   // null checking branches.

   161   static narrowOop encode_heap_oop_not_null(oop v);

   162   static narrowOop encode_heap_oop(oop v);

   164   // Load an oop out of the Java heap

   165   static narrowOop load_heap_oop(narrowOop* p);

   166   static oop       load_heap_oop(oop* p);

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

   169   static oop load_decode_heap_oop_not_null(narrowOop* p);

   170   static oop load_decode_heap_oop_not_null(oop* p);

   171   static oop load_decode_heap_oop(narrowOop* p);

   172   static oop load_decode_heap_oop(oop* p);

   174   // Store an oop into the heap.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

   193   static oop atomic_compare_exchange_oop(oop exchange_value,

   194                                          volatile HeapWord *dest,

   195                                          oop compare_value,

   196                                          bool prebarrier = false);

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

   199   oop obj_field(int offset) const;

   200   volatile oop obj_field_volatile(int offset) const;

   201   void obj_field_put(int offset, oop value);

   202   void obj_field_put_raw(int offset, oop value);

   203   void obj_field_put_volatile(int offset, oop value);

   205   Metadata* metadata_field(int offset) const;

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

   208   jbyte byte_field(int offset) const;

   209   void byte_field_put(int offset, jbyte contents);

   211   jchar char_field(int offset) const;

   212   void char_field_put(int offset, jchar contents);

   214   jboolean bool_field(int offset) const;

   215   void bool_field_put(int offset, jboolean contents);

   217   jint int_field(int offset) const;

   218   void int_field_put(int offset, jint contents);

   220   jshort short_field(int offset) const;

   221   void short_field_put(int offset, jshort contents);

   223   jlong long_field(int offset) const;

   224   void long_field_put(int offset, jlong contents);

   226   jfloat float_field(int offset) const;

   227   void float_field_put(int offset, jfloat contents);

   229   jdouble double_field(int offset) const;

   230   void double_field_put(int offset, jdouble contents);

   232   address address_field(int offset) const;

   233   void address_field_put(int offset, address contents);

   235   oop obj_field_acquire(int offset) const;

   236   void release_obj_field_put(int offset, oop value);

   238   jbyte byte_field_acquire(int offset) const;

   239   void release_byte_field_put(int offset, jbyte contents);

   241   jchar char_field_acquire(int offset) const;

   242   void release_char_field_put(int offset, jchar contents);

   244   jboolean bool_field_acquire(int offset) const;

   245   void release_bool_field_put(int offset, jboolean contents);

   247   jint int_field_acquire(int offset) const;

   248   void release_int_field_put(int offset, jint contents);

   250   jshort short_field_acquire(int offset) const;

   251   void release_short_field_put(int offset, jshort contents);

   253   jlong long_field_acquire(int offset) const;

   254   void release_long_field_put(int offset, jlong contents);

   256   jfloat float_field_acquire(int offset) const;

   257   void release_float_field_put(int offset, jfloat contents);

   259   jdouble double_field_acquire(int offset) const;

   260   void release_double_field_put(int offset, jdouble contents);

   262   address address_field_acquire(int offset) const;

   263   void release_address_field_put(int offset, address contents);

   265   // printing functions for VM debugging

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

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

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

   270   // printing on default output stream

   271   void print();

   272   void print_value();

   273   void print_address();

   275   // return the print strings

   276   char* print_string();

   277   char* print_value_string();

   279   // verification operations

   280   void verify_on(outputStream* st);

   281   void verify();

   283   // locking operations

   284   bool is_locked()   const;

   285   bool is_unlocked() const;

   286   bool has_bias_pattern() const;

   288   // asserts

   289   bool is_oop(bool ignore_mark_word = false) const;

   290   bool is_oop_or_null(bool ignore_mark_word = false) const;

   291 #ifndef PRODUCT

   292   bool is_unlocked_oop() const;

   293 #endif

   295   // garbage collection

   296   bool is_gc_marked() const;

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

   298   // reference field in "this".

   299   void follow_contents(void);

   301 #if INCLUDE_ALL_GCS

   302   // Parallel Scavenge

   303   void push_contents(PSPromotionManager* pm);

   305   // Parallel Old

   306   void update_contents(ParCompactionManager* cm);

   308   void follow_contents(ParCompactionManager* cm);

   309 #endif // INCLUDE_ALL_GCS

   311   bool is_scavengable() const;

   313   // Forward pointer operations for scavenge

   314   bool is_forwarded() const;

   316   void forward_to(oop p);

   317   bool cas_forward_to(oop p, markOop compare);

   319 #if INCLUDE_ALL_GCS

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

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

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

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

   324   oop forward_to_atomic(oop p);

   325 #endif // INCLUDE_ALL_GCS

   327   oop forwardee() const;

   329   // Age of object during scavenge

   330   uint age() const;

   331   void incr_age();

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

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

   335   int adjust_pointers();

   337   // mark-sweep support

   338   void follow_body(int begin, int end);

   340   // Fast access to barrier set

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

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

   344   // iterators, returns size of object

   345 #define OOP_ITERATE_DECL(OopClosureType, nv_suffix)                      \

   346   int oop_iterate(OopClosureType* blk);                                  \

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

   349   ALL_OOP_OOP_ITERATE_CLOSURES_1(OOP_ITERATE_DECL)

   350   ALL_OOP_OOP_ITERATE_CLOSURES_2(OOP_ITERATE_DECL)

   352 #if INCLUDE_ALL_GCS

   354 #define OOP_ITERATE_BACKWARDS_DECL(OopClosureType, nv_suffix)            \

   355   int oop_iterate_backwards(OopClosureType* blk);

   357   ALL_OOP_OOP_ITERATE_CLOSURES_1(OOP_ITERATE_BACKWARDS_DECL)

   358   ALL_OOP_OOP_ITERATE_CLOSURES_2(OOP_ITERATE_BACKWARDS_DECL)

   359 #endif

   361   int oop_iterate_no_header(OopClosure* bk);

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

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

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

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

   367   intptr_t identity_hash();

   368   intptr_t slow_identity_hash();

   370   // Alternate hashing code if string table is rehashed

   371   unsigned int new_hash(juint seed);

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

   374   bool     has_displaced_mark() const;

   375   markOop  displaced_mark() const;

   376   void     set_displaced_mark(markOop m);

   378   // for code generation

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

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

   381   static int klass_gap_offset_in_bytes();

   382 };

   384 #endif // SHARE_VM_OOPS_OOP_HPP

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

src/share/vm/oops/oop.hpp@710a3c8b516e

src/share/vm/oops/oop.hpp