1 /*
2 * Copyright (c) 2001, 2023, 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
25 #ifndef SHARE_GC_PARALLEL_MUTABLESPACE_HPP
26 #define SHARE_GC_PARALLEL_MUTABLESPACE_HPP
27
28 #include "memory/allocation.hpp"
29 #include "memory/iterator.hpp"
30 #include "memory/memRegion.hpp"
31 #include "utilities/copy.hpp"
32 #include "utilities/globalDefinitions.hpp"
33 #include "utilities/macros.hpp"
34
35 class WorkerThreads;
36
37 // A MutableSpace supports the concept of allocation. This includes the
38 // concepts that a space may be only partially full, and the query methods
39 // that go with such an assumption.
40 //
41 // MutableSpace is also responsible for minimizing the
42 // page allocation time by having the memory pretouched (with
43 // AlwaysPretouch) and for optimizing page placement on NUMA systems
44 // by make the underlying region interleaved (with UseNUMA).
45 //
46 // Invariant: bottom() <= top() <= end()
47 // top() and end() are exclusive.
48
49 class MutableSpaceMangler;
50
51 class MutableSpace: public CHeapObj<mtGC> {
52 friend class VMStructs;
53
54 // Helper for mangling unused space in debug builds
55 MutableSpaceMangler* _mangler;
56 // The last region which page had been setup to be interleaved.
57 MemRegion _last_setup_region;
58 size_t _alignment;
59 HeapWord* _bottom;
60 HeapWord* volatile _top;
61 HeapWord* _end;
62
63 MutableSpaceMangler* mangler() { return _mangler; }
64
65 void numa_setup_pages(MemRegion mr, size_t page_size, bool clear_space);
66
67 void set_last_setup_region(MemRegion mr) { _last_setup_region = mr; }
68 MemRegion last_setup_region() const { return _last_setup_region; }
69
70 public:
71 virtual ~MutableSpace();
72 MutableSpace(size_t page_size);
73
74 // Accessors
75 HeapWord* bottom() const { return _bottom; }
76 HeapWord* top() const { return _top; }
77 HeapWord* end() const { return _end; }
78
79 void set_bottom(HeapWord* value) { _bottom = value; }
80 virtual void set_top(HeapWord* value) { _top = value; }
81 void set_end(HeapWord* value) { _end = value; }
82
83 HeapWord* volatile* top_addr() { return &_top; }
84 HeapWord** end_addr() { return &_end; }
85
86 size_t alignment() { return _alignment; }
87
88 MemRegion region() const { return MemRegion(bottom(), end()); }
89
90 size_t capacity_in_bytes() const { return capacity_in_words() * HeapWordSize; }
91 size_t capacity_in_words() const { return pointer_delta(end(), bottom()); }
92
93 // Returns a subregion containing all objects in this space.
94 MemRegion used_region() { return MemRegion(bottom(), top()); }
95
96 static const bool SetupPages = true;
97 static const bool DontSetupPages = false;
98
99 // Initialization
100 virtual void initialize(MemRegion mr,
101 bool clear_space,
102 bool mangle_space,
103 bool setup_pages = SetupPages,
104 WorkerThreads* pretouch_workers = nullptr);
105
106 virtual void clear(bool mangle_space);
107 virtual void update() { }
108 virtual void accumulate_statistics() { }
109
110 // Methods used in mangling. See descriptions under SpaceMangler.
111 virtual void mangle_unused_area() PRODUCT_RETURN;
112 virtual void mangle_unused_area_complete() PRODUCT_RETURN;
113 virtual void check_mangled_unused_area(HeapWord* limit) PRODUCT_RETURN;
114 virtual void check_mangled_unused_area_complete() PRODUCT_RETURN;
115 virtual void set_top_for_allocations(HeapWord* v) PRODUCT_RETURN;
116
117 // Used to save the space's current top for later use during mangling.
118 virtual void set_top_for_allocations() PRODUCT_RETURN;
119
120 virtual void ensure_parsability() { }
121
122 virtual void mangle_region(MemRegion mr) PRODUCT_RETURN;
123
124 // Boolean queries.
125 bool is_empty() const { return used_in_words() == 0; }
126 bool not_empty() const { return used_in_words() > 0; }
127 bool contains(const void* p) const { return _bottom <= p && p < _end; }
128
129 // Size computations. Sizes are in bytes.
130 size_t used_in_bytes() const { return used_in_words() * HeapWordSize; }
131 size_t free_in_bytes() const { return free_in_words() * HeapWordSize; }
132
133 // Size computations. Sizes are in heapwords.
134 virtual size_t used_in_words() const { return pointer_delta(top(), bottom()); }
135 virtual size_t free_in_words() const { return pointer_delta(end(), top()); }
136 virtual size_t tlab_capacity(Thread* thr) const { return capacity_in_bytes(); }
137 virtual size_t tlab_used(Thread* thr) const { return used_in_bytes(); }
138 virtual size_t unsafe_max_tlab_alloc(Thread* thr) const { return free_in_bytes(); }
139
140 // Allocation (return null if full)
141 virtual HeapWord* cas_allocate(size_t word_size);
142 // Optional deallocation. Used in NUMA-allocator.
143 bool cas_deallocate(HeapWord *obj, size_t size);
144 // Return true if this space needs to be expanded in order to satisfy an
145 // allocation request of the indicated size. Concurrent allocations and
146 // resizes may change the result of a later call. Used by oldgen allocator.
147 // precondition: holding PSOldGenExpand_lock
148 bool needs_expand(size_t word_size) const;
149
150 // Iteration.
151 void oop_iterate(OopIterateClosure* cl);
152 void object_iterate(ObjectClosure* cl);
153
154 // Debugging
155 virtual void print() const;
156 virtual void print_on(outputStream* st) const;
157 virtual void print_short() const;
158 virtual void print_short_on(outputStream* st) const;
159 virtual void verify();
160 };
161
162 #endif // SHARE_GC_PARALLEL_MUTABLESPACE_HPP