1 /*
2 * Copyright (c) 2015, 2017, 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/zInitialize.hpp"
31 #include "gc/z/zList.hpp"
32 #include "gc/z/zLock.hpp"
33 #include "gc/z/zMark.hpp"
34 #include "gc/z/zObjectAllocator.hpp"
35 #include "gc/z/zPage.hpp"
36 #include "gc/z/zPageAllocator.hpp"
37 #include "gc/z/zPageTable.hpp"
38 #include "gc/z/zReferenceProcessor.hpp"
39 #include "gc/z/zRelocate.hpp"
40 #include "gc/z/zRelocationSet.hpp"
41 #include "gc/z/zRelocationSetSelector.hpp"
42 #include "gc/z/zRootsIterator.hpp"
43 #include "gc/z/zServiceability.hpp"
44 #include "gc/z/zWorkers.hpp"
45 #include "memory/allocation.hpp"
46
47 class ZHeap VALUE_OBJ_CLASS_SPEC {
48 private:
49 static ZHeap* _heap;
50
51 ZInitialize _initialize;
52 ZWorkers _workers;
53 ZObjectAllocator _object_allocator;
54 ZPageAllocator _page_allocator;
55 ZPageTable _pagetable;
56 ZMark _mark;
57 ZReferenceProcessor _reference_processor;
58 ZRelocate _relocate;
59 ZRelocationSet _relocation_set;
60 ZServiceability _serviceability;
61
62 size_t heap_min_size() const;
63 size_t heap_max_size() const;
64 size_t heap_max_reserve_size() const;
65
66 void out_of_memory();
67 void flip_views();
68 void fixup_partial_loads();
69 void process_weak_roots();
70
71 public:
72 static ZHeap* heap();
73
74 ZHeap();
75
76 bool is_initialized() const;
77
78 // Heap metrics
79 size_t min_capacity() const;
80 size_t max_capacity() const;
81 size_t capacity() const;
82 size_t max_reserve() const;
83 size_t used_high() const;
84 size_t used_low() const;
85 size_t used() const;
86 size_t allocated() const;
87 size_t reclaimed() const;
88
89 size_t tlab_capacity() const;
90 size_t tlab_used() const;
91 size_t max_tlab_size() const;
92 size_t unsafe_max_tlab_alloc() const;
93
94 bool is_in(uintptr_t addr) const;
95
96 // Block
97 uintptr_t block_start(uintptr_t addr) const;
98 size_t block_size(uintptr_t addr) const;
99 bool block_is_obj(uintptr_t addr) const;
100
101 // Raw pagetable exposed for barriers
102 ZPageTableEntry* pagetable_addr() const;
103
104 // Workers
105 void set_boost_worker_threads(bool boost);
106 void worker_threads_do(ThreadClosure* tc) const;
107 void print_worker_threads_on(outputStream* st) const;
108
109 // Reference processing
110 ReferenceDiscoverer* reference_discoverer();
111 void set_soft_reference_policy(bool clear);
112 void process_and_enqueue_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 bool retain_page(ZPage* page);
118 void release_page(ZPage* page, bool reclaimed);
119
120 // Object allocation
121 uintptr_t alloc_tlab(size_t size);
122 uintptr_t alloc_object(size_t size);
123 uintptr_t alloc_object_for_relocation(size_t size);
124 void undo_alloc_object_for_relocation(uintptr_t addr, size_t size);
125 void check_out_of_memory();
126
127 // Marking
128 bool is_object_live(uintptr_t addr) const;
129 bool is_object_strongly_live(uintptr_t addr) const;
130 template <bool finalizable, bool publish> void mark_object(uintptr_t addr);
131 void mark_start();
132 void mark();
133 void mark_flush_and_free();
134 bool mark_end();
135
136 // Post-marking & Pre-relocation
137 void destroy_detached_pages();
138
139 // Relocation set
140 void select_relocation_set();
141 void prepare_relocation_set();
142 void reset_relocation_set();
143
144 // Relocation
145 bool is_relocating(uintptr_t addr) const;
146 void relocate_start();
147 uintptr_t relocate_object(uintptr_t addr);
148 uintptr_t forward_object(uintptr_t addr);
149 void relocate();
150
151 // Iteration
152 void object_iterate(ObjectClosure* cl);
153
154 // Serviceability
155 void serviceability_initialize();
156 GCMemoryManager* serviceability_memory_manager();
157 MemoryPool* serviceability_memory_pool();
158 ZServiceabilityCounters* serviceability_counters();
159
160 // Printing
161 void print_on(outputStream* st) const;
162 void print_extended_on(outputStream* st) const;
163
164 // Verification
165 bool is_oop(oop object) const;
166 void verify();
167 };
168
169 #endif // SHARE_GC_Z_ZHEAP_HPP