/*

 * Copyright (c) 2001, 2015, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 *

 */

#ifndef SHARE_VM_GC_G1_G1COLLECTORPOLICY_HPP

#define SHARE_VM_GC_G1_G1COLLECTORPOLICY_HPP

#include "gc/g1/collectionSetChooser.hpp"

#include "gc/g1/g1CollectorState.hpp"

#include "gc/g1/g1InCSetState.hpp"

#include "gc/g1/g1MMUTracker.hpp"

#include "gc/shared/collectorPolicy.hpp"

// A G1CollectorPolicy makes policy decisions that determine the

// characteristics of the collector.  Examples include:

//   * choice of collection set.

//   * when to collect.

class HeapRegion;

class CollectionSetChooser;

class G1GCPhaseTimes;

// TraceYoungGenTime collects data on _both_ young and mixed evacuation pauses

// (the latter may contain non-young regions - i.e. regions that are

// technically in old) while TraceOldGenTime collects data about full GCs.

class TraceYoungGenTimeData : public CHeapObj<mtGC> {

 private:

  unsigned  _young_pause_num;

  unsigned  _mixed_pause_num;

  NumberSeq _all_stop_world_times_ms;

  NumberSeq _all_yield_times_ms;

  NumberSeq _total;

  NumberSeq _other;

  NumberSeq _root_region_scan_wait;

  NumberSeq _parallel;

  NumberSeq _ext_root_scan;

  NumberSeq _satb_filtering;

  NumberSeq _update_rs;

  NumberSeq _scan_rs;

  NumberSeq _obj_copy;

  NumberSeq _termination;

  NumberSeq _parallel_other;

  NumberSeq _clear_ct;

  void print_summary(const char* str, const NumberSeq* seq) const;

  void print_summary_sd(const char* str, const NumberSeq* seq) const;

public:

   TraceYoungGenTimeData() : _young_pause_num(0), _mixed_pause_num(0) {};

  void record_start_collection(double time_to_stop_the_world_ms);

  void record_yield_time(double yield_time_ms);

  void record_end_collection(double pause_time_ms, G1GCPhaseTimes* phase_times);

  void increment_young_collection_count();

  void increment_mixed_collection_count();

  void print() const;

};

class TraceOldGenTimeData : public CHeapObj<mtGC> {

 private:

  NumberSeq _all_full_gc_times;

 public:

  void record_full_collection(double full_gc_time_ms);

  void print() const;

};

// There are three command line options related to the young gen size:

// NewSize, MaxNewSize and NewRatio (There is also -Xmn, but that is

// just a short form for NewSize==MaxNewSize). G1 will use its internal

// heuristics to calculate the actual young gen size, so these options

// basically only limit the range within which G1 can pick a young gen

// size. Also, these are general options taking byte sizes. G1 will

// internally work with a number of regions instead. So, some rounding

// will occur.

//

// If nothing related to the the young gen size is set on the command

// line we should allow the young gen to be between G1NewSizePercent

// and G1MaxNewSizePercent of the heap size. This means that every time

// the heap size changes, the limits for the young gen size will be

// recalculated.

//

// If only -XX:NewSize is set we should use the specified value as the

// minimum size for young gen. Still using G1MaxNewSizePercent of the

// heap as maximum.

//

// If only -XX:MaxNewSize is set we should use the specified value as the

// maximum size for young gen. Still using G1NewSizePercent of the heap

// as minimum.

//

// If -XX:NewSize and -XX:MaxNewSize are both specified we use these values.

// No updates when the heap size changes. There is a special case when

// NewSize==MaxNewSize. This is interpreted as "fixed" and will use a

// different heuristic for calculating the collection set when we do mixed

// collection.

//

// If only -XX:NewRatio is set we should use the specified ratio of the heap

// as both min and max. This will be interpreted as "fixed" just like the

// NewSize==MaxNewSize case above. But we will update the min and max

// every time the heap size changes.

//

