1 /*
   2  * Copyright (c) 2015, 2019, 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 #ifndef SHARE_GC_SHENANDOAH_SHENANDOAHROOTPROCESSOR_HPP
  25 #define SHARE_GC_SHENANDOAH_SHENANDOAHROOTPROCESSOR_HPP
  26 
  27 #include "code/codeCache.hpp"
  28 #include "gc/shared/oopStorageParState.hpp"
  29 #include "gc/shenandoah/shenandoahCodeRoots.hpp"
  30 #include "gc/shenandoah/shenandoahHeap.hpp"
  31 #include "gc/shenandoah/shenandoahPhaseTimings.hpp"
  32 #include "gc/shared/strongRootsScope.hpp"
  33 #include "gc/shared/weakProcessor.hpp"
  34 #include "gc/shared/weakProcessorPhaseTimes.hpp"
  35 #include "gc/shared/workgroup.hpp"
  36 #include "memory/allocation.hpp"
  37 #include "memory/iterator.hpp"
  38 
  39 class ParallelCLDRootIterator {
  40 public:
  41   ParallelCLDRootIterator();
  42   void root_cld_do(CLDClosure* strong, CLDClosure* weak);
  43 };
  44 
  45 enum Shenandoah_process_roots_tasks {
  46   SHENANDOAH_RP_PS_Universe_oops_do,
  47   SHENANDOAH_RP_PS_JNIHandles_oops_do,
  48   SHENANDOAH_RP_PS_ObjectSynchronizer_oops_do,
  49   SHENANDOAH_RP_PS_Management_oops_do,
  50   SHENANDOAH_RP_PS_SystemDictionary_oops_do,
  51   SHENANDOAH_RP_PS_jvmti_oops_do,
  52   // Leave this one last.
  53   SHENANDOAH_RP_PS_NumElements
  54 };
  55 
  56 class ShenandoahRootProcessor : public StackObj {
  57   SubTasksDone* _process_strong_tasks;
  58   StrongRootsScope _srs;
  59   OopStorage::ParState<false, false> _par_state_string;
  60   ShenandoahPhaseTimings::Phase _phase;
  61   ParallelCLDRootIterator _cld_iterator;
  62   ShenandoahAllCodeRootsIterator _coderoots_all_iterator;
  63   CodeBlobClosure* _threads_nmethods_cl;
  64   WeakProcessorPhaseTimes _weak_processor_timings;
  65   WeakProcessor::Task     _weak_processor_task;
  66   bool                    _processed_weak_roots;
  67 
  68   void process_java_roots(OopClosure* scan_non_heap_roots,
  69                           CLDClosure* scan_strong_clds,
  70                           CLDClosure* scan_weak_clds,
  71                           CodeBlobClosure* scan_strong_code,
  72                           ThreadClosure* thread_cl,
  73                           uint worker_i);
  74 
  75   void process_vm_roots(OopClosure* scan_non_heap_roots,
  76                         uint worker_i);
  77 
  78   void weak_processor_timing_to_shenandoah_timing(const WeakProcessorPhases::Phase wpp,
  79                                                   const ShenandoahPhaseTimings::GCParPhases spp,
  80                                                   ShenandoahWorkerTimings* worker_times) const;
  81 
  82 public:
  83   ShenandoahRootProcessor(ShenandoahHeap* heap, uint n_workers,
  84                           ShenandoahPhaseTimings::Phase phase);
  85   ~ShenandoahRootProcessor();
  86 
  87   // Apply oops, clds and blobs to all strongly reachable roots in the system.
  88   // Optionally, apply class loader closure to weak clds, depending on class unloading
  89   // for the particular GC cycles.
  90   void process_strong_roots(OopClosure* oops,
  91                             CLDClosure* clds,
  92                             CodeBlobClosure* blobs,
  93                             ThreadClosure* thread_cl,
  94                             uint worker_id);
  95 
  96   // Apply oops, clds and blobs to strongly reachable roots in the system
  97   void process_all_roots(OopClosure* oops,
  98                          CLDClosure* clds,
  99                          CodeBlobClosure* blobs,
 100                          ThreadClosure* thread_cl,
 101                          uint worker_id);
 102 
 103   // Apply oops, clds and blobs to strongly and weakly reachable roots in the system
 104   template <typename IsAlive>
 105   void update_all_roots(OopClosure* oops,
 106                         CLDClosure* clds,
 107                         CodeBlobClosure* blobs,
 108                         ThreadClosure* thread_cl,
 109                         uint worker_id);
 110 
 111   // For slow debug/verification code
 112   void process_all_roots_slow(OopClosure* oops);
 113 
 114   // Number of worker threads used by the root processor.
 115   uint n_workers() const;
 116 };
 117 
 118 class ShenandoahRootEvacuator : public StackObj {
 119   SubTasksDone* _evacuation_tasks;
 120   StrongRootsScope _srs;
 121   ShenandoahPhaseTimings::Phase _phase;
 122   ShenandoahCsetCodeRootsIterator _coderoots_cset_iterator;
 123   OopStorage::ParState<false, false> _par_state_string;
 124 
 125   enum Shenandoah_evacuate_roots_tasks {
 126     SHENANDOAH_EVAC_Universe_oops_do,
 127     SHENANDOAH_EVAC_ObjectSynchronizer_oops_do,
 128     SHENANDOAH_EVAC_Management_oops_do,
 129     SHENANDOAH_EVAC_SystemDictionary_oops_do,
 130     SHENANDOAH_EVAC_jvmti_oops_do,
 131     // Leave this one last.
 132     SHENANDOAH_EVAC_NumElements
 133   };
 134 public:
 135   ShenandoahRootEvacuator(ShenandoahHeap* heap, uint n_workers,
 136                           ShenandoahPhaseTimings::Phase phase);
 137   ~ShenandoahRootEvacuator();
 138 
 139   void process_evacuate_roots(OopClosure* oops,
 140                               CodeBlobClosure* blobs,
 141                               uint worker_id);
 142 
 143   // Number of worker threads used by the root processor.
 144   uint n_workers() const;
 145 };
 146 #endif // SHARE_GC_SHENANDOAH_SHENANDOAHROOTPROCESSOR_HPP