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