1 /*
   2  * Copyright (c) 2001, 2009, 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 class HeapRegion;
  26 class G1CollectedHeap;
  27 class G1RemSet;
  28 class ConcurrentMark;
  29 class DirtyCardToOopClosure;
  30 class CMBitMap;
  31 class CMMarkStack;
  32 class G1ParScanThreadState;
  33 
  34 // A class that scans oops in a given heap region (much as OopsInGenClosure
  35 // scans oops in a generation.)
  36 class OopsInHeapRegionClosure: public OopsInGenClosure {
  37 protected:
  38   HeapRegion* _from;
  39 public:
  40   virtual void set_region(HeapRegion* from) { _from = from; }
  41 };
  42 
  43 class G1ParClosureSuper : public OopsInHeapRegionClosure {
  44 protected:
  45   G1CollectedHeap* _g1;
  46   G1RemSet* _g1_rem;
  47   ConcurrentMark* _cm;
  48   G1ParScanThreadState* _par_scan_state;
  49 public:
  50   G1ParClosureSuper(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state);
  51   bool apply_to_weak_ref_discovered_field() { return true; }
  52 };
  53 
  54 class G1ParPushHeapRSClosure : public G1ParClosureSuper {
  55 public:
  56   G1ParPushHeapRSClosure(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state) :
  57     G1ParClosureSuper(g1, par_scan_state) { }
  58   template <class T> void do_oop_nv(T* p);
  59   virtual void do_oop(oop* p)          { do_oop_nv(p); }
  60   virtual void do_oop(narrowOop* p)    { do_oop_nv(p); }
  61 };
  62 
  63 class G1ParScanClosure : public G1ParClosureSuper {
  64 public:
  65   G1ParScanClosure(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state) :
  66     G1ParClosureSuper(g1, par_scan_state) { }
  67   template <class T> void do_oop_nv(T* p);
  68   virtual void do_oop(oop* p)          { do_oop_nv(p); }
  69   virtual void do_oop(narrowOop* p)    { do_oop_nv(p); }
  70 };
  71 
  72 #define G1_PARTIAL_ARRAY_MASK 0x2
  73 
  74 template <class T> inline bool has_partial_array_mask(T* ref) {
  75   return ((uintptr_t)ref & G1_PARTIAL_ARRAY_MASK) == G1_PARTIAL_ARRAY_MASK;
  76 }
  77 
  78 template <class T> inline T* set_partial_array_mask(T obj) {
  79   assert(((uintptr_t)obj & G1_PARTIAL_ARRAY_MASK) == 0, "Information loss!");
  80   return (T*) ((uintptr_t)obj | G1_PARTIAL_ARRAY_MASK);
  81 }
  82 
  83 template <class T> inline oop clear_partial_array_mask(T* ref) {
  84   return oop((intptr_t)ref & ~G1_PARTIAL_ARRAY_MASK);
  85 }
  86 
  87 class G1ParScanPartialArrayClosure : public G1ParClosureSuper {
  88   G1ParScanClosure _scanner;
  89 public:
  90   G1ParScanPartialArrayClosure(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state) :
  91     G1ParClosureSuper(g1, par_scan_state), _scanner(g1, par_scan_state) { }
  92   template <class T> void do_oop_nv(T* p);
  93   virtual void do_oop(oop* p)       { do_oop_nv(p); }
  94   virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
  95 };
  96 
  97 
  98 class G1ParCopyHelper : public G1ParClosureSuper {
  99   G1ParScanClosure *_scanner;
 100 protected:
 101   template <class T> void mark_forwardee(T* p);
 102   oop copy_to_survivor_space(oop obj);
 103 public:
 104   G1ParCopyHelper(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state,
 105                   G1ParScanClosure *scanner) :
 106     G1ParClosureSuper(g1, par_scan_state), _scanner(scanner) { }
 107 };
 108 
 109 template<bool do_gen_barrier, G1Barrier barrier,
 110          bool do_mark_forwardee>
 111 class G1ParCopyClosure : public G1ParCopyHelper {
 112   G1ParScanClosure _scanner;
 113   template <class T> void do_oop_work(T* p);
 114 public:
 115   G1ParCopyClosure(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state) :
 116     _scanner(g1, par_scan_state), G1ParCopyHelper(g1, par_scan_state, &_scanner) { }
 117   template <class T> void do_oop_nv(T* p) {
 118     do_oop_work(p);
 119     if (do_mark_forwardee)
 120       mark_forwardee(p);
 121   }
 122   virtual void do_oop(oop* p)       { do_oop_nv(p); }
 123   virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
 124 };
 125 
 126 typedef G1ParCopyClosure<false, G1BarrierNone, false> G1ParScanExtRootClosure;
 127 typedef G1ParCopyClosure<true,  G1BarrierNone, false> G1ParScanPermClosure;
 128 typedef G1ParCopyClosure<false, G1BarrierRS,   false> G1ParScanHeapRSClosure;
 129 typedef G1ParCopyClosure<false, G1BarrierNone, true> G1ParScanAndMarkExtRootClosure;
 130 typedef G1ParCopyClosure<true,  G1BarrierNone, true> G1ParScanAndMarkPermClosure;
 131 typedef G1ParCopyClosure<false, G1BarrierRS,   true> G1ParScanAndMarkHeapRSClosure;
 132 
 133 // This is the only case when we set skip_cset_test. Basically, this
 134 // closure is (should?) only be called directly while we're draining
 135 // the overflow and task queues. In that case we know that the
 136 // reference in question points into the collection set, otherwise we
 137 // would not have pushed it on the queue. The following is defined in
 138 // g1_specialized_oop_closures.hpp.
 139 // typedef G1ParCopyClosure<false, G1BarrierEvac, false, true> G1ParScanHeapEvacClosure;
 140 // We need a separate closure to handle references during evacuation
 141 // failure processing, as we cannot asume that the reference already
 142 // points into the collection set (like G1ParScanHeapEvacClosure does).
 143 typedef G1ParCopyClosure<false, G1BarrierEvac, false> G1ParScanHeapEvacFailureClosure;
 144 
 145 class FilterIntoCSClosure: public OopClosure {
 146   G1CollectedHeap* _g1;
 147   OopClosure* _oc;
 148   DirtyCardToOopClosure* _dcto_cl;
 149 public:
 150   FilterIntoCSClosure(  DirtyCardToOopClosure* dcto_cl,
 151                         G1CollectedHeap* g1, OopClosure* oc) :
 152     _dcto_cl(dcto_cl), _g1(g1), _oc(oc)
 153   {}
 154   template <class T> void do_oop_nv(T* p);
 155   virtual void do_oop(oop* p)        { do_oop_nv(p); }
 156   virtual void do_oop(narrowOop* p)  { do_oop_nv(p); }
 157   bool apply_to_weak_ref_discovered_field() { return true; }
 158   bool do_header() { return false; }
 159 };
 160 
 161 class FilterInHeapRegionAndIntoCSClosure : public OopsInHeapRegionClosure {
 162   G1CollectedHeap* _g1;
 163   OopsInHeapRegionClosure* _oc;
 164 public:
 165   FilterInHeapRegionAndIntoCSClosure(G1CollectedHeap* g1,
 166                                      OopsInHeapRegionClosure* oc) :
 167     _g1(g1), _oc(oc)
 168   {}
 169   template <class T> void do_oop_nv(T* p);
 170   virtual void do_oop(oop* p) { do_oop_nv(p); }
 171   virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
 172   bool apply_to_weak_ref_discovered_field() { return true; }
 173   bool do_header() { return false; }
 174   void set_region(HeapRegion* from) {
 175     _oc->set_region(from);
 176   }
 177 };
 178 
 179 class FilterAndMarkInHeapRegionAndIntoCSClosure : public OopsInHeapRegionClosure {
 180   G1CollectedHeap* _g1;
 181   ConcurrentMark* _cm;
 182   OopsInHeapRegionClosure* _oc;
 183 public:
 184   FilterAndMarkInHeapRegionAndIntoCSClosure(G1CollectedHeap* g1,
 185                                             OopsInHeapRegionClosure* oc,
 186                                             ConcurrentMark* cm)
 187   : _g1(g1), _oc(oc), _cm(cm) { }
 188 
 189   template <class T> void do_oop_nv(T* p);
 190   virtual void do_oop(oop* p) { do_oop_nv(p); }
 191   virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
 192   bool apply_to_weak_ref_discovered_field() { return true; }
 193   bool do_header() { return false; }
 194   void set_region(HeapRegion* from) {
 195     _oc->set_region(from);
 196   }
 197 };
 198 
 199 class FilterOutOfRegionClosure: public OopClosure {
 200   HeapWord* _r_bottom;
 201   HeapWord* _r_end;
 202   OopClosure* _oc;
 203   int _out_of_region;
 204 public:
 205   FilterOutOfRegionClosure(HeapRegion* r, OopClosure* oc);
 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   bool apply_to_weak_ref_discovered_field() { return true; }
 210   bool do_header() { return false; }
 211   int out_of_region() { return _out_of_region; }
 212 };