1 /*
2 * Copyright (c) 1997, 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
25 #ifndef SHARE_VM_RUNTIME_VIRTUALSPACE_HPP
26 #define SHARE_VM_RUNTIME_VIRTUALSPACE_HPP
27
28 #include "utilities/globalDefinitions.hpp"
29
30 // ReservedSpace is a data structure for reserving a contiguous address range.
31
32 class ReservedSpace {
33 friend class VMStructs;
34 protected:
35 char* _base;
36 char* _nvdimm_base;
37 char* _nvdimm_base_nv;
38 size_t _size;
39 size_t _dram_size;
40 size_t _nvdimm_size;
41 size_t _noaccess_prefix;
42 size_t _alignment;
43 bool _special;
44 int _fd_for_heap;
45 int _fd_for_nvdimm;
46 private:
47 bool _executable;
48
49 // ReservedSpace
50 ReservedSpace(char* base, size_t size, size_t alignment, bool special,
51 bool executable);
52 protected:
53 void initialize(size_t size, size_t alignment, bool large,
54 char* requested_address,
55 bool executable);
56
57 public:
58 // Constructor
59 ReservedSpace();
60 // Initialize the reserved space with the given size. If preferred_page_size
61 // is set, use this as minimum page size/alignment. This may waste some space
62 // if the given size is not aligned to that value, as the reservation will be
63 // aligned up to the final alignment in this case.
64 ReservedSpace(size_t size, size_t preferred_page_size = 0);
65 ReservedSpace(size_t size, size_t alignment, bool large,
66 char* requested_address = NULL);
67 ReservedSpace(size_t size, size_t alignment, bool large, bool executable);
68
69 // Accessors
70 char* base() const { return _base; }
71 char* nvdimm_base() const { return _nvdimm_base; }
72 int nvdimm_fd() const { return _fd_for_nvdimm; }
73 void setup_fd(int fd) {_fd_for_nvdimm = fd; }
74 size_t size() const { return _size; }
75 size_t nvdimm_size() const { return _nvdimm_size; }
76 char* end() const { return _base + _size; }
77 size_t alignment() const { return _alignment; }
78 bool special() const { return _special; }
79 bool executable() const { return _executable; }
80 size_t noaccess_prefix() const { return _noaccess_prefix; }
81 bool is_reserved() const { return _base != NULL; }
82 void release();
83
84 // Splitting
85 ReservedSpace first_part(size_t partition_size, size_t alignment,
86 bool split = false, bool realloc = true);
87 ReservedSpace last_part (size_t partition_size, size_t alignment);
88
89 // These simply call the above using the default alignment.
90 inline ReservedSpace first_part(size_t partition_size,
91 bool split = false, bool realloc = true);
92 inline ReservedSpace last_part (size_t partition_size);
93
94 // Alignment
95 static size_t page_align_size_up(size_t size);
96 static size_t page_align_size_down(size_t size);
97 static size_t allocation_align_size_up(size_t size);
98 static size_t allocation_align_size_down(size_t size);
99 bool contains(const void* p) const {
100 return (base() <= ((char*)p)) && (((char*)p) < (base() + size()));
101 }
102 };
103
104 ReservedSpace
105 ReservedSpace::first_part(size_t partition_size, bool split, bool realloc)
106 {
107 return first_part(partition_size, alignment(), split, realloc);
108 }
109
110 ReservedSpace ReservedSpace::last_part(size_t partition_size)
111 {
112 return last_part(partition_size, alignment());
113 }
114
115 // Class encapsulating behavior specific of memory space reserved for Java heap.
116 class ReservedHeapSpace : public ReservedSpace {
117 private:
118 void try_reserve_heap(size_t size, size_t alignment, bool large,
119 char *requested_address);
120 void try_reserve_range(char *highest_start, char *lowest_start,
121 size_t attach_point_alignment, char *aligned_HBMA,
122 char *upper_bound, size_t size, size_t alignment, bool large);
123 void initialize_compressed_heap(const size_t size, size_t alignment, bool large);
124 // Create protection page at the beginning of the space.
125 void establish_noaccess_prefix();
126 void initialize_g1gc_nvdimm_dram_sizes(size_t size, size_t alignment);
127 public:
128 // Constructor. Tries to find a heap that is good for compressed oops.
129 // heap_allocation_directory is the path to the backing memory for Java heap. When set, Java heap will be allocated
130 // on the device which is managed by the file system where the directory resides.
131 ReservedHeapSpace(size_t size, size_t forced_base_alignment, bool large, const char* heap_allocation_directory = NULL);
132 // Returns the base to be used for compression, i.e. so that null can be
133 // encoded safely and implicit null checks can work.
134 char *compressed_oop_base() { return _base - _noaccess_prefix; }
135 };
136
137 // Class encapsulating behavior specific memory space for Code
138 class ReservedCodeSpace : public ReservedSpace {
139 public:
140 // Constructor
141 ReservedCodeSpace(size_t r_size, size_t rs_align, bool large);
142 };
143
144 // VirtualSpace is data structure for committing a previously reserved address range in smaller chunks.
145
146 class VirtualSpace {
147 friend class VMStructs;
148 private:
149 // Reserved area
150 char* _low_boundary;
151 char* _high_boundary;
152
153 // Committed area
154 char* _low;
155 char* _high;
156
157 // The entire space has been committed and pinned in memory, no
158 // os::commit_memory() or os::uncommit_memory().
159 bool _special;
160
161 // Need to know if commit should be executable.
162 bool _executable;
163
164 // MPSS Support
165 // Each virtualspace region has a lower, middle, and upper region.
166 // Each region has an end boundary and a high pointer which is the
167 // high water mark for the last allocated byte.
168 // The lower and upper unaligned to LargePageSizeInBytes uses default page.
169 // size. The middle region uses large page size.
170 char* _lower_high;
171 char* _middle_high;
172 char* _upper_high;
173
174 char* _lower_high_boundary;
175 char* _middle_high_boundary;
176 char* _upper_high_boundary;
177
178 size_t _lower_alignment;
179 size_t _middle_alignment;
180 size_t _upper_alignment;
181
182 // MPSS Accessors
183 char* lower_high() const { return _lower_high; }
184 char* middle_high() const { return _middle_high; }
185 char* upper_high() const { return _upper_high; }
186
187 char* lower_high_boundary() const { return _lower_high_boundary; }
188 char* middle_high_boundary() const { return _middle_high_boundary; }
189 char* upper_high_boundary() const { return _upper_high_boundary; }
190
191 size_t lower_alignment() const { return _lower_alignment; }
192 size_t middle_alignment() const { return _middle_alignment; }
193 size_t upper_alignment() const { return _upper_alignment; }
194
195 public:
196 // Committed area
197 char* low() const { return _low; }
198 char* high() const { return _high; }
199
200 // Reserved area
201 char* low_boundary() const { return _low_boundary; }
202 char* high_boundary() const { return _high_boundary; }
203
204 #if INCLUDE_AOT
205 // Set boundaries for code section in AOT library.
206 void set_low_boundary(char *p) { _low_boundary = p; }
207 void set_high_boundary(char *p) { _high_boundary = p; }
208 void set_low(char *p) { _low = p; }
209 void set_high(char *p) { _high = p; }
210 #endif
211
212 bool special() const { return _special; }
213
214 public:
215 // Initialization
216 VirtualSpace();
217 bool initialize_with_granularity(ReservedSpace rs, size_t committed_byte_size, size_t max_commit_ganularity);
218 bool initialize(ReservedSpace rs, size_t committed_byte_size);
219
220 // Destruction
221 ~VirtualSpace();
222
223 // Reserved memory
224 size_t reserved_size() const;
225 // Actually committed OS memory
226 size_t actual_committed_size() const;
227 // Memory used/expanded in this virtual space
228 size_t committed_size() const;
229 // Memory left to use/expand in this virtual space
230 size_t uncommitted_size() const;
231
232 bool contains(const void* p) const;
233
234 // Operations
235 // returns true on success, false otherwise
236 bool expand_by(size_t bytes, bool pre_touch = false);
237 void shrink_by(size_t bytes);
238 void release();
239
240 void check_for_contiguity() PRODUCT_RETURN;
241
242 // Debugging
243 void print_on(outputStream* out) PRODUCT_RETURN;
244 void print();
245 };
246
247 #endif // SHARE_VM_RUNTIME_VIRTUALSPACE_HPP