1 /*
  2  * Copyright (c) 1997, 2023, 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 #include "precompiled.hpp"
 26 #include "classfile/vmSymbols.hpp"
 27 #include "gc/shared/barrierSet.hpp"
 28 #include "gc/shared/barrierSetAssembler.hpp"
 29 #include "gc/shared/barrierSetNMethod.hpp"
 30 #include "gc/shared/barrierSetStackChunk.hpp"
 31 #include "memory/resourceArea.hpp"
 32 #include "oops/objArrayKlass.inline.hpp"
 33 #include "runtime/continuation.hpp"
 34 #include "runtime/javaThread.hpp"
 35 #include "utilities/debug.hpp"
 36 #include "utilities/macros.hpp"
 37 
 38 BarrierSet* BarrierSet::_barrier_set = nullptr;
 39 
 40 void BarrierSet::set_barrier_set(BarrierSet* barrier_set) {
 41   assert(_barrier_set == nullptr, "Already initialized");
 42   _barrier_set = barrier_set;
 43 
 44   // Notify barrier set of the current (main) thread.  Normally the
 45   // Thread constructor deals with this, but the main thread is
 46   // created before we get here.  Verify it isn't yet on the thread
 47   // list, else we'd also need to call BarrierSet::on_thread_attach.
 48   // This is the only thread that can exist at this point; the Thread
 49   // constructor objects to other threads being created before the
 50   // barrier set is available.
 51   assert(Thread::current()->is_Java_thread(),
 52          "Expected main thread to be a JavaThread");
 53   assert(!JavaThread::current()->on_thread_list(),
 54          "Main thread already on thread list.");
 55   _barrier_set->on_thread_create(Thread::current());
 56 }
 57 
 58 void BarrierSet::throw_array_null_pointer_store_exception(arrayOop src, arrayOop dst, TRAPS) {
 59   ResourceMark rm(THREAD);
 60   Klass* bound = ObjArrayKlass::cast(dst->klass())->element_klass();
 61   stringStream ss;
 62   ss.print("arraycopy: can not copy null values into %s[]",
 63            bound->external_name());
 64   THROW_MSG(vmSymbols::java_lang_NullPointerException(), ss.as_string());
 65 }
 66 
 67 void BarrierSet::throw_array_store_exception(arrayOop src, arrayOop dst, TRAPS) {
 68   ResourceMark rm(THREAD);
 69   Klass* bound = ObjArrayKlass::cast(dst->klass())->element_klass();
 70   Klass* stype = ObjArrayKlass::cast(src->klass())->element_klass();
 71   stringStream ss;
 72   if (!bound->is_subtype_of(stype)) {
 73     ss.print("arraycopy: type mismatch: can not copy %s[] into %s[]",
 74              stype->external_name(), bound->external_name());
 75   } else {
 76     // oop_arraycopy should return the index in the source array that
 77     // contains the problematic oop.
 78     ss.print("arraycopy: element type mismatch: can not cast one of the elements"
 79              " of %s[] to the type of the destination array, %s",
 80              stype->external_name(), bound->external_name());
 81   }
 82   THROW_MSG(vmSymbols::java_lang_ArrayStoreException(), ss.as_string());
 83 }
 84 
 85 static BarrierSetNMethod* select_barrier_set_nmethod(BarrierSetNMethod* barrier_set_nmethod) {
 86   if (barrier_set_nmethod != nullptr) {
 87     // The GC needs nmethod entry barriers to do concurrent GC
 88     return barrier_set_nmethod;
 89   } else {
 90     // The GC needs nmethod entry barriers to deal with continuations
 91     // and code cache unloading
 92     return new BarrierSetNMethod();
 93   }
 94 }
 95 
 96 static BarrierSetStackChunk* select_barrier_set_stack_chunk(BarrierSetStackChunk* barrier_set_stack_chunk) {
 97   if (barrier_set_stack_chunk != nullptr) {
 98     return barrier_set_stack_chunk;
 99   } else {
100     return new BarrierSetStackChunk();
101   }
102 }
103 
104 BarrierSet::BarrierSet(BarrierSetAssembler* barrier_set_assembler,
105                        BarrierSetC1* barrier_set_c1,
106                        BarrierSetC2* barrier_set_c2,
107                        BarrierSetNMethod* barrier_set_nmethod,
108                        BarrierSetStackChunk* barrier_set_stack_chunk,
109                        const FakeRtti& fake_rtti) :
110     _fake_rtti(fake_rtti),
111     _barrier_set_assembler(barrier_set_assembler),
112     _barrier_set_c1(barrier_set_c1),
113     _barrier_set_c2(barrier_set_c2),
114     _barrier_set_nmethod(select_barrier_set_nmethod(barrier_set_nmethod)),
115     _barrier_set_stack_chunk(select_barrier_set_stack_chunk(barrier_set_stack_chunk)) {
116 }
117 
118 void BarrierSet::on_thread_attach(Thread* thread) {
119   BarrierSetNMethod* bs_nm = barrier_set_nmethod();
120   if (bs_nm != nullptr) {
121     thread->set_nmethod_disarmed_guard_value(bs_nm->disarmed_guard_value());
122   }
123 }
124 
125 // Called from init.cpp
126 void gc_barrier_stubs_init() {
127   BarrierSet* bs = BarrierSet::barrier_set();
128 #ifndef ZERO
129   BarrierSetAssembler* bs_assembler = bs->barrier_set_assembler();
130   bs_assembler->barrier_stubs_init();
131 #endif
132 }