1 /*
2 * Copyright (c) 2001, 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_GC_G1_G1OOPCLOSURES_HPP
26 #define SHARE_VM_GC_G1_G1OOPCLOSURES_HPP
27
28 #include "memory/iterator.hpp"
29 #include "oops/markOop.hpp"
30
31 class HeapRegion;
32 class G1CollectedHeap;
33 class G1RemSet;
34 class ConcurrentMark;
35 class DirtyCardToOopClosure;
36 class CMBitMap;
37 class CMMarkStack;
38 class G1ParScanThreadState;
39 class CMTask;
40 class ReferenceProcessor;
41
42 // A class that scans oops in a given heap region (much as OopsInGenClosure
43 // scans oops in a generation.)
44 class OopsInHeapRegionClosure: public ExtendedOopClosure {
45 protected:
46 HeapRegion* _from;
47 public:
48 void set_region(HeapRegion* from) { _from = from; }
49 };
50
51 class G1ParClosureSuper : public OopsInHeapRegionClosure {
52 protected:
53 G1CollectedHeap* _g1;
54 G1ParScanThreadState* _par_scan_state;
55 uint _worker_id;
56 public:
57 // Initializes the instance, leaving _par_scan_state uninitialized. Must be done
58 // later using the set_par_scan_thread_state() method.
59 G1ParClosureSuper(G1CollectedHeap* g1);
60 G1ParClosureSuper(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state);
61 bool apply_to_weak_ref_discovered_field() { return true; }
62
63 void set_par_scan_thread_state(G1ParScanThreadState* par_scan_state);
64 };
65
66 class G1ParPushHeapRSClosure : public G1ParClosureSuper {
67 public:
68 G1ParPushHeapRSClosure(G1CollectedHeap* g1,
69 G1ParScanThreadState* par_scan_state):
70 G1ParClosureSuper(g1, par_scan_state) { }
71
72 template <class T> void do_oop_nv(T* p);
73 virtual void do_oop(oop* p) { do_oop_nv(p); }
74 virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
75 };
76
77 class G1ParScanClosure : public G1ParClosureSuper {
78 public:
79 G1ParScanClosure(G1CollectedHeap* g1, ReferenceProcessor* rp) :
80 G1ParClosureSuper(g1) {
81 assert(_ref_processor == NULL, "sanity");
82 _ref_processor = rp;
83 }
84
85 template <class T> void do_oop_nv(T* p);
86 virtual void do_oop(oop* p) { do_oop_nv(p); }
87 virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
88 };
89
90 // Add back base class for metadata
91 class G1ParCopyHelper : public G1ParClosureSuper {
92 protected:
93 Klass* _scanned_klass;
94 ConcurrentMark* _cm;
95
96 // Mark the object if it's not already marked. This is used to mark
97 // objects pointed to by roots that are guaranteed not to move
98 // during the GC (i.e., non-CSet objects). It is MT-safe.
99 void mark_object(oop obj);
100
101 // Mark the object if it's not already marked. This is used to mark
102 // objects pointed to by roots that have been forwarded during a
103 // GC. It is MT-safe.
104 void mark_forwarded_object(oop from_obj, oop to_obj);
105 public:
106 G1ParCopyHelper(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state);
107
108 void set_scanned_klass(Klass* k) { _scanned_klass = k; }
109 template <class T> void do_klass_barrier(T* p, oop new_obj);
110 };
111
112 enum G1Barrier {
113 G1BarrierNone,
114 G1BarrierKlass
115 };
116
117 enum G1Mark {
118 G1MarkNone,
119 G1MarkFromRoot,
120 G1MarkPromotedFromRoot
121 };
122
123 template <G1Barrier barrier, G1Mark do_mark_object>
124 class G1ParCopyClosure : public G1ParCopyHelper {
125 private:
126 template <class T> void do_oop_work(T* p);
127
128 public:
129 G1ParCopyClosure(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state,
130 ReferenceProcessor* rp) :
131 G1ParCopyHelper(g1, par_scan_state) {
132 assert(_ref_processor == NULL, "sanity");
133 }
134
135 template <class T> void do_oop_nv(T* p) { do_oop_work(p); }
136 virtual void do_oop(oop* p) { do_oop_nv(p); }
137 virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
138
139 G1CollectedHeap* g1() { return _g1; };
140 G1ParScanThreadState* pss() { return _par_scan_state; }
141 ReferenceProcessor* rp() { return _ref_processor; };
142 };
143
144 typedef G1ParCopyClosure<G1BarrierNone, G1MarkNone> G1ParScanExtRootClosure;
145 typedef G1ParCopyClosure<G1BarrierNone, G1MarkFromRoot> G1ParScanAndMarkExtRootClosure;
146 typedef G1ParCopyClosure<G1BarrierNone, G1MarkPromotedFromRoot> G1ParScanAndMarkWeakExtRootClosure;
147 // We use a separate closure to handle references during evacuation
148 // failure processing.
149
150 class FilterIntoCSClosure: public ExtendedOopClosure {
151 G1CollectedHeap* _g1;
152 OopClosure* _oc;
153 DirtyCardToOopClosure* _dcto_cl;
154 public:
155 FilterIntoCSClosure( DirtyCardToOopClosure* dcto_cl,
156 G1CollectedHeap* g1,
157 OopClosure* oc) :
158 _dcto_cl(dcto_cl), _g1(g1), _oc(oc) { }
159
160 template <class T> void do_oop_nv(T* p);
161 virtual void do_oop(oop* p) { do_oop_nv(p); }
162 virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
163 bool apply_to_weak_ref_discovered_field() { return true; }
164 };
165
166 class FilterOutOfRegionClosure: public ExtendedOopClosure {
167 HeapWord* _r_bottom;
168 HeapWord* _r_end;
169 OopClosure* _oc;
170 public:
171 FilterOutOfRegionClosure(HeapRegion* r, OopClosure* oc);
172 template <class T> void do_oop_nv(T* p);
173 virtual void do_oop(oop* p) { do_oop_nv(p); }
174 virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
175 bool apply_to_weak_ref_discovered_field() { return true; }
176 };
177
178 // Closure for iterating over object fields during concurrent marking
179 class G1CMOopClosure : public MetadataAwareOopClosure {
180 protected:
181 ConcurrentMark* _cm;
182 private:
183 G1CollectedHeap* _g1h;
184 CMTask* _task;
185 public:
186 G1CMOopClosure(G1CollectedHeap* g1h, ConcurrentMark* cm, CMTask* task);
187 template <class T> void do_oop_nv(T* p);
188 virtual void do_oop( oop* p) { do_oop_nv(p); }
189 virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
190 };
191
192 // Closure to scan the root regions during concurrent marking
193 class G1RootRegionScanClosure : public MetadataAwareOopClosure {
194 private:
195 G1CollectedHeap* _g1h;
196 ConcurrentMark* _cm;
197 uint _worker_id;
198 public:
199 G1RootRegionScanClosure(G1CollectedHeap* g1h, ConcurrentMark* cm,
200 uint worker_id) :
201 _g1h(g1h), _cm(cm), _worker_id(worker_id) { }
202 template <class T> void do_oop_nv(T* p);
203 virtual void do_oop( oop* p) { do_oop_nv(p); }
204 virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
205 };
206
207 // Closure that applies the given two closures in sequence.
208 // Used by the RSet refinement code (when updating RSets
209 // during an evacuation pause) to record cards containing
210 // pointers into the collection set.
211
212 class G1Mux2Closure : public ExtendedOopClosure {
213 OopClosure* _c1;
214 OopClosure* _c2;
215 public:
216 G1Mux2Closure(OopClosure *c1, OopClosure *c2);
217 template <class T> void do_oop_nv(T* p);
218 virtual void do_oop(oop* p) { do_oop_nv(p); }
219 virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
220 };
221
222 // A closure that returns true if it is actually applied
223 // to a reference
224
225 class G1TriggerClosure : public ExtendedOopClosure {
226 bool _triggered;
227 public:
228 G1TriggerClosure();
229 bool triggered() const { return _triggered; }
230 template <class T> void do_oop_nv(T* p);
231 virtual void do_oop(oop* p) { do_oop_nv(p); }
232 virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
233 };
234
235 // A closure which uses a triggering closure to determine
236 // whether to apply an oop closure.
237
238 class G1InvokeIfNotTriggeredClosure: public ExtendedOopClosure {
239 G1TriggerClosure* _trigger_cl;
240 OopClosure* _oop_cl;
241 public:
242 G1InvokeIfNotTriggeredClosure(G1TriggerClosure* t, OopClosure* oc);
243 template <class T> void do_oop_nv(T* p);
244 virtual void do_oop(oop* p) { do_oop_nv(p); }
245 virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
246 };
247
248 class G1UpdateRSOrPushRefOopClosure: public ExtendedOopClosure {
249 G1CollectedHeap* _g1;
250 G1RemSet* _g1_rem_set;
251 HeapRegion* _from;
252 G1ParPushHeapRSClosure* _push_ref_cl;
253 bool _record_refs_into_cset;
254 uint _worker_i;
255
256 public:
257 G1UpdateRSOrPushRefOopClosure(G1CollectedHeap* g1h,
258 G1RemSet* rs,
259 G1ParPushHeapRSClosure* push_ref_cl,
260 bool record_refs_into_cset,
261 uint worker_i = 0);
262
263 void set_from(HeapRegion* from) {
264 assert(from != NULL, "from region must be non-NULL");
265 _from = from;
266 }
267
268 bool self_forwarded(oop obj) {
269 markOop m = obj->mark();
270 bool result = (m->is_marked() && ((oop)m->decode_pointer() == obj));
271 return result;
272 }
273
274 bool apply_to_weak_ref_discovered_field() { return true; }
275
276 template <class T> void do_oop_nv(T* p);
277 virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
278 virtual void do_oop(oop* p) { do_oop_nv(p); }
279 };
280
281 #endif // SHARE_VM_GC_G1_G1OOPCLOSURES_HPP