1 /*
2 * Copyright (c) 2015, 2019, 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/z/zAllocationFlags.hpp"
28 #include "gc/z/zForwardingTable.hpp"
29 #include "gc/z/zMark.hpp"
30 #include "gc/z/zObjectAllocator.hpp"
31 #include "gc/z/zPage.hpp"
32 #include "gc/z/zPageAllocator.hpp"
33 #include "gc/z/zPageTable.hpp"
34 #include "gc/z/zReferenceProcessor.hpp"
35 #include "gc/z/zRelocate.hpp"
36 #include "gc/z/zRelocationSet.hpp"
37 #include "gc/z/zWeakRootsProcessor.hpp"
38 #include "gc/z/zServiceability.hpp"
39 #include "gc/z/zUnload.hpp"
40 #include "gc/z/zWorkers.hpp"
41
42 class ZHeap {
43 friend class VMStructs;
44
45 private:
46 static ZHeap* _heap;
47
48 ZWorkers _workers;
49 ZObjectAllocator _object_allocator;
50 ZPageAllocator _page_allocator;
51 ZPageTable _page_table;
52 ZForwardingTable _forwarding_table;
53 ZMark _mark;
54 ZReferenceProcessor _reference_processor;
55 ZWeakRootsProcessor _weak_roots_processor;
56 ZRelocate _relocate;
57 ZRelocationSet _relocation_set;
58 ZUnload _unload;
59 ZServiceability _serviceability;
60
61 size_t heap_min_size() const;
62 size_t heap_initial_size() const;
63 size_t heap_max_size() const;
64 size_t heap_max_reserve_size() const;
65
66 void flip_to_marked();
67 void flip_to_remapped();
68
69 void out_of_memory();
70 void fixup_partial_loads();
71
72 public:
73 static ZHeap* heap();
74
75 ZHeap();
76
77 bool is_initialized() const;
78
79 // Heap metrics
80 size_t min_capacity() const;
81 size_t max_capacity() const;
82 size_t soft_max_capacity() const;
83 size_t capacity() const;
84 size_t max_reserve() const;
85 size_t used_high() const;
86 size_t used_low() const;
87 size_t used() const;
88 size_t unused() const;
89 size_t allocated() const;
90 size_t reclaimed() const;
91
92 size_t tlab_capacity() const;
93 size_t tlab_used() const;
94 size_t max_tlab_size() const;
95 size_t unsafe_max_tlab_alloc() const;
96
97 bool is_in(uintptr_t addr) const;
98 uint32_t hash_oop(uintptr_t addr) const;
99
100 // Workers
101 uint nconcurrent_worker_threads() const;
102 uint nconcurrent_no_boost_worker_threads() const;
103 void set_boost_worker_threads(bool boost);
104 void worker_threads_do(ThreadClosure* tc) const;
105 void print_worker_threads_on(outputStream* st) const;
106
107 // Reference processing
108 ReferenceDiscoverer* reference_discoverer();
109 void set_soft_reference_policy(bool clear);
110
111 // Non-strong reference processing
112 void process_non_strong_references();
113
114 // Page allocation
115 ZPage* alloc_page(uint8_t type, size_t size, ZAllocationFlags flags);
116 void undo_alloc_page(ZPage* page);
117 void free_page(ZPage* page, bool reclaimed);
118
119 // Uncommit memory
120 uint64_t uncommit(uint64_t delay);
121
122 // Object allocation
123 uintptr_t alloc_tlab(size_t size);
124 uintptr_t alloc_object(size_t size);
125 uintptr_t alloc_object_for_relocation(size_t size);
126 void undo_alloc_object_for_relocation(uintptr_t addr, size_t size);
127 bool is_alloc_stalled() const;
128 void check_out_of_memory();
129
130 // Marking
131 bool is_object_live(uintptr_t addr) const;
132 bool is_object_strongly_live(uintptr_t addr) const;
133 template <bool follow, bool finalizable, bool publish> void mark_object(uintptr_t addr);
134 void mark_start();
135 void mark(bool initial);
136 void mark_flush_and_free(Thread* thread);
137 bool mark_end();
138
139 // Relocation set
140 void select_relocation_set();
141 void reset_relocation_set();
142
143 // Relocation
144 void relocate_start();
145 uintptr_t relocate_object(uintptr_t addr);
146 uintptr_t remap_object(uintptr_t addr);
147 void relocate();
148
149 // Iteration
150 void object_iterate(ObjectClosure* cl, bool visit_weaks);
151 void pages_do(ZPageClosure* cl);
152
153 // Serviceability
154 void serviceability_initialize();
155 GCMemoryManager* serviceability_memory_manager();
156 MemoryPool* serviceability_memory_pool();
157 ZServiceabilityCounters* serviceability_counters();
158
159 // Printing
160 void print_on(outputStream* st) const;
161 void print_extended_on(outputStream* st) const;
162 bool print_location(outputStream* st, uintptr_t addr) const;
163
164 // Verification
165 bool is_oop(uintptr_t addr) const;
166 void verify();
167 };
168
169 #endif // SHARE_GC_Z_ZHEAP_HPP