src/share/vm/memory/iterator.hpp

Thu, 21 Jan 2010 11:33:32 -0800

author
jmasa
date
Thu, 21 Jan 2010 11:33:32 -0800
changeset 1625
4788266644c1
parent 1435
a1423fe86a18
child 1907
c18cbe5936b8
permissions
-rw-r--r--

6895236: CMS: cmsOopClosures.inline.hpp:43 assert(..., "Should remember klasses in this context")
Summary: Adjust assertion checking for ExplicitGCInvokesConcurrentAndUnloadsClasses as a reason for class unloading
Reviewed-by: ysr

duke@435 1 /*
xdono@1383 2 * Copyright 1997-2009 Sun Microsystems, Inc. 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 *
duke@435 19 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@435 20 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@435 21 * have any questions.
duke@435 22 *
duke@435 23 */
duke@435 24
duke@435 25 // The following classes are C++ `closures` for iterating over objects, roots and spaces
duke@435 26
jrose@1424 27 class CodeBlob;
jrose@1429 28 class nmethod;
duke@435 29 class ReferenceProcessor;
ysr@1376 30 class DataLayout;
duke@435 31
ysr@777 32 // Closure provides abortability.
ysr@777 33
ysr@777 34 class Closure : public StackObj {
ysr@777 35 protected:
ysr@777 36 bool _abort;
ysr@777 37 void set_abort() { _abort = true; }
ysr@777 38 public:
ysr@777 39 Closure() : _abort(false) {}
ysr@777 40 // A subtype can use this mechanism to indicate to some iterator mapping
ysr@777 41 // functions that the iteration should cease.
ysr@777 42 bool abort() { return _abort; }
ysr@777 43 void clear_abort() { _abort = false; }
ysr@777 44 };
ysr@777 45
duke@435 46 // OopClosure is used for iterating through roots (oop*)
duke@435 47
ysr@777 48 class OopClosure : public Closure {
duke@435 49 public:
duke@435 50 ReferenceProcessor* _ref_processor;
duke@435 51 OopClosure(ReferenceProcessor* rp) : _ref_processor(rp) { }
duke@435 52 OopClosure() : _ref_processor(NULL) { }
duke@435 53 virtual void do_oop(oop* o) = 0;
duke@435 54 virtual void do_oop_v(oop* o) { do_oop(o); }
coleenp@548 55 virtual void do_oop(narrowOop* o) = 0;
coleenp@548 56 virtual void do_oop_v(narrowOop* o) { do_oop(o); }
duke@435 57
duke@435 58 // In support of post-processing of weak links of KlassKlass objects;
duke@435 59 // see KlassKlass::oop_oop_iterate().
jmasa@1370 60
jmasa@1370 61 virtual const bool should_remember_klasses() const {
jmasa@1370 62 assert(!must_remember_klasses(), "Should have overriden this method.");
jmasa@1370 63 return false;
jmasa@1370 64 }
jmasa@1370 65
duke@435 66 virtual void remember_klass(Klass* k) { /* do nothing */ }
duke@435 67
ysr@1376 68 // In support of post-processing of weak references in
ysr@1376 69 // ProfileData (MethodDataOop) objects; see, for example,
ysr@1376 70 // VirtualCallData::oop_iterate().
ysr@1376 71 virtual const bool should_remember_mdo() const { return false; }
ysr@1376 72 virtual void remember_mdo(DataLayout* v) { /* do nothing */ }
ysr@1376 73
duke@435 74 // The methods below control how object iterations invoking this closure
duke@435 75 // should be performed:
duke@435 76
duke@435 77 // If "true", invoke on header klass field.
duke@435 78 bool do_header() { return true; } // Note that this is non-virtual.
duke@435 79 // Controls how prefetching is done for invocations of this closure.
duke@435 80 Prefetch::style prefetch_style() { // Note that this is non-virtual.
duke@435 81 return Prefetch::do_none;
duke@435 82 }
ysr@777 83
ysr@777 84 // True iff this closure may be safely applied more than once to an oop
ysr@777 85 // location without an intervening "major reset" (like the end of a GC).
ysr@777 86 virtual bool idempotent() { return false; }
ysr@777 87 virtual bool apply_to_weak_ref_discovered_field() { return false; }
jmasa@1370 88
jmasa@1370 89 #ifdef ASSERT
jmasa@1370 90 static bool _must_remember_klasses;
jmasa@1370 91 static bool must_remember_klasses();
jmasa@1370 92 static void set_must_remember_klasses(bool v);
jmasa@1370 93 #endif
duke@435 94 };
duke@435 95
duke@435 96 // ObjectClosure is used for iterating through an object space
duke@435 97
ysr@777 98 class ObjectClosure : public Closure {
duke@435 99 public:
duke@435 100 // Called for each object.
duke@435 101 virtual void do_object(oop obj) = 0;
duke@435 102 };
duke@435 103
duke@435 104
duke@435 105 class BoolObjectClosure : public ObjectClosure {
duke@435 106 public:
duke@435 107 virtual bool do_object_b(oop obj) = 0;
duke@435 108 };
duke@435 109
duke@435 110 // Applies an oop closure to all ref fields in objects iterated over in an
duke@435 111 // object iteration.
duke@435 112 class ObjectToOopClosure: public ObjectClosure {
duke@435 113 OopClosure* _cl;
duke@435 114 public:
duke@435 115 void do_object(oop obj);
duke@435 116 ObjectToOopClosure(OopClosure* cl) : _cl(cl) {}
duke@435 117 };
duke@435 118
duke@435 119 // A version of ObjectClosure with "memory" (see _previous_address below)
duke@435 120 class UpwardsObjectClosure: public BoolObjectClosure {
duke@435 121 HeapWord* _previous_address;
duke@435 122 public:
duke@435 123 UpwardsObjectClosure() : _previous_address(NULL) { }
duke@435 124 void set_previous(HeapWord* addr) { _previous_address = addr; }
duke@435 125 HeapWord* previous() { return _previous_address; }
duke@435 126 // A return value of "true" can be used by the caller to decide
duke@435 127 // if this object's end should *NOT* be recorded in
duke@435 128 // _previous_address above.
duke@435 129 virtual bool do_object_bm(oop obj, MemRegion mr) = 0;
duke@435 130 };
duke@435 131
duke@435 132 // A version of ObjectClosure that is expected to be robust
duke@435 133 // in the face of possibly uninitialized objects.
duke@435 134 class ObjectClosureCareful : public ObjectClosure {
duke@435 135 public:
duke@435 136 virtual size_t do_object_careful_m(oop p, MemRegion mr) = 0;
duke@435 137 virtual size_t do_object_careful(oop p) = 0;
duke@435 138 };
duke@435 139
duke@435 140 // The following are used in CompactibleFreeListSpace and
duke@435 141 // ConcurrentMarkSweepGeneration.
duke@435 142
duke@435 143 // Blk closure (abstract class)
duke@435 144 class BlkClosure : public StackObj {
duke@435 145 public:
duke@435 146 virtual size_t do_blk(HeapWord* addr) = 0;
duke@435 147 };
duke@435 148
duke@435 149 // A version of BlkClosure that is expected to be robust
duke@435 150 // in the face of possibly uninitialized objects.
duke@435 151 class BlkClosureCareful : public BlkClosure {
duke@435 152 public:
duke@435 153 size_t do_blk(HeapWord* addr) {
duke@435 154 guarantee(false, "call do_blk_careful instead");
duke@435 155 return 0;
duke@435 156 }
duke@435 157 virtual size_t do_blk_careful(HeapWord* addr) = 0;
duke@435 158 };
duke@435 159
duke@435 160 // SpaceClosure is used for iterating over spaces
duke@435 161
duke@435 162 class Space;
duke@435 163 class CompactibleSpace;
duke@435 164
duke@435 165 class SpaceClosure : public StackObj {
duke@435 166 public:
duke@435 167 // Called for each space
duke@435 168 virtual void do_space(Space* s) = 0;
duke@435 169 };
duke@435 170
duke@435 171 class CompactibleSpaceClosure : public StackObj {
duke@435 172 public:
duke@435 173 // Called for each compactible space
duke@435 174 virtual void do_space(CompactibleSpace* s) = 0;
duke@435 175 };
duke@435 176
duke@435 177
jrose@1424 178 // CodeBlobClosure is used for iterating through code blobs
jrose@1424 179 // in the code cache or on thread stacks
jrose@1424 180
jrose@1424 181 class CodeBlobClosure : public Closure {
jrose@1424 182 public:
jrose@1424 183 // Called for each code blob.
jrose@1424 184 virtual void do_code_blob(CodeBlob* cb) = 0;
jrose@1424 185 };
jrose@1424 186
jrose@1424 187
jrose@1424 188 class MarkingCodeBlobClosure : public CodeBlobClosure {
jrose@1424 189 public:
jrose@1424 190 // Called for each code blob, but at most once per unique blob.
jrose@1429 191 virtual void do_newly_marked_nmethod(nmethod* nm) = 0;
jrose@1424 192
jrose@1424 193 virtual void do_code_blob(CodeBlob* cb);
jrose@1424 194 // = { if (!nmethod(cb)->test_set_oops_do_mark()) do_newly_marked_nmethod(cb); }
jrose@1424 195
jrose@1424 196 class MarkScope : public StackObj {
jrose@1424 197 protected:
jrose@1424 198 bool _active;
jrose@1424 199 public:
jrose@1424 200 MarkScope(bool activate = true);
jrose@1424 201 // = { if (active) nmethod::oops_do_marking_prologue(); }
jrose@1424 202 ~MarkScope();
jrose@1424 203 // = { if (active) nmethod::oops_do_marking_epilogue(); }
jrose@1424 204 };
jrose@1424 205 };
jrose@1424 206
jrose@1424 207
jrose@1424 208 // Applies an oop closure to all ref fields in code blobs
jrose@1424 209 // iterated over in an object iteration.
jrose@1424 210 class CodeBlobToOopClosure: public MarkingCodeBlobClosure {
jrose@1424 211 OopClosure* _cl;
jrose@1424 212 bool _do_marking;
jrose@1424 213 public:
jrose@1429 214 virtual void do_newly_marked_nmethod(nmethod* cb);
jrose@1424 215 // = { cb->oops_do(_cl); }
jrose@1424 216 virtual void do_code_blob(CodeBlob* cb);
jrose@1424 217 // = { if (_do_marking) super::do_code_blob(cb); else cb->oops_do(_cl); }
jrose@1424 218 CodeBlobToOopClosure(OopClosure* cl, bool do_marking)
jrose@1424 219 : _cl(cl), _do_marking(do_marking) {}
jrose@1424 220 };
jrose@1424 221
jrose@1424 222
duke@435 223
duke@435 224 // MonitorClosure is used for iterating over monitors in the monitors cache
duke@435 225
duke@435 226 class ObjectMonitor;
duke@435 227
duke@435 228 class MonitorClosure : public StackObj {
duke@435 229 public:
duke@435 230 // called for each monitor in cache
duke@435 231 virtual void do_monitor(ObjectMonitor* m) = 0;
duke@435 232 };
duke@435 233
duke@435 234 // A closure that is applied without any arguments.
duke@435 235 class VoidClosure : public StackObj {
duke@435 236 public:
duke@435 237 // I would have liked to declare this a pure virtual, but that breaks
duke@435 238 // in mysterious ways, for unknown reasons.
duke@435 239 virtual void do_void();
duke@435 240 };
duke@435 241
duke@435 242
duke@435 243 // YieldClosure is intended for use by iteration loops
duke@435 244 // to incrementalize their work, allowing interleaving
duke@435 245 // of an interruptable task so as to allow other
duke@435 246 // threads to run (which may not otherwise be able to access
duke@435 247 // exclusive resources, for instance). Additionally, the
duke@435 248 // closure also allows for aborting an ongoing iteration
duke@435 249 // by means of checking the return value from the polling
duke@435 250 // call.
duke@435 251 class YieldClosure : public StackObj {
duke@435 252 public:
duke@435 253 virtual bool should_return() = 0;
duke@435 254 };
duke@435 255
duke@435 256 // Abstract closure for serializing data (read or write).
duke@435 257
duke@435 258 class SerializeOopClosure : public OopClosure {
duke@435 259 public:
duke@435 260 // Return bool indicating whether closure implements read or write.
duke@435 261 virtual bool reading() const = 0;
duke@435 262
duke@435 263 // Read/write the int pointed to by i.
duke@435 264 virtual void do_int(int* i) = 0;
duke@435 265
duke@435 266 // Read/write the size_t pointed to by i.
duke@435 267 virtual void do_size_t(size_t* i) = 0;
duke@435 268
duke@435 269 // Read/write the void pointer pointed to by p.
duke@435 270 virtual void do_ptr(void** p) = 0;
duke@435 271
duke@435 272 // Read/write the HeapWord pointer pointed to be p.
duke@435 273 virtual void do_ptr(HeapWord** p) = 0;
duke@435 274
duke@435 275 // Read/write the region specified.
duke@435 276 virtual void do_region(u_char* start, size_t size) = 0;
duke@435 277
duke@435 278 // Check/write the tag. If reading, then compare the tag against
duke@435 279 // the passed in value and fail is they don't match. This allows
duke@435 280 // for verification that sections of the serialized data are of the
duke@435 281 // correct length.
duke@435 282 virtual void do_tag(int tag) = 0;
duke@435 283 };
jmasa@1370 284
jmasa@1370 285 #ifdef ASSERT
jmasa@1370 286 // This class is used to flag phases of a collection that
jmasa@1370 287 // can unload classes and which should override the
jmasa@1370 288 // should_remember_klasses() and remember_klass() of OopClosure.
jmasa@1370 289 // The _must_remember_klasses is set in the contructor and restored
jmasa@1370 290 // in the destructor. _must_remember_klasses is checked in assertions
jmasa@1370 291 // in the OopClosure implementations of should_remember_klasses() and
jmasa@1370 292 // remember_klass() and the expectation is that the OopClosure
jmasa@1370 293 // implementation should not be in use if _must_remember_klasses is set.
jmasa@1370 294 // Instances of RememberKlassesChecker can be place in
jmasa@1370 295 // marking phases of collections which can do class unloading.
jmasa@1370 296 // RememberKlassesChecker can be passed "false" to turn off checking.
jmasa@1370 297 // It is used by CMS when CMS yields to a different collector.
jmasa@1370 298 class RememberKlassesChecker: StackObj {
jmasa@1625 299 bool _saved_state;
jmasa@1625 300 bool _do_check;
jmasa@1370 301 public:
jmasa@1625 302 RememberKlassesChecker(bool checking_on) : _saved_state(false),
jmasa@1625 303 _do_check(true) {
jmasa@1625 304 // The ClassUnloading unloading flag affects the collectors except
jmasa@1625 305 // for CMS.
jmasa@1625 306 // CMS unloads classes if CMSClassUnloadingEnabled is true or
jmasa@1625 307 // if ExplicitGCInvokesConcurrentAndUnloadsClasses is true and
jmasa@1625 308 // the current collection is an explicit collection. Turning
jmasa@1625 309 // on the checking in general for
jmasa@1625 310 // ExplicitGCInvokesConcurrentAndUnloadsClasses and
jmasa@1625 311 // UseConcMarkSweepGC should not lead to false positives.
jmasa@1625 312 _do_check =
jmasa@1625 313 ClassUnloading && !UseConcMarkSweepGC ||
jmasa@1625 314 CMSClassUnloadingEnabled && UseConcMarkSweepGC ||
jmasa@1625 315 ExplicitGCInvokesConcurrentAndUnloadsClasses && UseConcMarkSweepGC;
jmasa@1625 316 if (_do_check) {
jmasa@1625 317 _saved_state = OopClosure::must_remember_klasses();
jmasa@1625 318 OopClosure::set_must_remember_klasses(checking_on);
jmasa@1370 319 }
jmasa@1370 320 }
jmasa@1370 321 ~RememberKlassesChecker() {
jmasa@1625 322 if (_do_check) {
jmasa@1625 323 OopClosure::set_must_remember_klasses(_saved_state);
jmasa@1370 324 }
jmasa@1370 325 }
jmasa@1370 326 };
jmasa@1370 327 #endif // ASSERT

mercurial