1/*
2 * Copyright (c) 2015, 2019, Red Hat, Inc. All rights reserved.
3 *
4 * This code is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 only, as
6 * published by the Free Software Foundation.
7 *
8 * This code is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
11 * version 2 for more details (a copy is included in the LICENSE file that
12 * accompanied this code).
13 *
14 * You should have received a copy of the GNU General Public License version
15 * 2 along with this work; if not, write to the Free Software Foundation,
16 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
17 *
18 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
19 * or visit www.oracle.com if you need additional information or have any
20 * questions.
21 *
22 */
23
24#ifndef SHARE_GC_SHENANDOAH_SHENANDOAHROOTPROCESSOR_HPP
25#define SHARE_GC_SHENANDOAH_SHENANDOAHROOTPROCESSOR_HPP
26
27#include "code/codeCache.hpp"
28#include "gc/shared/oopStorageParState.hpp"
29#include "gc/shenandoah/shenandoahCodeRoots.hpp"
30#include "gc/shenandoah/shenandoahHeap.hpp"
31#include "gc/shenandoah/shenandoahPhaseTimings.hpp"
32#include "gc/shared/strongRootsScope.hpp"
33#include "gc/shared/weakProcessor.hpp"
34#include "gc/shared/weakProcessorPhaseTimes.hpp"
35#include "gc/shared/workgroup.hpp"
36#include "memory/allocation.hpp"
37#include "memory/iterator.hpp"
38
39class ShenandoahSerialRoot {
40public:
41 typedef void (*OopsDo)(OopClosure*);
42private:
43 volatile bool _claimed;
44 const OopsDo _oops_do;
45 const ShenandoahPhaseTimings::GCParPhases _phase;
46
47public:
48 ShenandoahSerialRoot(OopsDo oops_do, ShenandoahPhaseTimings::GCParPhases);
49 void oops_do(OopClosure* cl, uint worker_id);
50};
51
52class ShenandoahSerialRoots {
53private:
54 ShenandoahSerialRoot _universe_root;
55 ShenandoahSerialRoot _object_synchronizer_root;
56 ShenandoahSerialRoot _management_root;
57 ShenandoahSerialRoot _system_dictionary_root;
58 ShenandoahSerialRoot _jvmti_root;
59public:
60 ShenandoahSerialRoots();
61 void oops_do(OopClosure* cl, uint worker_id);
62};
63
64class ShenandoahJNIHandleRoots : public ShenandoahSerialRoot {
65public:
66 ShenandoahJNIHandleRoots();
67};
68
69class ShenandoahThreadRoots {
70private:
71 const bool _is_par;
72public:
73 ShenandoahThreadRoots(bool is_par);
74 ~ShenandoahThreadRoots();
75
76 void oops_do(OopClosure* oops_cl, CodeBlobClosure* code_cl, uint worker_id);
77 void threads_do(ThreadClosure* tc, uint worker_id);
78};
79
80class ShenandoahWeakRoots {
81private:
82 WeakProcessorPhaseTimes _process_timings;
83 WeakProcessor::Task _task;
84public:
85 ShenandoahWeakRoots(uint n_workers);
86 ~ShenandoahWeakRoots();
87
88 template <typename IsAlive, typename KeepAlive>
89 void oops_do(IsAlive* is_alive, KeepAlive* keep_alive, uint worker_id);
90};
91
92class ShenandoahStringDedupRoots {
93public:
94 ShenandoahStringDedupRoots();
95 ~ShenandoahStringDedupRoots();
96
97 void oops_do(BoolObjectClosure* is_alive, OopClosure* keep_alive, uint worker_id);
98};
99
100template <typename ITR>
101class ShenandoahCodeCacheRoots {
102private:
103 ITR _coderoots_iterator;
104public:
105 ShenandoahCodeCacheRoots();
106 ~ShenandoahCodeCacheRoots();
107
108 void code_blobs_do(CodeBlobClosure* blob_cl, uint worker_id);
109};
110
111class ShenandoahClassLoaderDataRoots {
112public:
113 ShenandoahClassLoaderDataRoots();
114
115 void clds_do(CLDClosure* strong_clds, CLDClosure* weak_clds, uint worker_id);
116};
117
118class ShenandoahRootProcessor : public StackObj {
119private:
120 ShenandoahHeap* const _heap;
121 const ShenandoahPhaseTimings::Phase _phase;
122public:
123 ShenandoahRootProcessor(ShenandoahPhaseTimings::Phase phase);
124 ~ShenandoahRootProcessor();
125
126 ShenandoahHeap* heap() const { return _heap; }
127};
128
129template <typename ITR>
130class ShenandoahRootScanner : public ShenandoahRootProcessor {
131private:
132 ShenandoahSerialRoots _serial_roots;
133 ShenandoahJNIHandleRoots _jni_roots;
134 ShenandoahClassLoaderDataRoots _cld_roots;
135 ShenandoahThreadRoots _thread_roots;
136 ShenandoahCodeCacheRoots<ITR> _code_roots;
137public:
138 ShenandoahRootScanner(uint n_workers, ShenandoahPhaseTimings::Phase phase);
139
140 // Apply oops, clds and blobs to all strongly reachable roots in the system,
141 // during class unloading cycle
142 void strong_roots_do(uint worker_id, OopClosure* cl);
143 void strong_roots_do(uint worker_id, OopClosure* oops, CLDClosure* clds, CodeBlobClosure* code, ThreadClosure* tc = NULL);
144
145 // Apply oops, clds and blobs to all strongly reachable roots and weakly reachable
146 // roots when class unloading is disabled during this cycle
147 void roots_do(uint worker_id, OopClosure* cl);
148 void roots_do(uint worker_id, OopClosure* oops, CLDClosure* clds, CodeBlobClosure* code, ThreadClosure* tc = NULL);
149 // For heap object iteration
150 void roots_do_unchecked(OopClosure* cl);
151};
152
153typedef ShenandoahRootScanner<ShenandoahAllCodeRootsIterator> ShenandoahAllRootScanner;
154typedef ShenandoahRootScanner<ShenandoahCsetCodeRootsIterator> ShenandoahCSetRootScanner;
155
156// Evacuate all roots at a safepoint
157class ShenandoahRootEvacuator : public ShenandoahRootProcessor {
158private:
159 ShenandoahSerialRoots _serial_roots;
160 ShenandoahJNIHandleRoots _jni_roots;
161 ShenandoahClassLoaderDataRoots _cld_roots;
162 ShenandoahThreadRoots _thread_roots;
163 ShenandoahWeakRoots _weak_roots;
164 ShenandoahStringDedupRoots _dedup_roots;
165 ShenandoahCodeCacheRoots<ShenandoahCsetCodeRootsIterator> _code_roots;
166
167public:
168 ShenandoahRootEvacuator(uint n_workers, ShenandoahPhaseTimings::Phase phase);
169
170 void roots_do(uint worker_id, OopClosure* oops);
171};
172
173// Update all roots at a safepoint
174class ShenandoahRootUpdater : public ShenandoahRootProcessor {
175private:
176 ShenandoahSerialRoots _serial_roots;
177 ShenandoahJNIHandleRoots _jni_roots;
178 ShenandoahClassLoaderDataRoots _cld_roots;
179 ShenandoahThreadRoots _thread_roots;
180 ShenandoahWeakRoots _weak_roots;
181 ShenandoahStringDedupRoots _dedup_roots;
182 ShenandoahCodeCacheRoots<ShenandoahCsetCodeRootsIterator> _code_roots;
183 const bool _update_code_cache;
184
185public:
186 ShenandoahRootUpdater(uint n_workers, ShenandoahPhaseTimings::Phase phase, bool update_code_cache);
187
188 template<typename IsAlive, typename KeepAlive>
189 void roots_do(uint worker_id, IsAlive* is_alive, KeepAlive* keep_alive);
190};
191
192// Adjuster all roots at a safepoint during full gc
193class ShenandoahRootAdjuster : public ShenandoahRootProcessor {
194private:
195 ShenandoahSerialRoots _serial_roots;
196 ShenandoahJNIHandleRoots _jni_roots;
197 ShenandoahClassLoaderDataRoots _cld_roots;
198 ShenandoahThreadRoots _thread_roots;
199 ShenandoahWeakRoots _weak_roots;
200 ShenandoahStringDedupRoots _dedup_roots;
201 ShenandoahCodeCacheRoots<ShenandoahAllCodeRootsIterator> _code_roots;
202
203public:
204 ShenandoahRootAdjuster(uint n_workers, ShenandoahPhaseTimings::Phase phase);
205
206 void roots_do(uint worker_id, OopClosure* oops);
207};
208
209#endif // SHARE_GC_SHENANDOAH_SHENANDOAHROOTPROCESSOR_HPP
210