nlib
NMalloc.h
Go to the documentation of this file.
1 
2 /*--------------------------------------------------------------------------------*
3  Project: CrossRoad
4  Copyright (C)Nintendo All rights reserved.
5 
6  These coded instructions, statements, and computer programs contain proprietary
7  information of Nintendo and/or its licensed developers and are protected by
8  national and international copyright laws. They may not be disclosed to third
9  parties or copied or duplicated in any form, in whole or in part, without the
10  prior written consent of Nintendo.
11 
12  The content herein is highly confidential and should be handled accordingly.
13  *--------------------------------------------------------------------------------*/
14 
15 #pragma once
16 #ifndef INCLUDE_NN_NLIB_HEAP_NMALLOC_H_
17 #define INCLUDE_NN_NLIB_HEAP_NMALLOC_H_
18 
19 #include <errno.h>
20 #include <stddef.h>
21 #include <stdlib.h> // for malloc/free
22 
23 #ifdef __cplusplus
24 #include <new>
25 #include "nn/nlib/Config.h"
26 #else
27 #include "nn/nlib/Platform.h"
28 #endif
29 
30 #if defined(_MSC_VER) && defined(nx_heap_EXPORTS)
31 #undef NLIB_VIS_PUBLIC
32 #define NLIB_VIS_PUBLIC NLIB_WINEXPORT
33 #endif
34 
35 #ifndef INCLUDE_NN_NLIB_PLATFORM_H_
36 // some compilers complain about double declaration
37 typedef int errno_t;
38 #endif
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 typedef struct NLIB_VIS_PUBLIC {
45  size_t alloc_count;
46  size_t alloc_size;
47  size_t hash;
48 } HeapHash;
49 
50 typedef struct NLIB_VIS_PUBLIC {
51  void* addr;
52  size_t size;
53  unsigned int heap_option;
55 
56 #define NMALLOC_HEAPOPTION_ENABLE_ENV (0x00000001)
57 #define NMALLOC_HEAPOPTION_CACHE_DISABLE (0x00000004)
58 
59 #ifdef _MSC_VER
60 void nmalloc_get_settings(NMallocSettings* settings); // weak function
61 NLIB_VIS_PUBLIC void nmalloc_get_settings_default(NMallocSettings* settings);
62 #ifndef _WIN64
63 #pragma comment(linker, "/alternatename:_nmalloc_get_settings=_nmalloc_get_settings_default")
64 #else
65 #pragma comment(linker, "/alternatename:nmalloc_get_settings=nmalloc_get_settings_default")
66 #endif
67 #else
68 NLIB_VIS_PUBLIC void nmalloc_get_settings(NMallocSettings* settings); // weak function
69 #endif
70 
71 typedef enum {
77  NMALLOC_DUMP_BASIC = kNmallocDumpBasic,
78  NMALLOC_DUMP_SPANS = kNmallocDumpSpans,
79  NMALLOC_DUMP_POINTERS = kNmallocDumpPointers,
80  NMALLOC_DUMP_PAGESUMMARY = kNmallocDumpPageSummary,
81  NMALLOC_DUMP_ALL = kNmallocDumpAll
83 
84 typedef enum {
85  kNmallocQueryDump = 0,
86  kNmallocQueryPageSize,
87  kNmallocQueryAllocatedSize,
88  kNmallocQueryFreeSize,
89  kNmallocQuerySystemSize,
90  kNmallocQueryMaxAllocatableSize,
91  kNmallocQueryIsClean,
92  kNmallocQueryHeapHash,
93  kNmallocQueryUnifyFreelist,
94  kNmallocQuerySetColor,
95  kNmallocQueryGetColor,
96  kNmallocQuerySetName,
97  kNmallocQueryGetName,
98  kNmallocQueryCacheMin_,
99  kNmallocQueryCheckCache,
100  kNmallocQueryClearCache,
101  kNmallocQueryFinalizeCache,
102  kNmallocQueryFreeSizeNx,
103  kNmallocQueryMaxAllocatableSizeNx,
104  NMALLOC_QUERY_DUMP = kNmallocQueryDump,
105  NMALLOC_QUERY_PAGE_SIZE = kNmallocQueryPageSize,
106  NMALLOC_QUERY_ALLOCATED_SIZE = kNmallocQueryAllocatedSize,
107  NMALLOC_QUERY_FREE_SIZE = kNmallocQueryFreeSize,
108  NMALLOC_QUERY_SYSTEM_SIZE = kNmallocQuerySystemSize,
109  NMALLOC_QUERY_MAX_ALLOCATABLE_SIZE = kNmallocQueryMaxAllocatableSize,
110  NMALLOC_QUERY_IS_CLEAN = kNmallocQueryIsClean,
111  NMALLOC_QUERY_HEAP_HASH = kNmallocQueryHeapHash,
112  NMALLOC_QUERY_UNIFY_FREELIST = kNmallocQueryUnifyFreelist,
113  NMALLOC_QUERY_SET_COLOR = kNmallocQuerySetColor,
114  NMALLOC_QUERY_GET_COLOR = kNmallocQueryGetColor,
115  NMALLOC_QUERY_SET_NAME = kNmallocQuerySetName,
116  NMALLOC_QUERY_GET_NAME = kNmallocQueryGetName,
117  NMALLOC_QUERY_CACHE_MIN_ = kNmallocQueryCacheMin_,
118  NMALLOC_QUERY_CHECK_CACHE = kNmallocQueryCheckCache,
119  NMALLOC_QUERY_CLEAR_CACHE = kNmallocQueryClearCache,
120  NMALLOC_QUERY_FINALIZE_CACHE = kNmallocQueryFinalizeCache,
121  NMALLOC_QUERY_FREE_SIZE_NX = kNmallocQueryFreeSizeNx,
122  NMALLOC_QUERY_MAX_ALLOCATABLE_SIZE_NX = kNmallocQueryMaxAllocatableSizeNx
123 } NMallocQuery;
124 
125 typedef int (*nmalloc_heapwalk_callback)(void* allocated_ptr, size_t size, void* user_ptr);
126 
127 NLIB_VIS_PUBLIC errno_t nmalloc_query(int query, ...);
128 NLIB_CHECK_RESULT NLIB_VIS_PUBLIC void* nrealloc(void* ptr, size_t size)
129 NLIB_ATTRIBUTE_MALLOC NLIB_ATTRIBUTE_ALLOC_SIZE1(2) NLIB_ATTRIBUTE_ASSUME_ALIGNED(8);
130 NLIB_CHECK_RESULT NLIB_VIS_PUBLIC void* nmalloc(size_t size)
131 NLIB_ATTRIBUTE_MALLOC NLIB_ATTRIBUTE_ALLOC_SIZE1(1) NLIB_ATTRIBUTE_ASSUME_ALIGNED(8);
132 NLIB_CHECK_RESULT NLIB_VIS_PUBLIC void* ncalloc(size_t nmemb, size_t size)
133 NLIB_ATTRIBUTE_MALLOC NLIB_ATTRIBUTE_ALLOC_SIZE2(1, 2) NLIB_ATTRIBUTE_ASSUME_ALIGNED(8);
134 NLIB_CHECK_RESULT NLIB_VIS_PUBLIC void* nmalloc_aligned(size_t size, size_t algn)
135 NLIB_ATTRIBUTE_MALLOC NLIB_ATTRIBUTE_ALLOC_SIZE1(1) NLIB_ATTRIBUTE_ALLOC_ALIGN(2)
136 NLIB_ATTRIBUTE_ASSUME_ALIGNED(8);
137 NLIB_VIS_PUBLIC size_t nmalloc_size(const void* ptr) NLIB_NONNULL;
138 NLIB_VIS_PUBLIC void nfree(void* p);
139 NLIB_VIS_PUBLIC void nfree_size(void* p, size_t size);
140 
142 
143 #ifdef __cplusplus
144 }
145 #endif
146 
147 #ifdef __cplusplus
148 
149 inline bool operator==(const HeapHash& rhs, const HeapHash& lhs) {
150  return rhs.alloc_count == lhs.alloc_count && rhs.alloc_size == lhs.alloc_size &&
151  rhs.hash == lhs.hash;
152 }
153 
154 inline bool operator!=(const HeapHash& rhs, const HeapHash& lhs) {
155  return rhs.alloc_count != lhs.alloc_count || rhs.alloc_size != lhs.alloc_size ||
156  rhs.hash != lhs.hash;
157 }
158 
159 NLIB_NAMESPACE_BEGIN
160 namespace heap {
161 
162 template <typename T>
163 struct NMallocStlAllocator {
164  typedef size_t size_type;
165  typedef T value_type;
166  typedef T* pointer;
167  typedef const T* const_pointer;
168  typedef T& reference;
169  typedef const T& const_reference;
170  typedef ptrdiff_t difference_type;
171  template <typename U>
172  struct rebind {
173  typedef NMallocStlAllocator<U> other;
174  };
175  NMallocStlAllocator() {}
176  explicit NMallocStlAllocator(const NMallocStlAllocator<T>&) {}
177  template <class _Other>
178  NMallocStlAllocator(const NMallocStlAllocator<_Other>&) {}
179  pointer allocate(size_type n, const void* p = 0);
180  void deallocate(pointer p, size_type n) {
181 #if 1
182  nfree_size(p, n * sizeof(T));
183 #else
184  (void)n;
185  nfree(p);
186 #endif
187  }
188  void construct(pointer p, const T& t) { new ((void*)p) T(t); } // NOLINT
189  void construct(pointer p) { new ((void*)p) T(); } // NOLINT
190 #if defined(__cpp_rvalue_references) && defined(__cpp_variadic_templates)
191  template<class X, class... ARGS>
192  void construct(X* p, ARGS&&... args) {
193  new ((void*)p) X(std::forward<ARGS>(args)...); // NOLINT
194  }
195 #endif
196  void destroy(pointer ptr) {
197  (void)ptr;
198  (*ptr).~T();
199  }
200  template<class X>
201  void destroy(X* p) {
202  NLIB_UNUSED(p); // workaround for VS2012
203  p->~X();
204  }
205  size_t max_size() const {
206  size_t cnt = (size_t)-1 / sizeof(T);
207  return 0 < cnt ? cnt : 1;
208  }
209  pointer address(reference value) const { return &value; }
210  const_pointer address(const_reference value) const { return &value; }
211 };
212 
213 template <typename T>
214 typename NMallocStlAllocator<T>::pointer NMallocStlAllocator<T>::allocate(size_type n,
215  const void* p) {
216  (void)p;
217  void* pp = nmalloc(n * sizeof(T));
218  return reinterpret_cast<T*>(pp);
219 }
220 
221 template <class T1, class T2>
222 inline bool operator==(const NMallocStlAllocator<T1>&, const NMallocStlAllocator<T2>&) {
223  return true;
224 }
225 
226 template <class T1, class T2>
227 inline bool operator!=(const NMallocStlAllocator<T1>&, const NMallocStlAllocator<T2>&) {
228  return false;
229 }
230 
231 } // namespace heap
232 NLIB_NAMESPACE_END
233 
234 #endif
235 
236 #ifdef __cplusplus
237 #define NLIB_REPLACE_MALLOC \
238 extern "C" { \
239 void* nlib_malloc(size_t n) { \
240  return nmalloc(n); \
241  } \
242 void nlib_free(void* p) { \
243  nfree(p); \
244  } \
245 void* nlib_calloc(size_t nmemb, size_t size) { \
246  return ncalloc(nmemb, size); \
247  } \
248 void* nlib_realloc(void* ptr, size_t size) { \
249  return nrealloc(ptr, size); \
250  } \
251 void* nlib_memalign(size_t alignment, size_t size) { \
252  return nmalloc_aligned(size, alignment); \
253  } \
254 void nlib_free_size(void* ptr, size_t size) { \
255  nfree_size(ptr, size); \
256  } \
257 }
258 
259 #ifndef NN_PLATFORM_CTR
260 #define NLIB_REPLACE_MALLOC_NEW \
261  NLIB_REPLACE_MALLOC \
262 void* operator new(size_t size) { \
263  return nlib_malloc(size); \
264  } \
265 void operator delete(void* ptr) NLIB_NOEXCEPT { \
266  nlib_free(ptr); \
267  } \
268 void* operator new(size_t size, const std::nothrow_t&) NLIB_NOEXCEPT { \
269  return nlib_malloc(size); \
270  } \
271 void operator delete(void* ptr, const std::nothrow_t&) NLIB_NOEXCEPT { \
272  nlib_free(ptr); \
273  } \
274 void* operator new[](size_t size) { return nlib_malloc(size); } \
275 void operator delete[](void* ptr) NLIB_NOEXCEPT { nlib_free(ptr); } \
276 void* operator new[](size_t size, const std::nothrow_t&) NLIB_NOEXCEPT \
277 { return nlib_malloc(size); } \
278 void operator delete [](void* ptr, const std::nothrow_t&) NLIB_NOEXCEPT { nlib_free(ptr); } \
279 void operator delete(void* ptr, size_t size) NLIB_NOEXCEPT { \
280  nlib_free_size(ptr, size); \
281  } \
282 void operator delete(void* ptr, size_t size, const std::nothrow_t&) NLIB_NOEXCEPT { \
283  nlib_free_size(ptr, size); \
284  } \
285 void operator delete[](void* ptr, size_t size)NLIB_NOEXCEPT { nlib_free_size(ptr, size); } \
286 void operator delete[](void* ptr, size_t size, const std::nothrow_t&) NLIB_NOEXCEPT { \
287  nlib_free_size(ptr, size); \
288 }
289 #else
290 #define NLIB_REPLACE_MALLOC_NEW \
291  NLIB_REPLACE_MALLOC \
292 void* operator new(size_t size) throw(std::bad_alloc) { \
293  return nlib_malloc(size); \
294  } \
295 void operator delete(void* ptr) throw() { \
296  nlib_free(ptr); \
297  } \
298 void* operator new(size_t size, const std::nothrow_t&) throw() { \
299  return nlib_malloc(size); \
300  } \
301 void* operator new[](size_t size) throw(std::bad_alloc) { \
302  return nlib_malloc(size); \
303  } \
304 void operator delete[](void* ptr) throw() { \
305  nlib_free(ptr); \
306  } \
307 void* operator new[](size_t size, const std::nothrow_t&) throw() { \
308  return nlib_malloc(size); \
309  }
310 #endif
311 #else
312 #define NLIB_REPLACE_MALLOC \
313 void* nlib_malloc(size_t n) { \
314  return nmalloc(n); \
315  } \
316 void nlib_free(void* p) { \
317  nfree(p); \
318  } \
319 void* nlib_calloc(size_t nmemb, size_t size) { \
320  return ncalloc(nmemb, size); \
321  } \
322 void* nlib_realloc(void* ptr, size_t size) { \
323  return nrealloc(ptr, size); \
324  } \
325 void* nlib_memalign(size_t alignment, size_t size) { \
326  return nmalloc_aligned(size, alignment); \
327  } \
328 void nlib_free_size(void* ptr, size_t size) { \
329  nfree_size(ptr, size); \
330  }
331 #define NLIB_REPLACE_MALLOC_NEW NLIB_REPLACE_MALLOC
332 #endif
333 
334 #if defined(_MSC_VER) && defined(nx_heap_EXPORTS)
335 #undef NLIB_VIS_PUBLIC
336 #define NLIB_VIS_PUBLIC NLIB_WINIMPORT
337 #endif
338 
339 #endif // INCLUDE_NN_NLIB_HEAP_NMALLOC_H_
void nfree_size(void *p, size_t size)
Frees a memory region. Using information about memory sizes makes it possible to free memory quickly...
#define NLIB_ATTRIBUTE_MALLOC
Defines __attribute__((malloc)) if it is available for use.
int(* nmalloc_heapwalk_callback)(void *allocated_ptr, size_t size, void *user_ptr)
User-defined callback function that is called from nmalloc_walk_allocated_ptrs.
Definition: NMalloc.h:125
Only displays basic information.
Definition: NMalloc.h:72
void * nrealloc(void *ptr, size_t size)
Changes the memory allocation. Corresponds to the standard C function realloc.
Displays all information.
Definition: NMalloc.h:76
#define NLIB_CHECK_RESULT
Indicates that the caller of the function must check the returned value.
size_t nmalloc_size(const void *ptr)
Returns the amount of memory actually allocated at the ptr parameter.
size_t alloc_size
Total size of the regions allocated by the user application within the heap.
Definition: NMalloc.h:46
Displays the addresses and sizes of all memory allocated by the user application. ...
Definition: NMalloc.h:74
bool operator==(const HeapHash &rhs, const HeapHash &lhs)
Returns true if the two compared summaries are equal.
Definition: NMalloc.h:149
bool operator!=(const HeapHash &rhs, const HeapHash &lhs)
Returns true if the two compared summaries are not equal.
Definition: NMalloc.h:154
errno_t nmalloc_query(int query,...)
Gets and operates detailed data on the heap.
Basic APIs are declared with a C linkage.
void * ncalloc(size_t nmemb, size_t size)
Allocates an array of memory and elements initialized to 0.
void nfree(void *p)
Frees a memory region. Corresponds to the standard C function free.
#define NLIB_VIS_PUBLIC
Symbols for functions and classes are made available outside of the library.
Definition: Platform_unix.h:89
unsigned int heap_option
Specifies the heap options. The default is 0.
Definition: NMalloc.h:53
size_t alloc_count
Number of regions allocated by the user application within the heap.
Definition: NMalloc.h:45
size_t size
Specifies the maximum amount of memory that can be used by nmalloc. You must specify a multiple of 40...
Definition: NMalloc.h:52
Declares parameters that are initialized by nmalloc. Set by defining nmalloc_get_settings.
Definition: NMalloc.h:50
size_t hash
Hash value of the status of memory allocated by the user application within the heap.
Definition: NMalloc.h:47
void * nmalloc(size_t size)
Allocates a memory region of the specified size (in bytes). This corresponds to the standard C functi...
Displays the usage status for each page.
Definition: NMalloc.h:73
A file that contains the configuration information for each development environment.
Visually displays the overview of the page allocation density in the entire heap. An area of 1 MB is ...
Definition: NMalloc.h:75
void * addr
Specifies a pointer to the beginning of the region used by nmalloc.
Definition: NMalloc.h:51
void nmalloc_get_settings(NMallocSettings *settings)
User applications can define this function to control the initialization settings of nmalloc...
errno_t nmalloc_walk_allocated_ptrs(nmalloc_heapwalk_callback func, void *user_ptr)
The callback function func is called for each region allocated in the heap.
#define NLIB_NONNULL
Indicates that you cannot specify NULL for all arguments.
NMallocDumpMode
The type of the value that you specify for the second argument when specifying kNmallocQueryDump in t...
Definition: NMalloc.h:71
Structure that contains a summary of the memory usage status of the heap used by the user application...
Definition: NMalloc.h:44
void * nmalloc_aligned(size_t size, size_t algn)
Allocates memory with a specific alignment.
int errno_t
Indicates with an int-type typedef that a POSIX error value is returned as the return value...
Definition: NMalloc.h:37