annotate src/share/vm/memory/iterator.hpp @ 0:a61af66fc99e jdk7-b24

Initial load
author duke
date Sat, 01 Dec 2007 00:00:00 +0000
parents
children ba764ed4b6f2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a61af66fc99e Initial load
duke
parents:
diff changeset
1 /*
a61af66fc99e Initial load
duke
parents:
diff changeset
2 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
a61af66fc99e Initial load
duke
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
a61af66fc99e Initial load
duke
parents:
diff changeset
4 *
a61af66fc99e Initial load
duke
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
a61af66fc99e Initial load
duke
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
a61af66fc99e Initial load
duke
parents:
diff changeset
7 * published by the Free Software Foundation.
a61af66fc99e Initial load
duke
parents:
diff changeset
8 *
a61af66fc99e Initial load
duke
parents:
diff changeset
9 * This code is distributed in the hope that it will be useful, but WITHOUT
a61af66fc99e Initial load
duke
parents:
diff changeset
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
a61af66fc99e Initial load
duke
parents:
diff changeset
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
a61af66fc99e Initial load
duke
parents:
diff changeset
12 * version 2 for more details (a copy is included in the LICENSE file that
a61af66fc99e Initial load
duke
parents:
diff changeset
13 * accompanied this code).
a61af66fc99e Initial load
duke
parents:
diff changeset
14 *
a61af66fc99e Initial load
duke
parents:
diff changeset
15 * You should have received a copy of the GNU General Public License version
a61af66fc99e Initial load
duke
parents:
diff changeset
16 * 2 along with this work; if not, write to the Free Software Foundation,
a61af66fc99e Initial load
duke
parents:
diff changeset
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
a61af66fc99e Initial load
duke
parents:
diff changeset
18 *
a61af66fc99e Initial load
duke
parents:
diff changeset
19 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
a61af66fc99e Initial load
duke
parents:
diff changeset
20 * CA 95054 USA or visit www.sun.com if you need additional information or
a61af66fc99e Initial load
duke
parents:
diff changeset
21 * have any questions.
a61af66fc99e Initial load
duke
parents:
diff changeset
22 *
a61af66fc99e Initial load
duke
parents:
diff changeset
23 */
a61af66fc99e Initial load
duke
parents:
diff changeset
24
a61af66fc99e Initial load
duke
parents:
diff changeset
25 // The following classes are C++ `closures` for iterating over objects, roots and spaces
a61af66fc99e Initial load
duke
parents:
diff changeset
26
a61af66fc99e Initial load
duke
parents:
diff changeset
27 class ReferenceProcessor;
a61af66fc99e Initial load
duke
parents:
diff changeset
28
a61af66fc99e Initial load
duke
parents:
diff changeset
29 // OopClosure is used for iterating through roots (oop*)
a61af66fc99e Initial load
duke
parents:
diff changeset
30
a61af66fc99e Initial load
duke
parents:
diff changeset
31 class OopClosure : public StackObj {
a61af66fc99e Initial load
duke
parents:
diff changeset
32 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
33 ReferenceProcessor* _ref_processor;
a61af66fc99e Initial load
duke
parents:
diff changeset
34 OopClosure(ReferenceProcessor* rp) : _ref_processor(rp) { }
a61af66fc99e Initial load
duke
parents:
diff changeset
35 OopClosure() : _ref_processor(NULL) { }
a61af66fc99e Initial load
duke
parents:
diff changeset
36 virtual void do_oop(oop* o) = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
37 virtual void do_oop_v(oop* o) { do_oop(o); }
a61af66fc99e Initial load
duke
parents:
diff changeset
38
a61af66fc99e Initial load
duke
parents:
diff changeset
39 // In support of post-processing of weak links of KlassKlass objects;
a61af66fc99e Initial load
duke
parents:
diff changeset
40 // see KlassKlass::oop_oop_iterate().
a61af66fc99e Initial load
duke
parents:
diff changeset
41 virtual const bool should_remember_klasses() const { return false; }
a61af66fc99e Initial load
duke
parents:
diff changeset
42 virtual void remember_klass(Klass* k) { /* do nothing */ }
a61af66fc99e Initial load
duke
parents:
diff changeset
43
a61af66fc99e Initial load
duke
parents:
diff changeset
44 // If "true", invoke on nmethods (when scanning compiled frames).
a61af66fc99e Initial load
duke
parents:
diff changeset
45 virtual const bool do_nmethods() const { return false; }
a61af66fc99e Initial load
duke
parents:
diff changeset
46
a61af66fc99e Initial load
duke
parents:
diff changeset
47 // The methods below control how object iterations invoking this closure
a61af66fc99e Initial load
duke
parents:
diff changeset
48 // should be performed:
a61af66fc99e Initial load
duke
parents:
diff changeset
49
a61af66fc99e Initial load
duke
parents:
diff changeset
50 // If "true", invoke on header klass field.
a61af66fc99e Initial load
duke
parents:
diff changeset
51 bool do_header() { return true; } // Note that this is non-virtual.
a61af66fc99e Initial load
duke
parents:
diff changeset
52 // Controls how prefetching is done for invocations of this closure.
a61af66fc99e Initial load
duke
parents:
diff changeset
53 Prefetch::style prefetch_style() { // Note that this is non-virtual.
a61af66fc99e Initial load
duke
parents:
diff changeset
54 return Prefetch::do_none;
a61af66fc99e Initial load
duke
parents:
diff changeset
55 }
a61af66fc99e Initial load
duke
parents:
diff changeset
56 };
a61af66fc99e Initial load
duke
parents:
diff changeset
57
a61af66fc99e Initial load
duke
parents:
diff changeset
58 // ObjectClosure is used for iterating through an object space
a61af66fc99e Initial load
duke
parents:
diff changeset
59
a61af66fc99e Initial load
duke
parents:
diff changeset
60 class ObjectClosure : public StackObj {
a61af66fc99e Initial load
duke
parents:
diff changeset
61 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
62 // Called for each object.
a61af66fc99e Initial load
duke
parents:
diff changeset
63 virtual void do_object(oop obj) = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
64 };
a61af66fc99e Initial load
duke
parents:
diff changeset
65
a61af66fc99e Initial load
duke
parents:
diff changeset
66
a61af66fc99e Initial load
duke
parents:
diff changeset
67 class BoolObjectClosure : public ObjectClosure {
a61af66fc99e Initial load
duke
parents:
diff changeset
68 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
69 virtual bool do_object_b(oop obj) = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
70 };
a61af66fc99e Initial load
duke
parents:
diff changeset
71
a61af66fc99e Initial load
duke
parents:
diff changeset
72 // Applies an oop closure to all ref fields in objects iterated over in an
a61af66fc99e Initial load
duke
parents:
diff changeset
73 // object iteration.
a61af66fc99e Initial load
duke
parents:
diff changeset
74 class ObjectToOopClosure: public ObjectClosure {
a61af66fc99e Initial load
duke
parents:
diff changeset
75 OopClosure* _cl;
a61af66fc99e Initial load
duke
parents:
diff changeset
76 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
77 void do_object(oop obj);
a61af66fc99e Initial load
duke
parents:
diff changeset
78 ObjectToOopClosure(OopClosure* cl) : _cl(cl) {}
a61af66fc99e Initial load
duke
parents:
diff changeset
79 };
a61af66fc99e Initial load
duke
parents:
diff changeset
80
a61af66fc99e Initial load
duke
parents:
diff changeset
81 // A version of ObjectClosure with "memory" (see _previous_address below)
a61af66fc99e Initial load
duke
parents:
diff changeset
82 class UpwardsObjectClosure: public BoolObjectClosure {
a61af66fc99e Initial load
duke
parents:
diff changeset
83 HeapWord* _previous_address;
a61af66fc99e Initial load
duke
parents:
diff changeset
84 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
85 UpwardsObjectClosure() : _previous_address(NULL) { }
a61af66fc99e Initial load
duke
parents:
diff changeset
86 void set_previous(HeapWord* addr) { _previous_address = addr; }
a61af66fc99e Initial load
duke
parents:
diff changeset
87 HeapWord* previous() { return _previous_address; }
a61af66fc99e Initial load
duke
parents:
diff changeset
88 // A return value of "true" can be used by the caller to decide
a61af66fc99e Initial load
duke
parents:
diff changeset
89 // if this object's end should *NOT* be recorded in
a61af66fc99e Initial load
duke
parents:
diff changeset
90 // _previous_address above.
a61af66fc99e Initial load
duke
parents:
diff changeset
91 virtual bool do_object_bm(oop obj, MemRegion mr) = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
92 };
a61af66fc99e Initial load
duke
parents:
diff changeset
93
a61af66fc99e Initial load
duke
parents:
diff changeset
94 // A version of ObjectClosure that is expected to be robust
a61af66fc99e Initial load
duke
parents:
diff changeset
95 // in the face of possibly uninitialized objects.
a61af66fc99e Initial load
duke
parents:
diff changeset
96 class ObjectClosureCareful : public ObjectClosure {
a61af66fc99e Initial load
duke
parents:
diff changeset
97 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
98 virtual size_t do_object_careful_m(oop p, MemRegion mr) = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
99 virtual size_t do_object_careful(oop p) = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
100 };
a61af66fc99e Initial load
duke
parents:
diff changeset
101
a61af66fc99e Initial load
duke
parents:
diff changeset
102 // The following are used in CompactibleFreeListSpace and
a61af66fc99e Initial load
duke
parents:
diff changeset
103 // ConcurrentMarkSweepGeneration.
a61af66fc99e Initial load
duke
parents:
diff changeset
104
a61af66fc99e Initial load
duke
parents:
diff changeset
105 // Blk closure (abstract class)
a61af66fc99e Initial load
duke
parents:
diff changeset
106 class BlkClosure : public StackObj {
a61af66fc99e Initial load
duke
parents:
diff changeset
107 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
108 virtual size_t do_blk(HeapWord* addr) = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
109 };
a61af66fc99e Initial load
duke
parents:
diff changeset
110
a61af66fc99e Initial load
duke
parents:
diff changeset
111 // A version of BlkClosure that is expected to be robust
a61af66fc99e Initial load
duke
parents:
diff changeset
112 // in the face of possibly uninitialized objects.
a61af66fc99e Initial load
duke
parents:
diff changeset
113 class BlkClosureCareful : public BlkClosure {
a61af66fc99e Initial load
duke
parents:
diff changeset
114 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
115 size_t do_blk(HeapWord* addr) {
a61af66fc99e Initial load
duke
parents:
diff changeset
116 guarantee(false, "call do_blk_careful instead");
a61af66fc99e Initial load
duke
parents:
diff changeset
117 return 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
118 }
a61af66fc99e Initial load
duke
parents:
diff changeset
119 virtual size_t do_blk_careful(HeapWord* addr) = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
120 };
a61af66fc99e Initial load
duke
parents:
diff changeset
121
a61af66fc99e Initial load
duke
parents:
diff changeset
122 // SpaceClosure is used for iterating over spaces
a61af66fc99e Initial load
duke
parents:
diff changeset
123
a61af66fc99e Initial load
duke
parents:
diff changeset
124 class Space;
a61af66fc99e Initial load
duke
parents:
diff changeset
125 class CompactibleSpace;
a61af66fc99e Initial load
duke
parents:
diff changeset
126
a61af66fc99e Initial load
duke
parents:
diff changeset
127 class SpaceClosure : public StackObj {
a61af66fc99e Initial load
duke
parents:
diff changeset
128 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
129 // Called for each space
a61af66fc99e Initial load
duke
parents:
diff changeset
130 virtual void do_space(Space* s) = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
131 };
a61af66fc99e Initial load
duke
parents:
diff changeset
132
a61af66fc99e Initial load
duke
parents:
diff changeset
133 class CompactibleSpaceClosure : public StackObj {
a61af66fc99e Initial load
duke
parents:
diff changeset
134 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
135 // Called for each compactible space
a61af66fc99e Initial load
duke
parents:
diff changeset
136 virtual void do_space(CompactibleSpace* s) = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
137 };
a61af66fc99e Initial load
duke
parents:
diff changeset
138
a61af66fc99e Initial load
duke
parents:
diff changeset
139
a61af66fc99e Initial load
duke
parents:
diff changeset
140
a61af66fc99e Initial load
duke
parents:
diff changeset
141 // MonitorClosure is used for iterating over monitors in the monitors cache
a61af66fc99e Initial load
duke
parents:
diff changeset
142
a61af66fc99e Initial load
duke
parents:
diff changeset
143 class ObjectMonitor;
a61af66fc99e Initial load
duke
parents:
diff changeset
144
a61af66fc99e Initial load
duke
parents:
diff changeset
145 class MonitorClosure : public StackObj {
a61af66fc99e Initial load
duke
parents:
diff changeset
146 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
147 // called for each monitor in cache
a61af66fc99e Initial load
duke
parents:
diff changeset
148 virtual void do_monitor(ObjectMonitor* m) = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
149 };
a61af66fc99e Initial load
duke
parents:
diff changeset
150
a61af66fc99e Initial load
duke
parents:
diff changeset
151 // A closure that is applied without any arguments.
a61af66fc99e Initial load
duke
parents:
diff changeset
152 class VoidClosure : public StackObj {
a61af66fc99e Initial load
duke
parents:
diff changeset
153 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
154 // I would have liked to declare this a pure virtual, but that breaks
a61af66fc99e Initial load
duke
parents:
diff changeset
155 // in mysterious ways, for unknown reasons.
a61af66fc99e Initial load
duke
parents:
diff changeset
156 virtual void do_void();
a61af66fc99e Initial load
duke
parents:
diff changeset
157 };
a61af66fc99e Initial load
duke
parents:
diff changeset
158
a61af66fc99e Initial load
duke
parents:
diff changeset
159
a61af66fc99e Initial load
duke
parents:
diff changeset
160 // YieldClosure is intended for use by iteration loops
a61af66fc99e Initial load
duke
parents:
diff changeset
161 // to incrementalize their work, allowing interleaving
a61af66fc99e Initial load
duke
parents:
diff changeset
162 // of an interruptable task so as to allow other
a61af66fc99e Initial load
duke
parents:
diff changeset
163 // threads to run (which may not otherwise be able to access
a61af66fc99e Initial load
duke
parents:
diff changeset
164 // exclusive resources, for instance). Additionally, the
a61af66fc99e Initial load
duke
parents:
diff changeset
165 // closure also allows for aborting an ongoing iteration
a61af66fc99e Initial load
duke
parents:
diff changeset
166 // by means of checking the return value from the polling
a61af66fc99e Initial load
duke
parents:
diff changeset
167 // call.
a61af66fc99e Initial load
duke
parents:
diff changeset
168 class YieldClosure : public StackObj {
a61af66fc99e Initial load
duke
parents:
diff changeset
169 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
170 virtual bool should_return() = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
171 };
a61af66fc99e Initial load
duke
parents:
diff changeset
172
a61af66fc99e Initial load
duke
parents:
diff changeset
173 // Abstract closure for serializing data (read or write).
a61af66fc99e Initial load
duke
parents:
diff changeset
174
a61af66fc99e Initial load
duke
parents:
diff changeset
175 class SerializeOopClosure : public OopClosure {
a61af66fc99e Initial load
duke
parents:
diff changeset
176 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
177 // Return bool indicating whether closure implements read or write.
a61af66fc99e Initial load
duke
parents:
diff changeset
178 virtual bool reading() const = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
179
a61af66fc99e Initial load
duke
parents:
diff changeset
180 // Read/write the int pointed to by i.
a61af66fc99e Initial load
duke
parents:
diff changeset
181 virtual void do_int(int* i) = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
182
a61af66fc99e Initial load
duke
parents:
diff changeset
183 // Read/write the size_t pointed to by i.
a61af66fc99e Initial load
duke
parents:
diff changeset
184 virtual void do_size_t(size_t* i) = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
185
a61af66fc99e Initial load
duke
parents:
diff changeset
186 // Read/write the void pointer pointed to by p.
a61af66fc99e Initial load
duke
parents:
diff changeset
187 virtual void do_ptr(void** p) = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
188
a61af66fc99e Initial load
duke
parents:
diff changeset
189 // Read/write the HeapWord pointer pointed to be p.
a61af66fc99e Initial load
duke
parents:
diff changeset
190 virtual void do_ptr(HeapWord** p) = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
191
a61af66fc99e Initial load
duke
parents:
diff changeset
192 // Read/write the region specified.
a61af66fc99e Initial load
duke
parents:
diff changeset
193 virtual void do_region(u_char* start, size_t size) = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
194
a61af66fc99e Initial load
duke
parents:
diff changeset
195 // Check/write the tag. If reading, then compare the tag against
a61af66fc99e Initial load
duke
parents:
diff changeset
196 // the passed in value and fail is they don't match. This allows
a61af66fc99e Initial load
duke
parents:
diff changeset
197 // for verification that sections of the serialized data are of the
a61af66fc99e Initial load
duke
parents:
diff changeset
198 // correct length.
a61af66fc99e Initial load
duke
parents:
diff changeset
199 virtual void do_tag(int tag) = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
200 };