duke@435: /*
coleenp@4037:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
duke@435:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435:  *
duke@435:  * This code is free software; you can redistribute it and/or modify it
duke@435:  * under the terms of the GNU General Public License version 2 only, as
duke@435:  * published by the Free Software Foundation.
duke@435:  *
duke@435:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@435:  * version 2 for more details (a copy is included in the LICENSE file that
duke@435:  * accompanied this code).
duke@435:  *
duke@435:  * You should have received a copy of the GNU General Public License version
duke@435:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@435:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435:  *
trims@1907:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907:  * or visit www.oracle.com if you need additional information or have any
trims@1907:  * questions.
duke@435:  *
duke@435:  */
duke@435: 
stefank@2314: #ifndef SHARE_VM_OOPS_INSTANCEREFKLASS_HPP
stefank@2314: #define SHARE_VM_OOPS_INSTANCEREFKLASS_HPP
stefank@2314: 
stefank@2314: #include "oops/instanceKlass.hpp"
stefank@2314: 
coleenp@4047: // An InstanceRefKlass is a specialized InstanceKlass for Java
duke@435: // classes that are subclasses of java/lang/ref/Reference.
duke@435: //
duke@435: // These classes are used to implement soft/weak/final/phantom
duke@435: // references and finalization, and need special treatment by the
duke@435: // garbage collector.
duke@435: //
duke@435: // During GC discovered reference objects are added (chained) to one
duke@435: // of the four lists below, depending on the type of reference.
duke@435: // The linked occurs through the next field in class java/lang/ref/Reference.
duke@435: //
duke@435: // Afterwards, the discovered references are processed in decreasing
duke@435: // order of reachability. Reference objects eligible for notification
duke@435: // are linked to the static pending_list in class java/lang/ref/Reference,
duke@435: // and the pending list lock object in the same class is notified.
duke@435: 
duke@435: 
coleenp@4047: class InstanceRefKlass: public InstanceKlass {
coleenp@4037:   friend class InstanceKlass;
coleenp@4037: 
coleenp@4037:   // Constructor
coleenp@4047:   InstanceRefKlass(int vtable_len, int itable_len, int static_field_size, int nonstatic_oop_map_size, ReferenceType rt, AccessFlags access_flags, bool is_anonymous)
coleenp@4037:     : InstanceKlass(vtable_len, itable_len, static_field_size, nonstatic_oop_map_size, rt, access_flags, is_anonymous) {}
coleenp@4037: 
duke@435:  public:
coleenp@4047:   InstanceRefKlass() { assert(DumpSharedSpaces || UseSharedSpaces, "only for CDS"); }
duke@435:   // Type testing
duke@435:   bool oop_is_instanceRef() const             { return true; }
duke@435: 
coleenp@4037:   // Casting from Klass*
coleenp@4047:   static InstanceRefKlass* cast(Klass* k) {
coleenp@4047:     assert(k->oop_is_instanceRef(), "cast to InstanceRefKlass");
coleenp@4047:     return (InstanceRefKlass*) k;
duke@435:   }
duke@435: 
duke@435:   // Garbage collection
duke@435:   int  oop_adjust_pointers(oop obj);
duke@435:   void oop_follow_contents(oop obj);
duke@435: 
duke@435:   // Parallel Scavenge and Parallel Old
duke@435:   PARALLEL_GC_DECLS
duke@435: 
coleenp@4037:   int oop_oop_iterate(oop obj, ExtendedOopClosure* blk) {
duke@435:     return oop_oop_iterate_v(obj, blk);
duke@435:   }
coleenp@4037:   int oop_oop_iterate_m(oop obj, ExtendedOopClosure* blk, MemRegion mr) {
duke@435:     return oop_oop_iterate_v_m(obj, blk, mr);
duke@435:   }
duke@435: 
duke@435: #define InstanceRefKlass_OOP_OOP_ITERATE_DECL(OopClosureType, nv_suffix)                \
duke@435:   int oop_oop_iterate##nv_suffix(oop obj, OopClosureType* blk);                         \
duke@435:   int oop_oop_iterate##nv_suffix##_m(oop obj, OopClosureType* blk, MemRegion mr);
duke@435: 
duke@435:   ALL_OOP_OOP_ITERATE_CLOSURES_1(InstanceRefKlass_OOP_OOP_ITERATE_DECL)
ysr@777:   ALL_OOP_OOP_ITERATE_CLOSURES_2(InstanceRefKlass_OOP_OOP_ITERATE_DECL)
ysr@777: 
ysr@777: #ifndef SERIALGC
ysr@777: #define InstanceRefKlass_OOP_OOP_ITERATE_BACKWARDS_DECL(OopClosureType, nv_suffix)      \
ysr@777:   int oop_oop_iterate_backwards##nv_suffix(oop obj, OopClosureType* blk);
ysr@777: 
ysr@777:   ALL_OOP_OOP_ITERATE_CLOSURES_1(InstanceRefKlass_OOP_OOP_ITERATE_BACKWARDS_DECL)
ysr@777:   ALL_OOP_OOP_ITERATE_CLOSURES_2(InstanceRefKlass_OOP_OOP_ITERATE_BACKWARDS_DECL)
ysr@777: #endif // !SERIALGC
duke@435: 
duke@435:   static void release_and_notify_pending_list_lock(BasicLock *pending_list_basic_lock);
duke@435:   static void acquire_pending_list_lock(BasicLock *pending_list_basic_lock);
coleenp@2363:   static bool owns_pending_list_lock(JavaThread* thread);
duke@435: 
duke@435:   // Update non-static oop maps so 'referent', 'nextPending' and
duke@435:   // 'discovered' will look like non-oops
coleenp@4037:   static void update_nonstatic_oop_maps(Klass* k);
duke@435: 
duke@435:  public:
duke@435:   // Verification
duke@435:   void oop_verify_on(oop obj, outputStream* st);
duke@435: };
stefank@2314: 
stefank@2314: #endif // SHARE_VM_OOPS_INSTANCEREFKLASS_HPP