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, // Java heap
117 mtClass, // memory class for Java classes
118 mtThread, // memory for thread objects
119 mtThreadStack,
120 mtCode, // memory for generated code
121 mtGC, // memory for GC
122 mtCompiler, // memory for compiler
123 mtInternal, // memory used by VM, but does not belong to
124 // any of above categories, and not used for
125 // native memory tracking
126 mtOther, // memory not used by VM
127 mtSymbol, // symbol
128 mtNMT, // memory used by native memory tracking
129 mtClassShared, // class data sharing
130 mtChunk, // chunk that holds content of arenas
131 mtTest, // Test type for verifying NMT
132 mtTracing, // memory used for Tracing
133 mtLogging, // memory for logging
134 mtArguments, // memory for argument processing
135 mtModule, // memory for module processing
136 mtSynchronizer, // memory for synchronization primitives
137 mtSafepoint, // memory for safepoint support
138 mtNone, // undefined
139 mt_number_of_types // number of memory types (mtDontTrack
140 // is not included as validate type)
141 };
142
143 typedef MemoryType MEMFLAGS;
144
145
146 #if INCLUDE_NMT
147
148 extern bool NMT_track_callsite;
149
150 #else
151
152 const bool NMT_track_callsite = false;
153
154 #endif // INCLUDE_NMT
155
156 class NativeCallStack;
157
158
159 char* AllocateHeap(size_t size,
160 MEMFLAGS flags,
161 const NativeCallStack& stack,
162 AllocFailType alloc_failmode = AllocFailStrategy::EXIT_OOM);
163 char* AllocateHeap(size_t size,
164 MEMFLAGS flags,
165 AllocFailType alloc_failmode = AllocFailStrategy::EXIT_OOM);
166
167 char* ReallocateHeap(char *old,
168 size_t size,
169 MEMFLAGS flag,
170 AllocFailType alloc_failmode = AllocFailStrategy::EXIT_OOM);
171
172 void FreeHeap(void* p);
173
174 template <MEMFLAGS F> class CHeapObj ALLOCATION_SUPER_CLASS_SPEC {
175 public:
176 ALWAYSINLINE void* operator new(size_t size) throw() {
177 return (void*)AllocateHeap(size, F);
178 }
179
180 ALWAYSINLINE void* operator new(size_t size,
181 const NativeCallStack& stack) throw() {
182 return (void*)AllocateHeap(size, F, stack);
183 }
184
185 ALWAYSINLINE void* operator new(size_t size, const std::nothrow_t&,
186 const NativeCallStack& stack) throw() {
187 return (void*)AllocateHeap(size, F, stack, AllocFailStrategy::RETURN_NULL);
188 }
189
190 ALWAYSINLINE void* operator new(size_t size, const std::nothrow_t&) throw() {
191 return (void*)AllocateHeap(size, F, AllocFailStrategy::RETURN_NULL);
192 }
193
194 ALWAYSINLINE void* operator new[](size_t size) throw() {
195 return (void*)AllocateHeap(size, F);
196 }
197
198 ALWAYSINLINE void* operator new[](size_t size,
199 const NativeCallStack& stack) throw() {
200 return (void*)AllocateHeap(size, F, stack);
201 }
202
203 ALWAYSINLINE void* operator new[](size_t size, const std::nothrow_t&,
204 const NativeCallStack& stack) throw() {
205 return (void*)AllocateHeap(size, F, stack, AllocFailStrategy::RETURN_NULL);
206 }
207
208 ALWAYSINLINE void* operator new[](size_t size, const std::nothrow_t&) throw() {
209 return (void*)AllocateHeap(size, F, AllocFailStrategy::RETURN_NULL);
210 }
211
212 void operator delete(void* p) { FreeHeap(p); }
213 void operator delete [] (void* p) { FreeHeap(p); }
214 };
215
216 // Base class for objects allocated on the stack only.
217 // Calling new or delete will result in fatal error.
218
219 class StackObj ALLOCATION_SUPER_CLASS_SPEC {
220 private:
221 void* operator new(size_t size) throw();
222 void* operator new [](size_t size) throw();
223 #ifdef __IBMCPP__
224 public:
225 #endif
226 void operator delete(void* p);
227 void operator delete [](void* p);
228 };
229
230 // Base class for objects stored in Metaspace.
231 // Calling delete will result in fatal error.
232 //
233 // Do not inherit from something with a vptr because this class does
234 // not introduce one. This class is used to allocate both shared read-only
235 // and shared read-write classes.
236 //
237
238 class ClassLoaderData;
239 class MetaspaceClosure;
240
241 class MetaspaceObj {
242 // When CDS is enabled, all shared metaspace objects are mapped
243 // into a single contiguous memory block, so we can use these
244 // two pointers to quickly determine if something is in the
245 // shared metaspace.
246 //
247 // When CDS is not enabled, both pointers are set to NULL.
248 static void* _shared_metaspace_base; // (inclusive) low address
249 static void* _shared_metaspace_top; // (exclusive) high address
250
251 public:
252 bool is_metaspace_object() const;
253 bool is_shared() const {
254 // If no shared metaspace regions are mapped, _shared_metaspace_{base,top} will
255 // both be NULL and all values of p will be rejected quickly.
256 return (((void*)this) < _shared_metaspace_top && ((void*)this) >= _shared_metaspace_base);
257 }
258 void print_address_on(outputStream* st) const; // nonvirtual address printing
259
260 static void set_shared_metaspace_range(void* base, void* top) {
261 _shared_metaspace_base = base;
262 _shared_metaspace_top = top;
263 }
264 static void* shared_metaspace_base() { return _shared_metaspace_base; }
265 static void* shared_metaspace_top() { return _shared_metaspace_top; }
266
267 #define METASPACE_OBJ_TYPES_DO(f) \
268 f(Class) \
269 f(Symbol) \
270 f(TypeArrayU1) \
271 f(TypeArrayU2) \
272 f(TypeArrayU4) \
273 f(TypeArrayU8) \
274 f(TypeArrayOther) \
275 f(Method) \
276 f(ConstMethod) \
277 f(MethodData) \
278 f(ConstantPool) \
279 f(ConstantPoolCache) \
280 f(Annotations) \
281 f(MethodCounters)
282
283 #define METASPACE_OBJ_TYPE_DECLARE(name) name ## Type,
284 #define METASPACE_OBJ_TYPE_NAME_CASE(name) case name ## Type: return #name;
285
286 enum Type {
287 // Types are MetaspaceObj::ClassType, MetaspaceObj::SymbolType, etc
288 METASPACE_OBJ_TYPES_DO(METASPACE_OBJ_TYPE_DECLARE)
289 _number_of_types
290 };
291
292 static const char * type_name(Type type) {
293 switch(type) {
294 METASPACE_OBJ_TYPES_DO(METASPACE_OBJ_TYPE_NAME_CASE)
295 default:
296 ShouldNotReachHere();
297 return NULL;
298 }
299 }
300
301 static MetaspaceObj::Type array_type(size_t elem_size) {
302 switch (elem_size) {
303 case 1: return TypeArrayU1Type;
304 case 2: return TypeArrayU2Type;
305 case 4: return TypeArrayU4Type;
306 case 8: return TypeArrayU8Type;
307 default:
308 return TypeArrayOtherType;
309 }
310 }
311
312 void* operator new(size_t size, ClassLoaderData* loader_data,
313 size_t word_size,
314 Type type, Thread* thread) throw();
315 // can't use TRAPS from this header file.
316 void operator delete(void* p) { ShouldNotCallThis(); }
317
318 // Declare a *static* method with the same signature in any subclass of MetaspaceObj
319 // that should be read-only by default. See symbol.hpp for an example. This function
320 // is used by the templates in metaspaceClosure.hpp
321 static bool is_read_only_by_default() { return false; }
322 };
323
324 // Base class for classes that constitute name spaces.
325
326 class Arena;
327
328 class AllStatic {
329 public:
330 AllStatic() { ShouldNotCallThis(); }
331 ~AllStatic() { ShouldNotCallThis(); }
332 };
333
334
335 extern char* resource_allocate_bytes(size_t size,
336 AllocFailType alloc_failmode = AllocFailStrategy::EXIT_OOM);
337 extern char* resource_allocate_bytes(Thread* thread, size_t size,
338 AllocFailType alloc_failmode = AllocFailStrategy::EXIT_OOM);
339 extern char* resource_reallocate_bytes( char *old, size_t old_size, size_t new_size,
340 AllocFailType alloc_failmode = AllocFailStrategy::EXIT_OOM);
341 extern void resource_free_bytes( char *old, size_t size );
342
343 //----------------------------------------------------------------------
344 // Base class for objects allocated in the resource area per default.
345 // Optionally, objects may be allocated on the C heap with
346 // new(ResourceObj::C_HEAP) Foo(...) or in an Arena with new (&arena)
347 // ResourceObj's can be allocated within other objects, but don't use
348 // new or delete (allocation_type is unknown). If new is used to allocate,
349 // use delete to deallocate.
350 class ResourceObj ALLOCATION_SUPER_CLASS_SPEC {
351 public:
352 enum allocation_type { STACK_OR_EMBEDDED = 0, RESOURCE_AREA, C_HEAP, ARENA, allocation_mask = 0x3 };
353 static void set_allocation_type(address res, allocation_type type) NOT_DEBUG_RETURN;
354 #ifdef ASSERT
355 private:
356 // When this object is allocated on stack the new() operator is not
357 // called but garbage on stack may look like a valid allocation_type.
358 // Store negated 'this' pointer when new() is called to distinguish cases.
359 // Use second array's element for verification value to distinguish garbage.
360 uintptr_t _allocation_t[2];
361 bool is_type_set() const;
362 public:
363 allocation_type get_allocation_type() const;
364 bool allocated_on_stack() const { return get_allocation_type() == STACK_OR_EMBEDDED; }
365 bool allocated_on_res_area() const { return get_allocation_type() == RESOURCE_AREA; }
366 bool allocated_on_C_heap() const { return get_allocation_type() == C_HEAP; }
367 bool allocated_on_arena() const { return get_allocation_type() == ARENA; }
368 ResourceObj(); // default constructor
369 ResourceObj(const ResourceObj& r); // default copy constructor
370 ResourceObj& operator=(const ResourceObj& r); // default copy assignment
371 ~ResourceObj();
372 #endif // ASSERT
373
374 public:
375 void* operator new(size_t size, allocation_type type, MEMFLAGS flags) throw();
376 void* operator new [](size_t size, allocation_type type, MEMFLAGS flags) throw();
377 void* operator new(size_t size, const std::nothrow_t& nothrow_constant,
378 allocation_type type, MEMFLAGS flags) throw();
379 void* operator new [](size_t size, const std::nothrow_t& nothrow_constant,
380 allocation_type type, MEMFLAGS flags) throw();
381
382 void* operator new(size_t size, Arena *arena) throw();
383
384 void* operator new [](size_t size, Arena *arena) throw();
385
386 void* operator new(size_t size) throw() {
387 address res = (address)resource_allocate_bytes(size);
388 DEBUG_ONLY(set_allocation_type(res, RESOURCE_AREA);)
389 return res;
390 }
391
392 void* operator new(size_t size, const std::nothrow_t& nothrow_constant) throw() {
393 address res = (address)resource_allocate_bytes(size, AllocFailStrategy::RETURN_NULL);
394 DEBUG_ONLY(if (res != NULL) set_allocation_type(res, RESOURCE_AREA);)
395 return res;
396 }
397
398 void* operator new [](size_t size) throw() {
399 address res = (address)resource_allocate_bytes(size);
400 DEBUG_ONLY(set_allocation_type(res, RESOURCE_AREA);)
401 return res;
402 }
403
404 void* operator new [](size_t size, const std::nothrow_t& nothrow_constant) throw() {
405 address res = (address)resource_allocate_bytes(size, AllocFailStrategy::RETURN_NULL);
406 DEBUG_ONLY(if (res != NULL) set_allocation_type(res, RESOURCE_AREA);)
407 return res;
408 }
409
410 void operator delete(void* p);
411 void operator delete [](void* p);
412 };
413
414 // One of the following macros must be used when allocating an array
415 // or object to determine whether it should reside in the C heap on in
416 // the resource area.
417
418 #define NEW_RESOURCE_ARRAY(type, size)\
419 (type*) resource_allocate_bytes((size) * sizeof(type))
420
421 #define NEW_RESOURCE_ARRAY_RETURN_NULL(type, size)\
422 (type*) resource_allocate_bytes((size) * sizeof(type), AllocFailStrategy::RETURN_NULL)
423
424 #define NEW_RESOURCE_ARRAY_IN_THREAD(thread, type, size)\
425 (type*) resource_allocate_bytes(thread, (size) * sizeof(type))
426
427 #define NEW_RESOURCE_ARRAY_IN_THREAD_RETURN_NULL(thread, type, size)\
428 (type*) resource_allocate_bytes(thread, (size) * sizeof(type), AllocFailStrategy::RETURN_NULL)
429
430 #define REALLOC_RESOURCE_ARRAY(type, old, old_size, new_size)\
431 (type*) resource_reallocate_bytes((char*)(old), (old_size) * sizeof(type), (new_size) * sizeof(type))
432
433 #define REALLOC_RESOURCE_ARRAY_RETURN_NULL(type, old, old_size, new_size)\
434 (type*) resource_reallocate_bytes((char*)(old), (old_size) * sizeof(type),\
435 (new_size) * sizeof(type), AllocFailStrategy::RETURN_NULL)
436
437 #define FREE_RESOURCE_ARRAY(type, old, size)\
438 resource_free_bytes((char*)(old), (size) * sizeof(type))
439
440 #define FREE_FAST(old)\
441 /* nop */
442
443 #define NEW_RESOURCE_OBJ(type)\
444 NEW_RESOURCE_ARRAY(type, 1)
445
446 #define NEW_RESOURCE_OBJ_RETURN_NULL(type)\
447 NEW_RESOURCE_ARRAY_RETURN_NULL(type, 1)
448
449 #define NEW_C_HEAP_ARRAY3(type, size, memflags, pc, allocfail)\
450 (type*) AllocateHeap((size) * sizeof(type), memflags, pc, allocfail)
451
452 #define NEW_C_HEAP_ARRAY2(type, size, memflags, pc)\
453 (type*) (AllocateHeap((size) * sizeof(type), memflags, pc))
454
455 #define NEW_C_HEAP_ARRAY(type, size, memflags)\
456 (type*) (AllocateHeap((size) * sizeof(type), memflags))
457
458 #define NEW_C_HEAP_ARRAY2_RETURN_NULL(type, size, memflags, pc)\
459 NEW_C_HEAP_ARRAY3(type, (size), memflags, pc, AllocFailStrategy::RETURN_NULL)
460
461 #define NEW_C_HEAP_ARRAY_RETURN_NULL(type, size, memflags)\
462 NEW_C_HEAP_ARRAY3(type, (size), memflags, CURRENT_PC, AllocFailStrategy::RETURN_NULL)
463
464 #define REALLOC_C_HEAP_ARRAY(type, old, size, memflags)\
465 (type*) (ReallocateHeap((char*)(old), (size) * sizeof(type), memflags))
466
467 #define REALLOC_C_HEAP_ARRAY_RETURN_NULL(type, old, size, memflags)\
468 (type*) (ReallocateHeap((char*)(old), (size) * sizeof(type), memflags, AllocFailStrategy::RETURN_NULL))
469
470 #define FREE_C_HEAP_ARRAY(type, old) \
471 FreeHeap((char*)(old))
472
473 // allocate type in heap without calling ctor
474 #define NEW_C_HEAP_OBJ(type, memflags)\
475 NEW_C_HEAP_ARRAY(type, 1, memflags)
476
477 #define NEW_C_HEAP_OBJ_RETURN_NULL(type, memflags)\
478 NEW_C_HEAP_ARRAY_RETURN_NULL(type, 1, memflags)
479
480 // deallocate obj of type in heap without calling dtor
481 #define FREE_C_HEAP_OBJ(objname)\
482 FreeHeap((char*)objname);
483
484 // for statistics
485 #ifndef PRODUCT
486 class AllocStats : StackObj {
487 julong start_mallocs, start_frees;
488 julong start_malloc_bytes, start_mfree_bytes, start_res_bytes;
489 public:
490 AllocStats();
491
492 julong num_mallocs(); // since creation of receiver
493 julong alloc_bytes();
494 julong num_frees();
495 julong free_bytes();
496 julong resource_bytes();
497 void print();
498 };
499 #endif
500
501
502 //------------------------------ReallocMark---------------------------------
503 // Code which uses REALLOC_RESOURCE_ARRAY should check an associated
504 // ReallocMark, which is declared in the same scope as the reallocated
505 // pointer. Any operation that could __potentially__ cause a reallocation
506 // should check the ReallocMark.
507 class ReallocMark: public StackObj {
508 protected:
509 NOT_PRODUCT(int _nesting;)
510
511 public:
512 ReallocMark() PRODUCT_RETURN;
513 void check() PRODUCT_RETURN;
514 };
515
516 // Helper class to allocate arrays that may become large.
517 // Uses the OS malloc for allocations smaller than ArrayAllocatorMallocLimit
518 // and uses mapped memory for larger allocations.
519 // Most OS mallocs do something similar but Solaris malloc does not revert
520 // to mapped memory for large allocations. By default ArrayAllocatorMallocLimit
521 // is set so that we always use malloc except for Solaris where we set the
522 // limit to get mapped memory.
523 template <class E>
524 class ArrayAllocator : public AllStatic {
525 private:
526 static bool should_use_malloc(size_t length);
527
528 static E* allocate_malloc(size_t length, MEMFLAGS flags);
529 static E* allocate_mmap(size_t length, MEMFLAGS flags);
530
531 static void free_malloc(E* addr, size_t length);
532 static void free_mmap(E* addr, size_t length);
533
534 public:
535 static E* allocate(size_t length, MEMFLAGS flags);
536 static E* reallocate(E* old_addr, size_t old_length, size_t new_length, MEMFLAGS flags);
537 static void free(E* addr, size_t length);
538 };
539
540 // Uses mmaped memory for all allocations. All allocations are initially
541 // zero-filled. No pre-touching.
542 template <class E>
543 class MmapArrayAllocator : public AllStatic {
544 private:
545 static size_t size_for(size_t length);
546
547 public:
548 static E* allocate_or_null(size_t length, MEMFLAGS flags);
549 static E* allocate(size_t length, MEMFLAGS flags);
550 static void free(E* addr, size_t length);
551 };
552
553 // Uses malloc:ed memory for all allocations.
554 template <class E>
555 class MallocArrayAllocator : public AllStatic {
556 public:
557 static size_t size_for(size_t length);
558
559 static E* allocate(size_t length, MEMFLAGS flags);
560 static void free(E* addr);
561 };
562
563 #endif // SHARE_VM_MEMORY_ALLOCATION_HPP