1/*
2 * Copyright (c) 2001, 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_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
32class HeapRegion;
33class G1CollectedHeap;
34class G1RemSet;
35class G1ConcurrentMark;
36class DirtyCardToOopClosure;
37class G1CMBitMap;
38class G1ParScanThreadState;
39class G1CMTask;
40class ReferenceProcessor;
41
42class G1ScanClosureBase : public ExtendedOopClosure {
43protected:
44  G1CollectedHeap* _g1;
45  G1ParScanThreadState* _par_scan_state;
46  HeapRegion* _from;
47
48  G1ScanClosureBase(G1CollectedHeap* g1, 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);
56public:
57  // This closure needs special handling for InstanceRefKlass.
58  virtual ReferenceIterationMode reference_iteration_mode() { return DO_DISCOVERED_AND_DISCOVERY; }
59  void set_region(HeapRegion* from) { _from = from; }
60};
61
62// Used during the Update RS phase to refine remaining cards in the DCQ during garbage collection.
63class G1ScanObjsDuringUpdateRSClosure: public G1ScanClosureBase {
64  uint _worker_i;
65
66public:
67  G1ScanObjsDuringUpdateRSClosure(G1CollectedHeap* g1h,
68                                  G1ParScanThreadState* pss,
69                                  uint worker_i) :
70    G1ScanClosureBase(g1h, pss), _worker_i(worker_i) { }
71
72  template <class T> void do_oop_nv(T* p);
73  virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
74  virtual void do_oop(oop* p) { do_oop_nv(p); }
75};
76
77// Used during the Scan RS phase to scan cards from the remembered set during garbage collection.
78class G1ScanObjsDuringScanRSClosure : public G1ScanClosureBase {
79public:
80  G1ScanObjsDuringScanRSClosure(G1CollectedHeap* g1,
81                                G1ParScanThreadState* par_scan_state):
82    G1ScanClosureBase(g1, par_scan_state) { }
83
84  template <class T> void do_oop_nv(T* p);
85  virtual void do_oop(oop* p)          { do_oop_nv(p); }
86  virtual void do_oop(narrowOop* p)    { do_oop_nv(p); }
87};
88
89// This closure is applied to the fields of the objects that have just been copied during evacuation.
90class G1ScanEvacuatedObjClosure : public G1ScanClosureBase {
91public:
92  G1ScanEvacuatedObjClosure(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state) :
93    G1ScanClosureBase(g1, par_scan_state) { }
94
95  template <class T> void do_oop_nv(T* p);
96  virtual void do_oop(oop* p)          { do_oop_nv(p); }
97  virtual void do_oop(narrowOop* p)    { do_oop_nv(p); }
98
99  void set_ref_processor(ReferenceProcessor* rp) {
100    set_ref_processor_internal(rp);
101  }
102};
103
104// Add back base class for metadata
105class G1ParCopyHelper : public OopClosure {
106protected:
107  G1CollectedHeap* _g1;
108  G1ParScanThreadState* _par_scan_state;
109  uint _worker_id;              // Cache value from par_scan_state.
110  Klass* _scanned_klass;
111  G1ConcurrentMark* _cm;
112
113  // Mark the object if it's not already marked. This is used to mark
114  // objects pointed to by roots that are guaranteed not to move
115  // during the GC (i.e., non-CSet objects). It is MT-safe.
116  inline void mark_object(oop obj);
117
118  // Mark the object if it's not already marked. This is used to mark
119  // objects pointed to by roots that have been forwarded during a
120  // GC. It is MT-safe.
121  inline void mark_forwarded_object(oop from_obj, oop to_obj);
122
123  G1ParCopyHelper(G1CollectedHeap* g1,  G1ParScanThreadState* par_scan_state);
124  ~G1ParCopyHelper() { }
125
126 public:
127  void set_scanned_klass(Klass* k) { _scanned_klass = k; }
128  template <class T> inline void do_klass_barrier(T* p, oop new_obj);
129};
130
131enum G1Barrier {
132  G1BarrierNone,
133  G1BarrierKlass
134};
135
136enum G1Mark {
137  G1MarkNone,
138  G1MarkFromRoot,
139  G1MarkPromotedFromRoot
140};
141
142template <G1Barrier barrier, G1Mark do_mark_object, bool use_ext>
143class G1ParCopyClosure : public G1ParCopyHelper {
144public:
145  G1ParCopyClosure(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state) :
146      G1ParCopyHelper(g1, par_scan_state) { }
147
148  template <class T> void do_oop_work(T* p);
149  virtual void do_oop(oop* p)       { do_oop_work(p); }
150  virtual void do_oop(narrowOop* p) { do_oop_work(p); }
151};
152
153class G1KlassScanClosure : public KlassClosure {
154 G1ParCopyHelper* _closure;
155 bool             _process_only_dirty;
156 int              _count;
157 public:
158  G1KlassScanClosure(G1ParCopyHelper* closure, bool process_only_dirty)
159      : _process_only_dirty(process_only_dirty), _closure(closure), _count(0) {}
160  void do_klass(Klass* klass);
161};
162
163// Closure for iterating over object fields during concurrent marking
164class G1CMOopClosure : public MetadataAwareOopClosure {
165protected:
166  G1ConcurrentMark*  _cm;
167private:
168  G1CollectedHeap*   _g1h;
169  G1CMTask*          _task;
170public:
171  G1CMOopClosure(G1CollectedHeap* g1h, G1ConcurrentMark* cm, G1CMTask* task);
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};
176
177// Closure to scan the root regions during concurrent marking
178class G1RootRegionScanClosure : public MetadataAwareOopClosure {
179private:
180  G1CollectedHeap* _g1h;
181  G1ConcurrentMark* _cm;
182public:
183  G1RootRegionScanClosure(G1CollectedHeap* g1h, G1ConcurrentMark* cm) :
184    _g1h(g1h), _cm(cm) { }
185  template <class T> void do_oop_nv(T* p);
186  virtual void do_oop(      oop* p) { do_oop_nv(p); }
187  virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
188};
189
190class G1ConcurrentRefineOopClosure: public ExtendedOopClosure {
191  G1CollectedHeap* _g1;
192  uint _worker_i;
193
194public:
195  G1ConcurrentRefineOopClosure(G1CollectedHeap* g1h, uint worker_i) :
196    _g1(g1h),
197    _worker_i(worker_i) {
198  }
199
200  // This closure needs special handling for InstanceRefKlass.
201  virtual ReferenceIterationMode reference_iteration_mode() { return DO_DISCOVERED_AND_DISCOVERY; }
202
203  template <class T> void do_oop_nv(T* p);
204  virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
205  virtual void do_oop(oop* p)       { do_oop_nv(p); }
206};
207
208#endif // SHARE_VM_GC_G1_G1OOPCLOSURES_HPP
209