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 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 OopsInGenClosure {
  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   G1RemSet* _g1_rem;
  52   ConcurrentMark* _cm;
  53   G1ParScanThreadState* _par_scan_state;
  54   int _worker_i;
  55   bool _during_initial_mark;
  56   bool _mark_in_progress;
  57 public:
  58   G1ParClosureSuper(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state);
  59   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, ReferenceProcessor* rp) :
  76     G1ParClosureSuper(g1, par_scan_state)
  77   {
  78     assert(_ref_processor == NULL, "sanity");
  79     _ref_processor = rp;
  80   }
  81 
  82   template <class T> void do_oop_nv(T* p);
  83   virtual void do_oop(oop* p)          { do_oop_nv(p); }
  84   virtual void do_oop(narrowOop* p)    { do_oop_nv(p); }
  85 };
  86 
  87 #define G1_PARTIAL_ARRAY_MASK 0x2
  88 
  89 template <class T> inline bool has_partial_array_mask(T* ref) {
  90   return ((uintptr_t)ref & G1_PARTIAL_ARRAY_MASK) == G1_PARTIAL_ARRAY_MASK;
  91 }
  92 
  93 template <class T> inline T* set_partial_array_mask(T obj) {
  94   assert(((uintptr_t)obj & G1_PARTIAL_ARRAY_MASK) == 0, "Information loss!");
  95   return (T*) ((uintptr_t)obj | G1_PARTIAL_ARRAY_MASK);
  96 }
  97 
  98 template <class T> inline oop clear_partial_array_mask(T* ref) {
  99   return oop((intptr_t)ref & ~G1_PARTIAL_ARRAY_MASK);
 100 }
 101 
 102 class G1ParScanPartialArrayClosure : public G1ParClosureSuper {
 103   G1ParScanClosure _scanner;
 104 
 105 public:
 106   G1ParScanPartialArrayClosure(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state, ReferenceProcessor* rp) :
 107     G1ParClosureSuper(g1, par_scan_state), _scanner(g1, par_scan_state, rp)
 108   {
 109     assert(_ref_processor == NULL, "sanity");
 110   }
 111 
 112   G1ParScanClosure* scanner() {
 113     return &_scanner;
 114   }
 115 
 116   template <class T> void do_oop_nv(T* p);
 117   virtual void do_oop(oop* p)       { do_oop_nv(p); }
 118   virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
 119 };
 120 
 121 
 122 class G1ParCopyHelper : public G1ParClosureSuper {
 123   G1ParScanClosure *_scanner;
 124 protected:
 125   template <class T> void mark_object(T* p);
 126   oop copy_to_survivor_space(oop obj, bool should_mark_root,
 127                                       bool should_mark_copy);
 128 public:
 129   G1ParCopyHelper(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state,
 130                   G1ParScanClosure *scanner) :
 131     G1ParClosureSuper(g1, par_scan_state), _scanner(scanner) { }
 132 };
 133 
 134 template<bool do_gen_barrier, G1Barrier barrier,
 135          bool do_mark_object>
 136 class G1ParCopyClosure : public G1ParCopyHelper {
 137   G1ParScanClosure _scanner;
 138 
 139   template <class T> void do_oop_work(T* p);
 140 
 141 public:
 142   G1ParCopyClosure(G1CollectedHeap* g1, G1ParScanThreadState* par_scan_state,
 143                    ReferenceProcessor* rp) :
 144     _scanner(g1, par_scan_state, rp),
 145     G1ParCopyHelper(g1, par_scan_state, &_scanner)
 146   {
 147     assert(_ref_processor == NULL, "sanity");
 148   }
 149 
 150   G1ParScanClosure* scanner() { return &_scanner; }
 151 
 152   template <class T> void do_oop_nv(T* p) {
 153     do_oop_work(p);
 154   }
 155   virtual void do_oop(oop* p)       { do_oop_nv(p); }
 156   virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
 157 };
 158 
 159 typedef G1ParCopyClosure<false, G1BarrierNone, false> G1ParScanExtRootClosure;
 160 typedef G1ParCopyClosure<true,  G1BarrierNone, false> G1ParScanPermClosure;
 161 
 162 typedef G1ParCopyClosure<false, G1BarrierNone, true> G1ParScanAndMarkExtRootClosure;
 163 typedef G1ParCopyClosure<true,  G1BarrierNone, true> G1ParScanAndMarkPermClosure;
 164 
 165 // The following closure types are no longer used but are retained
 166 // for historical reasons:
 167 // typedef G1ParCopyClosure<false, G1BarrierRS,   false> G1ParScanHeapRSClosure;
 168 // typedef G1ParCopyClosure<false, G1BarrierRS,   true> G1ParScanAndMarkHeapRSClosure;
 169 
 170 // The following closure type is defined in g1_specialized_oop_closures.hpp:
 171 //
 172 // typedef G1ParCopyClosure<false, G1BarrierEvac, false> G1ParScanHeapEvacClosure;
 173 
 174 // We use a separate closure to handle references during evacuation
 175 // failure processing.
 176 // We could have used another instance of G1ParScanHeapEvacClosure
 177 // (since that closure no longer assumes that the references it
 178 // handles point into the collection set).
 179 
 180 typedef G1ParCopyClosure<false, G1BarrierEvac, false> G1ParScanHeapEvacFailureClosure;
 181 
 182 class FilterIntoCSClosure: public OopClosure {
 183   G1CollectedHeap* _g1;
 184   OopClosure* _oc;
 185   DirtyCardToOopClosure* _dcto_cl;
 186 public:
 187   FilterIntoCSClosure(  DirtyCardToOopClosure* dcto_cl,
 188                         G1CollectedHeap* g1,
 189                         OopClosure* oc) :
 190     _dcto_cl(dcto_cl), _g1(g1), _oc(oc) { }
 191 
 192   template <class T> void do_oop_nv(T* p);
 193   virtual void do_oop(oop* p)        { do_oop_nv(p); }
 194   virtual void do_oop(narrowOop* p)  { do_oop_nv(p); }
 195   bool apply_to_weak_ref_discovered_field() { return true; }
 196   bool do_header() { return false; }
 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 };
 213 
 214 // Closure for iterating over object fields during concurrent marking
 215 class G1CMOopClosure : public OopClosure {
 216   G1CollectedHeap*   _g1h;
 217   ConcurrentMark*    _cm;
 218   CMTask*            _task;
 219 public:
 220   G1CMOopClosure(G1CollectedHeap* g1h, ConcurrentMark* cm, CMTask* task);
 221   template <class T> void do_oop_nv(T* p);
 222   virtual void do_oop(      oop* p) { do_oop_nv(p); }
 223   virtual void do_oop(narrowOop* p) { do_oop_nv(p); }
 224 };
 225 
 226 #endif // SHARE_VM_GC_IMPLEMENTATION_G1_G1OOPCLOSURES_HPP