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_G1SATBCARDTABLEMODREFBS_HPP
  26 #define SHARE_VM_GC_IMPLEMENTATION_G1_G1SATBCARDTABLEMODREFBS_HPP
  27 
  28 #include "memory/cardTableModRefBS.hpp"
  29 #include "memory/memRegion.hpp"
  30 #include "oops/oop.inline.hpp"
  31 #include "utilities/macros.hpp"
  32 
  33 #if INCLUDE_ALL_GCS
  34 
  35 class DirtyCardQueueSet;
  36 
  37 // This barrier is specialized to use a logging barrier to support
  38 // snapshot-at-the-beginning marking.
  39 
  40 class G1SATBCardTableModRefBS: public CardTableModRefBSForCTRS {
  41 public:
  42   // Add "pre_val" to a set of objects that may have been disconnected from the
  43   // pre-marking object graph.
  44   static void enqueue(oop pre_val);
  45 
  46   G1SATBCardTableModRefBS(MemRegion whole_heap,
  47                           int max_covered_regions);
  48 
  49   bool is_a(BarrierSet::Name bsn) {
  50     return bsn == BarrierSet::G1SATBCT || CardTableModRefBS::is_a(bsn);
  51   }
  52 
  53   virtual bool has_write_ref_pre_barrier() { return true; }
  54 
  55   // This notes that we don't need to access any BarrierSet data
  56   // structures, so this can be called from a static context.
  57   template <class T> static void write_ref_field_pre_static(T* field, oop newVal) {
  58     T heap_oop = oopDesc::load_heap_oop(field);
  59     if (!oopDesc::is_null(heap_oop)) {
  60       enqueue(oopDesc::decode_heap_oop(heap_oop));
  61     }
  62   }
  63 
  64   // We export this to make it available in cases where the static
  65   // type of the barrier set is known.  Note that it is non-virtual.
  66   template <class T> inline void inline_write_ref_field_pre(T* field, oop newVal) {
  67     write_ref_field_pre_static(field, newVal);
  68   }
  69 
  70   // These are the more general virtual versions.
  71   virtual void write_ref_field_pre_work(oop* field, oop new_val) {
  72     inline_write_ref_field_pre(field, new_val);
  73   }
  74   virtual void write_ref_field_pre_work(narrowOop* field, oop new_val) {
  75     inline_write_ref_field_pre(field, new_val);
  76   }
  77   virtual void write_ref_field_pre_work(void* field, oop new_val) {
  78     guarantee(false, "Not needed");
  79   }
  80 
  81   template <class T> void write_ref_array_pre_work(T* dst, int count);
  82   virtual void write_ref_array_pre(oop* dst, int count, bool dest_uninitialized) {
  83     if (!dest_uninitialized) {
  84       write_ref_array_pre_work(dst, count);
  85     }
  86   }
  87   virtual void write_ref_array_pre(narrowOop* dst, int count, bool dest_uninitialized) {
  88     if (!dest_uninitialized) {
  89       write_ref_array_pre_work(dst, count);
  90     }
  91   }
  92 
  93 /*
  94    Claimed and deferred bits are used together in G1 during the evacuation
  95    pause. These bits can have the following state transitions:
  96    1. The claimed bit can be put over any other card state. Except that
  97       the "dirty -> dirty and claimed" transition is checked for in
  98       G1 code and is not used.
  99    2. Deferred bit can be set only if the previous state of the card
 100       was either clean or claimed. mark_card_deferred() is wait-free.
 101       We do not care if the operation is be successful because if
 102       it does not it will only result in duplicate entry in the update
 103       buffer because of the "cache-miss". So it's not worth spinning.
 104  */
 105 
 106   bool is_card_claimed(size_t card_index) {
 107     jbyte val = _byte_map[card_index];
 108     return (val & (clean_card_mask_val() | claimed_card_val())) == claimed_card_val();
 109   }
 110 
 111   void set_card_claimed(size_t card_index) {
 112       jbyte val = _byte_map[card_index];
 113       if (val == clean_card_val()) {
 114         val = (jbyte)claimed_card_val();
 115       } else {
 116         val |= (jbyte)claimed_card_val();
 117       }
 118       _byte_map[card_index] = val;
 119   }
 120 
 121   bool mark_card_deferred(size_t card_index);
 122 
 123   bool is_card_deferred(size_t card_index) {
 124     jbyte val = _byte_map[card_index];
 125     return (val & (clean_card_mask_val() | deferred_card_val())) == deferred_card_val();
 126   }
 127 
 128 };
 129 
 130 // Adds card-table logging to the post-barrier.
 131 // Usual invariant: all dirty cards are logged in the DirtyCardQueueSet.
 132 class G1SATBCardTableLoggingModRefBS: public G1SATBCardTableModRefBS {
 133  private:
 134   DirtyCardQueueSet& _dcqs;
 135  public:
 136   G1SATBCardTableLoggingModRefBS(MemRegion whole_heap,
 137                                  int max_covered_regions);
 138 
 139   bool is_a(BarrierSet::Name bsn) {
 140     return bsn == BarrierSet::G1SATBCTLogging ||
 141       G1SATBCardTableModRefBS::is_a(bsn);
 142   }
 143 
 144   void write_ref_field_work(void* field, oop new_val);
 145 
 146   // Can be called from static contexts.
 147   static void write_ref_field_static(void* field, oop new_val);
 148 
 149   // NB: if you do a whole-heap invalidation, the "usual invariant" defined
 150   // above no longer applies.
 151   void invalidate(MemRegion mr, bool whole_heap = false);
 152 
 153   void write_region_work(MemRegion mr)    { invalidate(mr); }
 154   void write_ref_array_work(MemRegion mr) { invalidate(mr); }
 155 
 156 
 157 };
 158 
 159 
 160 #endif // INCLUDE_ALL_GCS
 161 
 162 #endif // SHARE_VM_GC_IMPLEMENTATION_G1_G1SATBCARDTABLEMODREFBS_HPP