src/share/vm/memory/sharedHeap.hpp

Mon, 12 Aug 2019 18:30:40 +0300

author
apetushkov
date
Mon, 12 Aug 2019 18:30:40 +0300
changeset 9858
b985cbb00e68
parent 7659
38d6febe66af
child 7994
04ff2f6cd0eb
permissions
-rw-r--r--

8223147: JFR Backport
8199712: Flight Recorder
8203346: JFR: Inconsistent signature of jfr_add_string_constant
8195817: JFR.stop should require name of recording
8195818: JFR.start should increase autogenerated name by one
8195819: Remove recording=x from jcmd JFR.check output
8203921: JFR thread sampling is missing fixes from JDK-8194552
8203929: Limit amount of data for JFR.dump
8203664: JFR start failure after AppCDS archive created with JFR StartFlightRecording
8003209: JFR events for network utilization
8207392: [PPC64] Implement JFR profiling
8202835: jfr/event/os/TestSystemProcess.java fails on missing events
Summary: Backport JFR from JDK11. Initial integration
Reviewed-by: neugens

duke@435 1 /*
mikael@6198 2 * Copyright (c) 2000, 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_SHAREDHEAP_HPP
stefank@2314 26 #define SHARE_VM_MEMORY_SHAREDHEAP_HPP
stefank@2314 27
stefank@2314 28 #include "gc_interface/collectedHeap.hpp"
stefank@2314 29 #include "memory/generation.hpp"
stefank@2314 30
duke@435 31 // A "SharedHeap" is an implementation of a java heap for HotSpot. This
duke@435 32 // is an abstract class: there may be many different kinds of heaps. This
duke@435 33 // class defines the functions that a heap must implement, and contains
duke@435 34 // infrastructure common to all heaps.
duke@435 35
duke@435 36 class Generation;
duke@435 37 class BarrierSet;
duke@435 38 class GenRemSet;
duke@435 39 class Space;
duke@435 40 class SpaceClosure;
duke@435 41 class OopClosure;
duke@435 42 class OopsInGenClosure;
duke@435 43 class ObjectClosure;
duke@435 44 class SubTasksDone;
duke@435 45 class WorkGang;
jmasa@2188 46 class FlexibleWorkGang;
duke@435 47 class CollectorPolicy;
coleenp@4037 48 class KlassClosure;
duke@435 49
jmasa@3294 50 // Note on use of FlexibleWorkGang's for GC.
jmasa@3294 51 // There are three places where task completion is determined.
jmasa@3294 52 // In
jmasa@3294 53 // 1) ParallelTaskTerminator::offer_termination() where _n_threads
jmasa@3294 54 // must be set to the correct value so that count of workers that
jmasa@3294 55 // have offered termination will exactly match the number
jmasa@3294 56 // working on the task. Tasks such as those derived from GCTask
jmasa@3294 57 // use ParallelTaskTerminator's. Tasks that want load balancing
jmasa@3294 58 // by work stealing use this method to gauge completion.
jmasa@3294 59 // 2) SubTasksDone has a variable _n_threads that is used in
jmasa@3294 60 // all_tasks_completed() to determine completion. all_tasks_complete()
jmasa@3294 61 // counts the number of tasks that have been done and then reset
jmasa@3294 62 // the SubTasksDone so that it can be used again. When the number of
jmasa@3294 63 // tasks is set to the number of GC workers, then _n_threads must
mgerdin@7659 64 // be set to the number of active GC workers. G1RootProcessor and
mgerdin@7659 65 // GenCollectedHeap have SubTasksDone.
jmasa@3294 66 // 3) SequentialSubTasksDone has an _n_threads that is used in
jmasa@3294 67 // a way similar to SubTasksDone and has the same dependency on the
jmasa@3294 68 // number of active GC workers. CompactibleFreeListSpace and Space
jmasa@3294 69 // have SequentialSubTasksDone's.
mgerdin@7659 70 //
mgerdin@7659 71 // Examples of using SubTasksDone and SequentialSubTasksDone:
mgerdin@7659 72 // G1RootProcessor and GenCollectedHeap::process_roots() use
mgerdin@7659 73 // SubTasksDone* _process_strong_tasks to claim tasks for workers
mgerdin@7659 74 //
mgerdin@7659 75 // GenCollectedHeap::gen_process_roots() calls
coleenp@4037 76 // rem_set()->younger_refs_iterate()
jmasa@3294 77 // to scan the card table and which eventually calls down into
jmasa@3294 78 // CardTableModRefBS::par_non_clean_card_iterate_work(). This method
jmasa@3294 79 // uses SequentialSubTasksDone* _pst to claim tasks.
jmasa@3294 80 // Both SubTasksDone and SequentialSubTasksDone call their method
jmasa@3294 81 // all_tasks_completed() to count the number of GC workers that have
jmasa@3294 82 // finished their work. That logic is "when all the workers are
jmasa@3294 83 // finished the tasks are finished".
jmasa@3294 84 //
jmasa@3294 85 // The pattern that appears in the code is to set _n_threads
jmasa@3294 86 // to a value > 1 before a task that you would like executed in parallel
jmasa@3294 87 // and then to set it to 0 after that task has completed. A value of
jmasa@3294 88 // 0 is a "special" value in set_n_threads() which translates to
jmasa@3294 89 // setting _n_threads to 1.
jmasa@3294 90 //
jmasa@3294 91 // Some code uses _n_terminiation to decide if work should be done in
jmasa@3294 92 // parallel. The notorious possibly_parallel_oops_do() in threads.cpp
jmasa@3294 93 // is an example of such code. Look for variable "is_par" for other
jmasa@3294 94 // examples.
jmasa@3294 95 //
jmasa@3294 96 // The active_workers is not reset to 0 after a parallel phase. It's
jmasa@3294 97 // value may be used in later phases and in one instance at least
jmasa@3294 98 // (the parallel remark) it has to be used (the parallel remark depends
jmasa@3294 99 // on the partitioning done in the previous parallel scavenge).
jmasa@3294 100
duke@435 101 class SharedHeap : public CollectedHeap {
duke@435 102 friend class VMStructs;
duke@435 103
ysr@777 104 friend class VM_GC_Operation;
ysr@777 105 friend class VM_CGC_Operation;
ysr@777 106
duke@435 107 protected:
duke@435 108 // There should be only a single instance of "SharedHeap" in a program.
duke@435 109 // This is enforced with the protected constructor below, which will also
duke@435 110 // set the static pointer "_sh" to that instance.
duke@435 111 static SharedHeap* _sh;
duke@435 112
duke@435 113 // and the Gen Remembered Set, at least one good enough to scan the perm
duke@435 114 // gen.
duke@435 115 GenRemSet* _rem_set;
duke@435 116
duke@435 117 // A gc policy, controls global gc resource issues
duke@435 118 CollectorPolicy *_collector_policy;
duke@435 119
duke@435 120 // See the discussion below, in the specification of the reader function
duke@435 121 // for this variable.
duke@435 122 int _strong_roots_parity;
duke@435 123
duke@435 124 // If we're doing parallel GC, use this gang of threads.
jmasa@2188 125 FlexibleWorkGang* _workers;
duke@435 126
duke@435 127 // Full initialization is done in a concrete subtype's "initialize"
duke@435 128 // function.
duke@435 129 SharedHeap(CollectorPolicy* policy_);
duke@435 130
ysr@777 131 // Returns true if the calling thread holds the heap lock,
ysr@777 132 // or the calling thread is a par gc thread and the heap_lock is held
ysr@777 133 // by the vm thread doing a gc operation.
ysr@777 134 bool heap_lock_held_for_gc();
ysr@777 135 // True if the heap_lock is held by the a non-gc thread invoking a gc
ysr@777 136 // operation.
ysr@777 137 bool _thread_holds_heap_lock_for_gc;
ysr@777 138
duke@435 139 public:
duke@435 140 static SharedHeap* heap() { return _sh; }
duke@435 141
duke@435 142 void set_barrier_set(BarrierSet* bs);
duke@435 143
duke@435 144 // Does operations required after initialization has been done.
duke@435 145 virtual void post_initialize();
duke@435 146
duke@435 147 // Initialization of ("weak") reference processing support
duke@435 148 virtual void ref_processing_init();
duke@435 149
duke@435 150 // This function returns the "GenRemSet" object that allows us to scan
coleenp@4037 151 // generations in a fully generational heap.
duke@435 152 GenRemSet* rem_set() { return _rem_set; }
duke@435 153
duke@435 154 // Iteration functions.
coleenp@4037 155 void oop_iterate(ExtendedOopClosure* cl) = 0;
duke@435 156
duke@435 157 // Iterate over all spaces in use in the heap, in an undefined order.
duke@435 158 virtual void space_iterate(SpaceClosure* cl) = 0;
duke@435 159
duke@435 160 // A SharedHeap will contain some number of spaces. This finds the
duke@435 161 // space whose reserved area contains the given address, or else returns
duke@435 162 // NULL.
duke@435 163 virtual Space* space_containing(const void* addr) const = 0;
duke@435 164
duke@435 165 bool no_gc_in_progress() { return !is_gc_active(); }
duke@435 166
duke@435 167 // Some collectors will perform "process_strong_roots" in parallel.
duke@435 168 // Such a call will involve claiming some fine-grained tasks, such as
duke@435 169 // scanning of threads. To make this process simpler, we provide the
duke@435 170 // "strong_roots_parity()" method. Collectors that start parallel tasks
duke@435 171 // whose threads invoke "process_strong_roots" must
duke@435 172 // call "change_strong_roots_parity" in sequential code starting such a
duke@435 173 // task. (This also means that a parallel thread may only call
duke@435 174 // process_strong_roots once.)
duke@435 175 //
stefank@6992 176 // For calls to process_roots by sequential code, the parity is
duke@435 177 // updated automatically.
duke@435 178 //
duke@435 179 // The idea is that objects representing fine-grained tasks, such as
duke@435 180 // threads, will contain a "parity" field. A task will is claimed in the
stefank@6992 181 // current "process_roots" call only if its parity field is the
duke@435 182 // same as the "strong_roots_parity"; task claiming is accomplished by
duke@435 183 // updating the parity field to the strong_roots_parity with a CAS.
duke@435 184 //
duke@435 185 // If the client meats this spec, then strong_roots_parity() will have
duke@435 186 // the following properties:
duke@435 187 // a) to return a different value than was returned before the last
duke@435 188 // call to change_strong_roots_parity, and
duke@435 189 // c) to never return a distinguished value (zero) with which such
duke@435 190 // task-claiming variables may be initialized, to indicate "never
duke@435 191 // claimed".
jrose@1424 192 public:
duke@435 193 int strong_roots_parity() { return _strong_roots_parity; }
duke@435 194
stefank@6992 195 // Call these in sequential code around process_roots.
jrose@1424 196 // strong_roots_prologue calls change_strong_roots_parity, if
jrose@1424 197 // parallel tasks are enabled.
jrose@1424 198 class StrongRootsScope : public MarkingCodeBlobClosure::MarkScope {
stefank@6992 199 SharedHeap* _sh;
stefank@6992 200
stefank@6992 201 public:
stefank@6992 202 StrongRootsScope(SharedHeap* heap, bool activate = true);
jrose@1424 203 };
jrose@1424 204 friend class StrongRootsScope;
jrose@1424 205
stefank@6992 206 private:
stefank@6992 207 void change_strong_roots_parity();
stefank@6992 208
stefank@6992 209 public:
jmasa@2188 210 FlexibleWorkGang* workers() const { return _workers; }
duke@435 211
duke@435 212 // The functions below are helper functions that a subclass of
duke@435 213 // "SharedHeap" can use in the implementation of its virtual
duke@435 214 // functions.
duke@435 215
ysr@777 216 public:
duke@435 217
duke@435 218 // Do anything common to GC's.
duke@435 219 virtual void gc_prologue(bool full) = 0;
duke@435 220 virtual void gc_epilogue(bool full) = 0;
duke@435 221
jmasa@3294 222 // Sets the number of parallel threads that will be doing tasks
stefank@6992 223 // (such as process roots) subsequently.
jmasa@3357 224 virtual void set_par_threads(uint t);
jmasa@3294 225
duke@435 226 //
duke@435 227 // New methods from CollectedHeap
duke@435 228 //
duke@435 229
duke@435 230 // Some utilities.
ysr@777 231 void print_size_transition(outputStream* out,
ysr@777 232 size_t bytes_before,
duke@435 233 size_t bytes_after,
duke@435 234 size_t capacity);
duke@435 235 };
stefank@2314 236
stefank@2314 237 #endif // SHARE_VM_MEMORY_SHAREDHEAP_HPP

mercurial