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(true, &_claimed, false) == 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(true, &_claimed, false) == 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* const _bs;
 144   const bool               _disarm_nmethods;
 145 
 146 public:
 147   ZRootsIteratorCodeBlobClosure(OopClosure* cl, bool disarm_nmethods) :
 148     CodeBlobToOopClosure(cl, true /* fix_relocations */),
 149     _bs(BarrierSet::barrier_set()->barrier_set_nmethod()),
 150     _disarm_nmethods(disarm_nmethods) {}
 151 
 152   virtual void do_code_blob(CodeBlob* cb) {
 153     nmethod* const nm = cb->as_nmethod_or_null();
 154     if (nm != NULL && nm->oops_do_try_claim()) {
 155       CodeBlobToOopClosure::do_code_blob(cb);
 156       if (_disarm_nmethods) {
 157         _bs->disarm(nm);
 158       }
 159     }
 160   }
 161 };
 162 
 163 class ZRootsIteratorThreadClosure : public ThreadClosure {
 164 private:
 165   ZRootsIteratorClosure* const _cl;
 166   const bool                   _disarm_nmethods;
 167 
 168 public:
 169   ZRootsIteratorThreadClosure(ZRootsIteratorClosure* cl, bool disarm_nmethods) :
 170       _cl(cl),
 171       _disarm_nmethods(disarm_nmethods) {}
 172 
 173   virtual void do_thread(Thread* thread) {
 174     ZRootsIteratorCodeBlobClosure code_cl(_cl, _disarm_nmethods);
 175     thread->oops_do(_cl, ClassUnloading ? &code_cl : NULL);
 176     _cl->do_thread(thread);
 177   }
 178 };
 179 
 180 ZRootsIterator::ZRootsIterator(bool visit_jvmti_weak_export, bool disarm_nmethods) :
 181     _visit_jvmti_weak_export(visit_jvmti_weak_export),
 182     _disarm_nmethods(disarm_nmethods),
 183     _universe(this),
 184     _object_synchronizer(this),
 185     _management(this),
 186     _jvmti_export(this),
 187     _jvmti_weak_export(this),
 188     _system_dictionary(this),
 189     _threads(this),
 190     _code_cache(this) {
 191   assert(SafepointSynchronize::is_at_safepoint(), "Should be at safepoint");
 192   ZStatTimer timer(ZSubPhasePauseRootsSetup);
 193   Threads::change_thread_claim_token();
 194   COMPILER2_PRESENT(DerivedPointerTable::clear());
 195   if (ClassUnloading) {
 196     nmethod::oops_do_marking_prologue();
 197   } else {
 198     ZNMethod::oops_do_begin();
 199   }
 200 }
 201 
 202 ZRootsIterator::~ZRootsIterator() {
 203   ZStatTimer timer(ZSubPhasePauseRootsTeardown);
 204   ResourceMark rm;
 205   if (ClassUnloading) {
 206     nmethod::oops_do_marking_epilogue();
 207   } else {
 208     ZNMethod::oops_do_end();
 209   }
 210 
 211   COMPILER2_PRESENT(DerivedPointerTable::update_pointers());
 212   Threads::assert_all_threads_claimed();
 213 }
 214 
 215 void ZRootsIterator::do_universe(ZRootsIteratorClosure* cl) {
 216   ZStatTimer timer(ZSubPhasePauseRootsUniverse);
 217   Universe::oops_do(cl);
 218 }
 219 
 220 void ZRootsIterator::do_object_synchronizer(ZRootsIteratorClosure* cl) {
 221   ZStatTimer timer(ZSubPhasePauseRootsObjectSynchronizer);
 222   ObjectSynchronizer::oops_do(cl);
 223 }
 224 
 225 void ZRootsIterator::do_management(ZRootsIteratorClosure* cl) {
 226   ZStatTimer timer(ZSubPhasePauseRootsManagement);
 227   Management::oops_do(cl);
 228 }
 229 
 230 void ZRootsIterator::do_jvmti_export(ZRootsIteratorClosure* cl) {
 231   ZStatTimer timer(ZSubPhasePauseRootsJVMTIExport);
 232   JvmtiExport::oops_do(cl);
 233 }
 234 
 235 void ZRootsIterator::do_jvmti_weak_export(ZRootsIteratorClosure* cl) {
 236   ZStatTimer timer(ZSubPhasePauseRootsJVMTIWeakExport);
 237   AlwaysTrueClosure always_alive;
 238   JvmtiExport::weak_oops_do(&always_alive, cl);
 239 }
 240 
 241 void ZRootsIterator::do_system_dictionary(ZRootsIteratorClosure* cl) {
 242   ZStatTimer timer(ZSubPhasePauseRootsSystemDictionary);
 243   // Handles are processed via _vm_handles.
 244   SystemDictionary::oops_do(cl, false /* include_handles */);
 245 }
 246 
 247 void ZRootsIterator::do_threads(ZRootsIteratorClosure* cl) {
 248   ZStatTimer timer(ZSubPhasePauseRootsThreads);
 249   ResourceMark rm;
 250   ZRootsIteratorThreadClosure thread_cl(cl, _disarm_nmethods);
 251   Threads::possibly_parallel_threads_do(true, &thread_cl);
 252 }
 253 
 254 void ZRootsIterator::do_code_cache(ZRootsIteratorClosure* cl) {
 255   ZStatTimer timer(ZSubPhasePauseRootsCodeCache);
 256   ZNMethod::oops_do(cl);
 257 }
 258 
 259 void ZRootsIterator::oops_do(ZRootsIteratorClosure* cl) {
 260   ZStatTimer timer(ZSubPhasePauseRoots);
 261   _universe.oops_do(cl);
 262   _object_synchronizer.oops_do(cl);
 263   _management.oops_do(cl);
 264   _jvmti_export.oops_do(cl);
 265   _system_dictionary.oops_do(cl);
 266   _threads.oops_do(cl);
 267   if (!ClassUnloading) {
 268     _code_cache.oops_do(cl);
 269   }
 270   if (_visit_jvmti_weak_export) {
 271     _jvmti_weak_export.oops_do(cl);
 272   }
 273 }
 274 
 275 ZConcurrentRootsIterator::ZConcurrentRootsIterator(int cld_claim) :
 276     _jni_handles_iter(OopStorageSet::jni_global()),
 277     _vm_handles_iter(OopStorageSet::vm_global()),
 278     _cld_claim(cld_claim),
 279     _jni_handles(this),
 280     _vm_handles(this),
 281     _class_loader_data_graph(this) {
 282   ZStatTimer timer(ZSubPhaseConcurrentRootsSetup);
 283   ClassLoaderDataGraph::clear_claimed_marks(cld_claim);
 284 }
 285 
 286 ZConcurrentRootsIterator::~ZConcurrentRootsIterator() {
 287   ZStatTimer timer(ZSubPhaseConcurrentRootsTeardown);
 288 }
 289 
 290 void ZConcurrentRootsIterator::do_jni_handles(ZRootsIteratorClosure* cl) {
 291   ZStatTimer timer(ZSubPhaseConcurrentRootsJNIHandles);
 292   _jni_handles_iter.oops_do(cl);
 293 }
 294 
 295 void ZConcurrentRootsIterator::do_vm_handles(ZRootsIteratorClosure* cl) {
 296   ZStatTimer timer(ZSubPhaseConcurrentRootsVMHandles);
 297   _vm_handles_iter.oops_do(cl);
 298 }
 299 
 300 void ZConcurrentRootsIterator::do_class_loader_data_graph(ZRootsIteratorClosure* cl) {
 301   ZStatTimer timer(ZSubPhaseConcurrentRootsClassLoaderDataGraph);
 302   CLDToOopClosure cld_cl(cl, _cld_claim);
 303   ClassLoaderDataGraph::always_strong_cld_do(&cld_cl);
 304 }
 305 
 306 void ZConcurrentRootsIterator::oops_do(ZRootsIteratorClosure* cl) {
 307   ZStatTimer timer(ZSubPhaseConcurrentRoots);
 308   _jni_handles.oops_do(cl);
 309   _vm_handles.oops_do(cl),
 310   _class_loader_data_graph.oops_do(cl);
 311 }
 312 
 313 ZWeakRootsIterator::ZWeakRootsIterator() :
 314     _jvmti_weak_export(this),
 315     _jfr_weak(this) {
 316   assert(SafepointSynchronize::is_at_safepoint(), "Should be at safepoint");
 317   ZStatTimer timer(ZSubPhasePauseWeakRootsSetup);
 318 }
 319 
 320 ZWeakRootsIterator::~ZWeakRootsIterator() {
 321   ZStatTimer timer(ZSubPhasePauseWeakRootsTeardown);
 322 }
 323 
 324 void ZWeakRootsIterator::do_jvmti_weak_export(BoolObjectClosure* is_alive, ZRootsIteratorClosure* cl) {
 325   ZStatTimer timer(ZSubPhasePauseWeakRootsJVMTIWeakExport);
 326   JvmtiExport::weak_oops_do(is_alive, cl);
 327 }
 328 
 329 void ZWeakRootsIterator::do_jfr_weak(BoolObjectClosure* is_alive, ZRootsIteratorClosure* cl) {
 330 #if INCLUDE_JFR
 331   ZStatTimer timer(ZSubPhasePauseWeakRootsJFRWeak);
 332   Jfr::weak_oops_do(is_alive, cl);
 333 #endif
 334 }
 335 
 336 void ZWeakRootsIterator::weak_oops_do(BoolObjectClosure* is_alive, ZRootsIteratorClosure* cl) {
 337   ZStatTimer timer(ZSubPhasePauseWeakRoots);
 338   _jvmti_weak_export.weak_oops_do(is_alive, cl);
 339   _jfr_weak.weak_oops_do(is_alive, cl);
 340 }
 341 
 342 void ZWeakRootsIterator::oops_do(ZRootsIteratorClosure* cl) {
 343   AlwaysTrueClosure always_alive;
 344   weak_oops_do(&always_alive, cl);
 345 }
 346 
 347 ZConcurrentWeakRootsIterator::ZConcurrentWeakRootsIterator() :
 348     _vm_weak_handles_iter(OopStorageSet::vm_weak()),
 349     _jni_weak_handles_iter(OopStorageSet::jni_weak()),
 350     _string_table_iter(OopStorageSet::string_table_weak()),
 351     _resolved_method_table_iter(OopStorageSet::resolved_method_table_weak()),
 352     _vm_weak_handles(this),
 353     _jni_weak_handles(this),
 354     _string_table(this),
 355     _resolved_method_table(this) {
 356   StringTable::reset_dead_counter();
 357   ResolvedMethodTable::reset_dead_counter();
 358 }
 359 
 360 ZConcurrentWeakRootsIterator::~ZConcurrentWeakRootsIterator() {
 361   StringTable::finish_dead_counter();
 362   ResolvedMethodTable::finish_dead_counter();
 363 }
 364 
 365 void ZConcurrentWeakRootsIterator::do_vm_weak_handles(ZRootsIteratorClosure* cl) {
 366   ZStatTimer timer(ZSubPhaseConcurrentWeakRootsVMWeakHandles);
 367   _vm_weak_handles_iter.oops_do(cl);
 368 }
 369 
 370 void ZConcurrentWeakRootsIterator::do_jni_weak_handles(ZRootsIteratorClosure* cl) {
 371   ZStatTimer timer(ZSubPhaseConcurrentWeakRootsJNIWeakHandles);
 372   _jni_weak_handles_iter.oops_do(cl);
 373 }
 374 
 375 template <class Container>
 376 class ZDeadCounterClosure : public ZRootsIteratorClosure  {
 377 private:
 378   ZRootsIteratorClosure* const _cl;
 379   size_t                       _ndead;
 380 
 381 public:
 382   ZDeadCounterClosure(ZRootsIteratorClosure* cl) :
 383       _cl(cl),
 384       _ndead(0) {}
 385 
 386   ~ZDeadCounterClosure() {
 387     Container::inc_dead_counter(_ndead);
 388   }
 389 
 390   virtual void do_oop(oop* p) {
 391     _cl->do_oop(p);
 392     if (*p == NULL) {
 393       _ndead++;
 394     }
 395   }
 396 
 397   virtual void do_oop(narrowOop* p) {
 398     ShouldNotReachHere();
 399   }
 400 };
 401 
 402 void ZConcurrentWeakRootsIterator::do_string_table(ZRootsIteratorClosure* cl) {
 403   ZStatTimer timer(ZSubPhaseConcurrentWeakRootsStringTable);
 404   ZDeadCounterClosure<StringTable> counter_cl(cl);
 405   _string_table_iter.oops_do(&counter_cl);
 406 }
 407 
 408 void ZConcurrentWeakRootsIterator::do_resolved_method_table(ZRootsIteratorClosure* cl) {
 409   ZStatTimer timer(ZSubPhaseConcurrentWeakRootsResolvedMethodTable);
 410   ZDeadCounterClosure<ResolvedMethodTable> counter_cl(cl);
 411   _resolved_method_table_iter.oops_do(&counter_cl);
 412 }
 413 
 414 void ZConcurrentWeakRootsIterator::oops_do(ZRootsIteratorClosure* cl) {
 415   ZStatTimer timer(ZSubPhaseConcurrentWeakRoots);
 416   _vm_weak_handles.oops_do(cl);
 417   _jni_weak_handles.oops_do(cl);
 418   _string_table.oops_do(cl);
 419   _resolved_method_table.oops_do(cl);
 420 }