src/share/vm/gc_implementation/g1/ptrQueue.hpp

Mon, 19 Aug 2019 10:11:31 +0200

author
neugens
date
Mon, 19 Aug 2019 10:11:31 +0200
changeset 9861
a248d0be1309
parent 7445
42c091d63c72
child 7535
7ae4e26cb1e0
permissions
-rw-r--r--

8229401: Fix JFR code cache test failures
8223689: Add JFR Thread Sampling Support
8223690: Add JFR BiasedLock Event Support
8223691: Add JFR G1 Region Type Change Event Support
8223692: Add JFR G1 Heap Summary Event Support
Summary: Backport JFR from JDK11, additional fixes
Reviewed-by: neugens, apetushkov
Contributed-by: denghui.ddh@alibaba-inc.com

ysr@777 1 /*
tschatzl@7445 2 * Copyright (c) 2001, 2014, Oracle and/or its affiliates. All rights reserved.
ysr@777 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ysr@777 4 *
ysr@777 5 * This code is free software; you can redistribute it and/or modify it
ysr@777 6 * under the terms of the GNU General Public License version 2 only, as
ysr@777 7 * published by the Free Software Foundation.
ysr@777 8 *
ysr@777 9 * This code is distributed in the hope that it will be useful, but WITHOUT
ysr@777 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ysr@777 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ysr@777 12 * version 2 for more details (a copy is included in the LICENSE file that
ysr@777 13 * accompanied this code).
ysr@777 14 *
ysr@777 15 * You should have received a copy of the GNU General Public License version
ysr@777 16 * 2 along with this work; if not, write to the Free Software Foundation,
ysr@777 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ysr@777 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.
ysr@777 22 *
ysr@777 23 */
ysr@777 24
stefank@2314 25 #ifndef SHARE_VM_GC_IMPLEMENTATION_G1_PTRQUEUE_HPP
stefank@2314 26 #define SHARE_VM_GC_IMPLEMENTATION_G1_PTRQUEUE_HPP
stefank@2314 27
stefank@2314 28 #include "memory/allocation.hpp"
stefank@2314 29 #include "utilities/sizes.hpp"
stefank@2314 30
ysr@777 31 // There are various techniques that require threads to be able to log
ysr@777 32 // addresses. For example, a generational write barrier might log
ysr@777 33 // the addresses of modified old-generation objects. This type supports
ysr@777 34 // this operation.
ysr@777 35
iveresov@1546 36 // The definition of placement operator new(size_t, void*) in the <new>.
iveresov@1546 37 #include <new>
iveresov@1546 38
ysr@777 39 class PtrQueueSet;
apetrusenko@984 40 class PtrQueue VALUE_OBJ_CLASS_SPEC {
twisti@5726 41 friend class VMStructs;
ysr@777 42
ysr@777 43 protected:
ysr@777 44 // The ptr queue set to which this queue belongs.
ysr@777 45 PtrQueueSet* _qset;
ysr@777 46
ysr@777 47 // Whether updates should be logged.
ysr@777 48 bool _active;
ysr@777 49
ysr@777 50 // The buffer.
ysr@777 51 void** _buf;
ysr@777 52 // The index at which an object was last enqueued. Starts at "_sz"
ysr@777 53 // (indicating an empty buffer) and goes towards zero.
ysr@777 54 size_t _index;
ysr@777 55
ysr@777 56 // The size of the buffer.
ysr@777 57 size_t _sz;
ysr@777 58
ysr@777 59 // If true, the queue is permanent, and doesn't need to deallocate
ysr@777 60 // its buffer in the destructor (since that obtains a lock which may not
ysr@777 61 // be legally locked by then.
ysr@777 62 bool _perm;
ysr@777 63
ysr@777 64 // If there is a lock associated with this buffer, this is that lock.
ysr@777 65 Mutex* _lock;
ysr@777 66
ysr@777 67 PtrQueueSet* qset() { return _qset; }
tschatzl@7445 68 bool is_permanent() const { return _perm; }
tschatzl@7445 69
tschatzl@7445 70 // Process queue entries and release resources, if not permanent.
tschatzl@7445 71 void flush_impl();
ysr@777 72
ysr@777 73 public:
ysr@777 74 // Initialize this queue to contain a null buffer, and be part of the
ysr@777 75 // given PtrQueueSet.
tonyp@2469 76 PtrQueue(PtrQueueSet* qset, bool perm = false, bool active = false);
tschatzl@7445 77
tschatzl@7445 78 // Requires queue flushed or permanent.
tschatzl@7445 79 ~PtrQueue();
ysr@777 80
ysr@777 81 // Associate a lock with a ptr queue.
ysr@777 82 void set_lock(Mutex* lock) { _lock = lock; }
ysr@777 83
ysr@777 84 void reset() { if (_buf != NULL) _index = _sz; }
ysr@777 85
mgerdin@5860 86 void enqueue(volatile void* ptr) {
mgerdin@5860 87 enqueue((void*)(ptr));
mgerdin@5860 88 }
mgerdin@5860 89
ysr@777 90 // Enqueues the given "obj".
ysr@777 91 void enqueue(void* ptr) {
ysr@777 92 if (!_active) return;
ysr@777 93 else enqueue_known_active(ptr);
ysr@777 94 }
ysr@777 95
tonyp@2469 96 // This method is called when we're doing the zero index handling
tonyp@2469 97 // and gives a chance to the queues to do any pre-enqueueing
tonyp@2469 98 // processing they might want to do on the buffer. It should return
tonyp@2469 99 // true if the buffer should be enqueued, or false if enough
tonyp@2469 100 // entries were cleared from it so that it can be re-used. It should
tonyp@2469 101 // not return false if the buffer is still full (otherwise we can
tonyp@2469 102 // get into an infinite loop).
tonyp@2469 103 virtual bool should_enqueue_buffer() { return true; }
iveresov@1546 104 void handle_zero_index();
ysr@777 105 void locking_enqueue_completed_buffer(void** buf);
ysr@777 106
ysr@777 107 void enqueue_known_active(void* ptr);
ysr@777 108
ysr@777 109 size_t size() {
ysr@777 110 assert(_sz >= _index, "Invariant.");
ysr@777 111 return _buf == NULL ? 0 : _sz - _index;
ysr@777 112 }
ysr@777 113
tonyp@2197 114 bool is_empty() {
tonyp@2197 115 return _buf == NULL || _sz == _index;
tonyp@2197 116 }
tonyp@2197 117
ysr@777 118 // Set the "active" property of the queue to "b". An enqueue to an
ysr@777 119 // inactive thread is a no-op. Setting a queue to inactive resets its
ysr@777 120 // log to the empty state.
ysr@777 121 void set_active(bool b) {
ysr@777 122 _active = b;
ysr@777 123 if (!b && _buf != NULL) {
ysr@777 124 _index = _sz;
ysr@777 125 } else if (b && _buf != NULL) {
ysr@777 126 assert(_index == _sz, "invariant: queues are empty when activated.");
ysr@777 127 }
ysr@777 128 }
ysr@777 129
tonyp@1752 130 bool is_active() { return _active; }
tonyp@1752 131
ysr@777 132 static int byte_index_to_index(int ind) {
ysr@777 133 assert((ind % oopSize) == 0, "Invariant.");
ysr@777 134 return ind / oopSize;
ysr@777 135 }
ysr@777 136
ysr@777 137 static int index_to_byte_index(int byte_ind) {
ysr@777 138 return byte_ind * oopSize;
ysr@777 139 }
ysr@777 140
ysr@777 141 // To support compiler.
ysr@777 142 static ByteSize byte_offset_of_index() {
ysr@777 143 return byte_offset_of(PtrQueue, _index);
ysr@777 144 }
ysr@777 145 static ByteSize byte_width_of_index() { return in_ByteSize(sizeof(size_t)); }
ysr@777 146
ysr@777 147 static ByteSize byte_offset_of_buf() {
ysr@777 148 return byte_offset_of(PtrQueue, _buf);
ysr@777 149 }
ysr@777 150 static ByteSize byte_width_of_buf() { return in_ByteSize(sizeof(void*)); }
ysr@777 151
ysr@777 152 static ByteSize byte_offset_of_active() {
ysr@777 153 return byte_offset_of(PtrQueue, _active);
ysr@777 154 }
ysr@777 155 static ByteSize byte_width_of_active() { return in_ByteSize(sizeof(bool)); }
ysr@777 156
ysr@777 157 };
ysr@777 158
iveresov@1546 159 class BufferNode {
iveresov@1546 160 size_t _index;
iveresov@1546 161 BufferNode* _next;
iveresov@1546 162 public:
iveresov@1546 163 BufferNode() : _index(0), _next(NULL) { }
iveresov@1546 164 BufferNode* next() const { return _next; }
iveresov@1546 165 void set_next(BufferNode* n) { _next = n; }
iveresov@1546 166 size_t index() const { return _index; }
iveresov@1546 167 void set_index(size_t i) { _index = i; }
iveresov@1546 168
iveresov@1546 169 // Align the size of the structure to the size of the pointer
iveresov@1546 170 static size_t aligned_size() {
iveresov@1546 171 static const size_t alignment = round_to(sizeof(BufferNode), sizeof(void*));
iveresov@1546 172 return alignment;
iveresov@1546 173 }
iveresov@1546 174
iveresov@1546 175 // BufferNode is allocated before the buffer.
iveresov@1546 176 // The chunk of memory that holds both of them is a block.
iveresov@1546 177
iveresov@1546 178 // Produce a new BufferNode given a buffer.
iveresov@1546 179 static BufferNode* new_from_buffer(void** buf) {
iveresov@1546 180 return new (make_block_from_buffer(buf)) BufferNode;
iveresov@1546 181 }
iveresov@1546 182
iveresov@1546 183 // The following are the required conversion routines:
iveresov@1546 184 static BufferNode* make_node_from_buffer(void** buf) {
iveresov@1546 185 return (BufferNode*)make_block_from_buffer(buf);
iveresov@1546 186 }
iveresov@1546 187 static void** make_buffer_from_node(BufferNode *node) {
iveresov@1546 188 return make_buffer_from_block(node);
iveresov@1546 189 }
iveresov@1546 190 static void* make_block_from_node(BufferNode *node) {
iveresov@1546 191 return (void*)node;
iveresov@1546 192 }
iveresov@1546 193 static void** make_buffer_from_block(void* p) {
iveresov@1546 194 return (void**)((char*)p + aligned_size());
iveresov@1546 195 }
iveresov@1546 196 static void* make_block_from_buffer(void** p) {
iveresov@1546 197 return (void*)((char*)p - aligned_size());
iveresov@1546 198 }
iveresov@1546 199 };
iveresov@1546 200
ysr@777 201 // A PtrQueueSet represents resources common to a set of pointer queues.
ysr@777 202 // In particular, the individual queues allocate buffers from this shared
ysr@777 203 // set, and return completed buffers to the set.
ysr@777 204 // All these variables are are protected by the TLOQ_CBL_mon. XXX ???
apetrusenko@984 205 class PtrQueueSet VALUE_OBJ_CLASS_SPEC {
ysr@777 206 protected:
ysr@777 207 Monitor* _cbl_mon; // Protects the fields below.
iveresov@1546 208 BufferNode* _completed_buffers_head;
iveresov@1546 209 BufferNode* _completed_buffers_tail;
iveresov@1546 210 int _n_completed_buffers;
iveresov@1546 211 int _process_completed_threshold;
ysr@777 212 volatile bool _process_completed;
ysr@777 213
ysr@777 214 // This (and the interpretation of the first element as a "next"
ysr@777 215 // pointer) are protected by the TLOQ_FL_lock.
ysr@777 216 Mutex* _fl_lock;
iveresov@1546 217 BufferNode* _buf_free_list;
ysr@777 218 size_t _buf_free_list_sz;
iveresov@1051 219 // Queue set can share a freelist. The _fl_owner variable
iveresov@1051 220 // specifies the owner. It is set to "this" by default.
iveresov@1051 221 PtrQueueSet* _fl_owner;
ysr@777 222
ysr@777 223 // The size of all buffers in the set.
ysr@777 224 size_t _sz;
ysr@777 225
ysr@777 226 bool _all_active;
ysr@777 227
ysr@777 228 // If true, notify_all on _cbl_mon when the threshold is reached.
ysr@777 229 bool _notify_when_complete;
ysr@777 230
ysr@777 231 // Maximum number of elements allowed on completed queue: after that,
ysr@777 232 // enqueuer does the work itself. Zero indicates no maximum.
ysr@777 233 int _max_completed_queue;
iveresov@1546 234 int _completed_queue_padding;
ysr@777 235
ysr@777 236 int completed_buffers_list_length();
ysr@777 237 void assert_completed_buffer_list_len_correct_locked();
ysr@777 238 void assert_completed_buffer_list_len_correct();
ysr@777 239
ysr@777 240 protected:
ysr@777 241 // A mutator thread does the the work of processing a buffer.
ysr@777 242 // Returns "true" iff the work is complete (and the buffer may be
ysr@777 243 // deallocated).
ysr@777 244 virtual bool mut_process_buffer(void** buf) {
ysr@777 245 ShouldNotReachHere();
ysr@777 246 return false;
ysr@777 247 }
ysr@777 248
ysr@777 249 public:
ysr@777 250 // Create an empty ptr queue set.
ysr@777 251 PtrQueueSet(bool notify_when_complete = false);
ysr@777 252
ysr@777 253 // Because of init-order concerns, we can't pass these as constructor
ysr@777 254 // arguments.
ysr@777 255 void initialize(Monitor* cbl_mon, Mutex* fl_lock,
iveresov@1546 256 int process_completed_threshold,
iveresov@1546 257 int max_completed_queue,
iveresov@1051 258 PtrQueueSet *fl_owner = NULL) {
ysr@777 259 _max_completed_queue = max_completed_queue;
iveresov@1546 260 _process_completed_threshold = process_completed_threshold;
iveresov@1546 261 _completed_queue_padding = 0;
ysr@777 262 assert(cbl_mon != NULL && fl_lock != NULL, "Init order issue?");
iveresov@1051 263 _cbl_mon = cbl_mon;
iveresov@1051 264 _fl_lock = fl_lock;
iveresov@1051 265 _fl_owner = (fl_owner != NULL) ? fl_owner : this;
ysr@777 266 }
ysr@777 267
ysr@777 268 // Return an empty oop array of size _sz (required to be non-zero).
ysr@777 269 void** allocate_buffer();
ysr@777 270
ysr@777 271 // Return an empty buffer to the free list. The "buf" argument is
ysr@777 272 // required to be a pointer to the head of an array of length "_sz".
ysr@777 273 void deallocate_buffer(void** buf);
ysr@777 274
ysr@777 275 // Declares that "buf" is a complete buffer.
iveresov@1546 276 void enqueue_complete_buffer(void** buf, size_t index = 0);
iveresov@1546 277
iveresov@1546 278 // To be invoked by the mutator.
iveresov@1546 279 bool process_or_enqueue_complete_buffer(void** buf);
ysr@777 280
ysr@777 281 bool completed_buffers_exist_dirty() {
ysr@777 282 return _n_completed_buffers > 0;
ysr@777 283 }
ysr@777 284
ysr@777 285 bool process_completed_buffers() { return _process_completed; }
iveresov@1546 286 void set_process_completed(bool x) { _process_completed = x; }
ysr@777 287
tonyp@1752 288 bool is_active() { return _all_active; }
ysr@777 289
ysr@777 290 // Set the buffer size. Should be called before any "enqueue" operation
ysr@777 291 // can be called. And should only be called once.
ysr@777 292 void set_buffer_size(size_t sz);
ysr@777 293
ysr@777 294 // Get the buffer size.
ysr@777 295 size_t buffer_size() { return _sz; }
ysr@777 296
iveresov@1546 297 // Get/Set the number of completed buffers that triggers log processing.
iveresov@1546 298 void set_process_completed_threshold(int sz) { _process_completed_threshold = sz; }
iveresov@1546 299 int process_completed_threshold() const { return _process_completed_threshold; }
ysr@777 300
ysr@777 301 // Must only be called at a safe point. Indicates that the buffer free
ysr@777 302 // list size may be reduced, if that is deemed desirable.
ysr@777 303 void reduce_free_list();
ysr@777 304
iveresov@1546 305 int completed_buffers_num() { return _n_completed_buffers; }
iveresov@1051 306
iveresov@1051 307 void merge_bufferlists(PtrQueueSet* src);
iveresov@1546 308
iveresov@1546 309 void set_max_completed_queue(int m) { _max_completed_queue = m; }
iveresov@1546 310 int max_completed_queue() { return _max_completed_queue; }
iveresov@1546 311
iveresov@1546 312 void set_completed_queue_padding(int padding) { _completed_queue_padding = padding; }
iveresov@1546 313 int completed_queue_padding() { return _completed_queue_padding; }
iveresov@1546 314
iveresov@1546 315 // Notify the consumer if the number of buffers crossed the threshold
iveresov@1546 316 void notify_if_necessary();
ysr@777 317 };
stefank@2314 318
stefank@2314 319 #endif // SHARE_VM_GC_IMPLEMENTATION_G1_PTRQUEUE_HPP

mercurial