1 /*
   2  * Copyright (c) 2015, 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  */
  24 
  25 #ifndef SHARE_VM_OOPS_INSTANCEREFKLASS_INLINE_HPP
  26 #define SHARE_VM_OOPS_INSTANCEREFKLASS_INLINE_HPP
  27 
  28 #include "classfile/javaClasses.hpp"
  29 #include "gc/shared/referenceProcessor.hpp"
  30 #include "gc/shenandoah/shenandoahBarrierSet.hpp"
  31 #include "oops/instanceKlass.inline.hpp"
  32 #include "oops/instanceRefKlass.hpp"
  33 #include "oops/oop.inline.hpp"
  34 #include "utilities/debug.hpp"
  35 #include "utilities/globalDefinitions.hpp"
  36 #include "utilities/macros.hpp"
  37 
  38 template <bool nv, typename T, class OopClosureType, class Contains>
  39 void InstanceRefKlass::oop_oop_iterate_ref_processing_specialized(oop obj, OopClosureType* closure, Contains& contains) {
  40   T* disc_addr = (T*)java_lang_ref_Reference::discovered_addr(obj);
  41   if (closure->apply_to_weak_ref_discovered_field()) {
  42     Devirtualizer<nv>::do_oop(closure, disc_addr);
  43   }
  44 
  45   T* referent_addr = (T*)java_lang_ref_Reference::referent_addr(obj);
  46   T heap_oop = oopDesc::load_heap_oop(referent_addr);
  47   ReferenceProcessor* rp = closure->_ref_processor;
  48   if (!oopDesc::is_null(heap_oop)) {
  49     oop referent = oopDesc::decode_heap_oop_not_null(heap_oop);
  50     referent = oopDesc::bs()->resolve_and_update_oop(referent_addr, referent);
  51     if (!referent->is_gc_marked() && (rp != NULL) &&
  52         rp->discover_reference(obj, reference_type())) {
  53       return;
  54     } else if (contains(referent_addr)) {
  55       // treat referent as normal oop
  56       Devirtualizer<nv>::do_oop(closure, referent_addr);
  57     }
  58   }
  59   T* next_addr = (T*)java_lang_ref_Reference::next_addr(obj);
  60   T next_oop  = oopDesc::load_heap_oop(next_addr);
  61   // Treat discovered as normal oop, if ref is not "active" (next non-NULL)
  62   if (!oopDesc::is_null(next_oop) && contains(disc_addr)) {
  63     // i.e. ref is not "active"
  64     debug_only(
  65       if(TraceReferenceGC && PrintGCDetails) {
  66         gclog_or_tty->print_cr("   Process discovered as normal "
  67                                PTR_FORMAT, p2i(disc_addr));
  68       }
  69     )
  70     Devirtualizer<nv>::do_oop(closure, disc_addr);
  71   }
  72   // treat next as normal oop
  73   if (contains(next_addr)) {
  74     Devirtualizer<nv>::do_oop(closure, next_addr);
  75   }
  76 }
  77 
  78 class AlwaysContains {
  79  public:
  80   template <typename T> bool operator()(T* p) const { return true; }
  81 };
  82 
  83 template <bool nv, class OopClosureType>
  84 void InstanceRefKlass::oop_oop_iterate_ref_processing(oop obj, OopClosureType* closure) {
  85   AlwaysContains always_contains;
  86   if (UseCompressedOops) {
  87     oop_oop_iterate_ref_processing_specialized<nv, narrowOop>(obj, closure, always_contains);
  88   } else {
  89     oop_oop_iterate_ref_processing_specialized<nv, oop>(obj, closure, always_contains);
  90   }
  91 }
  92 
  93 class MrContains {
  94   const MemRegion _mr;
  95  public:
  96   MrContains(MemRegion mr) : _mr(mr) {}
  97   template <typename T> bool operator()(T* p) const { return _mr.contains(p); }
  98 };
  99 
 100 template <bool nv, class OopClosureType>
 101 void InstanceRefKlass::oop_oop_iterate_ref_processing_bounded(oop obj, OopClosureType* closure, MemRegion mr) {
 102   const MrContains contains(mr);
 103   if (UseCompressedOops) {
 104     oop_oop_iterate_ref_processing_specialized<nv, narrowOop>(obj, closure, contains);
 105   } else {
 106     oop_oop_iterate_ref_processing_specialized<nv, oop>(obj, closure, contains);
 107   }
 108 }
 109 
 110 template <bool nv, class OopClosureType>
 111 void InstanceRefKlass::oop_oop_iterate(oop obj, OopClosureType* closure) {
 112   InstanceKlass::oop_oop_iterate<nv>(obj, closure);
 113 
 114   oop_oop_iterate_ref_processing<nv>(obj, closure);
 115 }
 116 
 117 #if INCLUDE_ALL_GCS
 118 template <bool nv, class OopClosureType>
 119 void InstanceRefKlass::oop_oop_iterate_reverse(oop obj, OopClosureType* closure) {
 120   InstanceKlass::oop_oop_iterate_reverse<nv>(obj, closure);
 121 
 122   oop_oop_iterate_ref_processing<nv>(obj, closure);
 123 }
 124 #endif // INCLUDE_ALL_GCS
 125 
 126 
 127 template <bool nv, class OopClosureType>
 128 void InstanceRefKlass::oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr) {
 129   InstanceKlass::oop_oop_iterate_bounded<nv>(obj, closure, mr);
 130 
 131   oop_oop_iterate_ref_processing_bounded<nv>(obj, closure, mr);
 132 }
 133 
 134 // Macro to define InstanceRefKlass::oop_oop_iterate for virtual/nonvirtual for
 135 // all closures.  Macros calling macros above for each oop size.
 136 #define ALL_INSTANCE_REF_KLASS_OOP_OOP_ITERATE_DEFN(OopClosureType, nv_suffix)  \
 137   OOP_OOP_ITERATE_DEFN(          InstanceRefKlass, OopClosureType, nv_suffix)   \
 138   OOP_OOP_ITERATE_DEFN_BOUNDED(  InstanceRefKlass, OopClosureType, nv_suffix)   \
 139   OOP_OOP_ITERATE_DEFN_BACKWARDS(InstanceRefKlass, OopClosureType, nv_suffix)
 140 
 141 #endif // SHARE_VM_OOPS_INSTANCEREFKLASS_INLINE_HPP