1 /*
   2  * Copyright (c) 2001, 2016, 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_VM_GC_G1_VM_OPERATIONS_G1_HPP
  26 #define SHARE_VM_GC_G1_VM_OPERATIONS_G1_HPP
  27 
  28 #include "gc/g1/g1AllocationContext.hpp"
  29 #include "gc/shared/gcId.hpp"
  30 #include "gc/shared/referencePendingListLocker.hpp"
  31 #include "gc/shared/vmGCOperations.hpp"
  32 
  33 // VM_operations for the G1 collector.
  34 // VM_GC_Operation:
  35 //   - VM_CGC_Operation
  36 //   - VM_G1CollectFull
  37 //   - VM_G1OperationWithAllocRequest
  38 //     - VM_G1CollectForAllocation
  39 //     - VM_G1IncCollectionPause
  40 
  41 class VM_G1OperationWithAllocRequest : public VM_CollectForAllocation {
  42 protected:
  43   bool      _pause_succeeded;
  44   AllocationContext_t _allocation_context;
  45 
  46 public:
  47   VM_G1OperationWithAllocRequest(uint           gc_count_before,
  48                                  size_t         word_size,
  49                                  GCCause::Cause gc_cause)
  50     : VM_CollectForAllocation(word_size, gc_count_before, gc_cause),
  51       _pause_succeeded(false) {}
  52   bool pause_succeeded() { return _pause_succeeded; }
  53   void set_allocation_context(AllocationContext_t context) { _allocation_context = context; }
  54   AllocationContext_t  allocation_context() { return _allocation_context; }
  55 };
  56 
  57 class VM_G1CollectFull: public VM_GC_Operation {
  58 public:
  59   VM_G1CollectFull(uint gc_count_before,
  60                    uint full_gc_count_before,
  61                    GCCause::Cause cause)
  62     : VM_GC_Operation(gc_count_before, cause, full_gc_count_before, true) { }
  63   virtual VMOp_Type type() const { return VMOp_G1CollectFull; }
  64   virtual void doit();
  65   virtual const char* name() const {
  66     return "full garbage-first collection";
  67   }
  68 };
  69 
  70 class VM_G1CollectForAllocation: public VM_G1OperationWithAllocRequest {
  71 public:
  72   VM_G1CollectForAllocation(uint         gc_count_before,
  73                             size_t       word_size);
  74   virtual VMOp_Type type() const { return VMOp_G1CollectForAllocation; }
  75   virtual void doit();
  76   virtual const char* name() const {
  77     return "garbage-first collection to satisfy allocation";
  78   }
  79 };
  80 
  81 class VM_G1IncCollectionPause: public VM_G1OperationWithAllocRequest {
  82 private:
  83   bool         _should_initiate_conc_mark;
  84   bool         _should_retry_gc;
  85   double       _target_pause_time_ms;
  86   uint         _old_marking_cycles_completed_before;
  87 public:
  88   VM_G1IncCollectionPause(uint           gc_count_before,
  89                           size_t         word_size,
  90                           bool           should_initiate_conc_mark,
  91                           double         target_pause_time_ms,
  92                           GCCause::Cause gc_cause);
  93   virtual VMOp_Type type() const { return VMOp_G1IncCollectionPause; }
  94   virtual bool doit_prologue();
  95   virtual void doit();
  96   virtual void doit_epilogue();
  97   virtual const char* name() const {
  98     return "garbage-first incremental collection pause";
  99   }
 100   bool should_retry_gc() const { return _should_retry_gc; }
 101 };
 102 
 103 // Concurrent GC stop-the-world operations such as remark and cleanup;
 104 // consider sharing these with CMS's counterparts.
 105 class VM_CGC_Operation: public VM_Operation {
 106   VoidClosure*               _cl;
 107   const char*                _printGCMessage;
 108   bool                       _needs_pending_list_lock;
 109   ReferencePendingListLocker _pending_list_locker;
 110   uint                       _gc_id;
 111 
 112 protected:
 113   // java.lang.ref.Reference support
 114   void acquire_pending_list_lock();
 115   void release_and_notify_pending_list_lock();
 116 
 117 public:
 118   VM_CGC_Operation(VoidClosure* cl, const char *printGCMsg, bool needs_pending_list_lock)
 119     : _cl(cl), _printGCMessage(printGCMsg), _needs_pending_list_lock(needs_pending_list_lock), _gc_id(GCId::current()) {}
 120   virtual VMOp_Type type() const { return VMOp_CGC_Operation; }
 121   virtual void doit();
 122   virtual bool doit_prologue();
 123   virtual void doit_epilogue();
 124   virtual const char* name() const {
 125     return "concurrent gc";
 126   }
 127 };
 128 
 129 #endif // SHARE_VM_GC_G1_VM_OPERATIONS_G1_HPP