1 /*
   2  * Copyright (c) 2018, Red Hat, Inc. All rights reserved.
   3  *
   4  * This code is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License version 2 only, as
   6  * published by the Free Software Foundation.
   7  *
   8  * This code is distributed in the hope that it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  11  * version 2 for more details (a copy is included in the LICENSE file that
  12  * accompanied this code).
  13  *
  14  * You should have received a copy of the GNU General Public License version
  15  * 2 along with this work; if not, write to the Free Software Foundation,
  16  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  17  *
  18  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  19  * or visit www.oracle.com if you need additional information or have any
  20  * questions.
  21  *
  22  */
  23 
  24 #include "precompiled.hpp"
  25 #include "c1/c1_IR.hpp"
  26 #include "gc/shared/satbMarkQueue.hpp"
  27 #include "gc/shenandoah/shenandoahBarrierSetAssembler.hpp"
  28 #include "gc/shenandoah/shenandoahHeap.hpp"
  29 #include "gc/shenandoah/shenandoahHeapRegion.hpp"
  30 #include "gc/shenandoah/shenandoahRuntime.hpp"
  31 #include "gc/shenandoah/shenandoahThreadLocalData.hpp"
  32 #include "gc/shenandoah/c1/shenandoahBarrierSetC1.hpp"
  33 
  34 #ifdef ASSERT
  35 #define __ gen->lir(__FILE__, __LINE__)->
  36 #else
  37 #define __ gen->lir()->
  38 #endif
  39 
  40 void ShenandoahPreBarrierStub::emit_code(LIR_Assembler* ce) {
  41   ShenandoahBarrierSetAssembler* bs = (ShenandoahBarrierSetAssembler*)BarrierSet::barrier_set()->barrier_set_assembler();
  42   bs->gen_pre_barrier_stub(ce, this);
  43 }
  44 
  45 void ShenandoahLoadReferenceBarrierStub::emit_code(LIR_Assembler* ce) {
  46   ShenandoahBarrierSetAssembler* bs = (ShenandoahBarrierSetAssembler*)BarrierSet::barrier_set()->barrier_set_assembler();
  47   bs->gen_load_reference_barrier_stub(ce, this);
  48 }
  49 
  50 void ShenandoahBarrierSetC1::pre_barrier(LIRGenerator* gen, CodeEmitInfo* info, DecoratorSet decorators, LIR_Opr addr_opr, LIR_Opr pre_val) {
  51   // First we test whether marking is in progress.
  52   BasicType flag_type;
  53   bool patch = (decorators & C1_NEEDS_PATCHING) != 0;
  54   bool do_load = pre_val == LIR_OprFact::illegalOpr;
  55   if (in_bytes(SATBMarkQueue::byte_width_of_active()) == 4) {
  56     flag_type = T_INT;
  57   } else {
  58     guarantee(in_bytes(SATBMarkQueue::byte_width_of_active()) == 1,
  59               "Assumption");
  60     // Use unsigned type T_BOOLEAN here rather than signed T_BYTE since some platforms, eg. ARM,
  61     // need to use unsigned instructions to use the large offset to load the satb_mark_queue.
  62     flag_type = T_BOOLEAN;
  63   }
  64   LIR_Opr thrd = gen->getThreadPointer();
  65   LIR_Address* mark_active_flag_addr =
  66     new LIR_Address(thrd,
  67                     in_bytes(ShenandoahThreadLocalData::satb_mark_queue_active_offset()),
  68                     flag_type);
  69   // Read the marking-in-progress flag.
  70   LIR_Opr flag_val = gen->new_register(T_INT);
  71   __ load(mark_active_flag_addr, flag_val);
  72   __ cmp(lir_cond_notEqual, flag_val, LIR_OprFact::intConst(0));
  73 
  74   LIR_PatchCode pre_val_patch_code = lir_patch_none;
  75 
  76   CodeStub* slow;
  77 
  78   if (do_load) {
  79     assert(pre_val == LIR_OprFact::illegalOpr, "sanity");
  80     assert(addr_opr != LIR_OprFact::illegalOpr, "sanity");
  81 
  82     if (patch)
  83       pre_val_patch_code = lir_patch_normal;
  84 
  85     pre_val = gen->new_register(T_OBJECT);
  86 
  87     if (!addr_opr->is_address()) {
  88       assert(addr_opr->is_register(), "must be");
  89       addr_opr = LIR_OprFact::address(new LIR_Address(addr_opr, T_OBJECT));
  90     }
  91     slow = new ShenandoahPreBarrierStub(addr_opr, pre_val, pre_val_patch_code, info ? new CodeEmitInfo(info) : NULL);
  92   } else {
  93     assert(addr_opr == LIR_OprFact::illegalOpr, "sanity");
  94     assert(pre_val->is_register(), "must be");
  95     assert(pre_val->type() == T_OBJECT, "must be an object");
  96 
  97     slow = new ShenandoahPreBarrierStub(pre_val);
  98   }
  99 
 100   __ branch(lir_cond_notEqual, T_INT, slow);
 101   __ branch_destination(slow->continuation());
 102 }
 103 
 104 LIR_Opr ShenandoahBarrierSetC1::load_reference_barrier(LIRGenerator* gen, LIR_Opr obj) {
 105   if (ShenandoahLoadRefBarrier) {
 106     return load_reference_barrier_impl(gen, obj);
 107   } else {
 108     return obj;
 109   }
 110 }
 111 
 112 LIR_Opr ShenandoahBarrierSetC1::load_reference_barrier_impl(LIRGenerator* gen, LIR_Opr obj) {
 113   assert(ShenandoahLoadRefBarrier, "Should be enabled");
 114 
 115   obj = ensure_in_register(gen, obj);
 116   assert(obj->is_register(), "must be a register at this point");
 117   LIR_Opr result = gen->result_register_for(obj->value_type());
 118   __ move(obj, result);
 119   LIR_Opr tmp1 = gen->new_register(T_OBJECT);
 120   LIR_Opr tmp2 = gen->new_register(T_OBJECT);
 121 
 122   LIR_Opr thrd = gen->getThreadPointer();
 123   LIR_Address* active_flag_addr =
 124     new LIR_Address(thrd,
 125                     in_bytes(ShenandoahThreadLocalData::gc_state_offset()),
 126                     T_BYTE);
 127   // Read and check the gc-state-flag.
 128   LIR_Opr flag_val = gen->new_register(T_INT);
 129   __ load(active_flag_addr, flag_val);
 130   LIR_Opr mask = LIR_OprFact::intConst(ShenandoahHeap::HAS_FORWARDED |
 131                                        ShenandoahHeap::EVACUATION |
 132                                        ShenandoahHeap::TRAVERSAL);
 133   LIR_Opr mask_reg = gen->new_register(T_INT);
 134   __ move(mask, mask_reg);
 135 
 136   if (TwoOperandLIRForm) {
 137     __ logical_and(flag_val, mask_reg, flag_val);
 138   } else {
 139     LIR_Opr masked_flag = gen->new_register(T_INT);
 140     __ logical_and(flag_val, mask_reg, masked_flag);
 141     flag_val = masked_flag;
 142   }
 143   __ cmp(lir_cond_notEqual, flag_val, LIR_OprFact::intConst(0));
 144 
 145   CodeStub* slow = new ShenandoahLoadReferenceBarrierStub(obj, result, tmp1, tmp2);
 146   __ branch(lir_cond_notEqual, T_INT, slow);
 147   __ branch_destination(slow->continuation());
 148 
 149   return result;
 150 }
 151 
 152 LIR_Opr ShenandoahBarrierSetC1::ensure_in_register(LIRGenerator* gen, LIR_Opr obj) {
 153   if (!obj->is_register()) {
 154     LIR_Opr obj_reg = gen->new_register(T_OBJECT);
 155     if (obj->is_constant()) {
 156       __ move(obj, obj_reg);
 157     } else {
 158       __ leal(obj, obj_reg);
 159     }
 160     obj = obj_reg;
 161   }
 162   return obj;
 163 }
 164 
 165 LIR_Opr ShenandoahBarrierSetC1::storeval_barrier(LIRGenerator* gen, LIR_Opr obj, CodeEmitInfo* info, DecoratorSet decorators) {
 166   if (ShenandoahStoreValEnqueueBarrier) {
 167     obj = ensure_in_register(gen, obj);
 168     pre_barrier(gen, info, decorators, LIR_OprFact::illegalOpr, obj);
 169   }
 170   return obj;
 171 }
 172 
 173 void ShenandoahBarrierSetC1::store_at_resolved(LIRAccess& access, LIR_Opr value) {
 174   if (access.is_oop()) {
 175     if (ShenandoahSATBBarrier) {
 176       pre_barrier(access.gen(), access.access_emit_info(), access.decorators(), access.resolved_addr(), LIR_OprFact::illegalOpr /* pre_val */);
 177     }
 178     value = storeval_barrier(access.gen(), value, access.access_emit_info(), access.decorators());
 179   }
 180   BarrierSetC1::store_at_resolved(access, value);
 181 }
 182 
 183 void ShenandoahBarrierSetC1::load_at_resolved(LIRAccess& access, LIR_Opr result) {
 184   if (!access.is_oop()) {
 185     BarrierSetC1::load_at_resolved(access, result);
 186     return;
 187   }
 188 
 189   LIRGenerator* gen = access.gen();
 190 
 191   DecoratorSet decorators = access.decorators();
 192   if ((decorators & IN_NATIVE) != 0) {
 193     assert(access.is_oop(), "IN_NATIVE access only for oop values");
 194     BarrierSetC1::load_at_resolved(access, result);
 195     LIR_OprList* args = new LIR_OprList();
 196     args->append(result);
 197     BasicTypeList signature;
 198     signature.append(T_OBJECT);
 199     LIR_Opr call_result = gen->call_runtime(&signature, args,
 200                                             CAST_FROM_FN_PTR(address, ShenandoahRuntime::load_reference_barrier_native),
 201                                             objectType, NULL);
 202     __ move(call_result, result);
 203     return;
 204   }
 205 
 206   if (ShenandoahLoadRefBarrier) {
 207     LIR_Opr tmp = gen->new_register(T_OBJECT);
 208     BarrierSetC1::load_at_resolved(access, tmp);
 209     tmp = load_reference_barrier(access.gen(), tmp);
 210     __ move(tmp, result);
 211   } else {
 212     BarrierSetC1::load_at_resolved(access, result);
 213   }
 214 
 215   if (ShenandoahKeepAliveBarrier) {
 216     bool is_weak = (decorators & ON_WEAK_OOP_REF) != 0;
 217     bool is_phantom = (decorators & ON_PHANTOM_OOP_REF) != 0;
 218     bool is_anonymous = (decorators & ON_UNKNOWN_OOP_REF) != 0;
 219     if (is_weak || is_phantom || is_anonymous) {
 220       // Register the value in the referent field with the pre-barrier
 221       LabelObj *Lcont_anonymous;
 222       if (is_anonymous) {
 223         Lcont_anonymous = new LabelObj();
 224         generate_referent_check(access, Lcont_anonymous);
 225       }
 226       pre_barrier(access.gen(), access.access_emit_info(), access.decorators(), LIR_OprFact::illegalOpr /* addr_opr */,
 227                   result /* pre_val */);
 228       if (is_anonymous) {
 229         __ branch_destination(Lcont_anonymous->label());
 230       }
 231     }
 232   }
 233 }
 234 
 235 class C1ShenandoahPreBarrierCodeGenClosure : public StubAssemblerCodeGenClosure {
 236   virtual OopMapSet* generate_code(StubAssembler* sasm) {
 237     ShenandoahBarrierSetAssembler* bs = (ShenandoahBarrierSetAssembler*)BarrierSet::barrier_set()->barrier_set_assembler();
 238     bs->generate_c1_pre_barrier_runtime_stub(sasm);
 239     return NULL;
 240   }
 241 };
 242 
 243 class C1ShenandoahLoadReferenceBarrierCodeGenClosure : public StubAssemblerCodeGenClosure {
 244   virtual OopMapSet* generate_code(StubAssembler* sasm) {
 245     ShenandoahBarrierSetAssembler* bs = (ShenandoahBarrierSetAssembler*)BarrierSet::barrier_set()->barrier_set_assembler();
 246     bs->generate_c1_load_reference_barrier_runtime_stub(sasm);
 247     return NULL;
 248   }
 249 };
 250 
 251 void ShenandoahBarrierSetC1::generate_c1_runtime_stubs(BufferBlob* buffer_blob) {
 252   C1ShenandoahPreBarrierCodeGenClosure pre_code_gen_cl;
 253   _pre_barrier_c1_runtime_code_blob = Runtime1::generate_blob(buffer_blob, -1,
 254                                                               "shenandoah_pre_barrier_slow",
 255                                                               false, &pre_code_gen_cl);
 256   if (ShenandoahLoadRefBarrier) {
 257     C1ShenandoahLoadReferenceBarrierCodeGenClosure lrb_code_gen_cl;
 258     _load_reference_barrier_rt_code_blob = Runtime1::generate_blob(buffer_blob, -1,
 259                                                                   "shenandoah_load_reference_barrier_slow",
 260                                                                   false, &lrb_code_gen_cl);
 261   }
 262 }
 263 
 264 const char* ShenandoahBarrierSetC1::rtcall_name_for_address(address entry) {
 265   if (entry == CAST_FROM_FN_PTR(address, ShenandoahRuntime::load_reference_barrier_native)) {
 266     return "ShenandoahRuntime::load_reference_barrier_native";
 267   }
 268   return NULL;
 269 }