1 /*
   2  * Copyright (c) 2014, 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_G1PARSCANTHREADSTATE_HPP
  26 #define SHARE_GC_G1_G1PARSCANTHREADSTATE_HPP
  27 
  28 #include "gc/g1/g1CardTable.hpp"
  29 #include "gc/g1/g1CollectedHeap.hpp"
  30 #include "gc/g1/g1RedirtyCardsQueue.hpp"
  31 #include "gc/g1/g1OopClosures.hpp"
  32 #include "gc/g1/g1Policy.hpp"
  33 #include "gc/g1/g1RemSet.hpp"
  34 #include "gc/g1/heapRegionRemSet.hpp"
  35 #include "gc/shared/ageTable.hpp"
  36 #include "memory/allocation.hpp"
  37 #include "oops/oop.hpp"
  38 #include "utilities/ticks.hpp"
  39 
  40 class G1OopStarChunkedList;
  41 class G1PLABAllocator;
  42 class G1EvacuationRootClosures;
  43 class HeapRegion;
  44 class outputStream;
  45 
  46 class G1ParScanThreadState : public CHeapObj<mtGC> {
  47   G1CollectedHeap* _g1h;
  48   RefToScanQueue* _refs;
  49   G1RedirtyCardsQueue _rdcq;
  50   G1CardTable* _ct;
  51   G1EvacuationRootClosures* _closures;
  52 
  53   G1PLABAllocator* _plab_allocator;
  54 
  55   AgeTable _age_table;
  56   G1HeapRegionAttr _dest[G1HeapRegionAttr::Num];
  57   // Local tenuring threshold.
  58   uint _tenuring_threshold;
  59   G1ScanEvacuatedObjClosure  _scanner;
  60 
  61   uint _worker_id;
  62 
  63   // Remember the last enqueued card to avoid enqueuing the same card over and over;
  64   // since we only ever scan a card once, this is sufficient.
  65   size_t _last_enqueued_card;
  66 
  67   // Upper and lower threshold to start and end work queue draining.
  68   uint const _stack_trim_upper_threshold;
  69   uint const _stack_trim_lower_threshold;
  70 
  71   Tickspan _trim_ticks;
  72   // Map from young-age-index (0 == not young, 1 is youngest) to
  73   // surviving words. base is what we get back from the malloc call
  74   size_t* _surviving_young_words_base;
  75   // this points into the array, as we use the first few entries for padding
  76   size_t* _surviving_young_words;
  77 
  78   // Indicates whether in the last generation (old) there is no more space
  79   // available for allocation.
  80   bool _old_gen_is_full;
  81 
  82 #define PADDING_ELEM_NUM (DEFAULT_CACHE_LINE_SIZE / sizeof(size_t))
  83 
  84   G1RedirtyCardsQueue& redirty_cards_queue()     { return _rdcq; }
  85   G1CardTable* ct()                              { return _ct; }
  86 
  87   G1HeapRegionAttr dest(G1HeapRegionAttr original) const {
  88     assert(original.is_valid(),
  89            "Original region attr invalid: %s", original.get_type_str());
  90     assert(_dest[original.type()].is_valid_gen(),
  91            "Dest region attr is invalid: %s", _dest[original.type()].get_type_str());
  92     return _dest[original.type()];
  93   }
  94 
  95   size_t _num_optional_regions;
  96   G1OopStarChunkedList* _oops_into_optional_regions;
  97 
  98   G1NUMA* _numa;
  99 
 100   // Records how many object allocations happened at each node during copy to survivor.
 101   // Only starts recording when log of gc+heap+numa is enabled and its data is
 102   // transferred when flushed.
 103   size_t* _obj_alloc_stat;
 104 
 105 public:
 106   G1ParScanThreadState(G1CollectedHeap* g1h,
 107                        G1RedirtyCardsQueueSet* rdcqs,
 108                        uint worker_id,
 109                        size_t young_cset_length,
 110                        size_t optional_cset_length);
 111   virtual ~G1ParScanThreadState();
 112 
 113   void set_ref_discoverer(ReferenceDiscoverer* rd) { _scanner.set_ref_discoverer(rd); }
 114 
 115 #ifdef ASSERT
 116   bool queue_is_empty() const { return _refs->is_empty(); }
 117 
 118   bool verify_ref(narrowOop* ref) const;
 119   bool verify_ref(oop* ref) const;
 120   bool verify_task(StarTask ref) const;
 121 #endif // ASSERT
 122 
 123   template <class T> void do_oop_ext(T* ref);
 124   template <class T> void push_on_queue(T* ref);
 125 
 126   template <class T> void enqueue_card_if_tracked(G1HeapRegionAttr region_attr, T* p, oop o) {
 127     assert(!HeapRegion::is_in_same_region(p, o), "Should have filtered out cross-region references already.");
 128     assert(!_g1h->heap_region_containing(p)->is_young(), "Should have filtered out from-young references already.");
 129 
 130 #ifdef ASSERT
 131     HeapRegion* const hr_obj = _g1h->heap_region_containing((HeapWord*)o);
 132     assert(region_attr.needs_remset_update() == hr_obj->rem_set()->is_tracked(),
 133            "State flag indicating remset tracking disagrees (%s) with actual remembered set (%s) for region %u",
 134            BOOL_TO_STR(region_attr.needs_remset_update()),
 135            BOOL_TO_STR(hr_obj->rem_set()->is_tracked()),
 136            hr_obj->hrm_index());
 137 #endif
 138     if (!region_attr.needs_remset_update()) {
 139       return;
 140     }
 141     size_t card_index = ct()->index_for(p);
 142     // If the card hasn't been added to the buffer, do it.
 143     if (_last_enqueued_card != card_index) {
 144       redirty_cards_queue().enqueue(ct()->byte_for_index(card_index));
 145       _last_enqueued_card = card_index;
 146     }
 147   }
 148 
 149   G1EvacuationRootClosures* closures() { return _closures; }
 150   uint worker_id() { return _worker_id; }
 151 
 152   size_t lab_waste_words() const;
 153   size_t lab_undo_waste_words() const;
 154 
 155   void flush(size_t* surviving_young_words);
 156 
 157 private:
 158   #define G1_PARTIAL_ARRAY_MASK 0x2
 159 
 160   inline bool has_partial_array_mask(oop* ref) const {
 161     return ((uintptr_t)ref & G1_PARTIAL_ARRAY_MASK) == G1_PARTIAL_ARRAY_MASK;
 162   }
 163 
 164   // We never encode partial array oops as narrowOop*, so return false immediately.
 165   // This allows the compiler to create optimized code when popping references from
 166   // the work queue.
 167   inline bool has_partial_array_mask(narrowOop* ref) const {
 168     assert(((uintptr_t)ref & G1_PARTIAL_ARRAY_MASK) != G1_PARTIAL_ARRAY_MASK, "Partial array oop reference encoded as narrowOop*");
 169     return false;
 170   }
 171 
 172   // Only implement set_partial_array_mask() for regular oops, not for narrowOops.
 173   // We always encode partial arrays as regular oop, to allow the
 174   // specialization for has_partial_array_mask() for narrowOops above.
 175   // This means that unintentional use of this method with narrowOops are caught
 176   // by the compiler.
 177   inline oop* set_partial_array_mask(oop obj) const {
 178     assert(((uintptr_t)(void *)obj & G1_PARTIAL_ARRAY_MASK) == 0, "Information loss!");
 179     return (oop*) ((uintptr_t)(void *)obj | G1_PARTIAL_ARRAY_MASK);
 180   }
 181 
 182   inline oop clear_partial_array_mask(oop* ref) const {
 183     return cast_to_oop((intptr_t)ref & ~G1_PARTIAL_ARRAY_MASK);
 184   }
 185 
 186   inline void do_oop_partial_array(oop* p);
 187 
 188   // This method is applied to the fields of the objects that have just been copied.
 189   template <class T> inline void do_oop_evac(T* p);
 190 
 191   inline void deal_with_reference(oop* ref_to_scan);
 192   inline void deal_with_reference(narrowOop* ref_to_scan);
 193 
 194   inline void dispatch_reference(StarTask ref);
 195 
 196   // Tries to allocate word_sz in the PLAB of the next "generation" after trying to
 197   // allocate into dest. Previous_plab_refill_failed indicates whether previous
 198   // PLAB refill for the original (source) object failed.
 199   // Returns a non-NULL pointer if successful, and updates dest if required.
 200   // Also determines whether we should continue to try to allocate into the various
 201   // generations or just end trying to allocate.
 202   HeapWord* allocate_in_next_plab(G1HeapRegionAttr* dest,
 203                                   size_t word_sz,
 204                                   bool previous_plab_refill_failed,
 205                                   uint node_index);
 206 
 207   inline G1HeapRegionAttr next_region_attr(G1HeapRegionAttr const region_attr, markWord const m, uint& age);
 208 
 209   void report_promotion_event(G1HeapRegionAttr const dest_attr,
 210                               oop const old, size_t word_sz, uint age,
 211                               HeapWord * const obj_ptr, uint node_index) const;
 212 
 213   inline bool needs_partial_trimming() const;
 214   inline bool is_partially_trimmed() const;
 215 
 216   inline void trim_queue_to_threshold(uint threshold);
 217 
 218   // NUMA statistics related methods.
 219   inline void initialize_numa_stats();
 220   inline void flush_numa_stats();
 221   inline void update_numa_stats(uint node_index);
 222 
 223 public:
 224   oop copy_to_survivor_space(G1HeapRegionAttr const region_attr, oop const obj, markWord const old_mark);
 225 
 226   void trim_queue();
 227   void trim_queue_partially();
 228 
 229   Tickspan trim_ticks() const;
 230   void reset_trim_ticks();
 231 
 232   inline void steal_and_trim_queue(RefToScanQueueSet *task_queues);
 233 
 234   // An attempt to evacuate "obj" has failed; take necessary steps.
 235   oop handle_evacuation_failure_par(oop obj, markWord m);
 236 
 237   template <typename T>
 238   inline void remember_root_into_optional_region(T* p);
 239   template <typename T>
 240   inline void remember_reference_into_optional_region(T* p);
 241 
 242   inline G1OopStarChunkedList* oops_into_optional_region(const HeapRegion* hr);
 243 };
 244 
 245 class G1ParScanThreadStateSet : public StackObj {
 246   G1CollectedHeap* _g1h;
 247   G1RedirtyCardsQueueSet* _rdcqs;
 248   G1ParScanThreadState** _states;
 249   size_t* _surviving_young_words_total;
 250   size_t _young_cset_length;
 251   size_t _optional_cset_length;
 252   uint _n_workers;
 253   bool _flushed;
 254 
 255  public:
 256   G1ParScanThreadStateSet(G1CollectedHeap* g1h,
 257                           G1RedirtyCardsQueueSet* rdcqs,
 258                           uint n_workers,
 259                           size_t young_cset_length,
 260                           size_t optional_cset_length);
 261   ~G1ParScanThreadStateSet();
 262 
 263   void flush();
 264   void record_unused_optional_region(HeapRegion* hr);
 265 
 266   G1ParScanThreadState* state_for_worker(uint worker_id);
 267 
 268   const size_t* surviving_young_words() const;
 269 
 270  private:
 271   G1ParScanThreadState* new_par_scan_state(uint worker_id, size_t young_cset_length);
 272 };
 273 
 274 #endif // SHARE_GC_G1_G1PARSCANTHREADSTATE_HPP