1 /*
2 * Copyright (c) 1997, 2019, 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_GC_SERIAL_MARKSWEEP_HPP
26 #define SHARE_GC_SERIAL_MARKSWEEP_HPP
27
28 #include "gc/shared/collectedHeap.hpp"
29 #include "gc/shared/genOopClosures.hpp"
30 #include "gc/shared/taskqueue.hpp"
31 #include "memory/iterator.hpp"
32 #include "oops/markWord.hpp"
33 #include "oops/oop.hpp"
34 #include "runtime/timer.hpp"
35 #include "utilities/growableArray.hpp"
36 #include "utilities/stack.hpp"
37
38 class ReferenceProcessor;
39 class DataLayout;
40 class SerialOldTracer;
41 class SlidingForwarding;
42 class STWGCTimer;
43
44 // MarkSweep takes care of global mark-compact garbage collection for a
45 // GenCollectedHeap using a four-phase pointer forwarding algorithm. All
46 // generations are assumed to support marking; those that can also support
47 // compaction.
48 //
49 // Class unloading will only occur when a full gc is invoked.
50
51 // declared at end
52 class PreservedMark;
53 class MarkAndPushClosure;
54 class AdjustPointerClosure;
55
56 class MarkSweep : AllStatic {
57 //
58 // Inline closure decls
59 //
60 class FollowRootClosure: public BasicOopIterateClosure {
61 public:
62 virtual void do_oop(oop* p);
63 virtual void do_oop(narrowOop* p);
64 };
65
66 class FollowStackClosure: public VoidClosure {
67 public:
68 virtual void do_void();
69 };
70
71 // Used for java/lang/ref handling
72 class IsAliveClosure: public BoolObjectClosure {
73 public:
74 virtual bool do_object_b(oop p);
75 };
76
77 class KeepAliveClosure: public OopClosure {
78 protected:
79 template <class T> void do_oop_work(T* p);
80 public:
81 virtual void do_oop(oop* p);
82 virtual void do_oop(narrowOop* p);
83 };
84
85 //
86 // Friend decls
87 //
88 friend class AdjustPointerClosure;
89 friend class KeepAliveClosure;
90 friend class VM_MarkSweep;
91
92 //
93 // Vars
94 //
95 protected:
96 // Total invocations of a MarkSweep collection
97 static uint _total_invocations;
98
99 // Traversal stacks used during phase1
100 static Stack<oop, mtGC> _marking_stack;
101 static Stack<ObjArrayTask, mtGC> _objarray_stack;
102
103 // Space for storing/restoring mark word
104 static Stack<markWord, mtGC> _preserved_mark_stack;
105 static Stack<oop, mtGC> _preserved_oop_stack;
106 static size_t _preserved_count;
107 static size_t _preserved_count_max;
108 static PreservedMark* _preserved_marks;
109
110 // Reference processing (used in ...follow_contents)
111 static ReferenceProcessor* _ref_processor;
112
113 static STWGCTimer* _gc_timer;
114 static SerialOldTracer* _gc_tracer;
115
116 // Non public closures
117 static KeepAliveClosure keep_alive;
118
119 public:
120 static void initialize();
121
122 // Public closures
123 static IsAliveClosure is_alive;
124 static FollowRootClosure follow_root_closure;
125 static MarkAndPushClosure mark_and_push_closure;
126 static FollowStackClosure follow_stack_closure;
127 static CLDToOopClosure follow_cld_closure;
128
129 // Accessors
130 static uint total_invocations() { return _total_invocations; }
131
132 // Reference Processing
133 static ReferenceProcessor* const ref_processor() { return _ref_processor; }
134 static void set_ref_processor(ReferenceProcessor* rp);
135
136 static STWGCTimer* gc_timer() { return _gc_timer; }
137 static SerialOldTracer* gc_tracer() { return _gc_tracer; }
138
139 static void preserve_mark(oop p, markWord mark);
140 // Save the mark word so it can be restored later
141 static void adjust_marks(); // Adjust the pointers in the preserved marks table
142 static void restore_marks(); // Restore the marks that we saved in preserve_mark
143
144 static int adjust_pointers(const SlidingForwarding* const forwarding, oop obj);
145
146 static void follow_stack(); // Empty marking stack.
147
148 static void follow_klass(Klass* klass);
149
150 static void follow_cld(ClassLoaderData* cld);
151
152 template <class T> static inline void adjust_pointer(const SlidingForwarding* const forwarding, T* p);
153
154 // Check mark and maybe push on marking stack
155 template <class T> static void mark_and_push(T* p);
156
157 private:
158 // Call backs for marking
159 static void mark_object(oop obj);
160 // Mark pointer and follow contents. Empty marking stack afterwards.
161 template <class T> static inline void follow_root(T* p);
162
163 static inline void push_objarray(oop obj, size_t index);
164
165 static void follow_object(oop obj);
166
167 static void follow_array(objArrayOop array);
168
169 static void follow_array_chunk(objArrayOop array, int index);
170 };
171
172 class MarkAndPushClosure: public OopIterateClosure {
173 public:
174 template <typename T> void do_oop_work(T* p);
175 virtual void do_oop(oop* p);
176 virtual void do_oop(narrowOop* p);
177
178 virtual bool do_metadata() { return true; }
179 virtual void do_klass(Klass* k);
180 virtual void do_cld(ClassLoaderData* cld);
181
182 void set_ref_discoverer(ReferenceDiscoverer* rd) {
183 set_ref_discoverer_internal(rd);
184 }
185 };
186
187 class AdjustPointerClosure: public BasicOopIterateClosure {
188 private:
189 const SlidingForwarding* const _forwarding;
190 public:
191 AdjustPointerClosure(const SlidingForwarding* forwarding) : _forwarding(forwarding) {}
192 template <typename T> void do_oop_work(T* p);
193 virtual void do_oop(oop* p);
194 virtual void do_oop(narrowOop* p);
195 virtual ReferenceIterationMode reference_iteration_mode() { return DO_FIELDS; }
196 };
197
198 class PreservedMark {
199 private:
200 oop _obj;
201 markWord _mark;
202
203 public:
204 void init(oop obj, markWord mark) {
205 _obj = obj;
206 _mark = mark;
207 }
208
209 void adjust_pointer(const SlidingForwarding* const forwarding);
210 void restore();
211 };
212
213 #endif // SHARE_GC_SERIAL_MARKSWEEP_HPP