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

6814575: Update copyright year
Summary: Update copyright for files that have been modified in 2009, up to 03/09
Reviewed-by: katleman, tbell, ohair

     1 /*

     2  * Copyright 1997-2009 Sun Microsystems, Inc.  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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

    20  * CA 95054 USA or visit www.sun.com if you need additional information or

    21  * have any questions.

    22  *

    23  */

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

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

    27 // oopDesc is abstract.

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

    29 //

    30 // no virtual functions allowed

    32 // store into oop with store check

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

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

    36 // store into oop without store check

    37 template <class T> void oop_store_without_check(T* p, oop v);

    38 template <class T> void oop_store_without_check(volatile T* p, oop v);

    41 extern bool always_do_update_barrier;

    43 // Forward declarations.

    44 class OopClosure;

    45 class ScanClosure;

    46 class FastScanClosure;

    47 class FilteringClosure;

    48 class BarrierSet;

    49 class CMSIsAliveClosure;

    51 class PSPromotionManager;

    52 class ParCompactionManager;

    54 class oopDesc {

    55   friend class VMStructs;

    56  private:

    57   volatile markOop  _mark;

    58   union _metadata {

    59     wideKlassOop    _klass;

    60     narrowOop       _compressed_klass;

    61   } _metadata;

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

    64   static BarrierSet* _bs;

    66  public:

    67   markOop  mark() const         { return _mark; }

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

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

    72   void    release_set_mark(markOop m);

    73   markOop cas_set_mark(markOop new_mark, markOop old_mark);

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

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

    77   void init_mark();

    79   klassOop klass() const;

    80   klassOop klass_or_null() const volatile;

    81   oop* klass_addr();

    82   narrowOop* compressed_klass_addr();

    84   void set_klass(klassOop k);

    86   // For klass field compression

    87   int klass_gap() const;

    88   void set_klass_gap(int z);

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

    90   void set_klass_to_list_ptr(oop k);

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

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

    95   Klass* blueprint() const;

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

    98   bool is_a(klassOop k)  const;

   100   // Returns the actual oop size of the object

   101   int size();

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

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

   105   int size_given_klass(Klass* klass);

   107   // Some perm gen objects are not parseble immediately after

   108   // installation of their klass pointer.

   109   bool is_parsable();

   111   // Some perm gen objects that have been allocated and initialized

   112   // can be changed by the VM when not at a safe point (class rededfinition

   113   // is an example).  Such objects should not be examined by the

   114   // concurrent processing of a garbage collector if is_conc_safe()

   115   // returns false.

   116   bool is_conc_safe();

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

   119   bool is_instance()           const;

   120   bool is_instanceRef()        const;

   121   bool is_array()              const;

   122   bool is_objArray()           const;

   123   bool is_symbol()             const;

   124   bool is_klass()              const;

   125   bool is_thread()             const;

   126   bool is_method()             const;

   127   bool is_constMethod()        const;

   128   bool is_methodData()         const;

   129   bool is_constantPool()       const;

   130   bool is_constantPoolCache()  const;

   131   bool is_typeArray()          const;

   132   bool is_javaArray()          const;

   133   bool is_compiledICHolder()   const;

   135  private:

   136   // field addresses in oop

   137   void*     field_base(int offset)        const;

   139   jbyte*    byte_field_addr(int offset)   const;

   140   jchar*    char_field_addr(int offset)   const;

   141   jboolean* bool_field_addr(int offset)   const;

   142   jint*     int_field_addr(int offset)    const;

   143   jshort*   short_field_addr(int offset)  const;

   144   jlong*    long_field_addr(int offset)   const;

   145   jfloat*   float_field_addr(int offset)  const;

   146   jdouble*  double_field_addr(int offset) const;

   147   address*  address_field_addr(int offset) const;

   149  public:

   150   // Need this as public for garbage collection.

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

   153   // Oop encoding heap max

   154   static const uint64_t OopEncodingHeapMax =

   155               (uint64_t(max_juint) + 1) << LogMinObjAlignmentInBytes;

   157   static bool is_null(oop obj);

   158   static bool is_null(narrowOop obj);

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

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

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

   163   static oop decode_heap_oop_not_null(oop v);

   164   static oop decode_heap_oop_not_null(narrowOop v);

   165   static oop decode_heap_oop(oop v);

   166   static oop decode_heap_oop(narrowOop v);

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

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

   170   // null checking branches.

   171   static narrowOop encode_heap_oop_not_null(oop v);

   172   static narrowOop encode_heap_oop(oop v);

   174   // Load an oop out of the Java heap

   175   static narrowOop load_heap_oop(narrowOop* p);

   176   static oop       load_heap_oop(oop* p);

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

   179   static oop load_decode_heap_oop_not_null(narrowOop* p);

   180   static oop load_decode_heap_oop_not_null(oop* p);

   181   static oop load_decode_heap_oop(narrowOop* p);

   182   static oop load_decode_heap_oop(oop* p);

   184   // Store an oop into the heap.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

   203   static oop atomic_compare_exchange_oop(oop exchange_value,

   204                                          volatile HeapWord *dest,

   205                                          oop compare_value);

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

   208   oop obj_field(int offset) const;

   209   void obj_field_put(int offset, oop value);

   210   void obj_field_raw_put(int offset, oop value);

   212   jbyte byte_field(int offset) const;

   213   void byte_field_put(int offset, jbyte contents);

   215   jchar char_field(int offset) const;

   216   void char_field_put(int offset, jchar contents);

   218   jboolean bool_field(int offset) const;

   219   void bool_field_put(int offset, jboolean contents);

   221   jint int_field(int offset) const;

   222   void int_field_put(int offset, jint contents);

   224   jshort short_field(int offset) const;

   225   void short_field_put(int offset, jshort contents);

   227   jlong long_field(int offset) const;

   228   void long_field_put(int offset, jlong contents);

   230   jfloat float_field(int offset) const;

   231   void float_field_put(int offset, jfloat contents);

   233   jdouble double_field(int offset) const;

   234   void double_field_put(int offset, jdouble contents);

   236   address address_field(int offset) const;

   237   void address_field_put(int offset, address contents);

   239   oop obj_field_acquire(int offset) const;

   240   void release_obj_field_put(int offset, oop value);

   242   jbyte byte_field_acquire(int offset) const;

   243   void release_byte_field_put(int offset, jbyte contents);

   245   jchar char_field_acquire(int offset) const;

   246   void release_char_field_put(int offset, jchar contents);

   248   jboolean bool_field_acquire(int offset) const;

   249   void release_bool_field_put(int offset, jboolean contents);

   251   jint int_field_acquire(int offset) const;

   252   void release_int_field_put(int offset, jint contents);

   254   jshort short_field_acquire(int offset) const;

   255   void release_short_field_put(int offset, jshort contents);

   257   jlong long_field_acquire(int offset) const;

   258   void release_long_field_put(int offset, jlong contents);

   260   jfloat float_field_acquire(int offset) const;

   261   void release_float_field_put(int offset, jfloat contents);

   263   jdouble double_field_acquire(int offset) const;

   264   void release_double_field_put(int offset, jdouble 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();

   283   void verify_old_oop(oop* p, bool allow_dirty);

   284   void verify_old_oop(narrowOop* p, bool allow_dirty);

   286   // tells whether this oop is partially constructed (gc during class loading)

   287   bool partially_loaded();

   288   void set_partially_loaded();

   290   // locking operations

   291   bool is_locked()   const;

   292   bool is_unlocked() const;

   293   bool has_bias_pattern() const;

   295   // asserts

   296   bool is_oop(bool ignore_mark_word = false) const;

   297   bool is_oop_or_null(bool ignore_mark_word = false) const;

   298 #ifndef PRODUCT

   299   bool is_unlocked_oop() const;

   300 #endif

   302   // garbage collection

   303   bool is_gc_marked() const;

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

   305   // reference field in "this".

   306   void follow_contents(void);

   307   void follow_header(void);

   309 #ifndef SERIALGC

   310   // Parallel Scavenge

   311   void copy_contents(PSPromotionManager* pm);

   312   void push_contents(PSPromotionManager* pm);

   314   // Parallel Old

   315   void update_contents(ParCompactionManager* cm);

   316   void update_contents(ParCompactionManager* cm,

   317                        HeapWord* begin_limit,

   318                        HeapWord* end_limit);

   319   void update_contents(ParCompactionManager* cm,

   320                        klassOop old_klass,

   321                        HeapWord* begin_limit,

   322                        HeapWord* end_limit);

   324   void follow_contents(ParCompactionManager* cm);

   325   void follow_header(ParCompactionManager* cm);

   326 #endif // SERIALGC

   328   bool is_perm() const;

   329   bool is_perm_or_null() const;

   330   bool is_shared() const;

   331   bool is_shared_readonly() const;

   332   bool is_shared_readwrite() const;

   334   // Forward pointer operations for scavenge

   335   bool is_forwarded() const;

   337   void forward_to(oop p);

   338   bool cas_forward_to(oop p, markOop compare);

   340 #ifndef SERIALGC

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

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

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

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

   345   oop forward_to_atomic(oop p);

   346 #endif // SERIALGC

   348   oop forwardee() const;

   350   // Age of object during scavenge

   351   int age() const;

   352   void incr_age();

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

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

   356   int adjust_pointers();

   357   void adjust_header();

   359 #ifndef SERIALGC

   360   // Parallel old

   361   void update_header();

   362   void update_header(HeapWord* beg_addr, HeapWord* end_addr);

   363 #endif // SERIALGC

   365   // mark-sweep support

   366   void follow_body(int begin, int end);

   368   // Fast access to barrier set

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

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

   372   // iterators, returns size of object

   373 #define OOP_ITERATE_DECL(OopClosureType, nv_suffix)                      \

   374   int oop_iterate(OopClosureType* blk);                                  \

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

   377   ALL_OOP_OOP_ITERATE_CLOSURES_1(OOP_ITERATE_DECL)

   378   ALL_OOP_OOP_ITERATE_CLOSURES_2(OOP_ITERATE_DECL)

   380 #ifndef SERIALGC

   382 #define OOP_ITERATE_BACKWARDS_DECL(OopClosureType, nv_suffix)            \

   383   int oop_iterate_backwards(OopClosureType* blk);

   385   ALL_OOP_OOP_ITERATE_CLOSURES_1(OOP_ITERATE_BACKWARDS_DECL)

   386   ALL_OOP_OOP_ITERATE_CLOSURES_2(OOP_ITERATE_BACKWARDS_DECL)

   387 #endif

   389   void oop_iterate_header(OopClosure* blk);

   390   void oop_iterate_header(OopClosure* blk, MemRegion mr);

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

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

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

   395   intptr_t identity_hash();

   396   intptr_t slow_identity_hash();

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

   399   bool     has_displaced_mark() const;

   400   markOop  displaced_mark() const;

   401   void     set_displaced_mark(markOop m);

   403   // for code generation

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

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

   406   static int klass_gap_offset_in_bytes();

   407 };

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

src/share/vm/oops/oop.hpp@0fbdb4381b99

src/share/vm/oops/oop.hpp