1 /*
   2  * Copyright (c) 2000, 2011, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #include "precompiled.hpp"
  26 #include "classfile/symbolTable.hpp"
  27 #include "classfile/systemDictionary.hpp"
  28 #include "code/codeCache.hpp"
  29 #include "gc_interface/collectedHeap.inline.hpp"
  30 #include "memory/sharedHeap.hpp"
  31 #include "oops/oop.inline.hpp"
  32 #include "runtime/fprofiler.hpp"
  33 #include "runtime/java.hpp"
  34 #include "services/management.hpp"
  35 #include "utilities/copy.hpp"
  36 #include "utilities/workgroup.hpp"
  37 
  38 SharedHeap* SharedHeap::_sh;
  39 
  40 // The set of potentially parallel tasks in strong root scanning.
  41 enum SH_process_strong_roots_tasks {
  42   SH_PS_Universe_oops_do,
  43   SH_PS_JNIHandles_oops_do,
  44   SH_PS_ObjectSynchronizer_oops_do,
  45   SH_PS_FlatProfiler_oops_do,
  46   SH_PS_Management_oops_do,
  47   SH_PS_SystemDictionary_oops_do,
  48   SH_PS_jvmti_oops_do,
  49   SH_PS_StringTable_oops_do,
  50   SH_PS_CodeCache_oops_do,
  51   // Leave this one last.
  52   SH_PS_NumElements
  53 };
  54 
  55 SharedHeap::SharedHeap(CollectorPolicy* policy_) :
  56   CollectedHeap(),
  57   _collector_policy(policy_),
  58   _perm_gen(NULL), _rem_set(NULL),
  59   _strong_roots_parity(0),
  60   _process_strong_tasks(new SubTasksDone(SH_PS_NumElements)),
  61   _workers(NULL)
  62 {
  63   if (_process_strong_tasks == NULL || !_process_strong_tasks->valid()) {
  64     vm_exit_during_initialization("Failed necessary allocation.");
  65   }
  66   _sh = this;  // ch is static, should be set only once.
  67   if ((UseParNewGC ||
  68       (UseConcMarkSweepGC && CMSParallelRemarkEnabled) ||
  69        UseG1GC) &&
  70       ParallelGCThreads > 0) {
  71     _workers = new FlexibleWorkGang("Parallel GC Threads", ParallelGCThreads,
  72                             /* are_GC_task_threads */true,
  73                             /* are_ConcurrentGC_threads */false);
  74     if (_workers == NULL) {
  75       vm_exit_during_initialization("Failed necessary allocation.");
  76     } else {
  77       _workers->initialize_workers();
  78     }
  79   }
  80 }
  81 
  82 int SharedHeap::n_termination() {
  83   return _process_strong_tasks->n_threads();
  84 }
  85 
  86 void SharedHeap::set_n_termination(int t) {
  87   _process_strong_tasks->set_n_threads(t);
  88 }
  89 
  90 bool SharedHeap::heap_lock_held_for_gc() {
  91   Thread* t = Thread::current();
  92   return    Heap_lock->owned_by_self()
  93          || (   (t->is_GC_task_thread() ||  t->is_VM_thread())
  94              && _thread_holds_heap_lock_for_gc);
  95 }
  96 
  97 void SharedHeap::set_par_threads(uint t) {
  98   assert(t == 0 || !UseSerialGC, "Cannot have parallel threads");
  99   _n_par_threads = t;
 100   _process_strong_tasks->set_n_threads(t);
 101 }
 102 
 103 class AssertIsPermClosure: public OopClosure {
 104 public:
 105   virtual void do_oop(oop* p) {
 106     assert((*p) == NULL || (*p)->is_perm(), "Referent should be perm.");
 107   }
 108   virtual void do_oop(narrowOop* p) { ShouldNotReachHere(); }
 109 };
 110 static AssertIsPermClosure assert_is_perm_closure;
 111 
 112 #ifdef ASSERT
 113 class AssertNonScavengableClosure: public OopClosure {
 114 public:
 115   virtual void do_oop(oop* p) {
 116     assert(!Universe::heap()->is_in_partial_collection(*p),
 117       "Referent should not be scavengable.");  }
 118   virtual void do_oop(narrowOop* p) { ShouldNotReachHere(); }
 119 };
 120 static AssertNonScavengableClosure assert_is_non_scavengable_closure;
 121 #endif
 122 
 123 void SharedHeap::change_strong_roots_parity() {
 124   // Also set the new collection parity.
 125   assert(_strong_roots_parity >= 0 && _strong_roots_parity <= 2,
 126          "Not in range.");
 127   _strong_roots_parity++;
 128   if (_strong_roots_parity == 3) _strong_roots_parity = 1;
 129   assert(_strong_roots_parity >= 1 && _strong_roots_parity <= 2,
 130          "Not in range.");
 131 }
 132 
 133 SharedHeap::StrongRootsScope::StrongRootsScope(SharedHeap* outer, bool activate)
 134   : MarkScope(activate)
 135 {
 136   if (_active) {
 137     outer->change_strong_roots_parity();
 138   }
 139 }
 140 
 141 SharedHeap::StrongRootsScope::~StrongRootsScope() {
 142   // nothing particular
 143 }
 144 
 145 void SharedHeap::process_strong_roots(bool activate_scope,
 146                                       bool collecting_perm_gen,
 147                                       ScanningOption so,
 148                                       OopClosure* roots,
 149                                       CodeBlobClosure* code_roots,
 150                                       OopsInGenClosure* perm_blk) {
 151   StrongRootsScope srs(this, activate_scope);
 152   // General strong roots.
 153   assert(_strong_roots_parity != 0, "must have called prologue code");
 154   // _n_termination for _process_strong_tasks should be set up stream
 155   // in a method not running in a GC worker.  Otherwise the GC worker
 156   // could be trying to change the termination condition while the task
 157   // is executing in another GC worker.
 158   if (!_process_strong_tasks->is_task_claimed(SH_PS_Universe_oops_do)) {
 159     Universe::oops_do(roots);
 160     // Consider perm-gen discovered lists to be strong.
 161     perm_gen()->ref_processor()->weak_oops_do(roots);
 162   }
 163   // Global (strong) JNI handles
 164   if (!_process_strong_tasks->is_task_claimed(SH_PS_JNIHandles_oops_do))
 165     JNIHandles::oops_do(roots);
 166   // All threads execute this; the individual threads are task groups.
 167   if (ParallelGCThreads > 0) {
 168     Threads::possibly_parallel_oops_do(roots, code_roots);
 169   } else {
 170     Threads::oops_do(roots, code_roots);
 171   }
 172   if (!_process_strong_tasks-> is_task_claimed(SH_PS_ObjectSynchronizer_oops_do))
 173     ObjectSynchronizer::oops_do(roots);
 174   if (!_process_strong_tasks->is_task_claimed(SH_PS_FlatProfiler_oops_do))
 175     FlatProfiler::oops_do(roots);
 176   if (!_process_strong_tasks->is_task_claimed(SH_PS_Management_oops_do))
 177     Management::oops_do(roots);
 178   if (!_process_strong_tasks->is_task_claimed(SH_PS_jvmti_oops_do))
 179     JvmtiExport::oops_do(roots);
 180 
 181   if (!_process_strong_tasks->is_task_claimed(SH_PS_SystemDictionary_oops_do)) {
 182     if (so & SO_AllClasses) {
 183       SystemDictionary::oops_do(roots);
 184     } else if (so & SO_SystemClasses) {
 185       SystemDictionary::always_strong_oops_do(roots);
 186     }
 187   }
 188 
 189   if (!_process_strong_tasks->is_task_claimed(SH_PS_StringTable_oops_do)) {
 190     if (so & SO_Strings || (!collecting_perm_gen && !JavaObjectsInPerm)) {
 191       StringTable::oops_do(roots);
 192     }
 193     if (JavaObjectsInPerm) {
 194       // Verify the string table contents are in the perm gen
 195       NOT_PRODUCT(StringTable::oops_do(&assert_is_perm_closure));
 196     }
 197   }
 198 
 199   if (!_process_strong_tasks->is_task_claimed(SH_PS_CodeCache_oops_do)) {
 200     if (so & SO_CodeCache) {
 201       // (Currently, CMSCollector uses this to do intermediate-strength collections.)
 202       assert(collecting_perm_gen, "scanning all of code cache");
 203       assert(code_roots != NULL, "must supply closure for code cache");
 204       if (code_roots != NULL) {
 205         CodeCache::blobs_do(code_roots);
 206       }
 207     } else if (so & (SO_SystemClasses|SO_AllClasses)) {
 208       if (!collecting_perm_gen) {
 209         // If we are collecting from class statics, but we are not going to
 210         // visit all of the CodeCache, collect from the non-perm roots if any.
 211         // This makes the code cache function temporarily as a source of strong
 212         // roots for oops, until the next major collection.
 213         //
 214         // If collecting_perm_gen is true, we require that this phase will call
 215         // CodeCache::do_unloading.  This will kill off nmethods with expired
 216         // weak references, such as stale invokedynamic targets.
 217         CodeCache::scavenge_root_nmethods_do(code_roots);
 218       }
 219     }
 220     // Verify that the code cache contents are not subject to
 221     // movement by a scavenging collection.
 222     DEBUG_ONLY(CodeBlobToOopClosure assert_code_is_non_scavengable(&assert_is_non_scavengable_closure, /*do_marking=*/ false));
 223     DEBUG_ONLY(CodeCache::asserted_non_scavengable_nmethods_do(&assert_code_is_non_scavengable));
 224   }
 225 
 226   if (!collecting_perm_gen) {
 227     // All threads perform this; coordination is handled internally.
 228 
 229     rem_set()->younger_refs_iterate(perm_gen(), perm_blk);
 230   }
 231   _process_strong_tasks->all_tasks_completed();
 232 }
 233 
 234 class AlwaysTrueClosure: public BoolObjectClosure {
 235 public:
 236   void do_object(oop p) { ShouldNotReachHere(); }
 237   bool do_object_b(oop p) { return true; }
 238 };
 239 static AlwaysTrueClosure always_true;
 240 
 241 class SkipAdjustingSharedStrings: public OopClosure {
 242   OopClosure* _clo;
 243 public:
 244   SkipAdjustingSharedStrings(OopClosure* clo) : _clo(clo) {}
 245 
 246   virtual void do_oop(oop* p) {
 247     oop o = (*p);
 248     if (!o->is_shared_readwrite()) {
 249       _clo->do_oop(p);
 250     }
 251   }
 252   virtual void do_oop(narrowOop* p) { ShouldNotReachHere(); }
 253 };
 254 
 255 // Unmarked shared Strings in the StringTable (which got there due to
 256 // being in the constant pools of as-yet unloaded shared classes) were
 257 // not marked and therefore did not have their mark words preserved.
 258 // These entries are also deliberately not purged from the string
 259 // table during unloading of unmarked strings. If an identity hash
 260 // code was computed for any of these objects, it will not have been
 261 // cleared to zero during the forwarding process or by the
 262 // RecursiveAdjustSharedObjectClosure, and will be confused by the
 263 // adjusting process as a forwarding pointer. We need to skip
 264 // forwarding StringTable entries which contain unmarked shared
 265 // Strings. Actually, since shared strings won't be moving, we can
 266 // just skip adjusting any shared entries in the string table.
 267 
 268 void SharedHeap::process_weak_roots(OopClosure* root_closure,
 269                                     CodeBlobClosure* code_roots,
 270                                     OopClosure* non_root_closure) {
 271   // Global (weak) JNI handles
 272   JNIHandles::weak_oops_do(&always_true, root_closure);
 273 
 274   CodeCache::blobs_do(code_roots);
 275   if (UseSharedSpaces && !DumpSharedSpaces) {
 276     SkipAdjustingSharedStrings skip_closure(root_closure);
 277     StringTable::oops_do(&skip_closure);
 278   } else {
 279     StringTable::oops_do(root_closure);
 280   }
 281 }
 282 
 283 void SharedHeap::set_barrier_set(BarrierSet* bs) {
 284   _barrier_set = bs;
 285   // Cached barrier set for fast access in oops
 286   oopDesc::set_bs(bs);
 287 }
 288 
 289 void SharedHeap::post_initialize() {
 290   ref_processing_init();
 291 }
 292 
 293 void SharedHeap::ref_processing_init() {
 294   perm_gen()->ref_processor_init();
 295 }
 296 
 297 // Some utilities.
 298 void SharedHeap::print_size_transition(outputStream* out,
 299                                        size_t bytes_before,
 300                                        size_t bytes_after,
 301                                        size_t capacity) {
 302   out->print(" %d%s->%d%s(%d%s)",
 303              byte_size_in_proper_unit(bytes_before),
 304              proper_unit_for_byte_size(bytes_before),
 305              byte_size_in_proper_unit(bytes_after),
 306              proper_unit_for_byte_size(bytes_after),
 307              byte_size_in_proper_unit(capacity),
 308              proper_unit_for_byte_size(capacity));
 309 }