1 /*
   2  * Copyright (c) 2001, 2020, 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 #ifndef SHARE_GC_G1_G1CONCURRENTMARKTHREAD_HPP
  26 #define SHARE_GC_G1_G1CONCURRENTMARKTHREAD_HPP
  27 
  28 #include "gc/shared/concurrentGCThread.hpp"
  29 
  30 class G1ConcurrentMark;
  31 class G1Policy;
  32 
  33 // The concurrent mark thread triggers the various steps of the concurrent marking
  34 // cycle, including various marking cleanup.
  35 class G1ConcurrentMarkThread: public ConcurrentGCThread {
  36   friend class VMStructs;
  37 
  38   double _vtime_start;  // Initial virtual time.
  39   double _vtime_accum;  // Accumulated virtual time.
  40 
  41   G1ConcurrentMark* _cm;
  42 
  43   enum ServiceState {
  44     Idle,
  45     Started,
  46     InProgress
  47   };
  48 
  49   volatile ServiceState _state;
  50 
  51   // Wait for next cycle. Returns true if we should stop the service.
  52   bool wait_for_next_cycle();
  53 
  54   // Phases for the full concurrent marking cycle in order.
  55   //
  56   // We have to ensure that we finish scanning the root regions
  57   // before the next GC takes place. To ensure this we have to
  58   // make sure that we do not join the STS until the root regions
  59   // have been scanned. If we did then it's possible that a
  60   // subsequent GC could block us from joining the STS and proceed
  61   // without the root regions have been scanned which would be a
  62   // correctness issue.
  63   // ConcurrentGCBreakpoints must not be placed before the the root
  64   // region scan phase too for this reason.
  65   bool phase_concurrent_cycle_start();
  66   bool phase_clear_cld_claimed_marks();
  67   bool phase_scan_root_regions();
  68 
  69   bool phase_mark_loop();
  70   bool mark_loop_needs_restart() const;
  71   bool subphase_mark_from_roots();
  72   bool subphase_preclean();
  73   bool subphase_delay_to_keep_mmu_before_remark();
  74   bool subphase_remark();
  75   bool phase_rebuild_remembered_sets();
  76   bool phase_delay_to_keep_mmu_before_cleanup();
  77   bool phase_cleanup();
  78   bool phase_clear_bitmap_for_next_mark();
  79 
  80   void concurrent_cycle_start();
  81   // Perform a full concurrent cycle.
  82   void full_concurrent_cycle_do();
  83   void concurrent_cycle_end();
  84 
  85   // Delay pauses to meet MMU.
  86   void delay_to_keep_mmu(bool remark);
  87   double mmu_delay_end(G1Policy* policy, bool remark);
  88 
  89   void run_service();
  90   void stop_service();
  91 
  92  public:
  93   // Constructor
  94   G1ConcurrentMarkThread(G1ConcurrentMark* cm);
  95 
  96   // Total virtual time so far for this thread and concurrent marking tasks.
  97   double vtime_accum();
  98   // Marking virtual time so far this thread and concurrent marking tasks.
  99   double vtime_mark_accum();
 100 
 101   G1ConcurrentMark* cm()   { return _cm; }
 102 
 103   void set_idle()          { assert(_state != Started, "must not be starting a new cycle"); _state = Idle; }
 104   bool idle()              { return _state == Idle; }
 105   void set_started()       { assert(_state == Idle, "cycle in progress"); _state = Started; }
 106   bool started()           { return _state == Started; }
 107   void set_in_progress()   { assert(_state == Started, "must be starting a cycle"); _state = InProgress; }
 108   bool in_progress()       { return _state == InProgress; }
 109 
 110   // Returns true from the moment a marking cycle is
 111   // initiated (during the concurrent start pause when started() is set)
 112   // to the moment when the cycle completes (just after the next
 113   // marking bitmap has been cleared and in_progress() is
 114   // cleared). While during_cycle() is true we will not start another cycle
 115   // so that cycles do not overlap. We cannot use just in_progress()
 116   // as the CM thread might take some time to wake up before noticing
 117   // that started() is set and set in_progress().
 118   bool during_cycle()      { return !idle(); }
 119 };
 120 
 121 #endif // SHARE_GC_G1_G1CONCURRENTMARKTHREAD_HPP