// NewSize and MaxNewSize override NewRatio. So, NewRatio is ignored if it is

// combined with either NewSize or MaxNewSize. (A warning message is printed.)

class G1YoungGenSizer : public CHeapObj<mtGC> {

private:

  enum SizerKind {

    SizerDefaults,

    SizerNewSizeOnly,

    SizerMaxNewSizeOnly,

    SizerMaxAndNewSize,

    SizerNewRatio

  };

  SizerKind _sizer_kind;

  uint _min_desired_young_length;

  uint _max_desired_young_length;

  bool _adaptive_size;

  uint calculate_default_min_length(uint new_number_of_heap_regions);

  uint calculate_default_max_length(uint new_number_of_heap_regions);

  // Update the given values for minimum and maximum young gen length in regions

  // given the number of heap regions depending on the kind of sizing algorithm.

  void recalculate_min_max_young_length(uint number_of_heap_regions, uint* min_young_length, uint* max_young_length);

public:

  G1YoungGenSizer();

  // Calculate the maximum length of the young gen given the number of regions

  // depending on the sizing algorithm.

  uint max_young_length(uint number_of_heap_regions);

  void heap_size_changed(uint new_number_of_heap_regions);

  uint min_desired_young_length() {

    return _min_desired_young_length;

  }

  uint max_desired_young_length() {

    return _max_desired_young_length;

  }

  bool adaptive_young_list_length() const {

    return _adaptive_size;

  }

};

class G1CollectorPolicy: public CollectorPolicy {

  // either equal to the number of parallel threads, if ParallelGCThreads

  // has been set, or 1 otherwise

  int _parallel_gc_threads;

  // The number of GC threads currently active.

  uintx _no_of_gc_threads;

  G1MMUTracker* _mmu_tracker;

  void initialize_alignments();

  void initialize_flags();

  CollectionSetChooser* _collectionSetChooser;

  double _full_collection_start_sec;

  uint   _cur_collection_pause_used_regions_at_start;

  // These exclude marking times.

  TruncatedSeq* _recent_gc_times_ms;

  TruncatedSeq* _concurrent_mark_remark_times_ms;

  TruncatedSeq* _concurrent_mark_cleanup_times_ms;

  TraceYoungGenTimeData _trace_young_gen_time_data;

  TraceOldGenTimeData   _trace_old_gen_time_data;

  double _stop_world_start;

  uint _young_list_target_length;

  uint _young_list_fixed_length;

  // The max number of regions we can extend the eden by while the GC

  // locker is active. This should be >= _young_list_target_length;

  uint _young_list_max_length;

  SurvRateGroup* _short_lived_surv_rate_group;

  SurvRateGroup* _survivor_surv_rate_group;

  // add here any more surv rate groups

  double _gc_overhead_perc;

  double _reserve_factor;

  uint   _reserve_regions;

  enum PredictionConstants {

  };

  TruncatedSeq* _alloc_rate_ms_seq;

  double        _prev_collection_pause_end_ms;

  TruncatedSeq* _rs_length_diff_seq;

  TruncatedSeq* _cost_per_card_ms_seq;

  TruncatedSeq* _cost_scan_hcc_seq;

  TruncatedSeq* _young_cards_per_entry_ratio_seq;

  TruncatedSeq* _mixed_cards_per_entry_ratio_seq;

  TruncatedSeq* _cost_per_entry_ms_seq;

  TruncatedSeq* _mixed_cost_per_entry_ms_seq;

  TruncatedSeq* _cost_per_byte_ms_seq;

  TruncatedSeq* _constant_other_time_ms_seq;

  TruncatedSeq* _young_other_cost_per_region_ms_seq;

  TruncatedSeq* _non_young_other_cost_per_region_ms_seq;

  TruncatedSeq* _pending_cards_seq;

  TruncatedSeq* _rs_lengths_seq;

  TruncatedSeq* _cost_per_byte_ms_during_cm_seq;

