1 /* 2 * Copyright (c) 2015, 2018, 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.inline.hpp" 29 #include "gc/shared/referenceProcessor.hpp" 30 #include "logging/log.hpp" 31 #include "oops/access.inline.hpp" 32 #include "oops/compressedOops.inline.hpp" 33 #include "oops/instanceKlass.inline.hpp" 34 #include "oops/instanceRefKlass.hpp" 35 #include "oops/oop.inline.hpp" 36 #include "utilities/debug.hpp" 37 #include "utilities/globalDefinitions.hpp" 38 #include "utilities/macros.hpp" 39 40 template <typename T, class OopClosureType, class Contains> 41 void InstanceRefKlass::do_referent(oop obj, OopClosureType* closure, Contains& contains) { 42 T* referent_addr = (T*)java_lang_ref_Reference::referent_addr_raw(obj); 43 if (contains(referent_addr)) { 44 Devirtualizer::do_oop(closure, referent_addr); 45 } 46 } 47 48 template <typename T, class OopClosureType, class Contains> 49 void InstanceRefKlass::do_discovered(oop obj, OopClosureType* closure, Contains& contains) { 50 T* discovered_addr = (T*)java_lang_ref_Reference::discovered_addr_raw(obj); 51 if (contains(discovered_addr)) { 52 Devirtualizer::do_oop(closure, discovered_addr); 53 } 54 } 55 56 static inline oop load_referent(oop obj, ReferenceType type) { 57 if (type == REF_PHANTOM) { 58 return HeapAccess<ON_PHANTOM_OOP_REF | AS_NO_KEEPALIVE>::oop_load(java_lang_ref_Reference::referent_addr_raw(obj)); 59 } else { 60 return HeapAccess<ON_WEAK_OOP_REF | AS_NO_KEEPALIVE>::oop_load(java_lang_ref_Reference::referent_addr_raw(obj)); 61 } 62 } 63 64 template <typename T, class OopClosureType> 65 bool InstanceRefKlass::try_discover(oop obj, ReferenceType type, OopClosureType* closure) { 66 ReferenceDiscoverer* rd = closure->ref_discoverer(); 67 if (rd != NULL) { 68 oop referent = load_referent(obj, type); 69 if (referent != NULL) { 70 if (!referent->is_gc_marked()) { 71 // Only try to discover if not yet marked. 72 return rd->discover_reference(obj, type); 73 } 74 } 75 } 76 return false; 77 } 78 79 template <typename T, class OopClosureType, class Contains> 80 void InstanceRefKlass::oop_oop_iterate_discovery(oop obj, ReferenceType type, OopClosureType* closure, Contains& contains) { 81 // Try to discover reference and return if it succeeds. 82 if (try_discover<T>(obj, type, closure)) { 83 return; 84 } 85 86 // Treat referent and discovered as normal oops. 87 do_referent<T>(obj, closure, contains); 88 do_discovered<T>(obj, closure, contains); 89 } 90 91 template <typename T, class OopClosureType, class Contains> 92 void InstanceRefKlass::oop_oop_iterate_discovered_and_discovery(oop obj, ReferenceType type, OopClosureType* closure, Contains& contains) { 93 // Explicitly apply closure to the discovered field. 94 do_discovered<T>(obj, closure, contains); 95 // Then do normal reference processing with discovery. 96 oop_oop_iterate_discovery<T>(obj, type, closure, contains); 97 } 98 99 template <typename T, class OopClosureType, class Contains> 100 void InstanceRefKlass::oop_oop_iterate_fields(oop obj, OopClosureType* closure, Contains& contains) { 101 do_referent<T>(obj, closure, contains); 102 do_discovered<T>(obj, closure, contains); 103 } 104 105 template <typename T, class OopClosureType, class Contains> 106 void InstanceRefKlass::oop_oop_iterate_fields_except_referent(oop obj, OopClosureType* closure, Contains& contains) { 107 do_discovered<T>(obj, closure, contains); 108 } 109 110 template <typename T, class OopClosureType, class Contains> 111 void InstanceRefKlass::oop_oop_iterate_ref_processing(oop obj, OopClosureType* closure, Contains& contains) { 112 switch (closure->reference_iteration_mode()) { 113 case OopIterateClosure::DO_DISCOVERY: 114 trace_reference_gc<T>("do_discovery", obj); 115 oop_oop_iterate_discovery<T>(obj, reference_type(), closure, contains); 116 break; 117 case OopIterateClosure::DO_DISCOVERED_AND_DISCOVERY: 118 trace_reference_gc<T>("do_discovered_and_discovery", obj); 119 oop_oop_iterate_discovered_and_discovery<T>(obj, reference_type(), closure, contains); 120 break; 121 case OopIterateClosure::DO_FIELDS: 122 trace_reference_gc<T>("do_fields", obj); 123 oop_oop_iterate_fields<T>(obj, closure, contains); 124 break; 125 case OopIterateClosure::DO_FIELDS_EXCEPT_REFERENT: 126 trace_reference_gc<T>("do_fields_except_referent", obj); 127 oop_oop_iterate_fields_except_referent<T>(obj, closure, contains); 128 break; 129 default: 130 ShouldNotReachHere(); 131 } 132 } 133 134 class AlwaysContains { 135 public: 136 template <typename T> bool operator()(T* p) const { return true; } 137 }; 138 139 template <typename T, class OopClosureType> 140 void InstanceRefKlass::oop_oop_iterate_ref_processing(oop obj, OopClosureType* closure) { 141 AlwaysContains always_contains; 142 oop_oop_iterate_ref_processing<T>(obj, closure, always_contains); 143 } 144 145 class MrContains { 146 const MemRegion _mr; 147 public: 148 MrContains(MemRegion mr) : _mr(mr) {} 149 template <typename T> bool operator()(T* p) const { return _mr.contains(p); } 150 }; 151 152 template <typename T, class OopClosureType> 153 void InstanceRefKlass::oop_oop_iterate_ref_processing_bounded(oop obj, OopClosureType* closure, MemRegion mr) { 154 const MrContains contains(mr); 155 oop_oop_iterate_ref_processing<T>(obj, closure, contains); 156 } 157 158 template <typename T, class OopClosureType> 159 void InstanceRefKlass::oop_oop_iterate(oop obj, OopClosureType* closure) { 160 InstanceKlass::oop_oop_iterate<T>(obj, closure); 161 162 oop_oop_iterate_ref_processing<T>(obj, closure); 163 } 164 165 template <typename T, class OopClosureType> 166 void InstanceRefKlass::oop_oop_iterate_reverse(oop obj, OopClosureType* closure) { 167 InstanceKlass::oop_oop_iterate_reverse<T>(obj, closure); 168 169 oop_oop_iterate_ref_processing<T>(obj, closure); 170 } 171 172 template <typename T, class OopClosureType> 173 void InstanceRefKlass::oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr) { 174 InstanceKlass::oop_oop_iterate_bounded<T>(obj, closure, mr); 175 176 oop_oop_iterate_ref_processing_bounded<T>(obj, closure, mr); 177 } 178 179 #ifdef ASSERT 180 template <typename T> 181 void InstanceRefKlass::trace_reference_gc(const char *s, oop obj) { 182 T* referent_addr = (T*) java_lang_ref_Reference::referent_addr_raw(obj); 183 T* discovered_addr = (T*) java_lang_ref_Reference::discovered_addr_raw(obj); 184 185 log_develop_trace(gc, ref)("InstanceRefKlass %s for obj " PTR_FORMAT, s, p2i(obj)); 186 if (java_lang_ref_Reference::is_phantom(obj)) { 187 log_develop_trace(gc, ref)(" referent_addr/* " PTR_FORMAT " / " PTR_FORMAT, 188 p2i(referent_addr), p2i((oop)HeapAccess<ON_PHANTOM_OOP_REF | AS_NO_KEEPALIVE>::oop_load(referent_addr))); 189 } else { 190 log_develop_trace(gc, ref)(" referent_addr/* " PTR_FORMAT " / " PTR_FORMAT, 191 p2i(referent_addr), p2i((oop)HeapAccess<ON_WEAK_OOP_REF | AS_NO_KEEPALIVE>::oop_load(referent_addr))); 192 } 193 log_develop_trace(gc, ref)(" discovered_addr/* " PTR_FORMAT " / " PTR_FORMAT, 194 p2i(discovered_addr), p2i((oop)HeapAccess<AS_NO_KEEPALIVE>::oop_load(discovered_addr))); 195 } 196 #endif 197 198 #endif // SHARE_VM_OOPS_INSTANCEREFKLASS_INLINE_HPP