src/share/vm/memory/sharedHeap.hpp

Mon, 20 Sep 2010 14:38:38 -0700

author
jmasa
date
Mon, 20 Sep 2010 14:38:38 -0700
changeset 2188
8b10f48633dc
parent 1907
c18cbe5936b8
child 2314
f95d63e2154a
permissions
-rw-r--r--

6984287: Regularize how GC parallel workers are specified.
Summary: Associate number of GC workers with the workgang as opposed to the task.
Reviewed-by: johnc, ysr

duke@435 1 /*
jmasa@2188 2 * Copyright (c) 2000, 2010, 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
duke@435 25 // A "SharedHeap" is an implementation of a java heap for HotSpot. This
duke@435 26 // is an abstract class: there may be many different kinds of heaps. This
duke@435 27 // class defines the functions that a heap must implement, and contains
duke@435 28 // infrastructure common to all heaps.
duke@435 29
duke@435 30 class PermGen;
duke@435 31 class Generation;
duke@435 32 class BarrierSet;
duke@435 33 class GenRemSet;
duke@435 34 class Space;
duke@435 35 class SpaceClosure;
duke@435 36 class OopClosure;
duke@435 37 class OopsInGenClosure;
duke@435 38 class ObjectClosure;
duke@435 39 class SubTasksDone;
duke@435 40 class WorkGang;
jmasa@2188 41 class FlexibleWorkGang;
duke@435 42 class CollectorPolicy;
duke@435 43 class KlassHandle;
duke@435 44
duke@435 45 class SharedHeap : public CollectedHeap {
duke@435 46 friend class VMStructs;
duke@435 47
ysr@777 48 friend class VM_GC_Operation;
ysr@777 49 friend class VM_CGC_Operation;
ysr@777 50
duke@435 51 private:
duke@435 52 // For claiming strong_roots tasks.
duke@435 53 SubTasksDone* _process_strong_tasks;
duke@435 54
duke@435 55 protected:
duke@435 56 // There should be only a single instance of "SharedHeap" in a program.
duke@435 57 // This is enforced with the protected constructor below, which will also
duke@435 58 // set the static pointer "_sh" to that instance.
duke@435 59 static SharedHeap* _sh;
duke@435 60
duke@435 61 // All heaps contain a "permanent generation." This is some ways
duke@435 62 // similar to a generation in a generational system, in other ways not.
duke@435 63 // See the "PermGen" class.
duke@435 64 PermGen* _perm_gen;
duke@435 65
duke@435 66 // and the Gen Remembered Set, at least one good enough to scan the perm
duke@435 67 // gen.
duke@435 68 GenRemSet* _rem_set;
duke@435 69
duke@435 70 // A gc policy, controls global gc resource issues
duke@435 71 CollectorPolicy *_collector_policy;
duke@435 72
duke@435 73 // See the discussion below, in the specification of the reader function
duke@435 74 // for this variable.
duke@435 75 int _strong_roots_parity;
duke@435 76
duke@435 77 // If we're doing parallel GC, use this gang of threads.
jmasa@2188 78 FlexibleWorkGang* _workers;
duke@435 79
duke@435 80 // Number of parallel threads currently working on GC tasks.
duke@435 81 // O indicates use sequential code; 1 means use parallel code even with
duke@435 82 // only one thread, for performance testing purposes.
duke@435 83 int _n_par_threads;
duke@435 84
duke@435 85 // Full initialization is done in a concrete subtype's "initialize"
duke@435 86 // function.
duke@435 87 SharedHeap(CollectorPolicy* policy_);
duke@435 88
ysr@777 89 // Returns true if the calling thread holds the heap lock,
ysr@777 90 // or the calling thread is a par gc thread and the heap_lock is held
ysr@777 91 // by the vm thread doing a gc operation.
ysr@777 92 bool heap_lock_held_for_gc();
ysr@777 93 // True if the heap_lock is held by the a non-gc thread invoking a gc
ysr@777 94 // operation.
ysr@777 95 bool _thread_holds_heap_lock_for_gc;
ysr@777 96
duke@435 97 public:
duke@435 98 static SharedHeap* heap() { return _sh; }
duke@435 99
duke@435 100 CollectorPolicy *collector_policy() const { return _collector_policy; }
duke@435 101
duke@435 102 void set_barrier_set(BarrierSet* bs);
duke@435 103
duke@435 104 // Does operations required after initialization has been done.
duke@435 105 virtual void post_initialize();
duke@435 106
duke@435 107 // Initialization of ("weak") reference processing support
duke@435 108 virtual void ref_processing_init();
duke@435 109
duke@435 110 void set_perm(PermGen* perm_gen) { _perm_gen = perm_gen; }
duke@435 111
duke@435 112 // This function returns the "GenRemSet" object that allows us to scan
duke@435 113 // generations; at least the perm gen, possibly more in a fully
duke@435 114 // generational heap.
duke@435 115 GenRemSet* rem_set() { return _rem_set; }
duke@435 116
duke@435 117 // These function return the "permanent" generation, in which
duke@435 118 // reflective objects are allocated and stored. Two versions, the second
duke@435 119 // of which returns the view of the perm gen as a generation.
duke@435 120 PermGen* perm() const { return _perm_gen; }
duke@435 121 Generation* perm_gen() const { return _perm_gen->as_gen(); }
duke@435 122
duke@435 123 // Iteration functions.
duke@435 124 void oop_iterate(OopClosure* cl) = 0;
duke@435 125
duke@435 126 // Same as above, restricted to a memory region.
duke@435 127 virtual void oop_iterate(MemRegion mr, OopClosure* cl) = 0;
duke@435 128
duke@435 129 // Iterate over all objects allocated since the last collection, calling
duke@435 130 // "cl->do_object" on each. The heap must have been initialized properly
duke@435 131 // to support this function, or else this call will fail.
duke@435 132 virtual void object_iterate_since_last_GC(ObjectClosure* cl) = 0;
duke@435 133
duke@435 134 // Iterate over all spaces in use in the heap, in an undefined order.
duke@435 135 virtual void space_iterate(SpaceClosure* cl) = 0;
duke@435 136
duke@435 137 // A SharedHeap will contain some number of spaces. This finds the
duke@435 138 // space whose reserved area contains the given address, or else returns
duke@435 139 // NULL.
duke@435 140 virtual Space* space_containing(const void* addr) const = 0;
duke@435 141
duke@435 142 bool no_gc_in_progress() { return !is_gc_active(); }
duke@435 143
duke@435 144 // Some collectors will perform "process_strong_roots" in parallel.
duke@435 145 // Such a call will involve claiming some fine-grained tasks, such as
duke@435 146 // scanning of threads. To make this process simpler, we provide the
duke@435 147 // "strong_roots_parity()" method. Collectors that start parallel tasks
duke@435 148 // whose threads invoke "process_strong_roots" must
duke@435 149 // call "change_strong_roots_parity" in sequential code starting such a
duke@435 150 // task. (This also means that a parallel thread may only call
duke@435 151 // process_strong_roots once.)
duke@435 152 //
duke@435 153 // For calls to process_strong_roots by sequential code, the parity is
duke@435 154 // updated automatically.
duke@435 155 //
duke@435 156 // The idea is that objects representing fine-grained tasks, such as
duke@435 157 // threads, will contain a "parity" field. A task will is claimed in the
duke@435 158 // current "process_strong_roots" call only if its parity field is the
duke@435 159 // same as the "strong_roots_parity"; task claiming is accomplished by
duke@435 160 // updating the parity field to the strong_roots_parity with a CAS.
duke@435 161 //
duke@435 162 // If the client meats this spec, then strong_roots_parity() will have
duke@435 163 // the following properties:
duke@435 164 // a) to return a different value than was returned before the last
duke@435 165 // call to change_strong_roots_parity, and
duke@435 166 // c) to never return a distinguished value (zero) with which such
duke@435 167 // task-claiming variables may be initialized, to indicate "never
duke@435 168 // claimed".
jrose@1424 169 private:
duke@435 170 void change_strong_roots_parity();
jrose@1424 171 public:
duke@435 172 int strong_roots_parity() { return _strong_roots_parity; }
duke@435 173
jrose@1424 174 // Call these in sequential code around process_strong_roots.
jrose@1424 175 // strong_roots_prologue calls change_strong_roots_parity, if
jrose@1424 176 // parallel tasks are enabled.
jrose@1424 177 class StrongRootsScope : public MarkingCodeBlobClosure::MarkScope {
jrose@1424 178 public:
jrose@1424 179 StrongRootsScope(SharedHeap* outer, bool activate = true);
jrose@1424 180 ~StrongRootsScope();
jrose@1424 181 };
jrose@1424 182 friend class StrongRootsScope;
jrose@1424 183
duke@435 184 enum ScanningOption {
duke@435 185 SO_None = 0x0,
duke@435 186 SO_AllClasses = 0x1,
duke@435 187 SO_SystemClasses = 0x2,
duke@435 188 SO_Symbols = 0x4,
duke@435 189 SO_Strings = 0x8,
duke@435 190 SO_CodeCache = 0x10
duke@435 191 };
duke@435 192
jmasa@2188 193 FlexibleWorkGang* workers() const { return _workers; }
duke@435 194
duke@435 195 // Sets the number of parallel threads that will be doing tasks
duke@435 196 // (such as process strong roots) subsequently.
duke@435 197 virtual void set_par_threads(int t);
duke@435 198
duke@435 199 // Number of threads currently working on GC tasks.
duke@435 200 int n_par_threads() { return _n_par_threads; }
duke@435 201
duke@435 202 // Invoke the "do_oop" method the closure "roots" on all root locations.
duke@435 203 // If "collecting_perm_gen" is false, then roots that may only contain
duke@435 204 // references to permGen objects are not scanned. If true, the
duke@435 205 // "perm_gen" closure is applied to all older-to-younger refs in the
duke@435 206 // permanent generation. The "so" argument determines which of roots
duke@435 207 // the closure is applied to:
duke@435 208 // "SO_None" does none;
duke@435 209 // "SO_AllClasses" applies the closure to all entries in the SystemDictionary;
duke@435 210 // "SO_SystemClasses" to all the "system" classes and loaders;
duke@435 211 // "SO_Symbols" applies the closure to all entries in SymbolsTable;
duke@435 212 // "SO_Strings" applies the closure to all entries in StringTable;
duke@435 213 // "SO_CodeCache" applies the closure to all elements of the CodeCache.
jrose@1424 214 void process_strong_roots(bool activate_scope,
jrose@1424 215 bool collecting_perm_gen,
duke@435 216 ScanningOption so,
duke@435 217 OopClosure* roots,
jrose@1424 218 CodeBlobClosure* code_roots,
duke@435 219 OopsInGenClosure* perm_blk);
duke@435 220
duke@435 221 // Apply "blk" to all the weak roots of the system. These include
duke@435 222 // JNI weak roots, the code cache, system dictionary, symbol table,
duke@435 223 // string table.
duke@435 224 void process_weak_roots(OopClosure* root_closure,
jrose@1424 225 CodeBlobClosure* code_roots,
duke@435 226 OopClosure* non_root_closure);
duke@435 227
duke@435 228 // The functions below are helper functions that a subclass of
duke@435 229 // "SharedHeap" can use in the implementation of its virtual
duke@435 230 // functions.
duke@435 231
ysr@777 232 public:
duke@435 233
duke@435 234 // Do anything common to GC's.
duke@435 235 virtual void gc_prologue(bool full) = 0;
duke@435 236 virtual void gc_epilogue(bool full) = 0;
duke@435 237
duke@435 238 //
duke@435 239 // New methods from CollectedHeap
duke@435 240 //
duke@435 241
duke@435 242 size_t permanent_capacity() const {
duke@435 243 assert(perm_gen(), "NULL perm gen");
duke@435 244 return perm_gen()->capacity();
duke@435 245 }
duke@435 246
duke@435 247 size_t permanent_used() const {
duke@435 248 assert(perm_gen(), "NULL perm gen");
duke@435 249 return perm_gen()->used();
duke@435 250 }
duke@435 251
duke@435 252 bool is_in_permanent(const void *p) const {
duke@435 253 assert(perm_gen(), "NULL perm gen");
duke@435 254 return perm_gen()->is_in_reserved(p);
duke@435 255 }
duke@435 256
duke@435 257 // Different from is_in_permanent in that is_in_permanent
duke@435 258 // only checks if p is in the reserved area of the heap
duke@435 259 // and this checks to see if it in the commited area.
duke@435 260 // This is typically used by things like the forte stackwalker
duke@435 261 // during verification of suspicious frame values.
duke@435 262 bool is_permanent(const void *p) const {
duke@435 263 assert(perm_gen(), "NULL perm gen");
duke@435 264 return perm_gen()->is_in(p);
duke@435 265 }
duke@435 266
duke@435 267 HeapWord* permanent_mem_allocate(size_t size) {
duke@435 268 assert(perm_gen(), "NULL perm gen");
duke@435 269 return _perm_gen->mem_allocate(size);
duke@435 270 }
duke@435 271
duke@435 272 void permanent_oop_iterate(OopClosure* cl) {
duke@435 273 assert(perm_gen(), "NULL perm gen");
duke@435 274 _perm_gen->oop_iterate(cl);
duke@435 275 }
duke@435 276
duke@435 277 void permanent_object_iterate(ObjectClosure* cl) {
duke@435 278 assert(perm_gen(), "NULL perm gen");
duke@435 279 _perm_gen->object_iterate(cl);
duke@435 280 }
duke@435 281
duke@435 282 // Some utilities.
ysr@777 283 void print_size_transition(outputStream* out,
ysr@777 284 size_t bytes_before,
duke@435 285 size_t bytes_after,
duke@435 286 size_t capacity);
duke@435 287 };

mercurial