  G1YoungGenSizer* _young_gen_sizer;

  uint _eden_cset_region_length;

  uint _survivor_cset_region_length;

  uint _old_cset_region_length;

  void init_cset_region_lengths(uint eden_cset_region_length,

                                uint survivor_cset_region_length);

  uint eden_cset_region_length() const     { return _eden_cset_region_length;     }

  uint survivor_cset_region_length() const { return _survivor_cset_region_length; }

  uint old_cset_region_length() const      { return _old_cset_region_length;      }

  uint _free_regions_at_end_of_collection;

  size_t _recorded_rs_lengths;

  size_t _max_rs_lengths;

  size_t _rs_lengths_prediction;

#ifndef PRODUCT

  bool verify_young_ages(HeapRegion* head, SurvRateGroup *surv_rate_group);

#endif // PRODUCT

  void adjust_concurrent_refinement(double update_rs_time,

                                    double update_rs_processed_buffers,

                                    double goal_ms);

  uintx no_of_gc_threads() { return _no_of_gc_threads; }

  void set_no_of_gc_threads(uintx v) { _no_of_gc_threads = v; }

  double _pause_time_target_ms;

  size_t _pending_cards;

public:

  // Accessors

  void set_region_eden(HeapRegion* hr, int young_index_in_cset) {

    hr->set_eden();

    hr->install_surv_rate_group(_short_lived_surv_rate_group);

    hr->set_young_index_in_cset(young_index_in_cset);

  }

  void set_region_survivor(HeapRegion* hr, int young_index_in_cset) {

    assert(hr->is_survivor(), "pre-condition");

    hr->install_surv_rate_group(_survivor_surv_rate_group);

    hr->set_young_index_in_cset(young_index_in_cset);

  }

#ifndef PRODUCT

  bool verify_young_ages();

#endif // PRODUCT

  void record_max_rs_lengths(size_t rs_lengths) {

    _max_rs_lengths = rs_lengths;

  }

  double predict_base_elapsed_time_ms(size_t pending_cards) const;

  double predict_base_elapsed_time_ms(size_t pending_cards,

                                      size_t scanned_cards) const;

  size_t predict_bytes_to_copy(HeapRegion* hr) const;

  double predict_region_elapsed_time_ms(HeapRegion* hr, bool for_young_gc) const;

  void set_recorded_rs_lengths(size_t rs_lengths);

  uint cset_region_length() const       { return young_cset_region_length() +

                                           old_cset_region_length(); }

  uint young_cset_region_length() const { return eden_cset_region_length() +

                                           survivor_cset_region_length(); }

  double predict_survivor_regions_evac_time() const;

  void cset_regions_freed() {

    bool propagate = collector_state()->should_propagate();

    _short_lived_surv_rate_group->all_surviving_words_recorded(propagate);

    _survivor_surv_rate_group->all_surviving_words_recorded(propagate);

    // also call it on any more surv rate groups

  }

  G1MMUTracker* mmu_tracker() {

    return _mmu_tracker;

  }

  const G1MMUTracker* mmu_tracker() const {

    return _mmu_tracker;

  }

  double max_pause_time_ms() const {

    return _mmu_tracker->max_gc_time() * 1000.0;

  }

  // Returns an estimate of the survival rate of the region at yg-age

  // "yg_age".

private:

  // Statistics kept per GC stoppage, pause or full.

  TruncatedSeq* _recent_prev_end_times_for_all_gcs_sec;

  // Add a new GC of the given duration and end time to the record.

  void update_recent_gc_times(double end_time_sec, double elapsed_ms);

  // The head of the list (via "next_in_collection_set()") representing the

  // current collection set. Set from the incrementally built collection

  // set at the start of the pause.

  HeapRegion* _collection_set;

  // The number of bytes in the collection set before the pause. Set from

  // the incrementally built collection set at the start of an evacuation

  // pause, and incremented in finalize_old_cset_part() when adding old regions

