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