src/share/vm/memory/iterator.hpp

Tue, 30 Oct 2012 10:23:55 -0700

author
jmasa
date
Tue, 30 Oct 2012 10:23:55 -0700
changeset 4234
3fadc0e8cffe
parent 4050
ec98e58952b2
child 4298
d0aa87f04bd5
permissions
-rw-r--r--

8000988: VM deadlock when running btree006 on windows-i586
Reviewed-by: johnc, jcoomes, ysr

duke@435 1 /*
coleenp@4037 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
duke@435 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435 4 *
duke@435 5 * This code is free software; you can redistribute it and/or modify it
duke@435 6 * under the terms of the GNU General Public License version 2 only, as
duke@435 7 * published by the Free Software Foundation.
duke@435 8 *
duke@435 9 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@435 12 * version 2 for more details (a copy is included in the LICENSE file that
duke@435 13 * accompanied this code).
duke@435 14 *
duke@435 15 * You should have received a copy of the GNU General Public License version
duke@435 16 * 2 along with this work; if not, write to the Free Software Foundation,
duke@435 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435 18 *
trims@1907 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907 20 * or visit www.oracle.com if you need additional information or have any
trims@1907 21 * questions.
duke@435 22 *
duke@435 23 */
duke@435 24
stefank@2314 25 #ifndef SHARE_VM_MEMORY_ITERATOR_HPP
stefank@2314 26 #define SHARE_VM_MEMORY_ITERATOR_HPP
stefank@2314 27
stefank@2314 28 #include "memory/allocation.hpp"
stefank@2314 29 #include "memory/memRegion.hpp"
stefank@2314 30 #include "runtime/prefetch.hpp"
stefank@2314 31 #include "utilities/top.hpp"
stefank@2314 32
duke@435 33 // The following classes are C++ `closures` for iterating over objects, roots and spaces
duke@435 34
jrose@1424 35 class CodeBlob;
jrose@1429 36 class nmethod;
duke@435 37 class ReferenceProcessor;
ysr@1376 38 class DataLayout;
coleenp@4037 39 class KlassClosure;
coleenp@4037 40 class ClassLoaderData;
duke@435 41
ysr@777 42 // Closure provides abortability.
ysr@777 43
ysr@777 44 class Closure : public StackObj {
ysr@777 45 protected:
ysr@777 46 bool _abort;
ysr@777 47 void set_abort() { _abort = true; }
ysr@777 48 public:
ysr@777 49 Closure() : _abort(false) {}
ysr@777 50 // A subtype can use this mechanism to indicate to some iterator mapping
ysr@777 51 // functions that the iteration should cease.
ysr@777 52 bool abort() { return _abort; }
ysr@777 53 void clear_abort() { _abort = false; }
ysr@777 54 };
ysr@777 55
coleenp@4037 56 // OopClosure is used for iterating through references to Java objects.
duke@435 57
ysr@777 58 class OopClosure : public Closure {
duke@435 59 public:
duke@435 60 virtual void do_oop(oop* o) = 0;
duke@435 61 virtual void do_oop_v(oop* o) { do_oop(o); }
coleenp@548 62 virtual void do_oop(narrowOop* o) = 0;
coleenp@548 63 virtual void do_oop_v(narrowOop* o) { do_oop(o); }
coleenp@4037 64 };
duke@435 65
coleenp@4037 66 // ExtendedOopClosure adds extra code to be run during oop iterations.
coleenp@4037 67 // This is needed by the GC and is extracted to a separate type to not
coleenp@4037 68 // pollute the OopClosure interface.
coleenp@4037 69 class ExtendedOopClosure : public OopClosure {
coleenp@4037 70 public:
coleenp@4037 71 ReferenceProcessor* _ref_processor;
coleenp@4037 72 ExtendedOopClosure(ReferenceProcessor* rp) : _ref_processor(rp) { }
coleenp@4037 73 ExtendedOopClosure() : OopClosure(), _ref_processor(NULL) { }
jmasa@1370 74
coleenp@4037 75 // If the do_metadata functions return "true",
coleenp@4037 76 // we invoke the following when running oop_iterate():
coleenp@4037 77 //
coleenp@4037 78 // 1) do_klass on the header klass pointer.
coleenp@4037 79 // 2) do_klass on the klass pointer in the mirrors.
coleenp@4037 80 // 3) do_class_loader_data on the class loader data in class loaders.
coleenp@4037 81 //
coleenp@4037 82 // The virtual (without suffix) and the non-virtual (with _nv suffix) need
coleenp@4037 83 // to be updated together, or else the devirtualization will break.
coleenp@4037 84 //
coleenp@4037 85 // Providing default implementations of the _nv functions unfortunately
coleenp@4037 86 // removes the compile-time safeness, but reduces the clutter for the
coleenp@4037 87 // ExtendedOopClosures that don't need to walk the metadata. Currently,
coleenp@4037 88 // only CMS needs these.
jmasa@1370 89
coleenp@4037 90 virtual bool do_metadata() { return do_metadata_nv(); }
coleenp@4037 91 bool do_metadata_v() { return do_metadata(); }
coleenp@4037 92 bool do_metadata_nv() { return false; }
duke@435 93
coleenp@4037 94 virtual void do_klass(Klass* k) { do_klass_nv(k); }
coleenp@4037 95 void do_klass_v(Klass* k) { do_klass(k); }
coleenp@4037 96 void do_klass_nv(Klass* k) { ShouldNotReachHere(); }
ysr@1376 97
coleenp@4037 98 virtual void do_class_loader_data(ClassLoaderData* cld) { ShouldNotReachHere(); }
duke@435 99
duke@435 100 // Controls how prefetching is done for invocations of this closure.
duke@435 101 Prefetch::style prefetch_style() { // Note that this is non-virtual.
duke@435 102 return Prefetch::do_none;
duke@435 103 }
ysr@777 104
ysr@777 105 // True iff this closure may be safely applied more than once to an oop
ysr@777 106 // location without an intervening "major reset" (like the end of a GC).
ysr@777 107 virtual bool idempotent() { return false; }
ysr@777 108 virtual bool apply_to_weak_ref_discovered_field() { return false; }
coleenp@4037 109 };
jmasa@1370 110
coleenp@4037 111 // Wrapper closure only used to implement oop_iterate_no_header().
coleenp@4037 112 class NoHeaderExtendedOopClosure : public ExtendedOopClosure {
coleenp@4037 113 OopClosure* _wrapped_closure;
coleenp@4037 114 public:
coleenp@4037 115 NoHeaderExtendedOopClosure(OopClosure* cl) : _wrapped_closure(cl) {}
coleenp@4037 116 // Warning: this calls the virtual version do_oop in the the wrapped closure.
coleenp@4037 117 void do_oop_nv(oop* p) { _wrapped_closure->do_oop(p); }
coleenp@4037 118 void do_oop_nv(narrowOop* p) { _wrapped_closure->do_oop(p); }
coleenp@4037 119
coleenp@4037 120 void do_oop(oop* p) { assert(false, "Only the _nv versions should be used");
coleenp@4037 121 _wrapped_closure->do_oop(p); }
coleenp@4037 122 void do_oop(narrowOop* p) { assert(false, "Only the _nv versions should be used");
coleenp@4037 123 _wrapped_closure->do_oop(p);}
coleenp@4037 124 };
coleenp@4037 125
coleenp@4037 126 class KlassClosure : public Closure {
coleenp@4037 127 public:
coleenp@4037 128 virtual void do_klass(Klass* k) = 0;
duke@435 129 };
duke@435 130
stefank@4050 131 class KlassToOopClosure : public KlassClosure {
stefank@4050 132 OopClosure* _oop_closure;
stefank@4050 133 public:
stefank@4050 134 KlassToOopClosure(OopClosure* oop_closure) : _oop_closure(oop_closure) {}
stefank@4050 135 virtual void do_klass(Klass* k);
stefank@4050 136 };
stefank@4050 137
duke@435 138 // ObjectClosure is used for iterating through an object space
duke@435 139
ysr@777 140 class ObjectClosure : public Closure {
duke@435 141 public:
duke@435 142 // Called for each object.
duke@435 143 virtual void do_object(oop obj) = 0;
duke@435 144 };
duke@435 145
duke@435 146
duke@435 147 class BoolObjectClosure : public ObjectClosure {
duke@435 148 public:
duke@435 149 virtual bool do_object_b(oop obj) = 0;
duke@435 150 };
duke@435 151
duke@435 152 // Applies an oop closure to all ref fields in objects iterated over in an
duke@435 153 // object iteration.
duke@435 154 class ObjectToOopClosure: public ObjectClosure {
coleenp@4037 155 ExtendedOopClosure* _cl;
duke@435 156 public:
duke@435 157 void do_object(oop obj);
coleenp@4037 158 ObjectToOopClosure(ExtendedOopClosure* cl) : _cl(cl) {}
duke@435 159 };
duke@435 160
duke@435 161 // A version of ObjectClosure with "memory" (see _previous_address below)
duke@435 162 class UpwardsObjectClosure: public BoolObjectClosure {
duke@435 163 HeapWord* _previous_address;
duke@435 164 public:
duke@435 165 UpwardsObjectClosure() : _previous_address(NULL) { }
duke@435 166 void set_previous(HeapWord* addr) { _previous_address = addr; }
duke@435 167 HeapWord* previous() { return _previous_address; }
duke@435 168 // A return value of "true" can be used by the caller to decide
duke@435 169 // if this object's end should *NOT* be recorded in
duke@435 170 // _previous_address above.
duke@435 171 virtual bool do_object_bm(oop obj, MemRegion mr) = 0;
duke@435 172 };
duke@435 173
duke@435 174 // A version of ObjectClosure that is expected to be robust
duke@435 175 // in the face of possibly uninitialized objects.
duke@435 176 class ObjectClosureCareful : public ObjectClosure {
duke@435 177 public:
duke@435 178 virtual size_t do_object_careful_m(oop p, MemRegion mr) = 0;
duke@435 179 virtual size_t do_object_careful(oop p) = 0;
duke@435 180 };
duke@435 181
duke@435 182 // The following are used in CompactibleFreeListSpace and
duke@435 183 // ConcurrentMarkSweepGeneration.
duke@435 184
duke@435 185 // Blk closure (abstract class)
duke@435 186 class BlkClosure : public StackObj {
duke@435 187 public:
duke@435 188 virtual size_t do_blk(HeapWord* addr) = 0;
duke@435 189 };
duke@435 190
duke@435 191 // A version of BlkClosure that is expected to be robust
duke@435 192 // in the face of possibly uninitialized objects.
duke@435 193 class BlkClosureCareful : public BlkClosure {
duke@435 194 public:
duke@435 195 size_t do_blk(HeapWord* addr) {
duke@435 196 guarantee(false, "call do_blk_careful instead");
duke@435 197 return 0;
duke@435 198 }
duke@435 199 virtual size_t do_blk_careful(HeapWord* addr) = 0;
duke@435 200 };
duke@435 201
duke@435 202 // SpaceClosure is used for iterating over spaces
duke@435 203
duke@435 204 class Space;
duke@435 205 class CompactibleSpace;
duke@435 206
duke@435 207 class SpaceClosure : public StackObj {
duke@435 208 public:
duke@435 209 // Called for each space
duke@435 210 virtual void do_space(Space* s) = 0;
duke@435 211 };
duke@435 212
duke@435 213 class CompactibleSpaceClosure : public StackObj {
duke@435 214 public:
duke@435 215 // Called for each compactible space
duke@435 216 virtual void do_space(CompactibleSpace* s) = 0;
duke@435 217 };
duke@435 218
duke@435 219
jrose@1424 220 // CodeBlobClosure is used for iterating through code blobs
jrose@1424 221 // in the code cache or on thread stacks
jrose@1424 222
jrose@1424 223 class CodeBlobClosure : public Closure {
jrose@1424 224 public:
jrose@1424 225 // Called for each code blob.
jrose@1424 226 virtual void do_code_blob(CodeBlob* cb) = 0;
jrose@1424 227 };
jrose@1424 228
jrose@1424 229
jrose@1424 230 class MarkingCodeBlobClosure : public CodeBlobClosure {
jrose@1424 231 public:
jrose@1424 232 // Called for each code blob, but at most once per unique blob.
jrose@1429 233 virtual void do_newly_marked_nmethod(nmethod* nm) = 0;
jrose@1424 234
jrose@1424 235 virtual void do_code_blob(CodeBlob* cb);
jrose@1424 236 // = { if (!nmethod(cb)->test_set_oops_do_mark()) do_newly_marked_nmethod(cb); }
jrose@1424 237
jrose@1424 238 class MarkScope : public StackObj {
jrose@1424 239 protected:
jrose@1424 240 bool _active;
jrose@1424 241 public:
jrose@1424 242 MarkScope(bool activate = true);
jrose@1424 243 // = { if (active) nmethod::oops_do_marking_prologue(); }
jrose@1424 244 ~MarkScope();
jrose@1424 245 // = { if (active) nmethod::oops_do_marking_epilogue(); }
jrose@1424 246 };
jrose@1424 247 };
jrose@1424 248
jrose@1424 249
jrose@1424 250 // Applies an oop closure to all ref fields in code blobs
jrose@1424 251 // iterated over in an object iteration.
jrose@1424 252 class CodeBlobToOopClosure: public MarkingCodeBlobClosure {
jrose@1424 253 OopClosure* _cl;
jrose@1424 254 bool _do_marking;
jrose@1424 255 public:
jrose@1429 256 virtual void do_newly_marked_nmethod(nmethod* cb);
jrose@1424 257 // = { cb->oops_do(_cl); }
jrose@1424 258 virtual void do_code_blob(CodeBlob* cb);
jrose@1424 259 // = { if (_do_marking) super::do_code_blob(cb); else cb->oops_do(_cl); }
jrose@1424 260 CodeBlobToOopClosure(OopClosure* cl, bool do_marking)
jrose@1424 261 : _cl(cl), _do_marking(do_marking) {}
jrose@1424 262 };
jrose@1424 263
jrose@1424 264
duke@435 265
duke@435 266 // MonitorClosure is used for iterating over monitors in the monitors cache
duke@435 267
duke@435 268 class ObjectMonitor;
duke@435 269
duke@435 270 class MonitorClosure : public StackObj {
duke@435 271 public:
duke@435 272 // called for each monitor in cache
duke@435 273 virtual void do_monitor(ObjectMonitor* m) = 0;
duke@435 274 };
duke@435 275
duke@435 276 // A closure that is applied without any arguments.
duke@435 277 class VoidClosure : public StackObj {
duke@435 278 public:
duke@435 279 // I would have liked to declare this a pure virtual, but that breaks
duke@435 280 // in mysterious ways, for unknown reasons.
duke@435 281 virtual void do_void();
duke@435 282 };
duke@435 283
duke@435 284
duke@435 285 // YieldClosure is intended for use by iteration loops
duke@435 286 // to incrementalize their work, allowing interleaving
duke@435 287 // of an interruptable task so as to allow other
duke@435 288 // threads to run (which may not otherwise be able to access
duke@435 289 // exclusive resources, for instance). Additionally, the
duke@435 290 // closure also allows for aborting an ongoing iteration
duke@435 291 // by means of checking the return value from the polling
duke@435 292 // call.
duke@435 293 class YieldClosure : public StackObj {
duke@435 294 public:
duke@435 295 virtual bool should_return() = 0;
duke@435 296 };
duke@435 297
duke@435 298 // Abstract closure for serializing data (read or write).
duke@435 299
coleenp@4037 300 class SerializeClosure : public Closure {
duke@435 301 public:
duke@435 302 // Return bool indicating whether closure implements read or write.
duke@435 303 virtual bool reading() const = 0;
duke@435 304
duke@435 305 // Read/write the void pointer pointed to by p.
duke@435 306 virtual void do_ptr(void** p) = 0;
duke@435 307
duke@435 308 // Read/write the region specified.
duke@435 309 virtual void do_region(u_char* start, size_t size) = 0;
duke@435 310
duke@435 311 // Check/write the tag. If reading, then compare the tag against
duke@435 312 // the passed in value and fail is they don't match. This allows
duke@435 313 // for verification that sections of the serialized data are of the
duke@435 314 // correct length.
duke@435 315 virtual void do_tag(int tag) = 0;
duke@435 316 };
jmasa@1370 317
coleenp@2497 318 class SymbolClosure : public StackObj {
coleenp@2497 319 public:
coleenp@2497 320 virtual void do_symbol(Symbol**) = 0;
coleenp@2497 321
coleenp@2497 322 // Clear LSB in symbol address; it can be set by CPSlot.
coleenp@2497 323 static Symbol* load_symbol(Symbol** p) {
coleenp@2497 324 return (Symbol*)(intptr_t(*p) & ~1);
coleenp@2497 325 }
coleenp@2497 326
coleenp@2497 327 // Store symbol, adjusting new pointer if the original pointer was adjusted
coleenp@2497 328 // (symbol references in constant pool slots have their LSB set to 1).
coleenp@2497 329 static void store_symbol(Symbol** p, Symbol* sym) {
coleenp@2497 330 *p = (Symbol*)(intptr_t(sym) | (intptr_t(*p) & 1));
coleenp@2497 331 }
coleenp@2497 332 };
coleenp@2497 333
stefank@2314 334 #endif // SHARE_VM_MEMORY_ITERATOR_HPP

mercurial