Wed, 12 Mar 2014 15:22:45 +0100
8038404: Move object_iterate_mem from Space to CMS since it is only ever used by CMS
Reviewed-by: brutisso, tschatzl, stefank
1 /*
2 * Copyright (c) 1997, 2013, 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_MEMORY_ITERATOR_HPP
26 #define SHARE_VM_MEMORY_ITERATOR_HPP
28 #include "memory/allocation.hpp"
29 #include "memory/memRegion.hpp"
30 #include "runtime/prefetch.hpp"
31 #include "utilities/top.hpp"
33 // The following classes are C++ `closures` for iterating over objects, roots and spaces
35 class CodeBlob;
36 class nmethod;
37 class ReferenceProcessor;
38 class DataLayout;
39 class KlassClosure;
40 class ClassLoaderData;
42 // Closure provides abortability.
44 class Closure : public StackObj {
45 protected:
46 bool _abort;
47 void set_abort() { _abort = true; }
48 public:
49 Closure() : _abort(false) {}
50 // A subtype can use this mechanism to indicate to some iterator mapping
51 // functions that the iteration should cease.
52 bool abort() { return _abort; }
53 void clear_abort() { _abort = false; }
54 };
56 // OopClosure is used for iterating through references to Java objects.
58 class OopClosure : public Closure {
59 public:
60 virtual void do_oop(oop* o) = 0;
61 virtual void do_oop_v(oop* o) { do_oop(o); }
62 virtual void do_oop(narrowOop* o) = 0;
63 virtual void do_oop_v(narrowOop* o) { do_oop(o); }
64 };
66 // ExtendedOopClosure adds extra code to be run during oop iterations.
67 // This is needed by the GC and is extracted to a separate type to not
68 // pollute the OopClosure interface.
69 class ExtendedOopClosure : public OopClosure {
70 public:
71 ReferenceProcessor* _ref_processor;
72 ExtendedOopClosure(ReferenceProcessor* rp) : _ref_processor(rp) { }
73 ExtendedOopClosure() : OopClosure(), _ref_processor(NULL) { }
75 // If the do_metadata functions return "true",
76 // we invoke the following when running oop_iterate():
77 //
78 // 1) do_klass on the header klass pointer.
79 // 2) do_klass on the klass pointer in the mirrors.
80 // 3) do_class_loader_data on the class loader data in class loaders.
81 //
82 // The virtual (without suffix) and the non-virtual (with _nv suffix) need
83 // to be updated together, or else the devirtualization will break.
84 //
85 // Providing default implementations of the _nv functions unfortunately
86 // removes the compile-time safeness, but reduces the clutter for the
87 // ExtendedOopClosures that don't need to walk the metadata. Currently,
88 // only CMS needs these.
90 virtual bool do_metadata() { return do_metadata_nv(); }
91 bool do_metadata_v() { return do_metadata(); }
92 bool do_metadata_nv() { return false; }
94 virtual void do_klass(Klass* k) { do_klass_nv(k); }
95 void do_klass_v(Klass* k) { do_klass(k); }
96 void do_klass_nv(Klass* k) { ShouldNotReachHere(); }
98 virtual void do_class_loader_data(ClassLoaderData* cld) { ShouldNotReachHere(); }
100 // Controls how prefetching is done for invocations of this closure.
101 Prefetch::style prefetch_style() { // Note that this is non-virtual.
102 return Prefetch::do_none;
103 }
105 // True iff this closure may be safely applied more than once to an oop
106 // location without an intervening "major reset" (like the end of a GC).
107 virtual bool idempotent() { return false; }
108 virtual bool apply_to_weak_ref_discovered_field() { return false; }
109 };
111 // Wrapper closure only used to implement oop_iterate_no_header().
112 class NoHeaderExtendedOopClosure : public ExtendedOopClosure {
113 OopClosure* _wrapped_closure;
114 public:
115 NoHeaderExtendedOopClosure(OopClosure* cl) : _wrapped_closure(cl) {}
116 // Warning: this calls the virtual version do_oop in the the wrapped closure.
117 void do_oop_nv(oop* p) { _wrapped_closure->do_oop(p); }
118 void do_oop_nv(narrowOop* p) { _wrapped_closure->do_oop(p); }
120 void do_oop(oop* p) { assert(false, "Only the _nv versions should be used");
121 _wrapped_closure->do_oop(p); }
122 void do_oop(narrowOop* p) { assert(false, "Only the _nv versions should be used");
123 _wrapped_closure->do_oop(p);}
124 };
126 class KlassClosure : public Closure {
127 public:
128 virtual void do_klass(Klass* k) = 0;
129 };
131 class CLDClosure : public Closure {
132 public:
133 virtual void do_cld(ClassLoaderData* cld) = 0;
134 };
136 class KlassToOopClosure : public KlassClosure {
137 OopClosure* _oop_closure;
138 public:
139 KlassToOopClosure(OopClosure* oop_closure) : _oop_closure(oop_closure) {}
140 virtual void do_klass(Klass* k);
141 };
143 class CLDToOopClosure : public CLDClosure {
144 OopClosure* _oop_closure;
145 KlassToOopClosure _klass_closure;
146 bool _must_claim_cld;
148 public:
149 CLDToOopClosure(OopClosure* oop_closure, bool must_claim_cld = true) :
150 _oop_closure(oop_closure),
151 _klass_closure(oop_closure),
152 _must_claim_cld(must_claim_cld) {}
154 void do_cld(ClassLoaderData* cld);
155 };
157 // ObjectClosure is used for iterating through an object space
159 class ObjectClosure : public Closure {
160 public:
161 // Called for each object.
162 virtual void do_object(oop obj) = 0;
163 };
166 class BoolObjectClosure : public Closure {
167 public:
168 virtual bool do_object_b(oop obj) = 0;
169 };
171 // Applies an oop closure to all ref fields in objects iterated over in an
172 // object iteration.
173 class ObjectToOopClosure: public ObjectClosure {
174 ExtendedOopClosure* _cl;
175 public:
176 void do_object(oop obj);
177 ObjectToOopClosure(ExtendedOopClosure* cl) : _cl(cl) {}
178 };
180 // A version of ObjectClosure that is expected to be robust
181 // in the face of possibly uninitialized objects.
182 class ObjectClosureCareful : public ObjectClosure {
183 public:
184 virtual size_t do_object_careful_m(oop p, MemRegion mr) = 0;
185 virtual size_t do_object_careful(oop p) = 0;
186 };
188 // The following are used in CompactibleFreeListSpace and
189 // ConcurrentMarkSweepGeneration.
191 // Blk closure (abstract class)
192 class BlkClosure : public StackObj {
193 public:
194 virtual size_t do_blk(HeapWord* addr) = 0;
195 };
197 // A version of BlkClosure that is expected to be robust
198 // in the face of possibly uninitialized objects.
199 class BlkClosureCareful : public BlkClosure {
200 public:
201 size_t do_blk(HeapWord* addr) {
202 guarantee(false, "call do_blk_careful instead");
203 return 0;
204 }
205 virtual size_t do_blk_careful(HeapWord* addr) = 0;
206 };
208 // SpaceClosure is used for iterating over spaces
210 class Space;
211 class CompactibleSpace;
213 class SpaceClosure : public StackObj {
214 public:
215 // Called for each space
216 virtual void do_space(Space* s) = 0;
217 };
219 class CompactibleSpaceClosure : public StackObj {
220 public:
221 // Called for each compactible space
222 virtual void do_space(CompactibleSpace* s) = 0;
223 };
226 // CodeBlobClosure is used for iterating through code blobs
227 // in the code cache or on thread stacks
229 class CodeBlobClosure : public Closure {
230 public:
231 // Called for each code blob.
232 virtual void do_code_blob(CodeBlob* cb) = 0;
233 };
236 class MarkingCodeBlobClosure : public CodeBlobClosure {
237 public:
238 // Called for each code blob, but at most once per unique blob.
239 virtual void do_newly_marked_nmethod(nmethod* nm) = 0;
241 virtual void do_code_blob(CodeBlob* cb);
242 // = { if (!nmethod(cb)->test_set_oops_do_mark()) do_newly_marked_nmethod(cb); }
244 class MarkScope : public StackObj {
245 protected:
246 bool _active;
247 public:
248 MarkScope(bool activate = true);
249 // = { if (active) nmethod::oops_do_marking_prologue(); }
250 ~MarkScope();
251 // = { if (active) nmethod::oops_do_marking_epilogue(); }
252 };
253 };
256 // Applies an oop closure to all ref fields in code blobs
257 // iterated over in an object iteration.
258 class CodeBlobToOopClosure: public MarkingCodeBlobClosure {
259 OopClosure* _cl;
260 bool _do_marking;
261 public:
262 virtual void do_newly_marked_nmethod(nmethod* cb);
263 // = { cb->oops_do(_cl); }
264 virtual void do_code_blob(CodeBlob* cb);
265 // = { if (_do_marking) super::do_code_blob(cb); else cb->oops_do(_cl); }
266 CodeBlobToOopClosure(OopClosure* cl, bool do_marking)
267 : _cl(cl), _do_marking(do_marking) {}
268 };
272 // MonitorClosure is used for iterating over monitors in the monitors cache
274 class ObjectMonitor;
276 class MonitorClosure : public StackObj {
277 public:
278 // called for each monitor in cache
279 virtual void do_monitor(ObjectMonitor* m) = 0;
280 };
282 // A closure that is applied without any arguments.
283 class VoidClosure : public StackObj {
284 public:
285 // I would have liked to declare this a pure virtual, but that breaks
286 // in mysterious ways, for unknown reasons.
287 virtual void do_void();
288 };
291 // YieldClosure is intended for use by iteration loops
292 // to incrementalize their work, allowing interleaving
293 // of an interruptable task so as to allow other
294 // threads to run (which may not otherwise be able to access
295 // exclusive resources, for instance). Additionally, the
296 // closure also allows for aborting an ongoing iteration
297 // by means of checking the return value from the polling
298 // call.
299 class YieldClosure : public StackObj {
300 public:
301 virtual bool should_return() = 0;
302 };
304 // Abstract closure for serializing data (read or write).
306 class SerializeClosure : public Closure {
307 public:
308 // Return bool indicating whether closure implements read or write.
309 virtual bool reading() const = 0;
311 // Read/write the void pointer pointed to by p.
312 virtual void do_ptr(void** p) = 0;
314 // Read/write the region specified.
315 virtual void do_region(u_char* start, size_t size) = 0;
317 // Check/write the tag. If reading, then compare the tag against
318 // the passed in value and fail is they don't match. This allows
319 // for verification that sections of the serialized data are of the
320 // correct length.
321 virtual void do_tag(int tag) = 0;
322 };
324 class SymbolClosure : public StackObj {
325 public:
326 virtual void do_symbol(Symbol**) = 0;
328 // Clear LSB in symbol address; it can be set by CPSlot.
329 static Symbol* load_symbol(Symbol** p) {
330 return (Symbol*)(intptr_t(*p) & ~1);
331 }
333 // Store symbol, adjusting new pointer if the original pointer was adjusted
334 // (symbol references in constant pool slots have their LSB set to 1).
335 static void store_symbol(Symbol** p, Symbol* sym) {
336 *p = (Symbol*)(intptr_t(sym) | (intptr_t(*p) & 1));
337 }
338 };
340 #endif // SHARE_VM_MEMORY_ITERATOR_HPP