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_MEMORY_ALLOCATION_HPP
26 #define SHARE_VM_MEMORY_ALLOCATION_HPP
27
28 #include "runtime/globals.hpp"
29 #include "utilities/globalDefinitions.hpp"
30 #include "utilities/macros.hpp"
31
32 #include <new>
33
34 class AllocFailStrategy {
35 public:
36 enum AllocFailEnum { EXIT_OOM, RETURN_NULL };
37 };
38 typedef AllocFailStrategy::AllocFailEnum AllocFailType;
39
40 // The virtual machine must never call one of the implicitly declared
41 // global allocation or deletion functions. (Such calls may result in
42 // link-time or run-time errors.) For convenience and documentation of
43 // intended use, classes in the virtual machine may be derived from one
44 // of the following allocation classes, some of which define allocation
45 // and deletion functions.
46 // Note: std::malloc and std::free should never called directly.
47
48 //
49 // For objects allocated in the resource area (see resourceArea.hpp).
50 // - ResourceObj
51 //
52 // For objects allocated in the C-heap (managed by: free & malloc and tracked with NMT)
53 // - CHeapObj
54 //
55 // For objects allocated on the stack.
56 // - StackObj
57 //
58 // For classes used as name spaces.
59 // - AllStatic
60 //
61 // For classes in Metaspace (class data)
62 // - MetaspaceObj
63 //
64 // The printable subclasses are used for debugging and define virtual
65 // member functions for printing. Classes that avoid allocating the
66 // vtbl entries in the objects should therefore not be the printable
67 // subclasses.
68 //
69 // The following macros and function should be used to allocate memory
70 // directly in the resource area or in the C-heap, The _OBJ variants
71 // of the NEW/FREE_C_HEAP macros are used for alloc/dealloc simple
72 // objects which are not inherited from CHeapObj, note constructor and
73 // destructor are not called. The preferable way to allocate objects
74 // is using the new operator.
75 //
76 // WARNING: The array variant must only be used for a homogenous array
77 // where all objects are of the exact type specified. If subtypes are
78 // stored in the array then must pay attention to calling destructors
79 // at needed.
80 //
81 // NEW_RESOURCE_ARRAY(type, size)
82 // NEW_RESOURCE_OBJ(type)
83 // NEW_C_HEAP_ARRAY(type, size)
84 // NEW_C_HEAP_OBJ(type, memflags)
85 // FREE_C_HEAP_ARRAY(type, old)
86 // FREE_C_HEAP_OBJ(objname, type, memflags)
87 // char* AllocateHeap(size_t size, const char* name);
88 // void FreeHeap(void* p);
89 //
90
91 // In non product mode we introduce a super class for all allocation classes
92 // that supports printing.
93 // We avoid the superclass in product mode to save space.
94
95 #ifdef PRODUCT
96 #define ALLOCATION_SUPER_CLASS_SPEC
97 #else
98 #define ALLOCATION_SUPER_CLASS_SPEC : public AllocatedObj
99 class AllocatedObj {
100 public:
101 // Printing support
102 void print() const;
103 void print_value() const;
104
105 virtual void print_on(outputStream* st) const;
106 virtual void print_value_on(outputStream* st) const;
107 };
108 #endif
109
110
111 /*
112 * Memory types
113 */
114 enum MemoryType {
115 // Memory type by sub systems. It occupies lower byte.
116 mtJavaHeap = 0x00, // Java heap
117 mtClass = 0x01, // memory class for Java classes
118 mtThread = 0x02, // memory for thread objects
119 mtThreadStack = 0x03,
120 mtCode = 0x04, // memory for generated code
121 mtGC = 0x05, // memory for GC
122 mtCompiler = 0x06, // memory for compiler
123 mtInternal = 0x07, // memory used by VM, but does not belong to
124 // any of above categories, and not used for
125 // native memory tracking
126 mtOther = 0x08, // memory not used by VM
127 mtSymbol = 0x09, // symbol
128 mtNMT = 0x0A, // memory used by native memory tracking
129 mtClassShared = 0x0B, // class data sharing
130 mtChunk = 0x0C, // chunk that holds content of arenas
131 mtTest = 0x0D, // Test type for verifying NMT
132 mtTracing = 0x0E, // memory used for Tracing
133 mtLogging = 0x0F, // memory for logging
134 mtArguments = 0x10, // memory for argument processing
135 mtModule = 0x11, // memory for module processing
136 mtNone = 0x12, // undefined
137 mt_number_of_types = 0x13 // number of memory types (mtDontTrack
138 // is not included as validate type)
139 };
140
141 typedef MemoryType MEMFLAGS;
142
143
144 #if INCLUDE_NMT
145
146 extern bool NMT_track_callsite;
147
148 #else
149
150 const bool NMT_track_callsite = false;
151
152 #endif // INCLUDE_NMT
153
154 class NativeCallStack;
155
156
157 template <MEMFLAGS F> class CHeapObj ALLOCATION_SUPER_CLASS_SPEC {
158 public:
159 void* operator new(size_t size, const NativeCallStack& stack) throw();
160 void* operator new(size_t size) throw();
161 void* operator new (size_t size, const std::nothrow_t& nothrow_constant,
162 const NativeCallStack& stack) throw();
163 void* operator new (size_t size, const std::nothrow_t& nothrow_constant) throw();
164 void* operator new [](size_t size, const NativeCallStack& stack) throw();
165 void* operator new [](size_t size) throw();
166 void* operator new [](size_t size, const std::nothrow_t& nothrow_constant,
167 const NativeCallStack& stack) throw();
168 void* operator new [](size_t size, const std::nothrow_t& nothrow_constant) throw();
169 void operator delete(void* p);
170 void operator delete [] (void* p);
171 };
172
173 // Base class for objects allocated on the stack only.
174 // Calling new or delete will result in fatal error.
175
176 class StackObj ALLOCATION_SUPER_CLASS_SPEC {
177 private:
178 void* operator new(size_t size) throw();
179 void* operator new [](size_t size) throw();
180 #ifdef __IBMCPP__
181 public:
182 #endif
183 void operator delete(void* p);
184 void operator delete [](void* p);
185 };
186
187 // Base class for objects stored in Metaspace.
188 // Calling delete will result in fatal error.
189 //
190 // Do not inherit from something with a vptr because this class does
191 // not introduce one. This class is used to allocate both shared read-only
192 // and shared read-write classes.
193 //
194
195 class ClassLoaderData;
196 class MetaspaceClosure;
197
198 class MetaspaceObj {
199 friend class MetaspaceShared;
200 // When CDS is enabled, all shared metaspace objects are mapped
201 // into a single contiguous memory block, so we can use these
202 // two pointers to quickly determine if something is in the
203 // shared metaspace.
204 //
205 // When CDS is not enabled, both pointers are set to NULL.
206 static void* _shared_metaspace_base; // (inclusive) low address
207 static void* _shared_metaspace_top; // (exclusive) high address
208
209 public:
210 bool is_metaspace_object() const;
211 bool is_shared() const {
212 // If no shared metaspace regions are mapped, _shared_metaspace_{base,top} will
213 // both be NULL and all values of p will be rejected quickly.
214 return (((void*)this) < _shared_metaspace_top && ((void*)this) >= _shared_metaspace_base);
215 }
216 void print_address_on(outputStream* st) const; // nonvirtual address printing
217
218 #define METASPACE_OBJ_TYPES_DO(f) \
219 f(Class) \
220 f(Symbol) \
221 f(TypeArrayU1) \
222 f(TypeArrayU2) \
223 f(TypeArrayU4) \
224 f(TypeArrayU8) \
225 f(TypeArrayOther) \
226 f(Method) \
227 f(ConstMethod) \
228 f(MethodData) \
229 f(ConstantPool) \
230 f(ConstantPoolCache) \
231 f(Annotations) \
232 f(MethodCounters)
233
234 #define METASPACE_OBJ_TYPE_DECLARE(name) name ## Type,
235 #define METASPACE_OBJ_TYPE_NAME_CASE(name) case name ## Type: return #name;
236
237 enum Type {
238 // Types are MetaspaceObj::ClassType, MetaspaceObj::SymbolType, etc
239 METASPACE_OBJ_TYPES_DO(METASPACE_OBJ_TYPE_DECLARE)
240 _number_of_types
241 };
242
243 static const char * type_name(Type type) {
244 switch(type) {
245 METASPACE_OBJ_TYPES_DO(METASPACE_OBJ_TYPE_NAME_CASE)
246 default:
247 ShouldNotReachHere();
248 return NULL;
249 }
250 }
251
252 static MetaspaceObj::Type array_type(size_t elem_size) {
253 switch (elem_size) {
254 case 1: return TypeArrayU1Type;
255 case 2: return TypeArrayU2Type;
256 case 4: return TypeArrayU4Type;
257 case 8: return TypeArrayU8Type;
258 default:
259 return TypeArrayOtherType;
260 }
261 }
262
263 void* operator new(size_t size, ClassLoaderData* loader_data,
264 size_t word_size,
265 Type type, Thread* thread) throw();
266 // can't use TRAPS from this header file.
267 void operator delete(void* p) { ShouldNotCallThis(); }
268
269 // Declare a *static* method with the same signature in any subclass of MetaspaceObj
270 // that should be read-only by default. See symbol.hpp for an example. This function
271 // is used by the templates in metaspaceClosure.hpp
272 static bool is_read_only_by_default() { return false; }
273 };
274
275 // Base class for classes that constitute name spaces.
276
277 class Arena;
278
279 class AllStatic {
280 public:
281 AllStatic() { ShouldNotCallThis(); }
282 ~AllStatic() { ShouldNotCallThis(); }
283 };
284
285
286 extern char* resource_allocate_bytes(size_t size,
287 AllocFailType alloc_failmode = AllocFailStrategy::EXIT_OOM);
288 extern char* resource_allocate_bytes(Thread* thread, size_t size,
289 AllocFailType alloc_failmode = AllocFailStrategy::EXIT_OOM);
290 extern char* resource_reallocate_bytes( char *old, size_t old_size, size_t new_size,
291 AllocFailType alloc_failmode = AllocFailStrategy::EXIT_OOM);
292 extern void resource_free_bytes( char *old, size_t size );
293
294 //----------------------------------------------------------------------
295 // Base class for objects allocated in the resource area per default.
296 // Optionally, objects may be allocated on the C heap with
297 // new(ResourceObj::C_HEAP) Foo(...) or in an Arena with new (&arena)
298 // ResourceObj's can be allocated within other objects, but don't use
299 // new or delete (allocation_type is unknown). If new is used to allocate,
300 // use delete to deallocate.
301 class ResourceObj ALLOCATION_SUPER_CLASS_SPEC {
302 public:
303 enum allocation_type { STACK_OR_EMBEDDED = 0, RESOURCE_AREA, C_HEAP, ARENA, allocation_mask = 0x3 };
304 static void set_allocation_type(address res, allocation_type type) NOT_DEBUG_RETURN;
305 #ifdef ASSERT
306 private:
307 // When this object is allocated on stack the new() operator is not
308 // called but garbage on stack may look like a valid allocation_type.
309 // Store negated 'this' pointer when new() is called to distinguish cases.
310 // Use second array's element for verification value to distinguish garbage.
311 uintptr_t _allocation_t[2];
312 bool is_type_set() const;
313 public:
314 allocation_type get_allocation_type() const;
315 bool allocated_on_stack() const { return get_allocation_type() == STACK_OR_EMBEDDED; }
316 bool allocated_on_res_area() const { return get_allocation_type() == RESOURCE_AREA; }
317 bool allocated_on_C_heap() const { return get_allocation_type() == C_HEAP; }
318 bool allocated_on_arena() const { return get_allocation_type() == ARENA; }
319 ResourceObj(); // default constructor
320 ResourceObj(const ResourceObj& r); // default copy constructor
321 ResourceObj& operator=(const ResourceObj& r); // default copy assignment
322 ~ResourceObj();
323 #endif // ASSERT
324
325 public:
326 void* operator new(size_t size, allocation_type type, MEMFLAGS flags) throw();
327 void* operator new [](size_t size, allocation_type type, MEMFLAGS flags) throw();
328 void* operator new(size_t size, const std::nothrow_t& nothrow_constant,
329 allocation_type type, MEMFLAGS flags) throw();
330 void* operator new [](size_t size, const std::nothrow_t& nothrow_constant,
331 allocation_type type, MEMFLAGS flags) throw();
332
333 void* operator new(size_t size, Arena *arena) throw();
334
335 void* operator new [](size_t size, Arena *arena) throw();
336
337 void* operator new(size_t size) throw() {
338 address res = (address)resource_allocate_bytes(size);
339 DEBUG_ONLY(set_allocation_type(res, RESOURCE_AREA);)
340 return res;
341 }
342
343 void* operator new(size_t size, const std::nothrow_t& nothrow_constant) throw() {
344 address res = (address)resource_allocate_bytes(size, AllocFailStrategy::RETURN_NULL);
345 DEBUG_ONLY(if (res != NULL) set_allocation_type(res, RESOURCE_AREA);)
346 return res;
347 }
348
349 void* operator new [](size_t size) throw() {
350 address res = (address)resource_allocate_bytes(size);
351 DEBUG_ONLY(set_allocation_type(res, RESOURCE_AREA);)
352 return res;
353 }
354
355 void* operator new [](size_t size, const std::nothrow_t& nothrow_constant) throw() {
356 address res = (address)resource_allocate_bytes(size, AllocFailStrategy::RETURN_NULL);
357 DEBUG_ONLY(if (res != NULL) set_allocation_type(res, RESOURCE_AREA);)
358 return res;
359 }
360
361 void operator delete(void* p);
362 void operator delete [](void* p);
363 };
364
365 // One of the following macros must be used when allocating an array
366 // or object to determine whether it should reside in the C heap on in
367 // the resource area.
368
369 #define NEW_RESOURCE_ARRAY(type, size)\
370 (type*) resource_allocate_bytes((size) * sizeof(type))
371
372 #define NEW_RESOURCE_ARRAY_RETURN_NULL(type, size)\
373 (type*) resource_allocate_bytes((size) * sizeof(type), AllocFailStrategy::RETURN_NULL)
374
375 #define NEW_RESOURCE_ARRAY_IN_THREAD(thread, type, size)\
376 (type*) resource_allocate_bytes(thread, (size) * sizeof(type))
377
378 #define NEW_RESOURCE_ARRAY_IN_THREAD_RETURN_NULL(thread, type, size)\
379 (type*) resource_allocate_bytes(thread, (size) * sizeof(type), AllocFailStrategy::RETURN_NULL)
380
381 #define REALLOC_RESOURCE_ARRAY(type, old, old_size, new_size)\
382 (type*) resource_reallocate_bytes((char*)(old), (old_size) * sizeof(type), (new_size) * sizeof(type))
383
384 #define REALLOC_RESOURCE_ARRAY_RETURN_NULL(type, old, old_size, new_size)\
385 (type*) resource_reallocate_bytes((char*)(old), (old_size) * sizeof(type),\
386 (new_size) * sizeof(type), AllocFailStrategy::RETURN_NULL)
387
388 #define FREE_RESOURCE_ARRAY(type, old, size)\
389 resource_free_bytes((char*)(old), (size) * sizeof(type))
390
391 #define FREE_FAST(old)\
392 /* nop */
393
394 #define NEW_RESOURCE_OBJ(type)\
395 NEW_RESOURCE_ARRAY(type, 1)
396
397 #define NEW_RESOURCE_OBJ_RETURN_NULL(type)\
398 NEW_RESOURCE_ARRAY_RETURN_NULL(type, 1)
399
400 #define NEW_C_HEAP_ARRAY3(type, size, memflags, pc, allocfail)\
401 (type*) AllocateHeap((size) * sizeof(type), memflags, pc, allocfail)
402
403 #define NEW_C_HEAP_ARRAY2(type, size, memflags, pc)\
404 (type*) (AllocateHeap((size) * sizeof(type), memflags, pc))
405
406 #define NEW_C_HEAP_ARRAY(type, size, memflags)\
407 (type*) (AllocateHeap((size) * sizeof(type), memflags))
408
409 #define NEW_C_HEAP_ARRAY2_RETURN_NULL(type, size, memflags, pc)\
410 NEW_C_HEAP_ARRAY3(type, (size), memflags, pc, AllocFailStrategy::RETURN_NULL)
411
412 #define NEW_C_HEAP_ARRAY_RETURN_NULL(type, size, memflags)\
413 NEW_C_HEAP_ARRAY3(type, (size), memflags, CURRENT_PC, AllocFailStrategy::RETURN_NULL)
414
415 #define REALLOC_C_HEAP_ARRAY(type, old, size, memflags)\
416 (type*) (ReallocateHeap((char*)(old), (size) * sizeof(type), memflags))
417
418 #define REALLOC_C_HEAP_ARRAY_RETURN_NULL(type, old, size, memflags)\
419 (type*) (ReallocateHeap((char*)(old), (size) * sizeof(type), memflags, AllocFailStrategy::RETURN_NULL))
420
421 #define FREE_C_HEAP_ARRAY(type, old) \
422 FreeHeap((char*)(old))
423
424 // allocate type in heap without calling ctor
425 #define NEW_C_HEAP_OBJ(type, memflags)\
426 NEW_C_HEAP_ARRAY(type, 1, memflags)
427
428 #define NEW_C_HEAP_OBJ_RETURN_NULL(type, memflags)\
429 NEW_C_HEAP_ARRAY_RETURN_NULL(type, 1, memflags)
430
431 // deallocate obj of type in heap without calling dtor
432 #define FREE_C_HEAP_OBJ(objname)\
433 FreeHeap((char*)objname);
434
435 // for statistics
436 #ifndef PRODUCT
437 class AllocStats : StackObj {
438 julong start_mallocs, start_frees;
439 julong start_malloc_bytes, start_mfree_bytes, start_res_bytes;
440 public:
441 AllocStats();
442
443 julong num_mallocs(); // since creation of receiver
444 julong alloc_bytes();
445 julong num_frees();
446 julong free_bytes();
447 julong resource_bytes();
448 void print();
449 };
450 #endif
451
452
453 //------------------------------ReallocMark---------------------------------
454 // Code which uses REALLOC_RESOURCE_ARRAY should check an associated
455 // ReallocMark, which is declared in the same scope as the reallocated
456 // pointer. Any operation that could __potentially__ cause a reallocation
457 // should check the ReallocMark.
458 class ReallocMark: public StackObj {
459 protected:
460 NOT_PRODUCT(int _nesting;)
461
462 public:
463 ReallocMark() PRODUCT_RETURN;
464 void check() PRODUCT_RETURN;
465 };
466
467 // Helper class to allocate arrays that may become large.
468 // Uses the OS malloc for allocations smaller than ArrayAllocatorMallocLimit
469 // and uses mapped memory for larger allocations.
470 // Most OS mallocs do something similar but Solaris malloc does not revert
471 // to mapped memory for large allocations. By default ArrayAllocatorMallocLimit
472 // is set so that we always use malloc except for Solaris where we set the
473 // limit to get mapped memory.
474 template <class E>
475 class ArrayAllocator : public AllStatic {
476 private:
477 static bool should_use_malloc(size_t length);
478
479 static E* allocate_malloc(size_t length, MEMFLAGS flags);
480 static E* allocate_mmap(size_t length, MEMFLAGS flags);
481
482 static void free_malloc(E* addr, size_t length);
483 static void free_mmap(E* addr, size_t length);
484
485 public:
486 static E* allocate(size_t length, MEMFLAGS flags);
487 static E* reallocate(E* old_addr, size_t old_length, size_t new_length, MEMFLAGS flags);
488 static void free(E* addr, size_t length);
489 };
490
491 // Uses mmaped memory for all allocations. All allocations are initially
492 // zero-filled. No pre-touching.
493 template <class E>
494 class MmapArrayAllocator : public AllStatic {
495 private:
496 static size_t size_for(size_t length);
497
498 public:
499 static E* allocate_or_null(size_t length, MEMFLAGS flags);
500 static E* allocate(size_t length, MEMFLAGS flags);
501 static void free(E* addr, size_t length);
502 };
503
504 // Uses malloc:ed memory for all allocations.
505 template <class E>
506 class MallocArrayAllocator : public AllStatic {
507 public:
508 static size_t size_for(size_t length);
509
510 static E* allocate(size_t length, MEMFLAGS flags);
511 static void free(E* addr, size_t length);
512 };
513
514 #endif // SHARE_VM_MEMORY_ALLOCATION_HPP