1 /*
2  * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.
8  *
9  * This code is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12  * version 2 for more details (a copy is included in the LICENSE file that
13  * accompanied this code).
14  *
15  * You should have received a copy of the GNU General Public License version
16  * 2 along with this work; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18  *
19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20  * or visit www.oracle.com if you need additional information or have any
21  * questions.
22  */
23 
24 #ifndef SHARE_GC_Z_ZHEAP_HPP
25 #define SHARE_GC_Z_ZHEAP_HPP
26 
27 #include "gc/shared/gcTimer.hpp"
28 #include "gc/z/zAllocationFlags.hpp"
29 #include "gc/z/zArray.hpp"
30 #include "gc/z/zList.hpp"
31 #include "gc/z/zLock.hpp"
32 #include "gc/z/zMark.hpp"
33 #include "gc/z/zObjectAllocator.hpp"
34 #include "gc/z/zPage.hpp"
35 #include "gc/z/zPageAllocator.hpp"
36 #include "gc/z/zPageTable.hpp"
37 #include "gc/z/zReferenceProcessor.hpp"
38 #include "gc/z/zRelocate.hpp"
39 #include "gc/z/zRelocationSet.hpp"
40 #include "gc/z/zRelocationSetSelector.hpp"
41 #include "gc/z/zRootsIterator.hpp"
42 #include "gc/z/zWeakRootsProcessor.hpp"
43 #include "gc/z/zServiceability.hpp"
44 #include "gc/z/zUnload.hpp"
45 #include "gc/z/zWorkers.hpp"
46 #include "memory/allocation.hpp"
47 
48 class ZHeap {
49   friend class VMStructs;
50 
51 private:
52   static ZHeap*       _heap;
53 
54   ZWorkers            _workers;
55   ZObjectAllocator    _object_allocator;
56   ZPageAllocator      _page_allocator;
57   ZPageTable          _pagetable;
58   ZMark               _mark;
59   ZReferenceProcessor _reference_processor;
60   ZWeakRootsProcessor _weak_roots_processor;
61   ZRelocate           _relocate;
62   ZRelocationSet      _relocation_set;
63   ZUnload             _unload;
64   ZServiceability     _serviceability;
65 
66   size_t heap_min_size() const;
67   size_t heap_max_size() const;
68   size_t heap_max_reserve_size() const;
69 
70   void out_of_memory();
71   void flip_views();
72   void fixup_partial_loads();
73 
74 public:
75   static ZHeap* heap();
76 
77   ZHeap();
78 
79   bool is_initialized() const;
80 
81   // Heap metrics
82   size_t min_capacity() const;
83   size_t max_capacity() const;
84   size_t current_max_capacity() const;
85   size_t capacity() const;
86   size_t max_reserve() const;
87   size_t used_high() const;
88   size_t used_low() const;
89   size_t used() const;
90   size_t allocated() const;
91   size_t reclaimed() const;
92 
93   size_t tlab_capacity() const;
94   size_t tlab_used() const;
95   size_t max_tlab_size() const;
96   size_t unsafe_max_tlab_alloc() const;
97 
98   bool is_in(uintptr_t addr) const;
99 
100   // Block
101   uintptr_t block_start(uintptr_t addr) const;
102   size_t block_size(uintptr_t addr) const;
103   bool block_is_obj(uintptr_t addr) const;
104 
105   // Workers
106   uint nconcurrent_worker_threads() const;
107   uint nconcurrent_no_boost_worker_threads() const;
108   void set_boost_worker_threads(bool boost);
109   void worker_threads_do(ThreadClosure* tc) const;
110   void print_worker_threads_on(outputStream* st) const;
111 
112   // Reference processing
113   ReferenceDiscoverer* reference_discoverer();
114   void set_soft_reference_policy(bool clear);
115 
116   // Non-strong reference processing
117   void process_non_strong_references();
118 
119   // Page allocation
120   ZPage* alloc_page(uint8_t type, size_t size, ZAllocationFlags flags);
121   void undo_alloc_page(ZPage* page);
122   bool retain_page(ZPage* page);
123   void release_page(ZPage* page, bool reclaimed);
124 
125   // Object allocation
126   uintptr_t alloc_tlab(size_t size);
127   uintptr_t alloc_object(size_t size);
128   uintptr_t alloc_object_for_relocation(size_t size);
129   void undo_alloc_object_for_relocation(uintptr_t addr, size_t size);
130   bool is_alloc_stalled() const;
131   void check_out_of_memory();
132 
133   // Marking
134   bool is_object_live(uintptr_t addr) const;
135   bool is_object_strongly_live(uintptr_t addr) const;
136   template <bool finalizable, bool publish> void mark_object(uintptr_t addr);
137   void mark_start();
138   void mark(bool initial);
139   void mark_flush_and_free(Thread* thread);
140   bool mark_end();
141 
142   // Post-marking & Pre-relocation
143   void destroy_detached_pages();
144 
145   // Relocation set
146   void select_relocation_set();
147   void prepare_relocation_set();
148   void reset_relocation_set();
149 
150   // Relocation
151   bool is_relocating(uintptr_t addr) const;
152   void relocate_start();
153   uintptr_t relocate_object(uintptr_t addr);
154   uintptr_t forward_object(uintptr_t addr);
155   void relocate();
156 
157   // Iteration
158   void object_iterate(ObjectClosure* cl, bool visit_referents);
159 
160   // Serviceability
161   void serviceability_initialize();
162   GCMemoryManager* serviceability_memory_manager();
163   MemoryPool* serviceability_memory_pool();
164   ZServiceabilityCounters* serviceability_counters();
165 
166   // Printing
167   void print_on(outputStream* st) const;
168   void print_extended_on(outputStream* st) const;
169 
170   // Verification
171   bool is_oop(oop object) const;
172   void verify();
173 };
174 
175 #endif // SHARE_GC_Z_ZHEAP_HPP
176