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