src/share/vm/memory/iterator.hpp

Tue, 15 Sep 2009 21:53:47 -0700

author
jrose
date
Tue, 15 Sep 2009 21:53:47 -0700
changeset 1424
148e5441d916
parent 791
1ee8caae33af
child 1428
54b3b351d6f9
permissions
-rw-r--r--

6863023: need non-perm oops in code cache for JSR 292
Summary: Make a special root-list for those few nmethods which might contain non-perm oops.
Reviewed-by: twisti, kvn, never, jmasa, ysr

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

mercurial