1 /*
   2  * Copyright (c) 2001, 2017, 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_VM_GC_G1_G1OOPCLOSURES_HPP
  26 #define SHARE_VM_GC_G1_G1OOPCLOSURES_HPP
  27 
  28 #include "memory/iterator.hpp"
  29 #include "oops/markOop.hpp"
  30 
  31 class HeapRegion;
  32 class G1CollectedHeap;
  33 class G1RemSet;
  34 class G1ConcurrentMark;
  35 class DirtyCardToOopClosure;
  36 class G1CMBitMap;
  37 class G1ParScanThreadState;
  38 class G1CMTask;
  39 class ReferenceProcessor;
  40 
  41 // A class that scans oops in a given heap region (much as OopsInGenClosure
  42 // scans oops in a generation.)
  43 class OopsInHeapRegionClosure: public ExtendedOopClosure {
  44 protected:
  45   HeapRegion* _from;
  46 public:
  47   void set_region(HeapRegion* from) { _from = from; }
  48 };
  49 
  50 class G1ParClosureSuper : public OopsInHeapRegionClosure {
  51 protected:
  52   G1CollectedHeap* _g1;
  53   G1ParScanThreadState* _par_scan_state;
  54 
  55   G1ParClosureSuper(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state);
  56   ~G1ParClosureSuper() { }
  57 
  58 public:
  59   virtual bool apply_to_weak_ref_discovered_field() { return true; }
  60 };
  61 
  62 class G1ParPushHeapRSClosure : public G1ParClosureSuper {
  63 public:
  64   G1ParPushHeapRSClosure(G1CollectedHeap* g1,
  65                          G1ParScanThreadState* par_scan_state):
  66     G1ParClosureSuper(g1, par_scan_state) { }
  67 
  68   template <class T> void do_oop_nv(T* p);
  69   virtual void do_oop(oop* p)          { do_oop_nv(p); }
  70   virtual void do_oop(narrowOop* p)    { do_oop_nv(p); }
  71 };
  72 
  73 class G1ParScanClosure : public G1ParClosureSuper {
  74 public:
  75   G1ParScanClosure(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state) :
  76     G1ParClosureSuper(g1, par_scan_state) { }
  77 
  78   template <class T> void do_oop_nv(T* p);
  79   virtual void do_oop(oop* p)          { do_oop_nv(p); }
  80   virtual void do_oop(narrowOop* p)    { do_oop_nv(p); }
  81 
  82   void set_ref_processor(ReferenceProcessor* rp) {
  83     set_ref_processor_internal(rp);
  84   }
  85 };
  86 
  87 // Add back base class for metadata
  88 class G1ParCopyHelper : public OopClosure {
  89 protected:
  90   G1CollectedHeap* _g1;
  91   G1ParScanThreadState* _par_scan_state;
  92   uint _worker_id;              // Cache value from par_scan_state.
  93   Klass* _scanned_klass;
  94   G1ConcurrentMark* _cm;
  95 
  96   // Mark the object if it's not already marked. This is used to mark
  97   // objects pointed to by roots that are guaranteed not to move
  98   // during the GC (i.e., non-CSet objects). It is MT-safe.
  99   inline void mark_object(oop obj);
 100 
 101   // Mark the object if it's not already marked. This is used to mark
 102   // objects pointed to by roots that have been forwarded during a
 103   // GC. It is MT-safe.
 104   inline void mark_forwarded_object(oop from_obj, oop to_obj);
 105 
 106   G1ParCopyHelper(G1CollectedHeap* g1,  G1ParScanThreadState* par_scan_state);
 107   ~G1ParCopyHelper() { }
 108 
 109  public:
 110   void set_scanned_klass(Klass* k) { _scanned_klass = k; }
 111   template <class T> inline void do_klass_barrier(T* p, oop new_obj);
 112 };
 113 
 114 enum G1Barrier {
 115   G1BarrierNone,
 116   G1BarrierKlass
 117 };
 118 
 119 enum G1Mark {
 120   G1MarkNone,
 121   G1MarkFromRoot,
 122   G1MarkPromotedFromRoot
 123 };
 124 
 125 template <G1Barrier barrier, G1Mark do_mark_object, bool use_ext>
 126 class G1ParCopyClosure : public G1ParCopyHelper {
 127 public:
 128   G1ParCopyClosure(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state) :
 129       G1ParCopyHelper(g1, par_scan_state) { }
 130 
 131   template <class T> void do_oop_work(T* p);
 132   virtual void do_oop(oop* p)       { do_oop_work(p); }
 133   virtual void do_oop(narrowOop* p) { do_oop_work(p); }
 134 };
 135 
 136 class G1KlassScanClosure : public KlassClosure {
 137  G1ParCopyHelper* _closure;
 138  bool             _process_only_dirty;
 139  int              _count;
 140  public:
 141   G1KlassScanClosure(G1ParCopyHelper* closure, bool process_only_dirty)
 142       : _process_only_dirty(process_only_dirty), _closure(closure), _count(0) {}
 143   void do_klass(Klass* klass);
 144 };
 145 
 146 // Closure for iterating over object fields during concurrent marking
 147 class G1CMOopClosure : public MetadataAwareOopClosure {
 148 protected:
 149   G1ConcurrentMark*  _cm;
 150 private:
 151   G1CollectedHeap*   _g1h;
 152   G1CMTask*          _task;
 153 public:
 154   G1CMOopClosure(G1CollectedHeap* g1h, G1ConcurrentMark* cm, G1CMTask* task);
 155   template <class T> void do_oop_nv(T* p);
 156   virtual void do_oop(      oop* p) { do_oop_nv(p); }
 157   virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
 158 };
 159 
 160 // Closure to scan the root regions during concurrent marking
 161 class G1RootRegionScanClosure : public MetadataAwareOopClosure {
 162 private:
 163   G1CollectedHeap* _g1h;
 164   G1ConcurrentMark* _cm;
 165 public:
 166   G1RootRegionScanClosure(G1CollectedHeap* g1h, G1ConcurrentMark* cm) :
 167     _g1h(g1h), _cm(cm) { }
 168   template <class T> void do_oop_nv(T* p);
 169   virtual void do_oop(      oop* p) { do_oop_nv(p); }
 170   virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
 171 };
 172 
 173 class G1ConcurrentRefineOopClosure: public ExtendedOopClosure {
 174   G1CollectedHeap* _g1;
 175   uint _worker_i;
 176 
 177 public:
 178   G1ConcurrentRefineOopClosure(G1CollectedHeap* g1h, uint worker_i) :
 179     _g1(g1h),
 180     _worker_i(worker_i) {
 181   }
 182 
 183   bool apply_to_weak_ref_discovered_field() { return true; }
 184 
 185   template <class T> void do_oop_nv(T* p);
 186   virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
 187   virtual void do_oop(oop* p) { do_oop_nv(p); }
 188 };
 189 
 190 class G1UpdateRSOrPushRefOopClosure: public ExtendedOopClosure {
 191   G1CollectedHeap* _g1;
 192   HeapRegion* _from;
 193   G1ParPushHeapRSClosure* _push_ref_cl;
 194   bool _record_refs_into_cset;
 195   uint _worker_i;
 196   bool _has_refs_into_cset;
 197 
 198 public:
 199   G1UpdateRSOrPushRefOopClosure(G1CollectedHeap* g1h,
 200                                 G1ParPushHeapRSClosure* push_ref_cl,
 201                                 bool record_refs_into_cset,
 202                                 uint worker_i);
 203 
 204   void set_from(HeapRegion* from) {
 205     assert(from != NULL, "from region must be non-NULL");
 206     _from = from;
 207   }
 208 
 209   bool apply_to_weak_ref_discovered_field() { return true; }
 210 
 211   bool self_forwarded(oop obj) {
 212     markOop m = obj->mark();
 213     bool result = (m->is_marked() && ((oop)m->decode_pointer() == obj));
 214     return result;
 215   }
 216 
 217   bool has_refs_into_cset() const { return _has_refs_into_cset; }
 218 
 219   template <class T> inline void do_oop_nv(T* p);
 220   virtual inline void do_oop(narrowOop* p);
 221   virtual inline void do_oop(oop* p);
 222 };
 223 
 224 #endif // SHARE_VM_GC_G1_G1OOPCLOSURES_HPP