1 /*
2 * Copyright (c) 2001, 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_GC_G1_G1OOPCLOSURES_HPP
26 #define SHARE_VM_GC_G1_G1OOPCLOSURES_HPP
27
28 #include "gc/g1/g1InCSetState.hpp"
29 #include "memory/iterator.hpp"
30 #include "oops/markOop.hpp"
31
32 class HeapRegion;
33 class G1CollectedHeap;
34 class G1RemSet;
35 class G1ConcurrentMark;
36 class DirtyCardToOopClosure;
37 class G1CMBitMap;
38 class G1ParScanThreadState;
39 class G1ScanEvacuatedObjClosure;
40 class G1CMTask;
41 class ReferenceProcessor;
42
43 class G1ScanClosureBase : public BasicOopIterateClosure {
44 protected:
45 G1CollectedHeap* _g1h;
46 G1ParScanThreadState* _par_scan_state;
47
48 G1ScanClosureBase(G1CollectedHeap* g1h, G1ParScanThreadState* par_scan_state);
49 ~G1ScanClosureBase() { }
50
51 template <class T>
52 inline void prefetch_and_push(T* p, oop const obj);
53
54 template <class T>
55 inline void handle_non_cset_obj_common(InCSetState const state, T* p, oop const obj);
56 public:
57 virtual ReferenceIterationMode reference_iteration_mode() { return DO_FIELDS; }
58
59 inline void trim_queue_partially();
60 };
61
62 // Used during the Update RS phase to refine remaining cards in the DCQ during garbage collection.
63 class G1ScanObjsDuringUpdateRSClosure : public G1ScanClosureBase {
64 public:
65 G1ScanObjsDuringUpdateRSClosure(G1CollectedHeap* g1h,
66 G1ParScanThreadState* pss) :
67 G1ScanClosureBase(g1h, pss) { }
68
69 template <class T> void do_oop_work(T* p);
70 virtual void do_oop(narrowOop* p) { do_oop_work(p); }
71 virtual void do_oop(oop* p) { do_oop_work(p); }
72 };
73
74 // Used during the Scan RS phase to scan cards from the remembered set during garbage collection.
75 class G1ScanObjsDuringScanRSClosure : public G1ScanClosureBase {
76 public:
77 G1ScanObjsDuringScanRSClosure(G1CollectedHeap* g1h,
78 G1ParScanThreadState* par_scan_state):
79 G1ScanClosureBase(g1h, par_scan_state) { }
80
81 template <class T> void do_oop_work(T* p);
82 virtual void do_oop(oop* p) { do_oop_work(p); }
83 virtual void do_oop(narrowOop* p) { do_oop_work(p); }
84 };
85
86 // Used during Optional RS scanning to make sure we trim the queues in a timely manner.
87 class G1ScanRSForOptionalClosure : public OopClosure {
88 G1ScanObjsDuringScanRSClosure* _scan_cl;
89 public:
90 G1ScanRSForOptionalClosure(G1ScanObjsDuringScanRSClosure* cl) : _scan_cl(cl) { }
91
92 template <class T> void do_oop_work(T* p);
93 virtual void do_oop(oop* p) { do_oop_work(p); }
94 virtual void do_oop(narrowOop* p) { do_oop_work(p); }
95 };
96
97 // This closure is applied to the fields of the objects that have just been copied during evacuation.
98 class G1ScanEvacuatedObjClosure : public G1ScanClosureBase {
99 friend class G1ScanInYoungSetter;
100
101 enum ScanningInYoungValues {
102 False = 0,
103 True,
104 Uninitialized
105 };
106
107 ScanningInYoungValues _scanning_in_young;
108
109 public:
110 G1ScanEvacuatedObjClosure(G1CollectedHeap* g1h, G1ParScanThreadState* par_scan_state) :
111 G1ScanClosureBase(g1h, par_scan_state), _scanning_in_young(Uninitialized) { }
112
113 template <class T> void do_oop_work(T* p);
114 virtual void do_oop(oop* p) { do_oop_work(p); }
115 virtual void do_oop(narrowOop* p) { do_oop_work(p); }
116
117 // We need to do reference discovery while processing evacuated objects.
118 virtual ReferenceIterationMode reference_iteration_mode() { return DO_DISCOVERED_AND_DISCOVERY; }
119
120 void set_ref_discoverer(ReferenceDiscoverer* rd) {
121 set_ref_discoverer_internal(rd);
122 }
123 };
124
125 // RAII object to properly set the _scanning_in_young field in G1ScanEvacuatedObjClosure.
126 class G1ScanInYoungSetter : public StackObj {
127 G1ScanEvacuatedObjClosure* _closure;
128
129 public:
130 G1ScanInYoungSetter(G1ScanEvacuatedObjClosure* closure, bool new_value) : _closure(closure) {
131 assert(_closure->_scanning_in_young == G1ScanEvacuatedObjClosure::Uninitialized, "Must not be set");
132 _closure->_scanning_in_young = new_value ? G1ScanEvacuatedObjClosure::True : G1ScanEvacuatedObjClosure::False;
133 }
134
135 ~G1ScanInYoungSetter() {
136 DEBUG_ONLY(_closure->_scanning_in_young = G1ScanEvacuatedObjClosure::Uninitialized;)
137 }
138 };
139
140 // Add back base class for metadata
141 class G1ParCopyHelper : public OopClosure {
142 protected:
143 G1CollectedHeap* _g1h;
144 G1ParScanThreadState* _par_scan_state;
145 uint _worker_id; // Cache value from par_scan_state.
146 ClassLoaderData* _scanned_cld;
147 G1ConcurrentMark* _cm;
148
149 // Mark the object if it's not already marked. This is used to mark
150 // objects pointed to by roots that are guaranteed not to move
151 // during the GC (i.e., non-CSet objects). It is MT-safe.
152 inline void mark_object(oop obj);
153
154 // Mark the object if it's not already marked. This is used to mark
155 // objects pointed to by roots that have been forwarded during a
156 // GC. It is MT-safe.
157 inline void mark_forwarded_object(oop from_obj, oop to_obj);
158
159 G1ParCopyHelper(G1CollectedHeap* g1h, G1ParScanThreadState* par_scan_state);
160 ~G1ParCopyHelper() { }
161
162 public:
163 void set_scanned_cld(ClassLoaderData* cld) { _scanned_cld = cld; }
164 inline void do_cld_barrier(oop new_obj);
165
166 inline void trim_queue_partially();
167 };
168
169 enum G1Barrier {
170 G1BarrierNone,
171 G1BarrierCLD
172 };
173
174 enum G1Mark {
175 G1MarkNone,
176 G1MarkFromRoot,
177 G1MarkPromotedFromRoot
178 };
179
180 template <G1Barrier barrier, G1Mark do_mark_object>
181 class G1ParCopyClosure : public G1ParCopyHelper {
182 public:
183 G1ParCopyClosure(G1CollectedHeap* g1h, G1ParScanThreadState* par_scan_state) :
184 G1ParCopyHelper(g1h, par_scan_state) { }
185
186 template <class T> void do_oop_work(T* p);
187 virtual void do_oop(oop* p) { do_oop_work(p); }
188 virtual void do_oop(narrowOop* p) { do_oop_work(p); }
189 };
190
191 class G1CLDScanClosure : public CLDClosure {
192 G1ParCopyHelper* _closure;
193 bool _process_only_dirty;
194 int _claim;
195 int _count;
196 public:
197 G1CLDScanClosure(G1ParCopyHelper* closure,
198 bool process_only_dirty, int claim_value)
199 : _closure(closure), _process_only_dirty(process_only_dirty), _claim(claim_value), _count(0) {}
200 void do_cld(ClassLoaderData* cld);
201 };
202
203 // Closure for iterating over object fields during concurrent marking
204 class G1CMOopClosure : public MetadataVisitingOopIterateClosure {
205 G1CollectedHeap* _g1h;
206 G1CMTask* _task;
207 public:
208 G1CMOopClosure(G1CollectedHeap* g1h,G1CMTask* task);
209 template <class T> void do_oop_work(T* p);
210 virtual void do_oop( oop* p) { do_oop_work(p); }
211 virtual void do_oop(narrowOop* p) { do_oop_work(p); }
212 };
213
214 // Closure to scan the root regions during concurrent marking
215 class G1RootRegionScanClosure : public MetadataVisitingOopIterateClosure {
216 private:
217 G1CollectedHeap* _g1h;
218 G1ConcurrentMark* _cm;
219 uint _worker_id;
220 public:
221 G1RootRegionScanClosure(G1CollectedHeap* g1h, G1ConcurrentMark* cm, uint worker_id) :
222 _g1h(g1h), _cm(cm), _worker_id(worker_id) { }
223 template <class T> void do_oop_work(T* p);
224 virtual void do_oop( oop* p) { do_oop_work(p); }
225 virtual void do_oop(narrowOop* p) { do_oop_work(p); }
226 };
227
228 class G1ConcurrentRefineOopClosure: public BasicOopIterateClosure {
229 G1CollectedHeap* _g1h;
230 uint _worker_i;
231
232 public:
233 G1ConcurrentRefineOopClosure(G1CollectedHeap* g1h, uint worker_i) :
234 _g1h(g1h),
235 _worker_i(worker_i) {
236 }
237
238 virtual ReferenceIterationMode reference_iteration_mode() { return DO_FIELDS; }
239
240 template <class T> void do_oop_work(T* p);
241 virtual void do_oop(narrowOop* p) { do_oop_work(p); }
242 virtual void do_oop(oop* p) { do_oop_work(p); }
243 };
244
245 class G1RebuildRemSetClosure : public BasicOopIterateClosure {
246 G1CollectedHeap* _g1h;
247 uint _worker_id;
248 public:
249 G1RebuildRemSetClosure(G1CollectedHeap* g1h, uint worker_id) : _g1h(g1h), _worker_id(worker_id) {
250 }
251
252 template <class T> void do_oop_work(T* p);
253 virtual void do_oop(oop* p) { do_oop_work(p); }
254 virtual void do_oop(narrowOop* p) { do_oop_work(p); }
255
256 virtual ReferenceIterationMode reference_iteration_mode() { return DO_FIELDS; }
257 };
258
259 #endif // SHARE_VM_GC_G1_G1OOPCLOSURES_HPP