Wed, 23 Jan 2013 13:02:39 -0500
8005915: Unify SERIALGC and INCLUDE_ALTERNATE_GCS
Summary: Rename INCLUDE_ALTERNATE_GCS to INCLUDE_ALL_GCS and replace SERIALGC with INCLUDE_ALL_GCS.
Reviewed-by: coleenp, stefank
1 /*
2 * Copyright (c) 2005, 2012, 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 */
25 #ifndef SHARE_VM_GC_IMPLEMENTATION_SHARED_VMGCOPERATIONS_HPP
26 #define SHARE_VM_GC_IMPLEMENTATION_SHARED_VMGCOPERATIONS_HPP
28 #include "memory/heapInspection.hpp"
29 #include "runtime/handles.hpp"
30 #include "runtime/jniHandles.hpp"
31 #include "runtime/synchronizer.hpp"
32 #include "runtime/vm_operations.hpp"
33 #include "prims/jvmtiExport.hpp"
35 // The following class hierarchy represents
36 // a set of operations (VM_Operation) related to GC.
37 //
38 // VM_Operation
39 // VM_GC_Operation
40 // VM_GC_HeapInspection
41 // VM_GenCollectForAllocation
42 // VM_GenCollectFull
43 // VM_GenCollectFullConcurrent
44 // VM_ParallelGCFailedAllocation
45 // VM_ParallelGCSystemGC
46 // VM_GC_Operation
47 // - implements methods common to all classes in the hierarchy:
48 // prevents multiple gc requests and manages lock on heap;
49 //
50 // VM_GC_HeapInspection
51 // - prints class histogram on SIGBREAK if PrintClassHistogram
52 // is specified; and also the attach "inspectheap" operation
53 //
54 // VM_GenCollectForAllocation
55 // VM_ParallelGCFailedAllocation
56 // - this operation is invoked when allocation is failed;
57 // operation performs garbage collection and tries to
58 // allocate afterwards;
59 //
60 // VM_GenCollectFull
61 // VM_GenCollectFullConcurrent
62 // VM_ParallelGCSystemGC
63 // - these operations preform full collection of heaps of
64 // different kind
65 //
67 class VM_GC_Operation: public VM_Operation {
68 protected:
69 BasicLock _pending_list_basic_lock; // for refs pending list notification (PLL)
70 unsigned int _gc_count_before; // gc count before acquiring PLL
71 unsigned int _full_gc_count_before; // full gc count before acquiring PLL
72 bool _full; // whether a "full" collection
73 bool _prologue_succeeded; // whether doit_prologue succeeded
74 GCCause::Cause _gc_cause; // the putative cause for this gc op
75 bool _gc_locked; // will be set if gc was locked
77 virtual bool skip_operation() const;
79 // java.lang.ref.Reference support
80 void acquire_pending_list_lock();
81 void release_and_notify_pending_list_lock();
83 public:
84 VM_GC_Operation(unsigned int gc_count_before,
85 GCCause::Cause _cause,
86 unsigned int full_gc_count_before = 0,
87 bool full = false) {
88 _full = full;
89 _prologue_succeeded = false;
90 _gc_count_before = gc_count_before;
92 // A subclass constructor will likely overwrite the following
93 _gc_cause = _cause;
95 _gc_locked = false;
97 _full_gc_count_before = full_gc_count_before;
98 // In ParallelScavengeHeap::mem_allocate() collections can be
99 // executed within a loop and _all_soft_refs_clear can be set
100 // true after they have been cleared by a collection and another
101 // collection started so that _all_soft_refs_clear can be true
102 // when this collection is started. Don't assert that
103 // _all_soft_refs_clear have to be false here even though
104 // mutators have run. Soft refs will be cleared again in this
105 // collection.
106 }
107 ~VM_GC_Operation() {
108 CollectedHeap* ch = Universe::heap();
109 ch->collector_policy()->set_all_soft_refs_clear(false);
110 }
112 // Acquire the reference synchronization lock
113 virtual bool doit_prologue();
114 // Do notifyAll (if needed) and release held lock
115 virtual void doit_epilogue();
117 virtual bool allow_nested_vm_operations() const { return true; }
118 bool prologue_succeeded() const { return _prologue_succeeded; }
120 void set_gc_locked() { _gc_locked = true; }
121 bool gc_locked() const { return _gc_locked; }
123 static void notify_gc_begin(bool full = false);
124 static void notify_gc_end();
125 };
128 class VM_GC_HeapInspection: public VM_GC_Operation {
129 private:
130 outputStream* _out;
131 bool _full_gc;
132 bool _need_prologue;
133 public:
134 VM_GC_HeapInspection(outputStream* out, bool request_full_gc,
135 bool need_prologue) :
136 VM_GC_Operation(0 /* total collections, dummy, ignored */,
137 GCCause::_heap_inspection /* GC Cause */,
138 0 /* total full collections, dummy, ignored */,
139 request_full_gc) {
140 _out = out;
141 _full_gc = request_full_gc;
142 _need_prologue = need_prologue;
143 }
145 ~VM_GC_HeapInspection() {}
146 virtual VMOp_Type type() const { return VMOp_GC_HeapInspection; }
147 virtual bool skip_operation() const;
148 virtual bool doit_prologue();
149 virtual void doit();
150 };
153 class VM_GenCollectForAllocation: public VM_GC_Operation {
154 private:
155 HeapWord* _res;
156 size_t _size; // size of object to be allocated.
157 bool _tlab; // alloc is of a tlab.
158 public:
159 VM_GenCollectForAllocation(size_t size,
160 bool tlab,
161 unsigned int gc_count_before)
162 : VM_GC_Operation(gc_count_before, GCCause::_allocation_failure),
163 _size(size),
164 _tlab(tlab) {
165 _res = NULL;
166 }
167 ~VM_GenCollectForAllocation() {}
168 virtual VMOp_Type type() const { return VMOp_GenCollectForAllocation; }
169 virtual void doit();
170 HeapWord* result() const { return _res; }
171 };
174 // VM operation to invoke a collection of the heap as a
175 // GenCollectedHeap heap.
176 class VM_GenCollectFull: public VM_GC_Operation {
177 private:
178 int _max_level;
179 public:
180 VM_GenCollectFull(unsigned int gc_count_before,
181 unsigned int full_gc_count_before,
182 GCCause::Cause gc_cause,
183 int max_level)
184 : VM_GC_Operation(gc_count_before, gc_cause, full_gc_count_before, true /* full */),
185 _max_level(max_level) { }
186 ~VM_GenCollectFull() {}
187 virtual VMOp_Type type() const { return VMOp_GenCollectFull; }
188 virtual void doit();
189 };
191 class VM_CollectForMetadataAllocation: public VM_GC_Operation {
192 private:
193 MetaWord* _result;
194 size_t _size; // size of object to be allocated
195 Metaspace::MetadataType _mdtype;
196 ClassLoaderData* _loader_data;
197 public:
198 VM_CollectForMetadataAllocation(ClassLoaderData* loader_data,
199 size_t size, Metaspace::MetadataType mdtype,
200 unsigned int gc_count_before,
201 unsigned int full_gc_count_before,
202 GCCause::Cause gc_cause)
203 : VM_GC_Operation(gc_count_before, gc_cause, full_gc_count_before, true),
204 _loader_data(loader_data), _size(size), _mdtype(mdtype), _result(NULL) {
205 }
206 ~VM_CollectForMetadataAllocation() {
207 MetaspaceGC::set_expand_after_GC(false);
208 }
209 virtual VMOp_Type type() const { return VMOp_CollectForMetadataAllocation; }
210 virtual void doit();
211 MetaWord* result() const { return _result; }
212 };
214 class SvcGCMarker : public StackObj {
215 private:
216 JvmtiGCMarker _jgcm;
217 public:
218 typedef enum { MINOR, FULL, OTHER } reason_type;
220 SvcGCMarker(reason_type reason ) {
221 VM_GC_Operation::notify_gc_begin(reason == FULL);
222 }
224 ~SvcGCMarker() {
225 VM_GC_Operation::notify_gc_end();
226 }
227 };
229 #endif // SHARE_VM_GC_IMPLEMENTATION_SHARED_VMGCOPERATIONS_HPP