1 /*
   2  * Copyright (c) 2001, 2014, 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_IMPLEMENTATION_G1_G1OOPCLOSURES_HPP
  26 #define SHARE_VM_GC_IMPLEMENTATION_G1_G1OOPCLOSURES_HPP
  27 
  28 class HeapRegion;
  29 class G1CollectedHeap;
  30 class G1RemSet;
  31 class ConcurrentMark;
  32 class DirtyCardToOopClosure;
  33 class CMBitMap;
  34 class CMMarkStack;
  35 class G1ParScanThreadState;
  36 class CMTask;
  37 class ReferenceProcessor;
  38 
  39 // A class that scans oops in a given heap region (much as OopsInGenClosure
  40 // scans oops in a generation.)
  41 class OopsInHeapRegionClosure: public ExtendedOopClosure {
  42 protected:
  43   HeapRegion* _from;
  44 public:
  45   void set_region(HeapRegion* from) { _from = from; }
  46 };
  47 
  48 class G1ParClosureSuper : public OopsInHeapRegionClosure {
  49 protected:
  50   G1CollectedHeap* _g1;
  51   G1ParScanThreadState* _par_scan_state;
  52   uint _worker_id;
  53 public:
  54   G1ParClosureSuper(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state);
  55   bool apply_to_weak_ref_discovered_field() { return true; }
  56 };
  57 
  58 class G1ParPushHeapRSClosure : public G1ParClosureSuper {
  59 public:
  60   G1ParPushHeapRSClosure(G1CollectedHeap* g1,
  61                          G1ParScanThreadState* par_scan_state):
  62     G1ParClosureSuper(g1, par_scan_state) { }
  63 
  64   template <class T> void do_oop_nv(T* p);
  65   virtual void do_oop(oop* p)          { do_oop_nv(p); }
  66   virtual void do_oop(narrowOop* p)    { do_oop_nv(p); }
  67 };
  68 
  69 class G1ParScanClosure : public G1ParClosureSuper {
  70 public:
  71   G1ParScanClosure(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state, ReferenceProcessor* rp) :
  72     G1ParClosureSuper(g1, par_scan_state)
  73   {
  74     assert(_ref_processor == NULL, "sanity");
  75     _ref_processor = rp;
  76   }
  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 
  83 // Add back base class for metadata
  84 class G1ParCopyHelper : public G1ParClosureSuper {
  85 protected:
  86   Klass* _scanned_klass;
  87   ConcurrentMark* _cm;
  88 
  89   // Mark the object if it's not already marked. This is used to mark
  90   // objects pointed to by roots that are guaranteed not to move
  91   // during the GC (i.e., non-CSet objects). It is MT-safe.
  92   void mark_object(oop obj);
  93 
  94   // Mark the object if it's not already marked. This is used to mark
  95   // objects pointed to by roots that have been forwarded during a
  96   // GC. It is MT-safe.
  97   void mark_forwarded_object(oop from_obj, oop to_obj);
  98  public:
  99   G1ParCopyHelper(G1CollectedHeap* g1,  G1ParScanThreadState* par_scan_state);
 100 
 101   void set_scanned_klass(Klass* k) { _scanned_klass = k; }
 102   template <class T> void do_klass_barrier(T* p, oop new_obj);
 103 };
 104 
 105 template <G1Barrier barrier, bool do_mark_object>
 106 class G1ParCopyClosure : public G1ParCopyHelper {
 107   G1ParScanClosure _scanner;
 108   template <class T> void do_oop_work(T* p);
 109 
 110 protected:
 111   oop copy_to_survivor_space(oop obj);
 112 
 113 public:
 114   G1ParCopyClosure(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state,
 115                    ReferenceProcessor* rp) :
 116       _scanner(g1, par_scan_state, rp),
 117       G1ParCopyHelper(g1, par_scan_state) {
 118     assert(_ref_processor == NULL, "sanity");
 119   }
 120 
 121   G1ParScanClosure* scanner() { return &_scanner; }
 122 
 123   template <class T> void do_oop_nv(T* p) { do_oop_work(p); }
 124   virtual void do_oop(oop* p)       { do_oop_nv(p); }
 125   virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
 126 };
 127 
 128 typedef G1ParCopyClosure<G1BarrierNone, false> G1ParScanExtRootClosure;
 129 typedef G1ParCopyClosure<G1BarrierKlass, false> G1ParScanMetadataClosure;
 130 
 131 
 132 typedef G1ParCopyClosure<G1BarrierNone, true> G1ParScanAndMarkExtRootClosure;
 133 typedef G1ParCopyClosure<G1BarrierKlass, true> G1ParScanAndMarkMetadataClosure;
 134 
 135 // We use a separate closure to handle references during evacuation
 136 // failure processing.
 137 
 138 typedef G1ParCopyClosure<G1BarrierEvac, false> G1ParScanHeapEvacFailureClosure;
 139 
 140 class FilterIntoCSClosure: public ExtendedOopClosure {
 141   G1CollectedHeap* _g1;
 142   OopClosure* _oc;
 143   DirtyCardToOopClosure* _dcto_cl;
 144 public:
 145   FilterIntoCSClosure(  DirtyCardToOopClosure* dcto_cl,
 146                         G1CollectedHeap* g1,
 147                         OopClosure* oc) :
 148     _dcto_cl(dcto_cl), _g1(g1), _oc(oc) { }
 149 
 150   template <class T> void do_oop_nv(T* p);
 151   virtual void do_oop(oop* p)        { do_oop_nv(p); }
 152   virtual void do_oop(narrowOop* p)  { do_oop_nv(p); }
 153   bool apply_to_weak_ref_discovered_field() { return true; }
 154 };
 155 
 156 class FilterOutOfRegionClosure: public ExtendedOopClosure {
 157   HeapWord* _r_bottom;
 158   HeapWord* _r_end;
 159   OopClosure* _oc;
 160 public:
 161   FilterOutOfRegionClosure(HeapRegion* r, OopClosure* oc);
 162   template <class T> void do_oop_nv(T* p);
 163   virtual void do_oop(oop* p) { do_oop_nv(p); }
 164   virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
 165   bool apply_to_weak_ref_discovered_field() { return true; }
 166 };
 167 
 168 // Closure for iterating over object fields during concurrent marking
 169 class G1CMOopClosure : public ExtendedOopClosure {
 170 private:
 171   G1CollectedHeap*   _g1h;
 172   ConcurrentMark*    _cm;
 173   CMTask*            _task;
 174 public:
 175   G1CMOopClosure(G1CollectedHeap* g1h, ConcurrentMark* cm, CMTask* task);
 176   template <class T> void do_oop_nv(T* p);
 177   virtual void do_oop(      oop* p) { do_oop_nv(p); }
 178   virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
 179 };
 180 
 181 // Closure to scan the root regions during concurrent marking
 182 class G1RootRegionScanClosure : public ExtendedOopClosure {
 183 private:
 184   G1CollectedHeap* _g1h;
 185   ConcurrentMark*  _cm;
 186   uint _worker_id;
 187 public:
 188   G1RootRegionScanClosure(G1CollectedHeap* g1h, ConcurrentMark* cm,
 189                           uint worker_id) :
 190     _g1h(g1h), _cm(cm), _worker_id(worker_id) { }
 191   template <class T> void do_oop_nv(T* p);
 192   virtual void do_oop(      oop* p) { do_oop_nv(p); }
 193   virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
 194 };
 195 
 196 // Closure that applies the given two closures in sequence.
 197 // Used by the RSet refinement code (when updating RSets
 198 // during an evacuation pause) to record cards containing
 199 // pointers into the collection set.
 200 
 201 class G1Mux2Closure : public ExtendedOopClosure {
 202   OopClosure* _c1;
 203   OopClosure* _c2;
 204 public:
 205   G1Mux2Closure(OopClosure *c1, OopClosure *c2);
 206   template <class T> void do_oop_nv(T* p);
 207   virtual void do_oop(oop* p)        { do_oop_nv(p); }
 208   virtual void do_oop(narrowOop* p)  { do_oop_nv(p); }
 209 };
 210 
 211 // A closure that returns true if it is actually applied
 212 // to a reference
 213 
 214 class G1TriggerClosure : public ExtendedOopClosure {
 215   bool _triggered;
 216 public:
 217   G1TriggerClosure();
 218   bool triggered() const { return _triggered; }
 219   template <class T> void do_oop_nv(T* p);
 220   virtual void do_oop(oop* p)        { do_oop_nv(p); }
 221   virtual void do_oop(narrowOop* p)  { do_oop_nv(p); }
 222 };
 223 
 224 // A closure which uses a triggering closure to determine
 225 // whether to apply an oop closure.
 226 
 227 class G1InvokeIfNotTriggeredClosure: public ExtendedOopClosure {
 228   G1TriggerClosure* _trigger_cl;
 229   OopClosure* _oop_cl;
 230 public:
 231   G1InvokeIfNotTriggeredClosure(G1TriggerClosure* t, OopClosure* oc);
 232   template <class T> void do_oop_nv(T* p);
 233   virtual void do_oop(oop* p)        { do_oop_nv(p); }
 234   virtual void do_oop(narrowOop* p)  { do_oop_nv(p); }
 235 };
 236 
 237 class G1UpdateRSOrPushRefOopClosure: public ExtendedOopClosure {
 238   G1CollectedHeap* _g1;
 239   G1RemSet* _g1_rem_set;
 240   HeapRegion* _from;
 241   OopsInHeapRegionClosure* _push_ref_cl;
 242   bool _record_refs_into_cset;
 243   int _worker_i;
 244 
 245 public:
 246   G1UpdateRSOrPushRefOopClosure(G1CollectedHeap* g1h,
 247                                 G1RemSet* rs,
 248                                 OopsInHeapRegionClosure* push_ref_cl,
 249                                 bool record_refs_into_cset,
 250                                 int worker_i = 0);
 251 
 252   void set_from(HeapRegion* from) {
 253     assert(from != NULL, "from region must be non-NULL");
 254     _from = from;
 255   }
 256 
 257   bool self_forwarded(oop obj) {
 258     bool result = (obj->is_forwarded() && (obj->forwardee()== obj));
 259     return result;
 260   }
 261 
 262   bool apply_to_weak_ref_discovered_field() { return true; }
 263 
 264   template <class T> void do_oop_nv(T* p);
 265   virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
 266   virtual void do_oop(oop* p)       { do_oop_nv(p); }
 267 };
 268 
 269 #endif // SHARE_VM_GC_IMPLEMENTATION_G1_G1OOPCLOSURES_HPP