  // (if any) to the collection set.

  size_t _collection_set_bytes_used_before;

  // The number of bytes copied during the GC.

  size_t _bytes_copied_during_gc;

  // The associated information that is maintained while the incremental

  // collection set is being built with young regions. Used to populate

  // the recorded info for the evacuation pause.

  enum CSetBuildType {

    Active,             // We are actively building the collection set

    Inactive            // We are not actively building the collection set

  };

  CSetBuildType _inc_cset_build_state;

  // The head of the incrementally built collection set.

  HeapRegion* _inc_cset_head;

  // The tail of the incrementally built collection set.

  HeapRegion* _inc_cset_tail;

  // The number of bytes in the incrementally built collection set.

  // Used to set _collection_set_bytes_used_before at the start of

  // an evacuation pause.

  size_t _inc_cset_bytes_used_before;

  // Used to record the highest end of heap region in collection set

  HeapWord* _inc_cset_max_finger;

  // The RSet lengths recorded for regions in the CSet. It is updated

  // by the thread that adds a new region to the CSet. We assume that

  // only one thread can be allocating a new CSet region (currently,

  // it does so after taking the Heap_lock) hence no need to

  // synchronize updates to this field.

  size_t _inc_cset_recorded_rs_lengths;

  // A concurrent refinement thread periodically samples the young

  // region RSets and needs to update _inc_cset_recorded_rs_lengths as

  // the RSets grow. Instead of having to synchronize updates to that

  // field we accumulate them in this field and add it to

  // _inc_cset_recorded_rs_lengths_diffs at the start of a GC.

  ssize_t _inc_cset_recorded_rs_lengths_diffs;

  // The predicted elapsed time it will take to collect the regions in

  // the CSet. This is updated by the thread that adds a new region to

  // the CSet. See the comment for _inc_cset_recorded_rs_lengths about

  // MT-safety assumptions.

  double _inc_cset_predicted_elapsed_time_ms;

  // See the comment for _inc_cset_recorded_rs_lengths_diffs.

  double _inc_cset_predicted_elapsed_time_ms_diffs;

  // Stash a pointer to the g1 heap.

  G1CollectedHeap* _g1;

  G1GCPhaseTimes* _phase_times;

  // The ratio of gc time to elapsed time, computed over recent pauses.

  double _recent_avg_pause_time_ratio;

  double recent_avg_pause_time_ratio() const {

    return _recent_avg_pause_time_ratio;

  }

  // This set of variables tracks the collector efficiency, in order to

  // determine whether we should initiate a new marking.

  double _cur_mark_stop_world_time_ms;

  double _mark_remark_start_sec;

  double _mark_cleanup_start_sec;

  // Update the young list target length either by setting it to the

  // desired fixed value or by calculating it using G1's pause

  // prediction model. If no rs_lengths parameter is passed, predict

  // the RS lengths using the prediction model, otherwise use the

  // given rs_lengths as the prediction.

  void update_young_list_target_length(size_t rs_lengths = (size_t) -1);

  // Calculate and return the minimum desired young list target

  // length. This is the minimum desired young list length according

  // to the user's inputs.

  uint calculate_young_list_desired_min_length(uint base_min_length) const;

  // Calculate and return the maximum desired young list target

  // length. This is the maximum desired young list length according

  // to the user's inputs.

  uint calculate_young_list_desired_max_length() const;

  // Calculate and return the maximum young list target length that

  // can fit into the pause time goal. The parameters are: rs_lengths

  // represent the prediction of how large the young RSet lengths will

  // be, base_min_length is the already existing number of regions in

  // the young list, min_length and max_length are the desired min and

  // max young list length according to the user's inputs.

  uint calculate_young_list_target_length(size_t rs_lengths,

                                          uint base_min_length,

                                          uint desired_min_length,

                                          uint desired_max_length) const;

  // Calculate and return chunk size (in number of regions) for parallel

  // concurrent mark cleanup.