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
duke@435 | 1 | /* |
mikael@6198 | 2 | * Copyright (c) 1997, 2013, 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@6973 | 131 | class CLDClosure : public Closure { |
stefank@6973 | 132 | public: |
stefank@6973 | 133 | virtual void do_cld(ClassLoaderData* cld) = 0; |
stefank@6973 | 134 | }; |
stefank@6973 | 135 | |
stefank@4050 | 136 | class KlassToOopClosure : public KlassClosure { |
stefank@4050 | 137 | OopClosure* _oop_closure; |
stefank@4050 | 138 | public: |
stefank@4050 | 139 | KlassToOopClosure(OopClosure* oop_closure) : _oop_closure(oop_closure) {} |
stefank@4050 | 140 | virtual void do_klass(Klass* k); |
stefank@4050 | 141 | }; |
stefank@4050 | 142 | |
stefank@6973 | 143 | class CLDToOopClosure : public CLDClosure { |
stefank@4298 | 144 | OopClosure* _oop_closure; |
stefank@4298 | 145 | KlassToOopClosure _klass_closure; |
stefank@4298 | 146 | bool _must_claim_cld; |
stefank@4298 | 147 | |
stefank@4298 | 148 | public: |
stefank@4298 | 149 | CLDToOopClosure(OopClosure* oop_closure, bool must_claim_cld = true) : |
stefank@4298 | 150 | _oop_closure(oop_closure), |
stefank@4298 | 151 | _klass_closure(oop_closure), |
stefank@4298 | 152 | _must_claim_cld(must_claim_cld) {} |
stefank@4298 | 153 | |
stefank@4298 | 154 | void do_cld(ClassLoaderData* cld); |
stefank@4298 | 155 | }; |
stefank@4298 | 156 | |
duke@435 | 157 | // ObjectClosure is used for iterating through an object space |
duke@435 | 158 | |
ysr@777 | 159 | class ObjectClosure : public Closure { |
duke@435 | 160 | public: |
duke@435 | 161 | // Called for each object. |
duke@435 | 162 | virtual void do_object(oop obj) = 0; |
duke@435 | 163 | }; |
duke@435 | 164 | |
duke@435 | 165 | |
ehelin@5159 | 166 | class BoolObjectClosure : public Closure { |
duke@435 | 167 | public: |
duke@435 | 168 | virtual bool do_object_b(oop obj) = 0; |
duke@435 | 169 | }; |
duke@435 | 170 | |
duke@435 | 171 | // Applies an oop closure to all ref fields in objects iterated over in an |
duke@435 | 172 | // object iteration. |
duke@435 | 173 | class ObjectToOopClosure: public ObjectClosure { |
coleenp@4037 | 174 | ExtendedOopClosure* _cl; |
duke@435 | 175 | public: |
duke@435 | 176 | void do_object(oop obj); |
coleenp@4037 | 177 | ObjectToOopClosure(ExtendedOopClosure* cl) : _cl(cl) {} |
duke@435 | 178 | }; |
duke@435 | 179 | |
duke@435 | 180 | // A version of ObjectClosure that is expected to be robust |
duke@435 | 181 | // in the face of possibly uninitialized objects. |
duke@435 | 182 | class ObjectClosureCareful : public ObjectClosure { |
duke@435 | 183 | public: |
duke@435 | 184 | virtual size_t do_object_careful_m(oop p, MemRegion mr) = 0; |
duke@435 | 185 | virtual size_t do_object_careful(oop p) = 0; |
duke@435 | 186 | }; |
duke@435 | 187 | |
duke@435 | 188 | // The following are used in CompactibleFreeListSpace and |
duke@435 | 189 | // ConcurrentMarkSweepGeneration. |
duke@435 | 190 | |
duke@435 | 191 | // Blk closure (abstract class) |
duke@435 | 192 | class BlkClosure : public StackObj { |
duke@435 | 193 | public: |
duke@435 | 194 | virtual size_t do_blk(HeapWord* addr) = 0; |
duke@435 | 195 | }; |
duke@435 | 196 | |
duke@435 | 197 | // A version of BlkClosure that is expected to be robust |
duke@435 | 198 | // in the face of possibly uninitialized objects. |
duke@435 | 199 | class BlkClosureCareful : public BlkClosure { |
duke@435 | 200 | public: |
duke@435 | 201 | size_t do_blk(HeapWord* addr) { |
duke@435 | 202 | guarantee(false, "call do_blk_careful instead"); |
duke@435 | 203 | return 0; |
duke@435 | 204 | } |
duke@435 | 205 | virtual size_t do_blk_careful(HeapWord* addr) = 0; |
duke@435 | 206 | }; |
duke@435 | 207 | |
duke@435 | 208 | // SpaceClosure is used for iterating over spaces |
duke@435 | 209 | |
duke@435 | 210 | class Space; |
duke@435 | 211 | class CompactibleSpace; |
duke@435 | 212 | |
duke@435 | 213 | class SpaceClosure : public StackObj { |
duke@435 | 214 | public: |
duke@435 | 215 | // Called for each space |
duke@435 | 216 | virtual void do_space(Space* s) = 0; |
duke@435 | 217 | }; |
duke@435 | 218 | |
duke@435 | 219 | class CompactibleSpaceClosure : public StackObj { |
duke@435 | 220 | public: |
duke@435 | 221 | // Called for each compactible space |
duke@435 | 222 | virtual void do_space(CompactibleSpace* s) = 0; |
duke@435 | 223 | }; |
duke@435 | 224 | |
duke@435 | 225 | |
jrose@1424 | 226 | // CodeBlobClosure is used for iterating through code blobs |
jrose@1424 | 227 | // in the code cache or on thread stacks |
jrose@1424 | 228 | |
jrose@1424 | 229 | class CodeBlobClosure : public Closure { |
jrose@1424 | 230 | public: |
jrose@1424 | 231 | // Called for each code blob. |
jrose@1424 | 232 | virtual void do_code_blob(CodeBlob* cb) = 0; |
jrose@1424 | 233 | }; |
jrose@1424 | 234 | |
jrose@1424 | 235 | |
jrose@1424 | 236 | class MarkingCodeBlobClosure : public CodeBlobClosure { |
jrose@1424 | 237 | public: |
jrose@1424 | 238 | // Called for each code blob, but at most once per unique blob. |
jrose@1429 | 239 | virtual void do_newly_marked_nmethod(nmethod* nm) = 0; |
jrose@1424 | 240 | |
jrose@1424 | 241 | virtual void do_code_blob(CodeBlob* cb); |
jrose@1424 | 242 | // = { if (!nmethod(cb)->test_set_oops_do_mark()) do_newly_marked_nmethod(cb); } |
jrose@1424 | 243 | |
jrose@1424 | 244 | class MarkScope : public StackObj { |
jrose@1424 | 245 | protected: |
jrose@1424 | 246 | bool _active; |
jrose@1424 | 247 | public: |
jrose@1424 | 248 | MarkScope(bool activate = true); |
jrose@1424 | 249 | // = { if (active) nmethod::oops_do_marking_prologue(); } |
jrose@1424 | 250 | ~MarkScope(); |
jrose@1424 | 251 | // = { if (active) nmethod::oops_do_marking_epilogue(); } |
jrose@1424 | 252 | }; |
jrose@1424 | 253 | }; |
jrose@1424 | 254 | |
jrose@1424 | 255 | |
jrose@1424 | 256 | // Applies an oop closure to all ref fields in code blobs |
jrose@1424 | 257 | // iterated over in an object iteration. |
jrose@1424 | 258 | class CodeBlobToOopClosure: public MarkingCodeBlobClosure { |
jrose@1424 | 259 | OopClosure* _cl; |
jrose@1424 | 260 | bool _do_marking; |
jrose@1424 | 261 | public: |
jrose@1429 | 262 | virtual void do_newly_marked_nmethod(nmethod* cb); |
jrose@1424 | 263 | // = { cb->oops_do(_cl); } |
jrose@1424 | 264 | virtual void do_code_blob(CodeBlob* cb); |
jrose@1424 | 265 | // = { if (_do_marking) super::do_code_blob(cb); else cb->oops_do(_cl); } |
jrose@1424 | 266 | CodeBlobToOopClosure(OopClosure* cl, bool do_marking) |
jrose@1424 | 267 | : _cl(cl), _do_marking(do_marking) {} |
jrose@1424 | 268 | }; |
jrose@1424 | 269 | |
jrose@1424 | 270 | |
duke@435 | 271 | |
duke@435 | 272 | // MonitorClosure is used for iterating over monitors in the monitors cache |
duke@435 | 273 | |
duke@435 | 274 | class ObjectMonitor; |
duke@435 | 275 | |
duke@435 | 276 | class MonitorClosure : public StackObj { |
duke@435 | 277 | public: |
duke@435 | 278 | // called for each monitor in cache |
duke@435 | 279 | virtual void do_monitor(ObjectMonitor* m) = 0; |
duke@435 | 280 | }; |
duke@435 | 281 | |
duke@435 | 282 | // A closure that is applied without any arguments. |
duke@435 | 283 | class VoidClosure : public StackObj { |
duke@435 | 284 | public: |
duke@435 | 285 | // I would have liked to declare this a pure virtual, but that breaks |
duke@435 | 286 | // in mysterious ways, for unknown reasons. |
duke@435 | 287 | virtual void do_void(); |
duke@435 | 288 | }; |
duke@435 | 289 | |
duke@435 | 290 | |
duke@435 | 291 | // YieldClosure is intended for use by iteration loops |
duke@435 | 292 | // to incrementalize their work, allowing interleaving |
duke@435 | 293 | // of an interruptable task so as to allow other |
duke@435 | 294 | // threads to run (which may not otherwise be able to access |
duke@435 | 295 | // exclusive resources, for instance). Additionally, the |
duke@435 | 296 | // closure also allows for aborting an ongoing iteration |
duke@435 | 297 | // by means of checking the return value from the polling |
duke@435 | 298 | // call. |
duke@435 | 299 | class YieldClosure : public StackObj { |
duke@435 | 300 | public: |
duke@435 | 301 | virtual bool should_return() = 0; |
duke@435 | 302 | }; |
duke@435 | 303 | |
duke@435 | 304 | // Abstract closure for serializing data (read or write). |
duke@435 | 305 | |
coleenp@4037 | 306 | class SerializeClosure : public Closure { |
duke@435 | 307 | public: |
duke@435 | 308 | // Return bool indicating whether closure implements read or write. |
duke@435 | 309 | virtual bool reading() const = 0; |
duke@435 | 310 | |
duke@435 | 311 | // Read/write the void pointer pointed to by p. |
duke@435 | 312 | virtual void do_ptr(void** p) = 0; |
duke@435 | 313 | |
duke@435 | 314 | // Read/write the region specified. |
duke@435 | 315 | virtual void do_region(u_char* start, size_t size) = 0; |
duke@435 | 316 | |
duke@435 | 317 | // Check/write the tag. If reading, then compare the tag against |
duke@435 | 318 | // the passed in value and fail is they don't match. This allows |
duke@435 | 319 | // for verification that sections of the serialized data are of the |
duke@435 | 320 | // correct length. |
duke@435 | 321 | virtual void do_tag(int tag) = 0; |
duke@435 | 322 | }; |
jmasa@1370 | 323 | |
coleenp@2497 | 324 | class SymbolClosure : public StackObj { |
coleenp@2497 | 325 | public: |
coleenp@2497 | 326 | virtual void do_symbol(Symbol**) = 0; |
coleenp@2497 | 327 | |
coleenp@2497 | 328 | // Clear LSB in symbol address; it can be set by CPSlot. |
coleenp@2497 | 329 | static Symbol* load_symbol(Symbol** p) { |
coleenp@2497 | 330 | return (Symbol*)(intptr_t(*p) & ~1); |
coleenp@2497 | 331 | } |
coleenp@2497 | 332 | |
coleenp@2497 | 333 | // Store symbol, adjusting new pointer if the original pointer was adjusted |
coleenp@2497 | 334 | // (symbol references in constant pool slots have their LSB set to 1). |
coleenp@2497 | 335 | static void store_symbol(Symbol** p, Symbol* sym) { |
coleenp@2497 | 336 | *p = (Symbol*)(intptr_t(sym) | (intptr_t(*p) & 1)); |
coleenp@2497 | 337 | } |
coleenp@2497 | 338 | }; |
coleenp@2497 | 339 | |
stefank@2314 | 340 | #endif // SHARE_VM_MEMORY_ITERATOR_HPP |