1 /*
2 * Copyright (c) 2023, Oracle and/or its affiliates. All rights reserved.
3 * Copyright (c) 2013, 2021, Red Hat, Inc. All rights reserved.
4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 *
6 * This code is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 only, as
8 * published by the Free Software Foundation.
9 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 * or visit www.oracle.com if you need additional information or have any
22 * questions.
23 *
24 */
25
26 #ifndef SHARE_GC_SHENANDOAH_SHENANDOAHHEAP_HPP
27 #define SHARE_GC_SHENANDOAH_SHENANDOAHHEAP_HPP
28
29 #include "gc/shared/markBitMap.hpp"
30 #include "gc/shared/softRefPolicy.hpp"
31 #include "gc/shared/collectedHeap.hpp"
32 #include "gc/shenandoah/shenandoahAsserts.hpp"
33 #include "gc/shenandoah/shenandoahAllocRequest.hpp"
34 #include "gc/shenandoah/shenandoahLock.hpp"
35 #include "gc/shenandoah/shenandoahEvacOOMHandler.hpp"
36 #include "gc/shenandoah/shenandoahPadding.hpp"
37 #include "gc/shenandoah/shenandoahSharedVariables.hpp"
38 #include "gc/shenandoah/shenandoahUnload.hpp"
39 #include "memory/metaspace.hpp"
40 #include "services/memoryManager.hpp"
41 #include "utilities/globalDefinitions.hpp"
42 #include "utilities/stack.hpp"
43
44 class ConcurrentGCTimer;
45 class ObjectIterateScanRootClosure;
46 class ShenandoahCollectorPolicy;
47 class ShenandoahControlThread;
48 class ShenandoahGCSession;
49 class ShenandoahGCStateResetter;
50 class ShenandoahHeuristics;
51 class ShenandoahMarkingContext;
52 class ShenandoahMode;
53 class ShenandoahPhaseTimings;
54 class ShenandoahHeap;
55 class ShenandoahHeapRegion;
56 class ShenandoahHeapRegionClosure;
57 class ShenandoahCollectionSet;
58 class ShenandoahFreeSet;
59 class ShenandoahConcurrentMark;
60 class ShenandoahFullGC;
61 class ShenandoahMonitoringSupport;
62 class ShenandoahPacer;
63 class ShenandoahReferenceProcessor;
64 class ShenandoahVerifier;
65 class ShenandoahWorkerThreads;
66 class VMStructs;
67
68 // Used for buffering per-region liveness data.
69 // Needed since ShenandoahHeapRegion uses atomics to update liveness.
70 // The ShenandoahHeap array has max-workers elements, each of which is an array of
71 // uint16_t * max_regions. The choice of uint16_t is not accidental:
72 // there is a tradeoff between static/dynamic footprint that translates
73 // into cache pressure (which is already high during marking), and
74 // too many atomic updates. uint32_t is too large, uint8_t is too small.
75 typedef uint16_t ShenandoahLiveData;
76 #define SHENANDOAH_LIVEDATA_MAX ((ShenandoahLiveData)-1)
77
78 class ShenandoahRegionIterator : public StackObj {
79 private:
80 ShenandoahHeap* _heap;
81
106 public:
107 virtual void heap_region_do(ShenandoahHeapRegion* r) = 0;
108 virtual bool is_thread_safe() { return false; }
109 };
110
111 typedef ShenandoahLock ShenandoahHeapLock;
112 typedef ShenandoahLocker ShenandoahHeapLocker;
113 typedef Stack<oop, mtGC> ShenandoahScanObjectStack;
114
115 // Shenandoah GC is low-pause concurrent GC that uses Brooks forwarding pointers
116 // to encode forwarding data. See BrooksPointer for details on forwarding data encoding.
117 // See ShenandoahControlThread for GC cycle structure.
118 //
119 class ShenandoahHeap : public CollectedHeap {
120 friend class ShenandoahAsserts;
121 friend class VMStructs;
122 friend class ShenandoahGCSession;
123 friend class ShenandoahGCStateResetter;
124 friend class ShenandoahParallelObjectIterator;
125 friend class ShenandoahSafepoint;
126 // Supported GC
127 friend class ShenandoahConcurrentGC;
128 friend class ShenandoahDegenGC;
129 friend class ShenandoahFullGC;
130 friend class ShenandoahUnload;
131
132 // ---------- Locks that guard important data structures in Heap
133 //
134 private:
135 ShenandoahHeapLock _lock;
136
137 public:
138 ShenandoahHeapLock* lock() {
139 return &_lock;
140 }
141
142 // ---------- Initialization, termination, identification, printing routines
143 //
144 public:
145 static ShenandoahHeap* heap();
146
147 const char* name() const override { return "Shenandoah"; }
148 ShenandoahHeap::Name kind() const override { return CollectedHeap::Shenandoah; }
149
150 ShenandoahHeap(ShenandoahCollectorPolicy* policy);
151 jint initialize() override;
152 void post_initialize() override;
153 void initialize_mode();
154 void initialize_heuristics();
155
156 void initialize_serviceability() override;
157
158 void print_on(outputStream* st) const override;
159 void print_extended_on(outputStream *st) const override;
160 void print_tracing_info() const override;
161 void print_heap_regions_on(outputStream* st) const;
162
163 void stop() override;
164
165 void prepare_for_verify() override;
166 void verify(VerifyOption vo) override;
167
168 // WhiteBox testing support.
169 bool supports_concurrent_gc_breakpoints() const override {
170 return true;
171 }
172
173 // ---------- Heap counters and metrics
174 //
175 private:
176 size_t _initial_size;
177 size_t _minimum_size;
178 volatile size_t _soft_max_size;
179 shenandoah_padding(0);
180 volatile size_t _used;
181 volatile size_t _committed;
182 volatile size_t _bytes_allocated_since_gc_start;
183 shenandoah_padding(1);
184
185 public:
186 void increase_used(size_t bytes);
187 void decrease_used(size_t bytes);
188 void set_used(size_t bytes);
189
190 void increase_committed(size_t bytes);
191 void decrease_committed(size_t bytes);
192 void increase_allocated(size_t bytes);
193
194 size_t bytes_allocated_since_gc_start();
195 void reset_bytes_allocated_since_gc_start();
196
197 size_t min_capacity() const;
198 size_t max_capacity() const override;
199 size_t soft_max_capacity() const;
200 size_t initial_capacity() const;
201 size_t capacity() const override;
202 size_t used() const override;
203 size_t committed() const;
204
205 void set_soft_max_capacity(size_t v);
206
207 // ---------- Workers handling
208 //
209 private:
210 uint _max_workers;
211 ShenandoahWorkerThreads* _workers;
212 ShenandoahWorkerThreads* _safepoint_workers;
213
214 public:
215 uint max_workers();
216 void assert_gc_workers(uint nworker) NOT_DEBUG_RETURN;
217
218 WorkerThreads* workers() const;
219 WorkerThreads* safepoint_workers() override;
220
221 void gc_threads_do(ThreadClosure* tcl) const override;
222
223 // ---------- Heap regions handling machinery
224 //
225 private:
226 MemRegion _heap_region;
227 bool _heap_region_special;
228 size_t _num_regions;
229 ShenandoahHeapRegion** _regions;
230 ShenandoahRegionIterator _update_refs_iterator;
231
232 public:
233
234 inline HeapWord* base() const { return _heap_region.start(); }
235
236 inline size_t num_regions() const { return _num_regions; }
237 inline bool is_heap_region_special() { return _heap_region_special; }
238
239 inline ShenandoahHeapRegion* const heap_region_containing(const void* addr) const;
240 inline size_t heap_region_index_containing(const void* addr) const;
241
242 inline ShenandoahHeapRegion* const get_region(size_t region_idx) const;
243
244 void heap_region_iterate(ShenandoahHeapRegionClosure* blk) const;
245 void parallel_heap_region_iterate(ShenandoahHeapRegionClosure* blk) const;
246
247 // ---------- GC state machinery
248 //
249 // GC state describes the important parts of collector state, that may be
250 // used to make barrier selection decisions in the native and generated code.
251 // Multiple bits can be set at once.
252 //
253 // Important invariant: when GC state is zero, the heap is stable, and no barriers
254 // are required.
255 //
256 public:
257 enum GCStateBitPos {
258 // Heap has forwarded objects: needs LRB barriers.
259 HAS_FORWARDED_BITPOS = 0,
260
261 // Heap is under marking: needs SATB barriers.
262 MARKING_BITPOS = 1,
263
264 // Heap is under evacuation: needs LRB barriers. (Set together with HAS_FORWARDED)
265 EVACUATION_BITPOS = 2,
266
267 // Heap is under updating: needs no additional barriers.
268 UPDATEREFS_BITPOS = 3,
269
270 // Heap is under weak-reference/roots processing: needs weak-LRB barriers.
271 WEAK_ROOTS_BITPOS = 4,
272 };
273
274 enum GCState {
275 STABLE = 0,
276 HAS_FORWARDED = 1 << HAS_FORWARDED_BITPOS,
277 MARKING = 1 << MARKING_BITPOS,
278 EVACUATION = 1 << EVACUATION_BITPOS,
279 UPDATEREFS = 1 << UPDATEREFS_BITPOS,
280 WEAK_ROOTS = 1 << WEAK_ROOTS_BITPOS,
281 };
282
283 private:
284 bool _gc_state_changed;
285 ShenandoahSharedBitmap _gc_state;
286 ShenandoahSharedFlag _degenerated_gc_in_progress;
287 ShenandoahSharedFlag _full_gc_in_progress;
288 ShenandoahSharedFlag _full_gc_move_in_progress;
289 ShenandoahSharedFlag _progress_last_gc;
290 ShenandoahSharedFlag _concurrent_strong_root_in_progress;
291
292 // This updates the singlular, global gc state. This must happen on a safepoint.
293 void set_gc_state(uint mask, bool value);
294
295 public:
296 char gc_state() const;
297
298 // This copies the global gc state into a thread local variable for java threads.
299 // It is primarily intended to support quick access at barriers.
300 void propagate_gc_state_to_java_threads();
301
302 // This is public to support assertions that the state hasn't been changed off of
303 // a safepoint and that any changes were propagated to java threads after the safepoint.
304 bool has_gc_state_changed() const { return _gc_state_changed; }
305
306 void set_concurrent_mark_in_progress(bool in_progress);
307 void set_evacuation_in_progress(bool in_progress);
308 void set_update_refs_in_progress(bool in_progress);
309 void set_degenerated_gc_in_progress(bool in_progress);
310 void set_full_gc_in_progress(bool in_progress);
311 void set_full_gc_move_in_progress(bool in_progress);
312 void set_has_forwarded_objects(bool cond);
313 void set_concurrent_strong_root_in_progress(bool cond);
314 void set_concurrent_weak_root_in_progress(bool cond);
315
316 inline bool is_stable() const;
317 inline bool is_idle() const;
318 inline bool is_concurrent_mark_in_progress() const;
319 inline bool is_update_refs_in_progress() const;
320 inline bool is_evacuation_in_progress() const;
321 inline bool is_degenerated_gc_in_progress() const;
322 inline bool is_full_gc_in_progress() const;
323 inline bool is_full_gc_move_in_progress() const;
324 inline bool has_forwarded_objects() const;
325
326 inline bool is_stw_gc_in_progress() const;
327 inline bool is_concurrent_strong_root_in_progress() const;
328 inline bool is_concurrent_weak_root_in_progress() const;
329
330 private:
331 enum CancelState {
332 // Normal state. GC has not been cancelled and is open for cancellation.
333 // Worker threads can suspend for safepoint.
334 CANCELLABLE,
335
336 // GC has been cancelled. Worker threads can not suspend for
337 // safepoint but must finish their work as soon as possible.
338 CANCELLED
339 };
340
341 ShenandoahSharedEnumFlag<CancelState> _cancelled_gc;
342 bool try_cancel_gc();
343
344 public:
345
346 inline bool cancelled_gc() const;
347 inline bool check_cancelled_gc_and_yield(bool sts_active = true);
348
349 inline void clear_cancelled_gc();
350
351 void cancel_gc(GCCause::Cause cause);
352
353 public:
354 // Elastic heap support
355 void entry_uncommit(double shrink_before, size_t shrink_until);
356 void op_uncommit(double shrink_before, size_t shrink_until);
357
358 private:
359 // GC support
360 // Reset bitmap, prepare regions for new GC cycle
361 void prepare_gc();
362 void prepare_regions_and_collection_set(bool concurrent);
363 // Evacuation
364 void evacuate_collection_set(bool concurrent);
365 // Concurrent root processing
366 void prepare_concurrent_roots();
367 void finish_concurrent_roots();
368 // Concurrent class unloading support
369 void do_class_unloading();
370 // Reference updating
371 void prepare_update_heap_references(bool concurrent);
372 void update_heap_references(bool concurrent);
373 // Final update region states
374 void update_heap_region_states(bool concurrent);
375 void rebuild_free_set(bool concurrent);
376
377 void rendezvous_threads();
378 void recycle_trash();
379 public:
380 void notify_gc_progress() { _progress_last_gc.set(); }
381 void notify_gc_no_progress() { _progress_last_gc.unset(); }
382
383 //
384 // Mark support
385 private:
386 ShenandoahControlThread* _control_thread;
387 ShenandoahCollectorPolicy* _shenandoah_policy;
388 ShenandoahMode* _gc_mode;
389 ShenandoahHeuristics* _heuristics;
390 ShenandoahFreeSet* _free_set;
391 ShenandoahPacer* _pacer;
392 ShenandoahVerifier* _verifier;
393
394 ShenandoahPhaseTimings* _phase_timings;
395
396 ShenandoahControlThread* control_thread() { return _control_thread; }
397
398 public:
399 ShenandoahCollectorPolicy* shenandoah_policy() const { return _shenandoah_policy; }
400 ShenandoahMode* mode() const { return _gc_mode; }
401 ShenandoahHeuristics* heuristics() const { return _heuristics; }
402 ShenandoahFreeSet* free_set() const { return _free_set; }
403 ShenandoahPacer* pacer() const { return _pacer; }
404
405 ShenandoahPhaseTimings* phase_timings() const { return _phase_timings; }
406
407 ShenandoahVerifier* verifier();
408
409 // ---------- VM subsystem bindings
410 //
411 private:
412 ShenandoahMonitoringSupport* _monitoring_support;
413 MemoryPool* _memory_pool;
414 GCMemoryManager _stw_memory_manager;
415 GCMemoryManager _cycle_memory_manager;
416 ConcurrentGCTimer* _gc_timer;
417 SoftRefPolicy _soft_ref_policy;
418
419 // For exporting to SA
420 int _log_min_obj_alignment_in_bytes;
421 public:
422 ShenandoahMonitoringSupport* monitoring_support() { return _monitoring_support; }
423 GCMemoryManager* cycle_memory_manager() { return &_cycle_memory_manager; }
424 GCMemoryManager* stw_memory_manager() { return &_stw_memory_manager; }
425 SoftRefPolicy* soft_ref_policy() override { return &_soft_ref_policy; }
426
427 GrowableArray<GCMemoryManager*> memory_managers() override;
428 GrowableArray<MemoryPool*> memory_pools() override;
429 MemoryUsage memory_usage() override;
430 GCTracer* tracer();
431 ConcurrentGCTimer* gc_timer() const;
432
433 // ---------- Reference processing
434 //
435 private:
436 ShenandoahReferenceProcessor* const _ref_processor;
437
438 public:
439 ShenandoahReferenceProcessor* ref_processor() { return _ref_processor; }
440
441 // ---------- Class Unloading
442 //
443 private:
444 ShenandoahSharedFlag _unload_classes;
445 ShenandoahUnload _unloader;
446
447 public:
448 void set_unload_classes(bool uc);
449 bool unload_classes() const;
450
451 // Perform STW class unloading and weak root cleaning
452 void parallel_cleaning(bool full_gc);
453
454 private:
455 void stw_unload_classes(bool full_gc);
456 void stw_process_weak_roots(bool full_gc);
457 void stw_weak_refs(bool full_gc);
458
459 // Heap iteration support
460 void scan_roots_for_iteration(ShenandoahScanObjectStack* oop_stack, ObjectIterateScanRootClosure* oops);
461 bool prepare_aux_bitmap_for_iteration();
462 void reclaim_aux_bitmap_for_iteration();
463
464 // ---------- Generic interface hooks
465 // Minor things that super-interface expects us to implement to play nice with
466 // the rest of runtime. Some of the things here are not required to be implemented,
467 // and can be stubbed out.
468 //
469 public:
470 bool is_maximal_no_gc() const override shenandoah_not_implemented_return(false);
471
472 bool is_in(const void* p) const override;
473
474 bool requires_barriers(stackChunkOop obj) const override;
475
476 MemRegion reserved_region() const { return _reserved; }
477 bool is_in_reserved(const void* addr) const { return _reserved.contains(addr); }
478
479 void collect(GCCause::Cause cause) override;
480 void do_full_collection(bool clear_all_soft_refs) override;
481
482 // Used for parsing heap during error printing
483 HeapWord* block_start(const void* addr) const;
484 bool block_is_obj(const HeapWord* addr) const;
485 bool print_location(outputStream* st, void* addr) const override;
486
487 // Used for native heap walkers: heap dumpers, mostly
488 void object_iterate(ObjectClosure* cl) override;
489 // Parallel heap iteration support
490 ParallelObjectIteratorImpl* parallel_object_iterator(uint workers) override;
491
492 // Keep alive an object that was loaded with AS_NO_KEEPALIVE.
505 void unregister_nmethod(nmethod* nm) override;
506 void verify_nmethod(nmethod* nm) override {}
507
508 // ---------- Pinning hooks
509 //
510 public:
511 // Shenandoah supports per-object (per-region) pinning
512 void pin_object(JavaThread* thread, oop obj) override;
513 void unpin_object(JavaThread* thread, oop obj) override;
514
515 void sync_pinned_region_status();
516 void assert_pinned_region_status() NOT_DEBUG_RETURN;
517
518 // ---------- Concurrent Stack Processing support
519 //
520 public:
521 bool uses_stack_watermark_barrier() const override { return true; }
522
523 // ---------- Allocation support
524 //
525 private:
526 HeapWord* allocate_memory_under_lock(ShenandoahAllocRequest& request, bool& in_new_region);
527 inline HeapWord* allocate_from_gclab(Thread* thread, size_t size);
528 HeapWord* allocate_from_gclab_slow(Thread* thread, size_t size);
529 HeapWord* allocate_new_gclab(size_t min_size, size_t word_size, size_t* actual_size);
530
531 public:
532 HeapWord* allocate_memory(ShenandoahAllocRequest& request);
533 HeapWord* mem_allocate(size_t size, bool* what) override;
534 MetaWord* satisfy_failed_metadata_allocation(ClassLoaderData* loader_data,
535 size_t size,
536 Metaspace::MetadataType mdtype) override;
537
538 void notify_mutator_alloc_words(size_t words, bool waste);
539
540 HeapWord* allocate_new_tlab(size_t min_size, size_t requested_size, size_t* actual_size) override;
541 size_t tlab_capacity(Thread *thr) const override;
542 size_t unsafe_max_tlab_alloc(Thread *thread) const override;
543 size_t max_tlab_size() const override;
544 size_t tlab_used(Thread* ignored) const override;
545
546 void ensure_parsability(bool retire_labs) override;
547
548 void labs_make_parsable();
549 void tlabs_retire(bool resize);
550 void gclabs_retire(bool resize);
551
552 // ---------- Marking support
553 //
554 private:
555 ShenandoahMarkingContext* _marking_context;
556 MemRegion _bitmap_region;
557 MemRegion _aux_bitmap_region;
558 MarkBitMap _verification_bit_map;
559 MarkBitMap _aux_bit_map;
560
561 size_t _bitmap_size;
562 size_t _bitmap_regions_per_slice;
563 size_t _bitmap_bytes_per_slice;
564
565 size_t _pretouch_heap_page_size;
566 size_t _pretouch_bitmap_page_size;
567
568 bool _bitmap_region_special;
569 bool _aux_bitmap_region_special;
570
571 ShenandoahLiveData** _liveness_cache;
572
573 public:
574 inline ShenandoahMarkingContext* complete_marking_context() const;
575 inline ShenandoahMarkingContext* marking_context() const;
576 inline void mark_complete_marking_context();
577 inline void mark_incomplete_marking_context();
578
579 template<class T>
580 inline void marked_object_iterate(ShenandoahHeapRegion* region, T* cl);
581
582 template<class T>
583 inline void marked_object_iterate(ShenandoahHeapRegion* region, T* cl, HeapWord* limit);
584
585 template<class T>
586 inline void marked_object_oop_iterate(ShenandoahHeapRegion* region, T* cl, HeapWord* limit);
587
588 void reset_mark_bitmap();
589
590 // SATB barriers hooks
591 inline bool requires_marking(const void* entry) const;
592
593 // Support for bitmap uncommits
594 bool commit_bitmap_slice(ShenandoahHeapRegion *r);
595 bool uncommit_bitmap_slice(ShenandoahHeapRegion *r);
596 bool is_bitmap_slice_committed(ShenandoahHeapRegion* r, bool skip_self = false);
597
598 // Liveness caching support
599 ShenandoahLiveData* get_liveness_cache(uint worker_id);
600 void flush_liveness_cache(uint worker_id);
601
602 size_t pretouch_heap_page_size() { return _pretouch_heap_page_size; }
603
604 // ---------- Evacuation support
605 //
606 private:
607 ShenandoahCollectionSet* _collection_set;
608 ShenandoahEvacOOMHandler _oom_evac_handler;
609
610 public:
611 static address in_cset_fast_test_addr();
612
613 ShenandoahCollectionSet* collection_set() const { return _collection_set; }
614
615 // Checks if object is in the collection set.
616 inline bool in_collection_set(oop obj) const;
617
618 // Checks if location is in the collection set. Can be interior pointer, not the oop itself.
619 inline bool in_collection_set_loc(void* loc) const;
620
621 // Evacuates object src. Returns the evacuated object, either evacuated
622 // by this thread, or by some other thread.
623 inline oop evacuate_object(oop src, Thread* thread);
624
625 // Call before/after evacuation.
626 inline void enter_evacuation(Thread* t);
627 inline void leave_evacuation(Thread* t);
628
629 // ---------- Helper functions
630 //
631 public:
632 template <class T>
633 inline void conc_update_with_forwarded(T* p);
634
635 template <class T>
636 inline void update_with_forwarded(T* p);
637
638 static inline void atomic_update_oop(oop update, oop* addr, oop compare);
639 static inline void atomic_update_oop(oop update, narrowOop* addr, oop compare);
640 static inline void atomic_update_oop(oop update, narrowOop* addr, narrowOop compare);
641
642 static inline bool atomic_update_oop_check(oop update, oop* addr, oop compare);
643 static inline bool atomic_update_oop_check(oop update, narrowOop* addr, oop compare);
644 static inline bool atomic_update_oop_check(oop update, narrowOop* addr, narrowOop compare);
645
646 static inline void atomic_clear_oop( oop* addr, oop compare);
647 static inline void atomic_clear_oop(narrowOop* addr, oop compare);
648 static inline void atomic_clear_oop(narrowOop* addr, narrowOop compare);
649
650 void trash_humongous_region_at(ShenandoahHeapRegion *r);
651
652 private:
653 void trash_cset_regions();
654
655 // ---------- Testing helpers functions
656 //
657 private:
658 ShenandoahSharedFlag _inject_alloc_failure;
659
660 void try_inject_alloc_failure();
661 bool should_inject_alloc_failure();
662 };
663
664 #endif // SHARE_GC_SHENANDOAH_SHENANDOAHHEAP_HPP
|
1 /*
2 * Copyright (c) 2023, Oracle and/or its affiliates. All rights reserved.
3 * Copyright (c) 2013, 2021, Red Hat, Inc. All rights reserved.
4 * Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
5 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 *
7 * This code is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License version 2 only, as
9 * published by the Free Software Foundation.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 *
25 */
26
27 #ifndef SHARE_GC_SHENANDOAH_SHENANDOAHHEAP_HPP
28 #define SHARE_GC_SHENANDOAH_SHENANDOAHHEAP_HPP
29
30 #include "gc/shared/ageTable.hpp"
31 #include "gc/shared/markBitMap.hpp"
32 #include "gc/shared/softRefPolicy.hpp"
33 #include "gc/shared/collectedHeap.hpp"
34 #include "gc/shenandoah/shenandoahAgeCensus.hpp"
35 #include "gc/shenandoah/heuristics/shenandoahSpaceInfo.hpp"
36 #include "gc/shenandoah/shenandoahAsserts.hpp"
37 #include "gc/shenandoah/shenandoahAllocRequest.hpp"
38 #include "gc/shenandoah/shenandoahAsserts.hpp"
39 #include "gc/shenandoah/shenandoahController.hpp"
40 #include "gc/shenandoah/shenandoahLock.hpp"
41 #include "gc/shenandoah/shenandoahEvacOOMHandler.hpp"
42 #include "gc/shenandoah/shenandoahEvacTracker.hpp"
43 #include "gc/shenandoah/shenandoahGenerationType.hpp"
44 #include "gc/shenandoah/shenandoahMmuTracker.hpp"
45 #include "gc/shenandoah/shenandoahPadding.hpp"
46 #include "gc/shenandoah/shenandoahScanRemembered.hpp"
47 #include "gc/shenandoah/shenandoahSharedVariables.hpp"
48 #include "gc/shenandoah/shenandoahUnload.hpp"
49 #include "memory/metaspace.hpp"
50 #include "services/memoryManager.hpp"
51 #include "utilities/globalDefinitions.hpp"
52 #include "utilities/stack.hpp"
53
54 class ConcurrentGCTimer;
55 class ObjectIterateScanRootClosure;
56 class PLAB;
57 class ShenandoahCollectorPolicy;
58 class ShenandoahRegulatorThread;
59 class ShenandoahGCSession;
60 class ShenandoahGCStateResetter;
61 class ShenandoahGeneration;
62 class ShenandoahYoungGeneration;
63 class ShenandoahOldGeneration;
64 class ShenandoahHeuristics;
65 class ShenandoahOldHeuristics;
66 class ShenandoahYoungHeuristics;
67 class ShenandoahMarkingContext;
68 class ShenandoahPhaseTimings;
69 class ShenandoahHeap;
70 class ShenandoahHeapRegion;
71 class ShenandoahHeapRegionClosure;
72 class ShenandoahCollectionSet;
73 class ShenandoahFreeSet;
74 class ShenandoahConcurrentMark;
75 class ShenandoahFullGC;
76 class ShenandoahMonitoringSupport;
77 class ShenandoahMode;
78 class ShenandoahPacer;
79 class ShenandoahReferenceProcessor;
80 class ShenandoahVerifier;
81 class ShenandoahWorkerThreads;
82 class VMStructs;
83
84 // Used for buffering per-region liveness data.
85 // Needed since ShenandoahHeapRegion uses atomics to update liveness.
86 // The ShenandoahHeap array has max-workers elements, each of which is an array of
87 // uint16_t * max_regions. The choice of uint16_t is not accidental:
88 // there is a tradeoff between static/dynamic footprint that translates
89 // into cache pressure (which is already high during marking), and
90 // too many atomic updates. uint32_t is too large, uint8_t is too small.
91 typedef uint16_t ShenandoahLiveData;
92 #define SHENANDOAH_LIVEDATA_MAX ((ShenandoahLiveData)-1)
93
94 class ShenandoahRegionIterator : public StackObj {
95 private:
96 ShenandoahHeap* _heap;
97
122 public:
123 virtual void heap_region_do(ShenandoahHeapRegion* r) = 0;
124 virtual bool is_thread_safe() { return false; }
125 };
126
127 typedef ShenandoahLock ShenandoahHeapLock;
128 typedef ShenandoahLocker ShenandoahHeapLocker;
129 typedef Stack<oop, mtGC> ShenandoahScanObjectStack;
130
131 // Shenandoah GC is low-pause concurrent GC that uses Brooks forwarding pointers
132 // to encode forwarding data. See BrooksPointer for details on forwarding data encoding.
133 // See ShenandoahControlThread for GC cycle structure.
134 //
135 class ShenandoahHeap : public CollectedHeap {
136 friend class ShenandoahAsserts;
137 friend class VMStructs;
138 friend class ShenandoahGCSession;
139 friend class ShenandoahGCStateResetter;
140 friend class ShenandoahParallelObjectIterator;
141 friend class ShenandoahSafepoint;
142
143 // Supported GC
144 friend class ShenandoahConcurrentGC;
145 friend class ShenandoahOldGC;
146 friend class ShenandoahDegenGC;
147 friend class ShenandoahFullGC;
148 friend class ShenandoahUnload;
149
150 // ---------- Locks that guard important data structures in Heap
151 //
152 private:
153 ShenandoahHeapLock _lock;
154 ShenandoahGeneration* _gc_generation;
155
156 public:
157 ShenandoahHeapLock* lock() {
158 return &_lock;
159 }
160
161 ShenandoahGeneration* active_generation() const {
162 // last or latest generation might be a better name here.
163 return _gc_generation;
164 }
165
166 void set_gc_generation(ShenandoahGeneration* generation) {
167 _gc_generation = generation;
168 }
169
170 ShenandoahHeuristics* heuristics();
171
172 // ---------- Initialization, termination, identification, printing routines
173 //
174 public:
175 static ShenandoahHeap* heap();
176
177 const char* name() const override { return "Shenandoah"; }
178 ShenandoahHeap::Name kind() const override { return CollectedHeap::Shenandoah; }
179
180 ShenandoahHeap(ShenandoahCollectorPolicy* policy);
181 jint initialize() override;
182 void post_initialize() override;
183 void initialize_heuristics_generations();
184 virtual void print_init_logger() const;
185 void initialize_serviceability() override;
186
187 void print_on(outputStream* st) const override;
188 void print_extended_on(outputStream *st) const override;
189 void print_tracing_info() const override;
190 void print_heap_regions_on(outputStream* st) const;
191
192 void stop() override;
193
194 void prepare_for_verify() override;
195 void verify(VerifyOption vo) override;
196
197 bool verify_generation_usage(bool verify_old, size_t old_regions, size_t old_bytes, size_t old_waste,
198 bool verify_young, size_t young_regions, size_t young_bytes, size_t young_waste);
199
200 // WhiteBox testing support.
201 bool supports_concurrent_gc_breakpoints() const override {
202 return true;
203 }
204
205 // ---------- Heap counters and metrics
206 //
207 private:
208 size_t _initial_size;
209 size_t _minimum_size;
210
211 volatile size_t _soft_max_size;
212 shenandoah_padding(0);
213 volatile size_t _committed;
214 shenandoah_padding(1);
215
216 void increase_used(const ShenandoahAllocRequest& req);
217
218 public:
219 void increase_used(ShenandoahGeneration* generation, size_t bytes);
220 void decrease_used(ShenandoahGeneration* generation, size_t bytes);
221 void increase_humongous_waste(ShenandoahGeneration* generation, size_t bytes);
222 void decrease_humongous_waste(ShenandoahGeneration* generation, size_t bytes);
223
224 void increase_committed(size_t bytes);
225 void decrease_committed(size_t bytes);
226
227 void reset_bytes_allocated_since_gc_start();
228
229 size_t min_capacity() const;
230 size_t max_capacity() const override;
231 size_t soft_max_capacity() const;
232 size_t initial_capacity() const;
233 size_t capacity() const override;
234 size_t used() const override;
235 size_t committed() const;
236
237 void set_soft_max_capacity(size_t v);
238
239 // ---------- Periodic Tasks
240 //
241 private:
242 void notify_heap_changed();
243
244 public:
245 void set_forced_counters_update(bool value);
246 void handle_force_counters_update();
247
248 // ---------- Workers handling
249 //
250 private:
251 uint _max_workers;
252 ShenandoahWorkerThreads* _workers;
253 ShenandoahWorkerThreads* _safepoint_workers;
254
255 virtual void initialize_controller();
256
257 public:
258 uint max_workers();
259 void assert_gc_workers(uint nworker) NOT_DEBUG_RETURN;
260
261 WorkerThreads* workers() const;
262 WorkerThreads* safepoint_workers() override;
263
264 void gc_threads_do(ThreadClosure* tcl) const override;
265
266 // ---------- Heap regions handling machinery
267 //
268 private:
269 MemRegion _heap_region;
270 bool _heap_region_special;
271 size_t _num_regions;
272 ShenandoahHeapRegion** _regions;
273 uint8_t* _affiliations; // Holds array of enum ShenandoahAffiliation, including FREE status in non-generational mode
274 ShenandoahRegionIterator _update_refs_iterator;
275
276 public:
277
278 inline HeapWord* base() const { return _heap_region.start(); }
279
280 inline size_t num_regions() const { return _num_regions; }
281 inline bool is_heap_region_special() { return _heap_region_special; }
282
283 inline ShenandoahHeapRegion* heap_region_containing(const void* addr) const;
284 inline size_t heap_region_index_containing(const void* addr) const;
285
286 inline ShenandoahHeapRegion* get_region(size_t region_idx) const;
287
288 void heap_region_iterate(ShenandoahHeapRegionClosure* blk) const;
289 void parallel_heap_region_iterate(ShenandoahHeapRegionClosure* blk) const;
290
291 inline ShenandoahMmuTracker* mmu_tracker() { return &_mmu_tracker; };
292
293 // ---------- GC state machinery
294 //
295 // GC state describes the important parts of collector state, that may be
296 // used to make barrier selection decisions in the native and generated code.
297 // Multiple bits can be set at once.
298 //
299 // Important invariant: when GC state is zero, the heap is stable, and no barriers
300 // are required.
301 //
302 public:
303 enum GCStateBitPos {
304 // Heap has forwarded objects: needs LRB barriers.
305 HAS_FORWARDED_BITPOS = 0,
306
307 // Heap is under marking: needs SATB barriers.
308 // For generational mode, it means either young or old marking, or both.
309 MARKING_BITPOS = 1,
310
311 // Heap is under evacuation: needs LRB barriers. (Set together with HAS_FORWARDED)
312 EVACUATION_BITPOS = 2,
313
314 // Heap is under updating: needs no additional barriers.
315 UPDATEREFS_BITPOS = 3,
316
317 // Heap is under weak-reference/roots processing: needs weak-LRB barriers.
318 WEAK_ROOTS_BITPOS = 4,
319
320 // Young regions are under marking, need SATB barriers.
321 YOUNG_MARKING_BITPOS = 5,
322
323 // Old regions are under marking, need SATB barriers.
324 OLD_MARKING_BITPOS = 6
325 };
326
327 enum GCState {
328 STABLE = 0,
329 HAS_FORWARDED = 1 << HAS_FORWARDED_BITPOS,
330 MARKING = 1 << MARKING_BITPOS,
331 EVACUATION = 1 << EVACUATION_BITPOS,
332 UPDATEREFS = 1 << UPDATEREFS_BITPOS,
333 WEAK_ROOTS = 1 << WEAK_ROOTS_BITPOS,
334 YOUNG_MARKING = 1 << YOUNG_MARKING_BITPOS,
335 OLD_MARKING = 1 << OLD_MARKING_BITPOS
336 };
337
338 private:
339 bool _gc_state_changed;
340 ShenandoahSharedBitmap _gc_state;
341 ShenandoahSharedFlag _heap_changed;
342 ShenandoahSharedFlag _degenerated_gc_in_progress;
343 ShenandoahSharedFlag _full_gc_in_progress;
344 ShenandoahSharedFlag _full_gc_move_in_progress;
345 ShenandoahSharedFlag _concurrent_strong_root_in_progress;
346
347 size_t _gc_no_progress_count;
348
349 // This updates the singlular, global gc state. This must happen on a safepoint.
350 void set_gc_state(uint mask, bool value);
351
352 ShenandoahAgeCensus* _age_census; // Age census used for adapting tenuring threshold in generational mode
353
354 public:
355 char gc_state() const;
356
357 // This copies the global gc state into a thread local variable for java threads.
358 // It is primarily intended to support quick access at barriers.
359 void propagate_gc_state_to_java_threads();
360
361 // This is public to support assertions that the state hasn't been changed off of
362 // a safepoint and that any changes were propagated to java threads after the safepoint.
363 bool has_gc_state_changed() const { return _gc_state_changed; }
364
365 // Returns true if allocations have occurred in new regions or if regions have been
366 // uncommitted since the previous calls. This call will reset the flag to false.
367 bool has_changed() {
368 return _heap_changed.try_unset();
369 }
370
371 void set_concurrent_young_mark_in_progress(bool in_progress);
372 void set_concurrent_old_mark_in_progress(bool in_progress);
373 void set_evacuation_in_progress(bool in_progress);
374 void set_update_refs_in_progress(bool in_progress);
375 void set_degenerated_gc_in_progress(bool in_progress);
376 void set_full_gc_in_progress(bool in_progress);
377 void set_full_gc_move_in_progress(bool in_progress);
378 void set_has_forwarded_objects(bool cond);
379 void set_concurrent_strong_root_in_progress(bool cond);
380 void set_concurrent_weak_root_in_progress(bool cond);
381
382 void set_aging_cycle(bool cond);
383
384 inline bool is_stable() const;
385 inline bool is_idle() const;
386
387 inline bool is_concurrent_mark_in_progress() const;
388 inline bool is_concurrent_young_mark_in_progress() const;
389 inline bool is_concurrent_old_mark_in_progress() const;
390 inline bool is_update_refs_in_progress() const;
391 inline bool is_evacuation_in_progress() const;
392 inline bool is_degenerated_gc_in_progress() const;
393 inline bool is_full_gc_in_progress() const;
394 inline bool is_full_gc_move_in_progress() const;
395 inline bool has_forwarded_objects() const;
396
397 inline bool is_stw_gc_in_progress() const;
398 inline bool is_concurrent_strong_root_in_progress() const;
399 inline bool is_concurrent_weak_root_in_progress() const;
400 bool is_prepare_for_old_mark_in_progress() const;
401 inline bool is_aging_cycle() const;
402
403 // Return the age census object for young gen (in generational mode)
404 inline ShenandoahAgeCensus* age_census() const;
405
406 private:
407 void manage_satb_barrier(bool active);
408
409 enum CancelState {
410 // Normal state. GC has not been cancelled and is open for cancellation.
411 // Worker threads can suspend for safepoint.
412 CANCELLABLE,
413
414 // GC has been cancelled. Worker threads can not suspend for
415 // safepoint but must finish their work as soon as possible.
416 CANCELLED
417 };
418
419 double _cancel_requested_time;
420 ShenandoahSharedEnumFlag<CancelState> _cancelled_gc;
421
422 // Returns true if cancel request was successfully communicated.
423 // Returns false if some other thread already communicated cancel
424 // request. A true return value does not mean GC has been
425 // cancelled, only that the process of cancelling GC has begun.
426 bool try_cancel_gc();
427
428 public:
429 inline bool cancelled_gc() const;
430 inline bool check_cancelled_gc_and_yield(bool sts_active = true);
431
432 inline void clear_cancelled_gc(bool clear_oom_handler = true);
433
434 void cancel_concurrent_mark();
435 void cancel_gc(GCCause::Cause cause);
436
437 public:
438 // These will uncommit empty regions if heap::committed > shrink_until
439 // and there exists at least one region which was made empty before shrink_before.
440 void maybe_uncommit(double shrink_before, size_t shrink_until);
441 void op_uncommit(double shrink_before, size_t shrink_until);
442
443 // Returns true if the soft maximum heap has been changed using management APIs.
444 bool check_soft_max_changed();
445
446 private:
447 // GC support
448 // Evacuation
449 void evacuate_collection_set(bool concurrent);
450 // Concurrent root processing
451 void prepare_concurrent_roots();
452 void finish_concurrent_roots();
453 // Concurrent class unloading support
454 void do_class_unloading();
455 // Reference updating
456 void prepare_update_heap_references(bool concurrent);
457 void update_heap_references(bool concurrent);
458 // Final update region states
459 void update_heap_region_states(bool concurrent);
460
461 void rendezvous_threads();
462 void recycle_trash();
463 public:
464 void rebuild_free_set(bool concurrent);
465 void notify_gc_progress();
466 void notify_gc_no_progress();
467 size_t get_gc_no_progress_count() const;
468
469 //
470 // Mark support
471 private:
472 ShenandoahYoungGeneration* _young_generation;
473 ShenandoahGeneration* _global_generation;
474 ShenandoahOldGeneration* _old_generation;
475
476 protected:
477 ShenandoahController* _control_thread;
478
479 private:
480 ShenandoahCollectorPolicy* _shenandoah_policy;
481 ShenandoahMode* _gc_mode;
482 ShenandoahFreeSet* _free_set;
483 ShenandoahPacer* _pacer;
484 ShenandoahVerifier* _verifier;
485
486 ShenandoahPhaseTimings* _phase_timings;
487 ShenandoahEvacuationTracker* _evac_tracker;
488 ShenandoahMmuTracker _mmu_tracker;
489 ShenandoahGenerationSizer _generation_sizer;
490
491 public:
492 ShenandoahController* control_thread() { return _control_thread; }
493
494 ShenandoahYoungGeneration* young_generation() const { return _young_generation; }
495 ShenandoahGeneration* global_generation() const { return _global_generation; }
496 ShenandoahOldGeneration* old_generation() const { return _old_generation; }
497 ShenandoahGeneration* generation_for(ShenandoahAffiliation affiliation) const;
498 const ShenandoahGenerationSizer* generation_sizer() const { return &_generation_sizer; }
499
500 ShenandoahCollectorPolicy* shenandoah_policy() const { return _shenandoah_policy; }
501 ShenandoahMode* mode() const { return _gc_mode; }
502 ShenandoahFreeSet* free_set() const { return _free_set; }
503 ShenandoahPacer* pacer() const { return _pacer; }
504
505 ShenandoahPhaseTimings* phase_timings() const { return _phase_timings; }
506 ShenandoahEvacuationTracker* evac_tracker() const { return _evac_tracker; }
507
508 ShenandoahEvacOOMHandler* oom_evac_handler() { return &_oom_evac_handler; }
509
510 void on_cycle_start(GCCause::Cause cause, ShenandoahGeneration* generation);
511 void on_cycle_end(ShenandoahGeneration* generation);
512
513 ShenandoahVerifier* verifier();
514
515 // ---------- VM subsystem bindings
516 //
517 private:
518 ShenandoahMonitoringSupport* _monitoring_support;
519 MemoryPool* _memory_pool;
520 GCMemoryManager _stw_memory_manager;
521 GCMemoryManager _cycle_memory_manager;
522 ConcurrentGCTimer* _gc_timer;
523 SoftRefPolicy _soft_ref_policy;
524
525 // For exporting to SA
526 int _log_min_obj_alignment_in_bytes;
527 public:
528 ShenandoahMonitoringSupport* monitoring_support() const { return _monitoring_support; }
529 GCMemoryManager* cycle_memory_manager() { return &_cycle_memory_manager; }
530 GCMemoryManager* stw_memory_manager() { return &_stw_memory_manager; }
531 SoftRefPolicy* soft_ref_policy() override { return &_soft_ref_policy; }
532
533 GrowableArray<GCMemoryManager*> memory_managers() override;
534 GrowableArray<MemoryPool*> memory_pools() override;
535 MemoryUsage memory_usage() override;
536 GCTracer* tracer();
537 ConcurrentGCTimer* gc_timer() const;
538
539 // ---------- Class Unloading
540 //
541 private:
542 ShenandoahSharedFlag _is_aging_cycle;
543 ShenandoahSharedFlag _unload_classes;
544 ShenandoahUnload _unloader;
545
546 public:
547 void set_unload_classes(bool uc);
548 bool unload_classes() const;
549
550 // Perform STW class unloading and weak root cleaning
551 void parallel_cleaning(bool full_gc);
552
553 private:
554 void stw_unload_classes(bool full_gc);
555 void stw_process_weak_roots(bool full_gc);
556 void stw_weak_refs(bool full_gc);
557
558 inline void assert_lock_for_affiliation(ShenandoahAffiliation orig_affiliation,
559 ShenandoahAffiliation new_affiliation);
560
561 // Heap iteration support
562 void scan_roots_for_iteration(ShenandoahScanObjectStack* oop_stack, ObjectIterateScanRootClosure* oops);
563 bool prepare_aux_bitmap_for_iteration();
564 void reclaim_aux_bitmap_for_iteration();
565
566 // ---------- Generic interface hooks
567 // Minor things that super-interface expects us to implement to play nice with
568 // the rest of runtime. Some of the things here are not required to be implemented,
569 // and can be stubbed out.
570 //
571 public:
572 bool is_maximal_no_gc() const override shenandoah_not_implemented_return(false);
573
574 inline bool is_in(const void* p) const override;
575
576 inline bool is_in_active_generation(oop obj) const;
577 inline bool is_in_young(const void* p) const;
578 inline bool is_in_old(const void* p) const;
579 inline bool is_old(oop pobj) const;
580
581 inline ShenandoahAffiliation region_affiliation(const ShenandoahHeapRegion* r);
582 inline void set_affiliation(ShenandoahHeapRegion* r, ShenandoahAffiliation new_affiliation);
583
584 inline ShenandoahAffiliation region_affiliation(size_t index);
585
586 bool requires_barriers(stackChunkOop obj) const override;
587
588 MemRegion reserved_region() const { return _reserved; }
589 bool is_in_reserved(const void* addr) const { return _reserved.contains(addr); }
590
591 void collect(GCCause::Cause cause) override;
592 void do_full_collection(bool clear_all_soft_refs) override;
593
594 // Used for parsing heap during error printing
595 HeapWord* block_start(const void* addr) const;
596 bool block_is_obj(const HeapWord* addr) const;
597 bool print_location(outputStream* st, void* addr) const override;
598
599 // Used for native heap walkers: heap dumpers, mostly
600 void object_iterate(ObjectClosure* cl) override;
601 // Parallel heap iteration support
602 ParallelObjectIteratorImpl* parallel_object_iterator(uint workers) override;
603
604 // Keep alive an object that was loaded with AS_NO_KEEPALIVE.
617 void unregister_nmethod(nmethod* nm) override;
618 void verify_nmethod(nmethod* nm) override {}
619
620 // ---------- Pinning hooks
621 //
622 public:
623 // Shenandoah supports per-object (per-region) pinning
624 void pin_object(JavaThread* thread, oop obj) override;
625 void unpin_object(JavaThread* thread, oop obj) override;
626
627 void sync_pinned_region_status();
628 void assert_pinned_region_status() NOT_DEBUG_RETURN;
629
630 // ---------- Concurrent Stack Processing support
631 //
632 public:
633 bool uses_stack_watermark_barrier() const override { return true; }
634
635 // ---------- Allocation support
636 //
637 protected:
638 inline HeapWord* allocate_from_gclab(Thread* thread, size_t size);
639
640 private:
641 HeapWord* allocate_memory_under_lock(ShenandoahAllocRequest& request, bool& in_new_region);
642 HeapWord* allocate_from_gclab_slow(Thread* thread, size_t size);
643 HeapWord* allocate_new_gclab(size_t min_size, size_t word_size, size_t* actual_size);
644
645 public:
646 HeapWord* allocate_memory(ShenandoahAllocRequest& request);
647 HeapWord* mem_allocate(size_t size, bool* what) override;
648 MetaWord* satisfy_failed_metadata_allocation(ClassLoaderData* loader_data,
649 size_t size,
650 Metaspace::MetadataType mdtype) override;
651
652 void notify_mutator_alloc_words(size_t words, size_t waste);
653
654 HeapWord* allocate_new_tlab(size_t min_size, size_t requested_size, size_t* actual_size) override;
655 size_t tlab_capacity(Thread *thr) const override;
656 size_t unsafe_max_tlab_alloc(Thread *thread) const override;
657 size_t max_tlab_size() const override;
658 size_t tlab_used(Thread* ignored) const override;
659
660 void ensure_parsability(bool retire_labs) override;
661
662 void labs_make_parsable();
663 void tlabs_retire(bool resize);
664 void gclabs_retire(bool resize);
665
666 // ---------- Marking support
667 //
668 private:
669 ShenandoahMarkingContext* _marking_context;
670 MemRegion _bitmap_region;
671 MemRegion _aux_bitmap_region;
672 MarkBitMap _verification_bit_map;
673 MarkBitMap _aux_bit_map;
674
675 size_t _bitmap_size;
676 size_t _bitmap_regions_per_slice;
677 size_t _bitmap_bytes_per_slice;
678
679 size_t _pretouch_heap_page_size;
680 size_t _pretouch_bitmap_page_size;
681
682 bool _bitmap_region_special;
683 bool _aux_bitmap_region_special;
684
685 ShenandoahLiveData** _liveness_cache;
686
687 public:
688 inline ShenandoahMarkingContext* complete_marking_context() const;
689 inline ShenandoahMarkingContext* marking_context() const;
690
691 template<class T>
692 inline void marked_object_iterate(ShenandoahHeapRegion* region, T* cl);
693
694 template<class T>
695 inline void marked_object_iterate(ShenandoahHeapRegion* region, T* cl, HeapWord* limit);
696
697 template<class T>
698 inline void marked_object_oop_iterate(ShenandoahHeapRegion* region, T* cl, HeapWord* limit);
699
700 // SATB barriers hooks
701 inline bool requires_marking(const void* entry) const;
702
703 // Support for bitmap uncommits
704 bool commit_bitmap_slice(ShenandoahHeapRegion *r);
705 bool uncommit_bitmap_slice(ShenandoahHeapRegion *r);
706 bool is_bitmap_slice_committed(ShenandoahHeapRegion* r, bool skip_self = false);
707
708 // Liveness caching support
709 ShenandoahLiveData* get_liveness_cache(uint worker_id);
710 void flush_liveness_cache(uint worker_id);
711
712 size_t pretouch_heap_page_size() { return _pretouch_heap_page_size; }
713
714 // ---------- Evacuation support
715 //
716 private:
717 ShenandoahCollectionSet* _collection_set;
718 ShenandoahEvacOOMHandler _oom_evac_handler;
719
720 oop try_evacuate_object(oop src, Thread* thread, ShenandoahHeapRegion* from_region, ShenandoahAffiliation target_gen);
721 public:
722
723 static address in_cset_fast_test_addr();
724
725 ShenandoahCollectionSet* collection_set() const { return _collection_set; }
726
727 // Checks if object is in the collection set.
728 inline bool in_collection_set(oop obj) const;
729
730 // Checks if location is in the collection set. Can be interior pointer, not the oop itself.
731 inline bool in_collection_set_loc(void* loc) const;
732
733 // Evacuates or promotes object src. Returns the evacuated object, either evacuated
734 // by this thread, or by some other thread.
735 virtual oop evacuate_object(oop src, Thread* thread);
736
737 // Call before/after evacuation.
738 inline void enter_evacuation(Thread* t);
739 inline void leave_evacuation(Thread* t);
740
741 // ---------- Generational support
742 //
743 private:
744 RememberedScanner* _card_scan;
745
746 public:
747 inline RememberedScanner* card_scan() { return _card_scan; }
748 void clear_cards_for(ShenandoahHeapRegion* region);
749 void mark_card_as_dirty(void* location);
750 void cancel_old_gc();
751
752 // ---------- Helper functions
753 //
754 public:
755 template <class T>
756 inline void conc_update_with_forwarded(T* p);
757
758 template <class T>
759 inline void update_with_forwarded(T* p);
760
761 static inline void atomic_update_oop(oop update, oop* addr, oop compare);
762 static inline void atomic_update_oop(oop update, narrowOop* addr, oop compare);
763 static inline void atomic_update_oop(oop update, narrowOop* addr, narrowOop compare);
764
765 static inline bool atomic_update_oop_check(oop update, oop* addr, oop compare);
766 static inline bool atomic_update_oop_check(oop update, narrowOop* addr, oop compare);
767 static inline bool atomic_update_oop_check(oop update, narrowOop* addr, narrowOop compare);
768
769 static inline void atomic_clear_oop( oop* addr, oop compare);
770 static inline void atomic_clear_oop(narrowOop* addr, oop compare);
771 static inline void atomic_clear_oop(narrowOop* addr, narrowOop compare);
772
773 size_t trash_humongous_region_at(ShenandoahHeapRegion *r);
774
775 static inline void increase_object_age(oop obj, uint additional_age);
776
777 // Return the object's age, or a sentinel value when the age can't
778 // necessarily be determined because of concurrent locking by the
779 // mutator
780 static inline uint get_object_age(oop obj);
781
782 void transfer_old_pointers_from_satb();
783
784 void log_heap_status(const char *msg) const;
785
786 private:
787 void trash_cset_regions();
788
789 // ---------- Testing helpers functions
790 //
791 private:
792 ShenandoahSharedFlag _inject_alloc_failure;
793
794 void try_inject_alloc_failure();
795 bool should_inject_alloc_failure();
796 };
797
798 #endif // SHARE_GC_SHENANDOAH_SHENANDOAHHEAP_HPP
|