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 "memory/referenceProcessor.hpp"
30 #include "oops/instanceRefKlass.hpp"
31 #include "oops/instanceKlass.inline.hpp"
32 #include "oops/oop.inline.hpp"
33 #include "utilities/debug.hpp"
34 #include "utilities/globalDefinitions.hpp"
35 #include "utilities/macros.hpp"
36
37 template <bool nv, typename T, class OopClosureType, class Contains>
38 void InstanceRefKlass::oop_oop_iterate_ref_processing_specialized(oop obj, OopClosureType* closure, Contains& contains) {
39 T* disc_addr = (T*)java_lang_ref_Reference::discovered_addr(obj);
40 if (closure->apply_to_weak_ref_discovered_field()) {
41 Devirtualizer<nv>::do_oop(closure, disc_addr);
42 }
43
44 T* referent_addr = (T*)java_lang_ref_Reference::referent_addr(obj);
45 T heap_oop = oopDesc::load_heap_oop(referent_addr);
46 ReferenceProcessor* rp = closure->_ref_processor;
47 if (!oopDesc::is_null(heap_oop)) {
48 oop referent = oopDesc::decode_heap_oop_not_null(heap_oop);
49 if (!referent->is_gc_marked() && (rp != NULL) &&
50 rp->discover_reference(obj, reference_type())) {
51 return;
52 } else if (contains(referent_addr)) {
53 // treat referent as normal oop
54 Devirtualizer<nv>::do_oop(closure, referent_addr);
55 }
56 }
57 T* next_addr = (T*)java_lang_ref_Reference::next_addr(obj);
58 if (ReferenceProcessor::pending_list_uses_discovered_field()) {
59 T next_oop = oopDesc::load_heap_oop(next_addr);
60 // Treat discovered as normal oop, if ref is not "active" (next non-NULL)
61 if (!oopDesc::is_null(next_oop) && contains(disc_addr)) {
62 // i.e. ref is not "active"
63 debug_only(
64 if(TraceReferenceGC && PrintGCDetails) {
65 gclog_or_tty->print_cr(" Process discovered as normal "
66 PTR_FORMAT, p2i(disc_addr));
67 }
68 )
69 Devirtualizer<nv>::do_oop(closure, disc_addr);
70 }
71 } else {
72 // In the case of older JDKs which do not use the discovered field for
73 // the pending list, an inactive ref (next != NULL) must always have a
74 // NULL discovered field.
75 debug_only(
76 T next_oop = oopDesc::load_heap_oop(next_addr);
77 T disc_oop = oopDesc::load_heap_oop(disc_addr);
78 assert(oopDesc::is_null(next_oop) || oopDesc::is_null(disc_oop),
79 err_msg("Found an inactive reference " PTR_FORMAT " with a non-NULL"
80 "discovered field", p2i(obj)));
81 )
82 }
83 // treat next as normal oop
84 if (contains(next_addr)) {
85 Devirtualizer<nv>::do_oop(closure, next_addr);
86 }
87 }
88
89 class AlwaysContains {
90 public:
91 template <typename T> bool operator()(T* p) const { return true; }
92 };
93
94 template <bool nv, class OopClosureType>
95 void InstanceRefKlass::oop_oop_iterate_ref_processing(oop obj, OopClosureType* closure) {
96 AlwaysContains always_contains;
97 if (UseCompressedOops) {
98 oop_oop_iterate_ref_processing_specialized<nv, narrowOop>(obj, closure, always_contains);
99 } else {
100 oop_oop_iterate_ref_processing_specialized<nv, oop>(obj, closure, always_contains);
101 }
102 }
103
104 class MrContains {
105 const MemRegion _mr;
106 public:
107 MrContains(MemRegion mr) : _mr(mr) {}
108 template <typename T> bool operator()(T* p) const { return _mr.contains(p); }
109 };
110
111 template <bool nv, class OopClosureType>
112 void InstanceRefKlass::oop_oop_iterate_ref_processing_bounded(oop obj, OopClosureType* closure, MemRegion mr) {
113 const MrContains contains(mr);
114 if (UseCompressedOops) {
115 oop_oop_iterate_ref_processing_specialized<nv, narrowOop>(obj, closure, contains);
116 } else {
117 oop_oop_iterate_ref_processing_specialized<nv, oop>(obj, closure, contains);
118 }
119 }
120
121 template <bool nv, class OopClosureType>
122 int InstanceRefKlass::oop_oop_iterate(oop obj, OopClosureType* closure) {
123 // Get size before changing pointers
124 int size = InstanceKlass::oop_oop_iterate<nv>(obj, closure);
125
126 oop_oop_iterate_ref_processing<nv>(obj, closure);
127
128 return size;
129 }
130
131 #if INCLUDE_ALL_GCS
132 template <bool nv, class OopClosureType>
133 int InstanceRefKlass::
134 oop_oop_iterate_reverse(oop obj, OopClosureType* closure) {
135 // Get size before changing pointers
136 int size = InstanceKlass::oop_oop_iterate_reverse<nv>(obj, closure);
137
138 oop_oop_iterate_ref_processing<nv>(obj, closure);
139
140 return size;
141 }
142 #endif // INCLUDE_ALL_GCS
143
144
145 template <bool nv, class OopClosureType>
146 int InstanceRefKlass::oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr) {
147 // Get size before changing pointers
148 int size = InstanceKlass::oop_oop_iterate_bounded<nv>(obj, closure, mr);
149
150 oop_oop_iterate_ref_processing_bounded<nv>(obj, closure, mr);
151
152 return size;
153 }
154
155 // Macro to define InstanceRefKlass::oop_oop_iterate for virtual/nonvirtual for
156 // all closures. Macros calling macros above for each oop size.
157
158 #define InstanceRefKlass_OOP_OOP_ITERATE_DEFN(OopClosureType, nv_suffix) \
159 \
160 int InstanceRefKlass::oop_oop_iterate##nv_suffix(oop obj, OopClosureType* closure) { \
161 return oop_oop_iterate<nvs_to_bool(nv_suffix)>(obj, closure); \
162 }
163
164 #if INCLUDE_ALL_GCS
165 #define InstanceRefKlass_OOP_OOP_ITERATE_BACKWARDS_DEFN(OopClosureType, nv_suffix) \
166 \
167 int InstanceRefKlass::oop_oop_iterate_backwards##nv_suffix(oop obj, OopClosureType* closure) { \
168 return oop_oop_iterate_reverse<nvs_to_bool(nv_suffix)>(obj, closure); \
169 }
170 #else
171 #define InstanceRefKlass_OOP_OOP_ITERATE_BACKWARDS_DEFN(OopClosureType, nv_suffix)
172 #endif
173
174
175 #define InstanceRefKlass_OOP_OOP_ITERATE_DEFN_m(OopClosureType, nv_suffix) \
176 \
177 int InstanceRefKlass::oop_oop_iterate##nv_suffix##_m(oop obj, OopClosureType* closure, MemRegion mr) { \
178 return oop_oop_iterate_bounded<nvs_to_bool(nv_suffix)>(obj, closure, mr); \
179 }
180
181 #define ALL_INSTANCE_REF_KLASS_OOP_OOP_ITERATE_DEFN(OopClosureType, nv_suffix) \
182 InstanceRefKlass_OOP_OOP_ITERATE_DEFN( OopClosureType, nv_suffix) \
183 InstanceRefKlass_OOP_OOP_ITERATE_DEFN_m( OopClosureType, nv_suffix) \
184 InstanceRefKlass_OOP_OOP_ITERATE_BACKWARDS_DEFN(OopClosureType, nv_suffix)
185
186
187 #endif // SHARE_VM_OOPS_INSTANCEREFKLASS_INLINE_HPP