1 /*
2 * Copyright (c) 2005, 2020, 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_PARALLEL_PSCOMPACTIONMANAGER_HPP
26 #define SHARE_GC_PARALLEL_PSCOMPACTIONMANAGER_HPP
27
28 #include "gc/parallel/psParallelCompact.hpp"
29 #include "gc/shared/taskqueue.hpp"
30 #include "memory/allocation.hpp"
31 #include "utilities/stack.hpp"
32
33 class MutableSpace;
34 class PSOldGen;
35 class ParCompactionManager;
36 class ObjectStartArray;
37 class ParallelCompactData;
38 class ParMarkBitMap;
39
40 class ParCompactionManager : public CHeapObj<mtGC> {
41 friend class ParMarkBitMap;
42 friend class PSParallelCompact;
43 friend class CompactionWithStealingTask;
44 friend class UpdateAndFillClosure;
45 friend class RefProcTaskExecutor;
46 friend class PCRefProcTask;
47 friend class MarkFromRootsTask;
48 friend class UpdateDensePrefixAndCompactionTask;
49
50 public:
51
52 // ------------------------ Don't putback if not needed
53 // Actions that the compaction manager should take.
54 enum Action {
55 Update,
56 Copy,
57 UpdateAndCopy,
58 CopyAndUpdate,
59 NotValid
60 };
61 // ------------------------ End don't putback if not needed
62
63 private:
64 typedef GenericTaskQueue<oop, mtGC> OopTaskQueue;
65 typedef GenericTaskQueueSet<OopTaskQueue, mtGC> OopTaskQueueSet;
66
67 // 32-bit: 4K * 8 = 32KiB; 64-bit: 8K * 16 = 128KiB
68 #define QUEUE_SIZE (1 << NOT_LP64(12) LP64_ONLY(13))
69 typedef OverflowTaskQueue<ObjArrayTask, mtGC, QUEUE_SIZE> ObjArrayTaskQueue;
70 typedef GenericTaskQueueSet<ObjArrayTaskQueue, mtGC> ObjArrayTaskQueueSet;
71 #undef QUEUE_SIZE
72 typedef OverflowTaskQueue<size_t, mtGC> RegionTaskQueue;
73 typedef GenericTaskQueueSet<RegionTaskQueue, mtGC> RegionTaskQueueSet;
74
75 static ParCompactionManager** _manager_array;
76 static OopTaskQueueSet* _oop_task_queues;
77 static ObjArrayTaskQueueSet* _objarray_task_queues;
78 static ObjectStartArray* _start_array;
79 static RegionTaskQueueSet* _region_task_queues;
80 static PSOldGen* _old_gen;
81
82 private:
83 OverflowTaskQueue<oop, mtGC> _marking_stack;
84 ObjArrayTaskQueue _objarray_stack;
85 size_t _next_shadow_region;
86
87 // Is there a way to reuse the _marking_stack for the
88 // saving empty regions? For now just create a different
89 // type of TaskQueue.
90 RegionTaskQueue _region_stack;
91
92 static ParMarkBitMap* _mark_bitmap;
93
94 // Contains currently free shadow regions. We use it in
95 // a LIFO fashion for better data locality and utilization.
96 static GrowableArray<size_t>* _shadow_region_array;
97
98 // Provides mutual exclusive access of _shadow_region_array.
99 // See pop/push_shadow_region_mt_safe() below
100 static Monitor* _shadow_region_monitor;
101
102 Action _action;
103
104 HeapWord* _last_query_beg;
105 oop _last_query_obj;
106 size_t _last_query_ret;
107
108 static PSOldGen* old_gen() { return _old_gen; }
109 static ObjectStartArray* start_array() { return _start_array; }
110 static OopTaskQueueSet* oop_task_queues() { return _oop_task_queues; }
111
112 static void initialize(ParMarkBitMap* mbm);
113
114 protected:
115 // Array of task queues. Needed by the task terminator.
116 static RegionTaskQueueSet* region_task_queues() { return _region_task_queues; }
117 OverflowTaskQueue<oop, mtGC>* marking_stack() { return &_marking_stack; }
118
119 // Pushes onto the marking stack. If the marking stack is full,
120 // pushes onto the overflow stack.
121 void stack_push(oop obj);
122 // Do not implement an equivalent stack_pop. Deal with the
123 // marking stack and overflow stack directly.
124
125 public:
126 static const size_t InvalidShadow = ~0;
127 static size_t pop_shadow_region_mt_safe(PSParallelCompact::RegionData* region_ptr);
128 static void push_shadow_region_mt_safe(size_t shadow_region);
129 static void push_shadow_region(size_t shadow_region);
130 static void remove_all_shadow_regions();
131
132 inline size_t next_shadow_region() { return _next_shadow_region; }
133 inline void set_next_shadow_region(size_t record) { _next_shadow_region = record; }
134 inline size_t move_next_shadow_region_by(size_t workers) {
135 _next_shadow_region += workers;
136 return next_shadow_region();
137 }
138
139 void reset_bitmap_query_cache() {
140 _last_query_beg = NULL;
141 _last_query_obj = NULL;
142 _last_query_ret = 0;
143 }
144
145 Action action() { return _action; }
146 void set_action(Action v) { _action = v; }
147
148 // Bitmap query support, cache last query and result
149 HeapWord* last_query_begin() { return _last_query_beg; }
150 oop last_query_object() { return _last_query_obj; }
151 size_t last_query_return() { return _last_query_ret; }
152
153 void set_last_query_begin(HeapWord *new_beg) { _last_query_beg = new_beg; }
154 void set_last_query_object(oop new_obj) { _last_query_obj = new_obj; }
155 void set_last_query_return(size_t new_ret) { _last_query_ret = new_ret; }
156
157 static void reset_all_bitmap_query_caches();
158
159 RegionTaskQueue* region_stack() { return &_region_stack; }
160
161 inline static ParCompactionManager* manager_array(uint index);
162
163 ParCompactionManager();
164
165 // Pushes onto the region stack at the given index. If the
166 // region stack is full,
167 // pushes onto the region overflow stack.
168 static void verify_region_list_empty(uint stack_index);
169 ParMarkBitMap* mark_bitmap() { return _mark_bitmap; }
170
171 // void drain_stacks();
172
173 bool should_update();
174 bool should_copy();
175
176 // Save for later processing. Must not fail.
177 inline void push(oop obj);
178 inline void push_objarray(oop objarray, size_t index);
179 inline void push_region(size_t index);
180
181 // Check mark and maybe push on marking stack.
182 template <typename T> inline void mark_and_push(T* p);
183
184 inline void follow_klass(Klass* klass);
185
186 void follow_class_loader(ClassLoaderData* klass);
187
188 // Access function for compaction managers
189 static ParCompactionManager* gc_thread_compaction_manager(uint index);
190
191 static bool steal(int queue_num, oop& t);
192 static bool steal_objarray(int queue_num, ObjArrayTask& t);
193 static bool steal(int queue_num, size_t& region);
194
195 // Process tasks remaining on any marking stack
196 void follow_marking_stacks();
197 inline bool marking_stacks_empty() const;
198
199 // Process tasks remaining on any stack
200 void drain_region_stacks();
201
202 void follow_contents(oop obj);
203 void follow_array(objArrayOop array, int index);
204
205 void update_contents(oop obj);
206
207 class FollowStackClosure: public VoidClosure {
208 private:
209 ParCompactionManager* _compaction_manager;
210 public:
211 FollowStackClosure(ParCompactionManager* cm) : _compaction_manager(cm) { }
212 virtual void do_void();
213 };
214 };
215
216 inline ParCompactionManager* ParCompactionManager::manager_array(uint index) {
217 assert(_manager_array != NULL, "access of NULL manager_array");
218 assert(index <= ParallelGCThreads, "out of range manager_array access");
219 return _manager_array[index];
220 }
221
222 bool ParCompactionManager::marking_stacks_empty() const {
223 return _marking_stack.is_empty() && _objarray_stack.is_empty();
224 }
225
226 #endif // SHARE_GC_PARALLEL_PSCOMPACTIONMANAGER_HPP