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