1 /*
2 * Copyright (c) 2016, 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_G1_G1POLICY_HPP
26 #define SHARE_GC_G1_G1POLICY_HPP
27
28 #include "gc/g1/g1CollectorState.hpp"
29 #include "gc/g1/g1GCPhaseTimes.hpp"
30 #include "gc/g1/g1HeapRegionAttr.hpp"
31 #include "gc/g1/g1InitialMarkToMixedTimeTracker.hpp"
32 #include "gc/g1/g1MMUTracker.hpp"
33 #include "gc/g1/g1RemSetTrackingPolicy.hpp"
34 #include "gc/g1/g1Predictions.hpp"
35 #include "gc/g1/g1YoungGenSizer.hpp"
36 #include "gc/shared/gcCause.hpp"
37 #include "utilities/pair.hpp"
38
39 // A G1Policy makes policy decisions that determine the
40 // characteristics of the collector. Examples include:
41 // * choice of collection set.
42 // * when to collect.
43
44 class HeapRegion;
45 class G1CollectionSet;
46 class G1CollectionSetCandidates;
47 class G1CollectionSetChooser;
48 class G1IHOPControl;
49 class G1Analytics;
50 class G1SurvivorRegions;
51 class G1YoungGenSizer;
52 class GCPolicyCounters;
53 class STWGCTimer;
54
55 class G1Policy: public CHeapObj<mtGC> {
56 private:
57
58 static G1IHOPControl* create_ihop_control(const G1Predictions* predictor);
59 // Update the IHOP control with necessary statistics.
60 void update_ihop_prediction(double mutator_time_s,
61 size_t mutator_alloc_bytes,
62 size_t young_gen_size,
63 bool this_gc_was_young_only);
64 void report_ihop_statistics();
65
66 G1Predictions _predictor;
67 G1Analytics* _analytics;
68 G1RemSetTrackingPolicy _remset_tracker;
69 G1MMUTracker* _mmu_tracker;
70 G1IHOPControl* _ihop_control;
71
72 GCPolicyCounters* _policy_counters;
73
74 double _full_collection_start_sec;
75
76 jlong _collection_pause_end_millis;
77
78 uint _young_list_target_length;
79 uint _young_list_fixed_length;
80
81 // The max number of regions we can extend the eden by while the GC
82 // locker is active. This should be >= _young_list_target_length;
83 uint _young_list_max_length;
84
85 // SurvRateGroups below must be initialized after the predictor because they
86 // indirectly use it through this object passed to their constructor.
87 SurvRateGroup* _short_lived_surv_rate_group;
88 SurvRateGroup* _survivor_surv_rate_group;
89
90 double _reserve_factor;
91 // This will be set when the heap is expanded
92 // for the first time during initialization.
93 uint _reserve_regions;
94
95 G1YoungGenSizer* _young_gen_sizer;
96
97 uint _free_regions_at_end_of_collection;
98
99 size_t _rs_length;
100
101 size_t _rs_length_prediction;
102
103 size_t _pending_cards_at_gc_start;
104 size_t _pending_cards_at_prev_gc_end;
105 size_t _total_mutator_refined_cards;
106 size_t _total_concurrent_refined_cards;
107 Tickspan _total_concurrent_refinement_time;
108
109 // The amount of allocated bytes in old gen during the last mutator and the following
110 // young GC phase.
111 size_t _bytes_allocated_in_old_since_last_gc;
112
113 G1InitialMarkToMixedTimeTracker _initial_mark_to_mixed;
114
115 bool should_update_surv_rate_group_predictors() {
116 return collector_state()->in_young_only_phase() && !collector_state()->mark_or_rebuild_in_progress();
117 }
118
119 double logged_cards_processing_time() const;
120 public:
121 const G1Predictions& predictor() const { return _predictor; }
122 const G1Analytics* analytics() const { return const_cast<const G1Analytics*>(_analytics); }
123
124 G1RemSetTrackingPolicy* remset_tracker() { return &_remset_tracker; }
125
126 // Add the given number of bytes to the total number of allocated bytes in the old gen.
127 void add_bytes_allocated_in_old_since_last_gc(size_t bytes) { _bytes_allocated_in_old_since_last_gc += bytes; }
128
129 void set_region_eden(HeapRegion* hr) {
130 hr->set_eden();
131 hr->install_surv_rate_group(_short_lived_surv_rate_group);
132 }
133
134 void set_region_survivor(HeapRegion* hr) {
135 assert(hr->is_survivor(), "pre-condition");
136 hr->install_surv_rate_group(_survivor_surv_rate_group);
137 }
138
139 void record_rs_length(size_t rs_length) {
140 _rs_length = rs_length;
141 }
142
143 double predict_base_elapsed_time_ms(size_t num_pending_cards) const;
144 double predict_base_elapsed_time_ms(size_t num_pending_cards,
145 size_t rs_length) const;
146 size_t predict_bytes_to_copy(HeapRegion* hr) const;
147 double predict_region_elapsed_time_ms(HeapRegion* hr, bool for_young_gc) const;
148
149 double predict_survivor_regions_evac_time() const;
150
151 void cset_regions_freed() {
152 bool update = should_update_surv_rate_group_predictors();
153
154 _short_lived_surv_rate_group->all_surviving_words_recorded(predictor(), update);
155 _survivor_surv_rate_group->all_surviving_words_recorded(predictor(), update);
156 }
157
158 G1MMUTracker* mmu_tracker() {
159 return _mmu_tracker;
160 }
161
162 const G1MMUTracker* mmu_tracker() const {
163 return _mmu_tracker;
164 }
165
166 double max_pause_time_ms() const {
167 return _mmu_tracker->max_gc_time() * 1000.0;
168 }
169
170 double predict_yg_surv_rate(int age, SurvRateGroup* surv_rate_group) const;
171
172 double predict_yg_surv_rate(int age) const;
173
174 double accum_yg_surv_rate_pred(int age) const;
175
176 private:
177 G1CollectionSet* _collection_set;
178 double average_time_ms(G1GCPhaseTimes::GCParPhases phase) const;
179 double other_time_ms(double pause_time_ms) const;
180
181 double young_other_time_ms() const;
182 double non_young_other_time_ms() const;
183 double constant_other_time_ms(double pause_time_ms) const;
184
185 G1CollectionSetChooser* cset_chooser() const;
186
187 // Stash a pointer to the g1 heap.
188 G1CollectedHeap* _g1h;
189
190 G1GCPhaseTimes* _phase_times;
191
192 // This set of variables tracks the collector efficiency, in order to
193 // determine whether we should initiate a new marking.
194 double _mark_remark_start_sec;
195 double _mark_cleanup_start_sec;
196
197 // Updates the internal young list maximum and target lengths. Returns the
198 // unbounded young list target length. If no rs_length parameter is passed,
199 // predict the RS length using the prediction model, otherwise use the
200 // given rs_length as the prediction.
201 uint update_young_list_max_and_target_length();
202 uint update_young_list_max_and_target_length(size_t rs_length);
203
204 // Update the young list target length either by setting it to the
205 // desired fixed value or by calculating it using G1's pause
206 // prediction model.
207 // Returns the unbounded young list target length.
208 uint update_young_list_target_length(size_t rs_length);
209
210 // Calculate and return the minimum desired young list target
211 // length. This is the minimum desired young list length according
212 // to the user's inputs.
213 uint calculate_young_list_desired_min_length(uint base_min_length) const;
214
215 // Calculate and return the maximum desired young list target
216 // length. This is the maximum desired young list length according
217 // to the user's inputs.
218 uint calculate_young_list_desired_max_length() const;
219
220 // Calculate and return the maximum young list target length that
221 // can fit into the pause time goal. The parameters are: rs_length
222 // represent the prediction of how large the young RSet lengths will
223 // be, base_min_length is the already existing number of regions in
224 // the young list, min_length and max_length are the desired min and
225 // max young list length according to the user's inputs.
226 uint calculate_young_list_target_length(size_t rs_length,
227 uint base_min_length,
228 uint desired_min_length,
229 uint desired_max_length) const;
230
231 // Result of the bounded_young_list_target_length() method, containing both the
232 // bounded as well as the unbounded young list target lengths in this order.
233 typedef Pair<uint, uint, StackObj> YoungTargetLengths;
234 YoungTargetLengths young_list_target_lengths(size_t rs_length) const;
235
236 void update_rs_length_prediction();
237 void update_rs_length_prediction(size_t prediction);
238
239 // Check whether a given young length (young_length) fits into the
240 // given target pause time and whether the prediction for the amount
241 // of objects to be copied for the given length will fit into the
242 // given free space (expressed by base_free_regions). It is used by
243 // calculate_young_list_target_length().
244 bool predict_will_fit(uint young_length, double base_time_ms,
245 uint base_free_regions, double target_pause_time_ms) const;
246
247 public:
248 size_t pending_cards_at_gc_start() const { return _pending_cards_at_gc_start; }
249
250 size_t total_concurrent_refined_cards() const {
251 return _total_concurrent_refined_cards;
252 }
253
254 size_t total_mutator_refined_cards() const {
255 return _total_mutator_refined_cards;
256 }
257
258 // Calculate the minimum number of old regions we'll add to the CSet
259 // during a mixed GC.
260 uint calc_min_old_cset_length() const;
261
262 // Calculate the maximum number of old regions we'll add to the CSet
263 // during a mixed GC.
264 uint calc_max_old_cset_length() const;
265
266 // Returns the given amount of reclaimable bytes (that represents
267 // the amount of reclaimable space still to be collected) as a
268 // percentage of the current heap capacity.
269 double reclaimable_bytes_percent(size_t reclaimable_bytes) const;
270
271 jlong collection_pause_end_millis() { return _collection_pause_end_millis; }
272
273 private:
274 void clear_collection_set_candidates();
275 // Sets up marking if proper conditions are met.
276 void maybe_start_marking();
277
278 // The kind of STW pause.
279 enum PauseKind {
280 FullGC,
281 YoungOnlyGC,
282 MixedGC,
283 LastYoungGC,
284 InitialMarkGC,
285 Cleanup,
286 Remark
287 };
288
289 // Calculate PauseKind from internal state.
290 PauseKind young_gc_pause_kind() const;
291 // Record the given STW pause with the given start and end times (in s).
292 void record_pause(PauseKind kind, double start, double end);
293 // Indicate that we aborted marking before doing any mixed GCs.
294 void abort_time_to_mixed_tracking();
295
296 void record_concurrent_refinement_data(bool is_full_collection);
297
298 public:
299
300 G1Policy(STWGCTimer* gc_timer);
301
302 virtual ~G1Policy();
303
304 static G1Policy* create_policy(STWGCTimer* gc_timer_stw);
305
306 G1CollectorState* collector_state() const;
307
308 G1GCPhaseTimes* phase_times() const { return _phase_times; }
309
310 // Check the current value of the young list RSet length and
311 // compare it against the last prediction. If the current value is
312 // higher, recalculate the young list target length prediction.
313 void revise_young_list_target_length_if_necessary(size_t rs_length);
314
315 // This should be called after the heap is resized.
316 void record_new_heap_size(uint new_number_of_regions);
317
318 virtual void init(G1CollectedHeap* g1h, G1CollectionSet* collection_set);
319
320 void note_gc_start();
321
322 bool need_to_start_conc_mark(const char* source, size_t alloc_word_size = 0);
323
324 bool about_to_start_mixed_phase() const;
325
326 // Record the start and end of an evacuation pause.
327 void record_collection_pause_start(double start_time_sec);
328 virtual void record_collection_pause_end(double pause_time_ms);
329
330 // Record the start and end of a full collection.
331 void record_full_collection_start();
332 virtual void record_full_collection_end();
333
334 // Must currently be called while the world is stopped.
335 void record_concurrent_mark_init_end(double mark_init_elapsed_time_ms);
336
337 // Record start and end of remark.
338 void record_concurrent_mark_remark_start();
339 void record_concurrent_mark_remark_end();
340
341 // Record start, end, and completion of cleanup.
342 void record_concurrent_mark_cleanup_start();
343 void record_concurrent_mark_cleanup_end();
344
345 void print_phases();
346
347 bool next_gc_should_be_mixed(const char* true_action_str,
348 const char* false_action_str) const;
349
350 // Calculate and return the number of initial and optional old gen regions from
351 // the given collection set candidates and the remaining time.
352 void calculate_old_collection_set_regions(G1CollectionSetCandidates* candidates,
353 double time_remaining_ms,
354 uint& num_initial_regions,
355 uint& num_optional_regions);
356
357 // Calculate the number of optional regions from the given collection set candidates,
358 // the remaining time and the maximum number of these regions and return the number
359 // of actually selected regions in num_optional_regions.
360 void calculate_optional_collection_set_regions(G1CollectionSetCandidates* candidates,
361 uint const max_optional_regions,
362 double time_remaining_ms,
363 uint& num_optional_regions);
364
365 private:
366 // Set the state to start a concurrent marking cycle and clear
367 // _initiate_conc_mark_if_possible because it has now been
368 // acted on.
369 void initiate_conc_mark();
370
371 public:
372 // This sets the initiate_conc_mark_if_possible() flag to start a
373 // new cycle, as long as we are not already in one. It's best if it
374 // is called during a safepoint when the test whether a cycle is in
375 // progress or not is stable.
376 bool force_initial_mark_if_outside_cycle(GCCause::Cause gc_cause);
377
378 // This is called at the very beginning of an evacuation pause (it
379 // has to be the first thing that the pause does). If
380 // initiate_conc_mark_if_possible() is true, and the concurrent
381 // marking thread has completed its work during the previous cycle,
382 // it will set in_initial_mark_gc() to so that the pause does
383 // the initial-mark work and start a marking cycle.
384 void decide_on_conc_mark_initiation();
385
386 void finished_recalculating_age_indexes(bool is_survivors) {
387 if (is_survivors) {
388 _survivor_surv_rate_group->finished_recalculating_age_indexes();
389 } else {
390 _short_lived_surv_rate_group->finished_recalculating_age_indexes();
391 }
392 }
393
394 size_t young_list_target_length() const { return _young_list_target_length; }
395
396 bool should_allocate_mutator_region() const;
397
398 bool can_expand_young_list() const;
399
400 uint young_list_max_length() const {
401 return _young_list_max_length;
402 }
403
404 bool use_adaptive_young_list_length() const;
405
406 void transfer_survivors_to_cset(const G1SurvivorRegions* survivors);
407
408 private:
409 //
410 // Survivor regions policy.
411 //
412
413 // Current tenuring threshold, set to 0 if the collector reaches the
414 // maximum amount of survivors regions.
415 uint _tenuring_threshold;
416
417 // The limit on the number of regions allocated for survivors.
418 uint _max_survivor_regions;
419
420 AgeTable _survivors_age_table;
421
422 size_t desired_survivor_size(uint max_regions) const;
423
424 // Fraction used when predicting how many optional regions to include in
425 // the CSet. This fraction of the available time is used for optional regions,
426 // the rest is used to add old regions to the normal CSet.
427 double optional_prediction_fraction() { return 0.2; }
428
429 public:
430 // Fraction used when evacuating the optional regions. This fraction of the
431 // remaining time is used to choose what regions to include in the evacuation.
432 double optional_evacuation_fraction() { return 0.75; }
433
434 uint tenuring_threshold() const { return _tenuring_threshold; }
435
436 uint max_survivor_regions() {
437 return _max_survivor_regions;
438 }
439
440 void note_start_adding_survivor_regions() {
441 _survivor_surv_rate_group->start_adding_regions();
442 }
443
444 void note_stop_adding_survivor_regions() {
445 _survivor_surv_rate_group->stop_adding_regions();
446 }
447
448 void record_age_table(AgeTable* age_table) {
449 _survivors_age_table.merge(age_table);
450 }
451
452 void print_age_table();
453
454 void update_max_gc_locker_expansion();
455
456 void update_survivors_policy();
457
458 virtual bool force_upgrade_to_full() {
459 return false;
460 }
461 };
462
463 #endif // SHARE_GC_G1_G1POLICY_HPP