1 /*
2 * Copyright (c) 2015, 2017, 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/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::do_referent(oop obj, OopClosureType* closure, Contains& contains) {
40 T* referent_addr = (T*)java_lang_ref_Reference::referent_addr(obj);
41 if (contains(referent_addr)) {
42 Devirtualizer<nv>::do_oop(closure, referent_addr);
43 }
44 }
45
46 template <bool nv, typename T, class OopClosureType, class Contains>
47 void InstanceRefKlass::do_next(oop obj, OopClosureType* closure, Contains& contains) {
48 T* next_addr = (T*)java_lang_ref_Reference::next_addr(obj);
49 if (contains(next_addr)) {
50 Devirtualizer<nv>::do_oop(closure, next_addr);
51 }
52 }
53
54 template <bool nv, typename T, class OopClosureType, class Contains>
55 void InstanceRefKlass::do_discovered(oop obj, OopClosureType* closure, Contains& contains) {
56 T* discovered_addr = (T*)java_lang_ref_Reference::discovered_addr(obj);
57 if (contains(discovered_addr)) {
58 Devirtualizer<nv>::do_oop(closure, discovered_addr);
59 }
60 }
61
62 template <typename T, class OopClosureType>
63 bool InstanceRefKlass::try_discover(oop obj, ReferenceType type, OopClosureType* closure) {
64 ReferenceProcessor* rp = closure->ref_processor();
65 if (rp != NULL) {
66 T referent_oop = oopDesc::load_heap_oop((T*)java_lang_ref_Reference::referent_addr(obj));
67 if (!oopDesc::is_null(referent_oop)) {
68 oop referent = oopDesc::decode_heap_oop_not_null(referent_oop);
69 if (!referent->is_gc_marked()) {
70 // Only try to discover if not yet marked.
71 return rp->discover_reference(obj, type);
72 }
73 }
74 }
75 return false;
76 }
77
78 template <bool nv, typename T, class OopClosureType, class Contains>
79 void InstanceRefKlass::oop_oop_iterate_discovery(oop obj, ReferenceType type, OopClosureType* closure, Contains& contains) {
80 log_develop_trace(gc, ref)("Process reference with discovery " PTR_FORMAT, p2i(obj));
81
82 // Try to discover reference and return if it succeeds.
83 if (try_discover<T>(obj, type, closure)) {
84 return;
85 }
86
87 // Treat referent as normal oop.
88 do_referent<nv, T>(obj, closure, contains);
89
90 // Treat discovered as normal oop, if ref is not "active" (next non-NULL).
91 T next_oop = oopDesc::load_heap_oop((T*)java_lang_ref_Reference::next_addr(obj));
92 if (!oopDesc::is_null(next_oop)) {
93 do_discovered<nv, T>(obj, closure, contains);
94 }
95
96 // Treat next as normal oop.
97 do_next<nv, T>(obj, closure, contains);
98 }
99
100 template <bool nv, typename T, class OopClosureType, class Contains>
101 void InstanceRefKlass::oop_oop_iterate_fields(oop obj, OopClosureType* closure, Contains& contains) {
102 do_referent<nv, T>(obj, closure, contains);
103 do_discovered<nv, T>(obj, closure, contains);
104 do_next<nv, T>(obj, closure, contains);
105
106 trace_reference_gc("InstanceRefKlass::oop_oop_iterate_fields()",
107 obj,
108 (T*)java_lang_ref_Reference::referent_addr(obj),
109 (T*)java_lang_ref_Reference::next_addr(obj),
110 (T*)java_lang_ref_Reference::discovered_addr(obj));
111 }
112
113 template <bool nv, typename T, class OopClosureType, class Contains>
114 void InstanceRefKlass::oop_oop_iterate_discovered_and_discovery(oop obj, ReferenceType type, OopClosureType* closure, Contains& contains) {
115 // Explicitly apply closure to the discovered field.
116 do_discovered<nv, T>(obj, closure, contains);
117 // Then do normal reference processing with discovery.
118 oop_oop_iterate_discovery<nv, T>(obj, type, closure, contains);
119 }
120
121 template <bool nv, typename T, class OopClosureType, class Contains>
122 void InstanceRefKlass::oop_oop_iterate_ref_processing_specialized(oop obj, OopClosureType* closure, Contains& contains) {
123 switch (closure->reference_iteration_mode()) {
124 case ExtendedOopClosure::DO_DISCOVERY:
125 oop_oop_iterate_discovery<nv, T>(obj, reference_type(), closure, contains);
126 break;
127 case ExtendedOopClosure::DO_DISCOVERED_AND_DISCOVERY:
128 oop_oop_iterate_discovered_and_discovery<nv, T>(obj, reference_type(), closure, contains);
129 break;
130 case ExtendedOopClosure::DO_FIELDS:
131 oop_oop_iterate_fields<nv, T>(obj, closure, contains);
132 break;
133 default:
134 ShouldNotReachHere();
135 }
136 }
137
138 class AlwaysContains {
139 public:
140 template <typename T> bool operator()(T* p) const { return true; }
141 };
142
143 template <bool nv, class OopClosureType>
144 void InstanceRefKlass::oop_oop_iterate_ref_processing(oop obj, OopClosureType* closure) {
145 AlwaysContains always_contains;
146 if (UseCompressedOops) {
147 oop_oop_iterate_ref_processing_specialized<nv, narrowOop>(obj, closure, always_contains);
148 } else {
149 oop_oop_iterate_ref_processing_specialized<nv, oop>(obj, closure, always_contains);
150 }
151 }
152
153 class MrContains {
154 const MemRegion _mr;
155 public:
156 MrContains(MemRegion mr) : _mr(mr) {}
157 template <typename T> bool operator()(T* p) const { return _mr.contains(p); }
158 };
159
160 template <bool nv, class OopClosureType>
161 void InstanceRefKlass::oop_oop_iterate_ref_processing_bounded(oop obj, OopClosureType* closure, MemRegion mr) {
162 const MrContains contains(mr);
163 if (UseCompressedOops) {
164 oop_oop_iterate_ref_processing_specialized<nv, narrowOop>(obj, closure, contains);
165 } else {
166 oop_oop_iterate_ref_processing_specialized<nv, oop>(obj, closure, contains);
167 }
168 }
169
170 template <bool nv, class OopClosureType>
171 void InstanceRefKlass::oop_oop_iterate(oop obj, OopClosureType* closure) {
172 InstanceKlass::oop_oop_iterate<nv>(obj, closure);
173
174 oop_oop_iterate_ref_processing<nv>(obj, closure);
175 }
176
177 #if INCLUDE_ALL_GCS
178 template <bool nv, class OopClosureType>
179 void InstanceRefKlass::oop_oop_iterate_reverse(oop obj, OopClosureType* closure) {
180 InstanceKlass::oop_oop_iterate_reverse<nv>(obj, closure);
181
182 oop_oop_iterate_ref_processing<nv>(obj, closure);
183 }
184 #endif // INCLUDE_ALL_GCS
185
186
187 template <bool nv, class OopClosureType>
188 void InstanceRefKlass::oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr) {
189 InstanceKlass::oop_oop_iterate_bounded<nv>(obj, closure, mr);
190
191 oop_oop_iterate_ref_processing_bounded<nv>(obj, closure, mr);
192 }
193
194 #ifdef ASSERT
195 template <typename T>
196 void InstanceRefKlass::trace_reference_gc(const char *s, oop obj, T* referent_addr, T* next_addr, T* discovered_addr) {
197 log_develop_trace(gc, ref)("%s obj " PTR_FORMAT, s, p2i(obj));
198 log_develop_trace(gc, ref)(" referent_addr/* " PTR_FORMAT " / " PTR_FORMAT,
199 p2i(referent_addr), p2i(referent_addr ? (address)oopDesc::load_decode_heap_oop(referent_addr) : NULL));
200 log_develop_trace(gc, ref)(" next_addr/* " PTR_FORMAT " / " PTR_FORMAT,
201 p2i(next_addr), p2i(next_addr ? (address)oopDesc::load_decode_heap_oop(next_addr) : NULL));
202 log_develop_trace(gc, ref)(" discovered_addr/* " PTR_FORMAT " / " PTR_FORMAT,
203 p2i(discovered_addr), p2i(discovered_addr ? (address)oopDesc::load_decode_heap_oop(discovered_addr) : NULL));
204 }
205 #endif
206
207 // Macro to define InstanceRefKlass::oop_oop_iterate for virtual/nonvirtual for
208 // all closures. Macros calling macros above for each oop size.
209 #define ALL_INSTANCE_REF_KLASS_OOP_OOP_ITERATE_DEFN(OopClosureType, nv_suffix) \
210 OOP_OOP_ITERATE_DEFN( InstanceRefKlass, OopClosureType, nv_suffix) \
211 OOP_OOP_ITERATE_DEFN_BOUNDED( InstanceRefKlass, OopClosureType, nv_suffix) \
212 OOP_OOP_ITERATE_DEFN_BACKWARDS(InstanceRefKlass, OopClosureType, nv_suffix)
213
214 #endif // SHARE_VM_OOPS_INSTANCEREFKLASS_INLINE_HPP