1 /*
   2  * Copyright (c) 2015, 2019, 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 #include "precompiled.hpp"
  25 #include "classfile/classLoaderDataGraph.hpp"
  26 #include "classfile/stringTable.hpp"
  27 #include "classfile/systemDictionary.hpp"
  28 #include "code/codeCache.hpp"
  29 #include "compiler/oopMap.hpp"
  30 #include "gc/shared/barrierSet.hpp"
  31 #include "gc/shared/barrierSetNMethod.hpp"
  32 #include "gc/shared/oopStorageParState.inline.hpp"
  33 #include "gc/shared/oopStorageSet.hpp"
  34 #include "gc/shared/suspendibleThreadSet.hpp"
  35 #include "gc/z/zBarrierSetNMethod.hpp"
  36 #include "gc/z/zGlobals.hpp"
  37 #include "gc/z/zNMethod.hpp"
  38 #include "gc/z/zOopClosures.inline.hpp"
  39 #include "gc/z/zRootsIterator.hpp"
  40 #include "gc/z/zStat.hpp"
  41 #include "gc/z/zThreadLocalData.hpp"
  42 #include "memory/resourceArea.hpp"
  43 #include "memory/universe.hpp"
  44 #include "prims/jvmtiExport.hpp"
  45 #include "prims/resolvedMethodTable.hpp"
  46 #include "runtime/atomic.hpp"
  47 #include "runtime/thread.hpp"
  48 #include "runtime/safepoint.hpp"
  49 #include "runtime/synchronizer.hpp"
  50 #include "services/management.hpp"
  51 #include "utilities/debug.hpp"
  52 #if INCLUDE_JFR
  53 #include "jfr/jfr.hpp"
  54 #endif
  55 
  56 static const ZStatSubPhase ZSubPhasePauseRootsSetup("Pause Roots Setup");
  57 static const ZStatSubPhase ZSubPhasePauseRoots("Pause Roots");
  58 static const ZStatSubPhase ZSubPhasePauseRootsTeardown("Pause Roots Teardown");
  59 static const ZStatSubPhase ZSubPhasePauseRootsUniverse("Pause Roots Universe");
  60 static const ZStatSubPhase ZSubPhasePauseRootsObjectSynchronizer("Pause Roots ObjectSynchronizer");
  61 static const ZStatSubPhase ZSubPhasePauseRootsManagement("Pause Roots Management");
  62 static const ZStatSubPhase ZSubPhasePauseRootsJVMTIExport("Pause Roots JVMTIExport");
  63 static const ZStatSubPhase ZSubPhasePauseRootsJVMTIWeakExport("Pause Roots JVMTIWeakExport");
  64 static const ZStatSubPhase ZSubPhasePauseRootsSystemDictionary("Pause Roots SystemDictionary");
  65 static const ZStatSubPhase ZSubPhasePauseRootsThreads("Pause Roots Threads");
  66 static const ZStatSubPhase ZSubPhasePauseRootsCodeCache("Pause Roots CodeCache");
  67 
  68 static const ZStatSubPhase ZSubPhaseConcurrentRootsSetup("Concurrent Roots Setup");
  69 static const ZStatSubPhase ZSubPhaseConcurrentRoots("Concurrent Roots");
  70 static const ZStatSubPhase ZSubPhaseConcurrentRootsTeardown("Concurrent Roots Teardown");
  71 static const ZStatSubPhase ZSubPhaseConcurrentRootsJNIHandles("Concurrent Roots JNIHandles");
  72 static const ZStatSubPhase ZSubPhaseConcurrentRootsVMHandles("Concurrent Roots VMHandles");
  73 static const ZStatSubPhase ZSubPhaseConcurrentRootsClassLoaderDataGraph("Concurrent Roots ClassLoaderDataGraph");
  74 
  75 static const ZStatSubPhase ZSubPhasePauseWeakRootsSetup("Pause Weak Roots Setup");
  76 static const ZStatSubPhase ZSubPhasePauseWeakRoots("Pause Weak Roots");
  77 static const ZStatSubPhase ZSubPhasePauseWeakRootsTeardown("Pause Weak Roots Teardown");
  78 static const ZStatSubPhase ZSubPhasePauseWeakRootsJVMTIWeakExport("Pause Weak Roots JVMTIWeakExport");
  79 static const ZStatSubPhase ZSubPhasePauseWeakRootsJFRWeak("Pause Weak Roots JFRWeak");
  80 
  81 static const ZStatSubPhase ZSubPhaseConcurrentWeakRoots("Concurrent Weak Roots");
  82 static const ZStatSubPhase ZSubPhaseConcurrentWeakRootsVMWeakHandles("Concurrent Weak Roots VMWeakHandles");
  83 static const ZStatSubPhase ZSubPhaseConcurrentWeakRootsJNIWeakHandles("Concurrent Weak Roots JNIWeakHandles");
  84 static const ZStatSubPhase ZSubPhaseConcurrentWeakRootsStringTable("Concurrent Weak Roots StringTable");
  85 static const ZStatSubPhase ZSubPhaseConcurrentWeakRootsResolvedMethodTable("Concurrent Weak Roots ResolvedMethodTable");
  86 
  87 template <typename T, void (T::*F)(ZRootsIteratorClosure*)>
  88 ZSerialOopsDo<T, F>::ZSerialOopsDo(T* iter) :
  89     _iter(iter),
  90     _claimed(false) {}
  91 
  92 template <typename T, void (T::*F)(ZRootsIteratorClosure*)>
  93 void ZSerialOopsDo<T, F>::oops_do(ZRootsIteratorClosure* cl) {
  94   if (!_claimed && Atomic::cmpxchg(&_claimed, false, true) == false) {
  95     (_iter->*F)(cl);
  96   }
  97 }
  98 
  99 template <typename T, void (T::*F)(ZRootsIteratorClosure*)>
 100 ZParallelOopsDo<T, F>::ZParallelOopsDo(T* iter) :
 101     _iter(iter),
 102     _completed(false) {}
 103 
 104 template <typename T, void (T::*F)(ZRootsIteratorClosure*)>
 105 void ZParallelOopsDo<T, F>::oops_do(ZRootsIteratorClosure* cl) {
 106   if (!_completed) {
 107     (_iter->*F)(cl);
 108     if (!_completed) {
 109       _completed = true;
 110     }
 111   }
 112 }
 113 
 114 template <typename T, void (T::*F)(BoolObjectClosure*, ZRootsIteratorClosure*)>
 115 ZSerialWeakOopsDo<T, F>::ZSerialWeakOopsDo(T* iter) :
 116     _iter(iter),
 117     _claimed(false) {}
 118 
 119 template <typename T, void (T::*F)(BoolObjectClosure*, ZRootsIteratorClosure*)>
 120 void ZSerialWeakOopsDo<T, F>::weak_oops_do(BoolObjectClosure* is_alive, ZRootsIteratorClosure* cl) {
 121   if (!_claimed && Atomic::cmpxchg(&_claimed, false, true) == false) {
 122     (_iter->*F)(is_alive, cl);
 123   }
 124 }
 125 
 126 template <typename T, void (T::*F)(BoolObjectClosure*, ZRootsIteratorClosure*)>
 127 ZParallelWeakOopsDo<T, F>::ZParallelWeakOopsDo(T* iter) :
 128     _iter(iter),
 129     _completed(false) {}
 130 
 131 template <typename T, void (T::*F)(BoolObjectClosure*, ZRootsIteratorClosure*)>
 132 void ZParallelWeakOopsDo<T, F>::weak_oops_do(BoolObjectClosure* is_alive, ZRootsIteratorClosure* cl) {
 133   if (!_completed) {
 134     (_iter->*F)(is_alive, cl);
 135     if (!_completed) {
 136       _completed = true;
 137     }
 138   }
 139 }
 140 
 141 class ZRootsIteratorCodeBlobClosure : public CodeBlobToOopClosure {
 142 private:
 143   BarrierSetNMethod* _bs;
 144 
 145 public:
 146   ZRootsIteratorCodeBlobClosure(OopClosure* cl) :
 147     CodeBlobToOopClosure(cl, true /* fix_relocations */),
 148     _bs(BarrierSet::barrier_set()->barrier_set_nmethod()) {}
 149 
 150   virtual void do_code_blob(CodeBlob* cb) {
 151     nmethod* const nm = cb->as_nmethod_or_null();
 152     if (nm != NULL && nm->oops_do_try_claim()) {
 153       CodeBlobToOopClosure::do_code_blob(cb);
 154       _bs->disarm(nm);
 155     }
 156   }
 157 };
 158 
 159 class ZRootsIteratorThreadClosure : public ThreadClosure {
 160 private:
 161   ZRootsIteratorClosure* _cl;
 162 
 163 public:
 164   ZRootsIteratorThreadClosure(ZRootsIteratorClosure* cl) :
 165       _cl(cl) {}
 166 
 167   virtual void do_thread(Thread* thread) {
 168     ZRootsIteratorCodeBlobClosure code_cl(_cl);
 169     thread->oops_do(_cl, ClassUnloading ? &code_cl : NULL);
 170     _cl->do_thread(thread);
 171   }
 172 };
 173 
 174 ZRootsIterator::ZRootsIterator(bool visit_jvmti_weak_export) :
 175     _visit_jvmti_weak_export(visit_jvmti_weak_export),
 176     _universe(this),
 177     _object_synchronizer(this),
 178     _management(this),
 179     _jvmti_export(this),
 180     _jvmti_weak_export(this),
 181     _system_dictionary(this),
 182     _threads(this),
 183     _code_cache(this) {
 184   assert(SafepointSynchronize::is_at_safepoint(), "Should be at safepoint");
 185   ZStatTimer timer(ZSubPhasePauseRootsSetup);
 186   Threads::change_thread_claim_token();
 187   COMPILER2_PRESENT(DerivedPointerTable::clear());
 188   if (ClassUnloading) {
 189     nmethod::oops_do_marking_prologue();
 190   } else {
 191     ZNMethod::oops_do_begin();
 192   }
 193 }
 194 
 195 ZRootsIterator::~ZRootsIterator() {
 196   ZStatTimer timer(ZSubPhasePauseRootsTeardown);
 197   ResourceMark rm;
 198   if (ClassUnloading) {
 199     nmethod::oops_do_marking_epilogue();
 200   } else {
 201     ZNMethod::oops_do_end();
 202   }
 203 
 204   COMPILER2_PRESENT(DerivedPointerTable::update_pointers());
 205   Threads::assert_all_threads_claimed();
 206 }
 207 
 208 void ZRootsIterator::do_universe(ZRootsIteratorClosure* cl) {
 209   ZStatTimer timer(ZSubPhasePauseRootsUniverse);
 210   Universe::oops_do(cl);
 211 }
 212 
 213 void ZRootsIterator::do_object_synchronizer(ZRootsIteratorClosure* cl) {
 214   ZStatTimer timer(ZSubPhasePauseRootsObjectSynchronizer);
 215   ObjectSynchronizer::oops_do(cl);
 216 }
 217 
 218 void ZRootsIterator::do_management(ZRootsIteratorClosure* cl) {
 219   ZStatTimer timer(ZSubPhasePauseRootsManagement);
 220   Management::oops_do(cl);
 221 }
 222 
 223 void ZRootsIterator::do_jvmti_export(ZRootsIteratorClosure* cl) {
 224   ZStatTimer timer(ZSubPhasePauseRootsJVMTIExport);
 225   JvmtiExport::oops_do(cl);
 226 }
 227 
 228 void ZRootsIterator::do_jvmti_weak_export(ZRootsIteratorClosure* cl) {
 229   ZStatTimer timer(ZSubPhasePauseRootsJVMTIWeakExport);
 230   AlwaysTrueClosure always_alive;
 231   JvmtiExport::weak_oops_do(&always_alive, cl);
 232 }
 233 
 234 void ZRootsIterator::do_system_dictionary(ZRootsIteratorClosure* cl) {
 235   ZStatTimer timer(ZSubPhasePauseRootsSystemDictionary);
 236   // Handles are processed via _vm_handles.
 237   SystemDictionary::oops_do(cl, false /* include_handles */);
 238 }
 239 
 240 void ZRootsIterator::do_threads(ZRootsIteratorClosure* cl) {
 241   ZStatTimer timer(ZSubPhasePauseRootsThreads);
 242   ResourceMark rm;
 243   ZRootsIteratorThreadClosure thread_cl(cl);
 244   Threads::possibly_parallel_threads_do(true, &thread_cl);
 245 }
 246 
 247 void ZRootsIterator::do_code_cache(ZRootsIteratorClosure* cl) {
 248   ZStatTimer timer(ZSubPhasePauseRootsCodeCache);
 249   ZNMethod::oops_do(cl);
 250 }
 251 
 252 void ZRootsIterator::oops_do(ZRootsIteratorClosure* cl) {
 253   ZStatTimer timer(ZSubPhasePauseRoots);
 254   _universe.oops_do(cl);
 255   _object_synchronizer.oops_do(cl);
 256   _management.oops_do(cl);
 257   _jvmti_export.oops_do(cl);
 258   _system_dictionary.oops_do(cl);
 259   _threads.oops_do(cl);
 260   if (!ClassUnloading) {
 261     _code_cache.oops_do(cl);
 262   }
 263   if (_visit_jvmti_weak_export) {
 264     _jvmti_weak_export.oops_do(cl);
 265   }
 266 }
 267 
 268 ZConcurrentRootsIterator::ZConcurrentRootsIterator(int cld_claim) :
 269     _jni_handles_iter(OopStorageSet::jni_global()),
 270     _vm_handles_iter(OopStorageSet::vm_global()),
 271     _cld_claim(cld_claim),
 272     _jni_handles(this),
 273     _vm_handles(this),
 274     _class_loader_data_graph(this) {
 275   ZStatTimer timer(ZSubPhaseConcurrentRootsSetup);
 276   ClassLoaderDataGraph::clear_claimed_marks(cld_claim);
 277 }
 278 
 279 ZConcurrentRootsIterator::~ZConcurrentRootsIterator() {
 280   ZStatTimer timer(ZSubPhaseConcurrentRootsTeardown);
 281 }
 282 
 283 void ZConcurrentRootsIterator::do_jni_handles(ZRootsIteratorClosure* cl) {
 284   ZStatTimer timer(ZSubPhaseConcurrentRootsJNIHandles);
 285   _jni_handles_iter.oops_do(cl);
 286 }
 287 
 288 void ZConcurrentRootsIterator::do_vm_handles(ZRootsIteratorClosure* cl) {
 289   ZStatTimer timer(ZSubPhaseConcurrentRootsVMHandles);
 290   _vm_handles_iter.oops_do(cl);
 291 }
 292 
 293 void ZConcurrentRootsIterator::do_class_loader_data_graph(ZRootsIteratorClosure* cl) {
 294   ZStatTimer timer(ZSubPhaseConcurrentRootsClassLoaderDataGraph);
 295   CLDToOopClosure cld_cl(cl, _cld_claim);
 296   ClassLoaderDataGraph::always_strong_cld_do(&cld_cl);
 297 }
 298 
 299 void ZConcurrentRootsIterator::oops_do(ZRootsIteratorClosure* cl) {
 300   ZStatTimer timer(ZSubPhaseConcurrentRoots);
 301   _jni_handles.oops_do(cl);
 302   _vm_handles.oops_do(cl),
 303   _class_loader_data_graph.oops_do(cl);
 304 }
 305 
 306 ZWeakRootsIterator::ZWeakRootsIterator() :
 307     _jvmti_weak_export(this),
 308     _jfr_weak(this) {
 309   assert(SafepointSynchronize::is_at_safepoint(), "Should be at safepoint");
 310   ZStatTimer timer(ZSubPhasePauseWeakRootsSetup);
 311 }
 312 
 313 ZWeakRootsIterator::~ZWeakRootsIterator() {
 314   ZStatTimer timer(ZSubPhasePauseWeakRootsTeardown);
 315 }
 316 
 317 void ZWeakRootsIterator::do_jvmti_weak_export(BoolObjectClosure* is_alive, ZRootsIteratorClosure* cl) {
 318   ZStatTimer timer(ZSubPhasePauseWeakRootsJVMTIWeakExport);
 319   JvmtiExport::weak_oops_do(is_alive, cl);
 320 }
 321 
 322 void ZWeakRootsIterator::do_jfr_weak(BoolObjectClosure* is_alive, ZRootsIteratorClosure* cl) {
 323 #if INCLUDE_JFR
 324   ZStatTimer timer(ZSubPhasePauseWeakRootsJFRWeak);
 325   Jfr::weak_oops_do(is_alive, cl);
 326 #endif
 327 }
 328 
 329 void ZWeakRootsIterator::weak_oops_do(BoolObjectClosure* is_alive, ZRootsIteratorClosure* cl) {
 330   ZStatTimer timer(ZSubPhasePauseWeakRoots);
 331   _jvmti_weak_export.weak_oops_do(is_alive, cl);
 332   _jfr_weak.weak_oops_do(is_alive, cl);
 333 }
 334 
 335 void ZWeakRootsIterator::oops_do(ZRootsIteratorClosure* cl) {
 336   AlwaysTrueClosure always_alive;
 337   weak_oops_do(&always_alive, cl);
 338 }
 339 
 340 ZConcurrentWeakRootsIterator::ZConcurrentWeakRootsIterator() :
 341     _vm_weak_handles_iter(OopStorageSet::vm_weak()),
 342     _jni_weak_handles_iter(OopStorageSet::jni_weak()),
 343     _string_table_iter(OopStorageSet::string_table_weak()),
 344     _resolved_method_table_iter(OopStorageSet::resolved_method_table_weak()),
 345     _vm_weak_handles(this),
 346     _jni_weak_handles(this),
 347     _string_table(this),
 348     _resolved_method_table(this) {
 349   StringTable::reset_dead_counter();
 350   ResolvedMethodTable::reset_dead_counter();
 351 }
 352 
 353 ZConcurrentWeakRootsIterator::~ZConcurrentWeakRootsIterator() {
 354   StringTable::finish_dead_counter();
 355   ResolvedMethodTable::finish_dead_counter();
 356 }
 357 
 358 void ZConcurrentWeakRootsIterator::do_vm_weak_handles(ZRootsIteratorClosure* cl) {
 359   ZStatTimer timer(ZSubPhaseConcurrentWeakRootsVMWeakHandles);
 360   _vm_weak_handles_iter.oops_do(cl);
 361 }
 362 
 363 void ZConcurrentWeakRootsIterator::do_jni_weak_handles(ZRootsIteratorClosure* cl) {
 364   ZStatTimer timer(ZSubPhaseConcurrentWeakRootsJNIWeakHandles);
 365   _jni_weak_handles_iter.oops_do(cl);
 366 }
 367 
 368 template <class Container>
 369 class ZDeadCounterClosure : public ZRootsIteratorClosure  {
 370 private:
 371   ZRootsIteratorClosure* const _cl;
 372   size_t                       _ndead;
 373 
 374 public:
 375   ZDeadCounterClosure(ZRootsIteratorClosure* cl) :
 376       _cl(cl),
 377       _ndead(0) {}
 378 
 379   ~ZDeadCounterClosure() {
 380     Container::inc_dead_counter(_ndead);
 381   }
 382 
 383   virtual void do_oop(oop* p) {
 384     _cl->do_oop(p);
 385     if (*p == NULL) {
 386       _ndead++;
 387     }
 388   }
 389 
 390   virtual void do_oop(narrowOop* p) {
 391     ShouldNotReachHere();
 392   }
 393 };
 394 
 395 void ZConcurrentWeakRootsIterator::do_string_table(ZRootsIteratorClosure* cl) {
 396   ZStatTimer timer(ZSubPhaseConcurrentWeakRootsStringTable);
 397   ZDeadCounterClosure<StringTable> counter_cl(cl);
 398   _string_table_iter.oops_do(&counter_cl);
 399 }
 400 
 401 void ZConcurrentWeakRootsIterator::do_resolved_method_table(ZRootsIteratorClosure* cl) {
 402   ZStatTimer timer(ZSubPhaseConcurrentWeakRootsResolvedMethodTable);
 403   ZDeadCounterClosure<ResolvedMethodTable> counter_cl(cl);
 404   _resolved_method_table_iter.oops_do(&counter_cl);
 405 }
 406 
 407 void ZConcurrentWeakRootsIterator::oops_do(ZRootsIteratorClosure* cl) {
 408   ZStatTimer timer(ZSubPhaseConcurrentWeakRoots);
 409   _vm_weak_handles.oops_do(cl);
 410   _jni_weak_handles.oops_do(cl);
 411   _string_table.oops_do(cl);
 412   _resolved_method_table.oops_do(cl);
 413 }