Mon, 24 Aug 2009 10:36:31 -0700
6798898: CMS: bugs related to class unloading
Summary: Override should_remember_klasses() and remember_klass() as needed.
Reviewed-by: ysr, jcoomes
duke@435 | 1 | /* |
xdono@631 | 2 | * Copyright 1997-2008 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 | |
duke@435 | 27 | class ReferenceProcessor; |
duke@435 | 28 | |
ysr@777 | 29 | // Closure provides abortability. |
ysr@777 | 30 | |
ysr@777 | 31 | class Closure : public StackObj { |
ysr@777 | 32 | protected: |
ysr@777 | 33 | bool _abort; |
ysr@777 | 34 | void set_abort() { _abort = true; } |
ysr@777 | 35 | public: |
ysr@777 | 36 | Closure() : _abort(false) {} |
ysr@777 | 37 | // A subtype can use this mechanism to indicate to some iterator mapping |
ysr@777 | 38 | // functions that the iteration should cease. |
ysr@777 | 39 | bool abort() { return _abort; } |
ysr@777 | 40 | void clear_abort() { _abort = false; } |
ysr@777 | 41 | }; |
ysr@777 | 42 | |
duke@435 | 43 | // OopClosure is used for iterating through roots (oop*) |
duke@435 | 44 | |
ysr@777 | 45 | class OopClosure : public Closure { |
duke@435 | 46 | public: |
duke@435 | 47 | ReferenceProcessor* _ref_processor; |
duke@435 | 48 | OopClosure(ReferenceProcessor* rp) : _ref_processor(rp) { } |
duke@435 | 49 | OopClosure() : _ref_processor(NULL) { } |
duke@435 | 50 | virtual void do_oop(oop* o) = 0; |
duke@435 | 51 | virtual void do_oop_v(oop* o) { do_oop(o); } |
coleenp@548 | 52 | virtual void do_oop(narrowOop* o) = 0; |
coleenp@548 | 53 | virtual void do_oop_v(narrowOop* o) { do_oop(o); } |
duke@435 | 54 | |
duke@435 | 55 | // In support of post-processing of weak links of KlassKlass objects; |
duke@435 | 56 | // see KlassKlass::oop_oop_iterate(). |
jmasa@1370 | 57 | |
jmasa@1370 | 58 | virtual const bool should_remember_klasses() const { |
jmasa@1370 | 59 | assert(!must_remember_klasses(), "Should have overriden this method."); |
jmasa@1370 | 60 | return false; |
jmasa@1370 | 61 | } |
jmasa@1370 | 62 | |
duke@435 | 63 | virtual void remember_klass(Klass* k) { /* do nothing */ } |
duke@435 | 64 | |
duke@435 | 65 | // If "true", invoke on nmethods (when scanning compiled frames). |
duke@435 | 66 | virtual const bool do_nmethods() const { return false; } |
duke@435 | 67 | |
duke@435 | 68 | // The methods below control how object iterations invoking this closure |
duke@435 | 69 | // should be performed: |
duke@435 | 70 | |
duke@435 | 71 | // If "true", invoke on header klass field. |
duke@435 | 72 | bool do_header() { return true; } // Note that this is non-virtual. |
duke@435 | 73 | // Controls how prefetching is done for invocations of this closure. |
duke@435 | 74 | Prefetch::style prefetch_style() { // Note that this is non-virtual. |
duke@435 | 75 | return Prefetch::do_none; |
duke@435 | 76 | } |
ysr@777 | 77 | |
ysr@777 | 78 | // True iff this closure may be safely applied more than once to an oop |
ysr@777 | 79 | // location without an intervening "major reset" (like the end of a GC). |
ysr@777 | 80 | virtual bool idempotent() { return false; } |
ysr@777 | 81 | virtual bool apply_to_weak_ref_discovered_field() { return false; } |
jmasa@1370 | 82 | |
jmasa@1370 | 83 | #ifdef ASSERT |
jmasa@1370 | 84 | static bool _must_remember_klasses; |
jmasa@1370 | 85 | static bool must_remember_klasses(); |
jmasa@1370 | 86 | static void set_must_remember_klasses(bool v); |
jmasa@1370 | 87 | #endif |
duke@435 | 88 | }; |
duke@435 | 89 | |
duke@435 | 90 | // ObjectClosure is used for iterating through an object space |
duke@435 | 91 | |
ysr@777 | 92 | class ObjectClosure : public Closure { |
duke@435 | 93 | public: |
duke@435 | 94 | // Called for each object. |
duke@435 | 95 | virtual void do_object(oop obj) = 0; |
duke@435 | 96 | }; |
duke@435 | 97 | |
duke@435 | 98 | |
duke@435 | 99 | class BoolObjectClosure : public ObjectClosure { |
duke@435 | 100 | public: |
duke@435 | 101 | virtual bool do_object_b(oop obj) = 0; |
duke@435 | 102 | }; |
duke@435 | 103 | |
duke@435 | 104 | // Applies an oop closure to all ref fields in objects iterated over in an |
duke@435 | 105 | // object iteration. |
duke@435 | 106 | class ObjectToOopClosure: public ObjectClosure { |
duke@435 | 107 | OopClosure* _cl; |
duke@435 | 108 | public: |
duke@435 | 109 | void do_object(oop obj); |
duke@435 | 110 | ObjectToOopClosure(OopClosure* cl) : _cl(cl) {} |
duke@435 | 111 | }; |
duke@435 | 112 | |
duke@435 | 113 | // A version of ObjectClosure with "memory" (see _previous_address below) |
duke@435 | 114 | class UpwardsObjectClosure: public BoolObjectClosure { |
duke@435 | 115 | HeapWord* _previous_address; |
duke@435 | 116 | public: |
duke@435 | 117 | UpwardsObjectClosure() : _previous_address(NULL) { } |
duke@435 | 118 | void set_previous(HeapWord* addr) { _previous_address = addr; } |
duke@435 | 119 | HeapWord* previous() { return _previous_address; } |
duke@435 | 120 | // A return value of "true" can be used by the caller to decide |
duke@435 | 121 | // if this object's end should *NOT* be recorded in |
duke@435 | 122 | // _previous_address above. |
duke@435 | 123 | virtual bool do_object_bm(oop obj, MemRegion mr) = 0; |
duke@435 | 124 | }; |
duke@435 | 125 | |
duke@435 | 126 | // A version of ObjectClosure that is expected to be robust |
duke@435 | 127 | // in the face of possibly uninitialized objects. |
duke@435 | 128 | class ObjectClosureCareful : public ObjectClosure { |
duke@435 | 129 | public: |
duke@435 | 130 | virtual size_t do_object_careful_m(oop p, MemRegion mr) = 0; |
duke@435 | 131 | virtual size_t do_object_careful(oop p) = 0; |
duke@435 | 132 | }; |
duke@435 | 133 | |
duke@435 | 134 | // The following are used in CompactibleFreeListSpace and |
duke@435 | 135 | // ConcurrentMarkSweepGeneration. |
duke@435 | 136 | |
duke@435 | 137 | // Blk closure (abstract class) |
duke@435 | 138 | class BlkClosure : public StackObj { |
duke@435 | 139 | public: |
duke@435 | 140 | virtual size_t do_blk(HeapWord* addr) = 0; |
duke@435 | 141 | }; |
duke@435 | 142 | |
duke@435 | 143 | // A version of BlkClosure that is expected to be robust |
duke@435 | 144 | // in the face of possibly uninitialized objects. |
duke@435 | 145 | class BlkClosureCareful : public BlkClosure { |
duke@435 | 146 | public: |
duke@435 | 147 | size_t do_blk(HeapWord* addr) { |
duke@435 | 148 | guarantee(false, "call do_blk_careful instead"); |
duke@435 | 149 | return 0; |
duke@435 | 150 | } |
duke@435 | 151 | virtual size_t do_blk_careful(HeapWord* addr) = 0; |
duke@435 | 152 | }; |
duke@435 | 153 | |
duke@435 | 154 | // SpaceClosure is used for iterating over spaces |
duke@435 | 155 | |
duke@435 | 156 | class Space; |
duke@435 | 157 | class CompactibleSpace; |
duke@435 | 158 | |
duke@435 | 159 | class SpaceClosure : public StackObj { |
duke@435 | 160 | public: |
duke@435 | 161 | // Called for each space |
duke@435 | 162 | virtual void do_space(Space* s) = 0; |
duke@435 | 163 | }; |
duke@435 | 164 | |
duke@435 | 165 | class CompactibleSpaceClosure : public StackObj { |
duke@435 | 166 | public: |
duke@435 | 167 | // Called for each compactible space |
duke@435 | 168 | virtual void do_space(CompactibleSpace* s) = 0; |
duke@435 | 169 | }; |
duke@435 | 170 | |
duke@435 | 171 | |
duke@435 | 172 | |
duke@435 | 173 | // MonitorClosure is used for iterating over monitors in the monitors cache |
duke@435 | 174 | |
duke@435 | 175 | class ObjectMonitor; |
duke@435 | 176 | |
duke@435 | 177 | class MonitorClosure : public StackObj { |
duke@435 | 178 | public: |
duke@435 | 179 | // called for each monitor in cache |
duke@435 | 180 | virtual void do_monitor(ObjectMonitor* m) = 0; |
duke@435 | 181 | }; |
duke@435 | 182 | |
duke@435 | 183 | // A closure that is applied without any arguments. |
duke@435 | 184 | class VoidClosure : public StackObj { |
duke@435 | 185 | public: |
duke@435 | 186 | // I would have liked to declare this a pure virtual, but that breaks |
duke@435 | 187 | // in mysterious ways, for unknown reasons. |
duke@435 | 188 | virtual void do_void(); |
duke@435 | 189 | }; |
duke@435 | 190 | |
duke@435 | 191 | |
duke@435 | 192 | // YieldClosure is intended for use by iteration loops |
duke@435 | 193 | // to incrementalize their work, allowing interleaving |
duke@435 | 194 | // of an interruptable task so as to allow other |
duke@435 | 195 | // threads to run (which may not otherwise be able to access |
duke@435 | 196 | // exclusive resources, for instance). Additionally, the |
duke@435 | 197 | // closure also allows for aborting an ongoing iteration |
duke@435 | 198 | // by means of checking the return value from the polling |
duke@435 | 199 | // call. |
duke@435 | 200 | class YieldClosure : public StackObj { |
duke@435 | 201 | public: |
duke@435 | 202 | virtual bool should_return() = 0; |
duke@435 | 203 | }; |
duke@435 | 204 | |
duke@435 | 205 | // Abstract closure for serializing data (read or write). |
duke@435 | 206 | |
duke@435 | 207 | class SerializeOopClosure : public OopClosure { |
duke@435 | 208 | public: |
duke@435 | 209 | // Return bool indicating whether closure implements read or write. |
duke@435 | 210 | virtual bool reading() const = 0; |
duke@435 | 211 | |
duke@435 | 212 | // Read/write the int pointed to by i. |
duke@435 | 213 | virtual void do_int(int* i) = 0; |
duke@435 | 214 | |
duke@435 | 215 | // Read/write the size_t pointed to by i. |
duke@435 | 216 | virtual void do_size_t(size_t* i) = 0; |
duke@435 | 217 | |
duke@435 | 218 | // Read/write the void pointer pointed to by p. |
duke@435 | 219 | virtual void do_ptr(void** p) = 0; |
duke@435 | 220 | |
duke@435 | 221 | // Read/write the HeapWord pointer pointed to be p. |
duke@435 | 222 | virtual void do_ptr(HeapWord** p) = 0; |
duke@435 | 223 | |
duke@435 | 224 | // Read/write the region specified. |
duke@435 | 225 | virtual void do_region(u_char* start, size_t size) = 0; |
duke@435 | 226 | |
duke@435 | 227 | // Check/write the tag. If reading, then compare the tag against |
duke@435 | 228 | // the passed in value and fail is they don't match. This allows |
duke@435 | 229 | // for verification that sections of the serialized data are of the |
duke@435 | 230 | // correct length. |
duke@435 | 231 | virtual void do_tag(int tag) = 0; |
duke@435 | 232 | }; |
jmasa@1370 | 233 | |
jmasa@1370 | 234 | #ifdef ASSERT |
jmasa@1370 | 235 | // This class is used to flag phases of a collection that |
jmasa@1370 | 236 | // can unload classes and which should override the |
jmasa@1370 | 237 | // should_remember_klasses() and remember_klass() of OopClosure. |
jmasa@1370 | 238 | // The _must_remember_klasses is set in the contructor and restored |
jmasa@1370 | 239 | // in the destructor. _must_remember_klasses is checked in assertions |
jmasa@1370 | 240 | // in the OopClosure implementations of should_remember_klasses() and |
jmasa@1370 | 241 | // remember_klass() and the expectation is that the OopClosure |
jmasa@1370 | 242 | // implementation should not be in use if _must_remember_klasses is set. |
jmasa@1370 | 243 | // Instances of RememberKlassesChecker can be place in |
jmasa@1370 | 244 | // marking phases of collections which can do class unloading. |
jmasa@1370 | 245 | // RememberKlassesChecker can be passed "false" to turn off checking. |
jmasa@1370 | 246 | // It is used by CMS when CMS yields to a different collector. |
jmasa@1370 | 247 | class RememberKlassesChecker: StackObj { |
jmasa@1370 | 248 | bool _state; |
jmasa@1370 | 249 | bool _skip; |
jmasa@1370 | 250 | public: |
jmasa@1370 | 251 | RememberKlassesChecker(bool checking_on) : _state(false), _skip(false) { |
jmasa@1370 | 252 | _skip = !(ClassUnloading && !UseConcMarkSweepGC || |
jmasa@1370 | 253 | CMSClassUnloadingEnabled && UseConcMarkSweepGC); |
jmasa@1370 | 254 | if (_skip) { |
jmasa@1370 | 255 | return; |
jmasa@1370 | 256 | } |
jmasa@1370 | 257 | _state = OopClosure::must_remember_klasses(); |
jmasa@1370 | 258 | OopClosure::set_must_remember_klasses(checking_on); |
jmasa@1370 | 259 | } |
jmasa@1370 | 260 | ~RememberKlassesChecker() { |
jmasa@1370 | 261 | if (_skip) { |
jmasa@1370 | 262 | return; |
jmasa@1370 | 263 | } |
jmasa@1370 | 264 | OopClosure::set_must_remember_klasses(_state); |
jmasa@1370 | 265 | } |
jmasa@1370 | 266 | }; |
jmasa@1370 | 267 | #endif // ASSERT |