doxygen: add newline after \file
[blender.git] / intern / guardedalloc / intern / mallocn_intern.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2013 by Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup MEM
22  */
23
24 #ifndef __MALLOCN_INTERN_H__
25 #define __MALLOCN_INTERN_H__
26
27 /* mmap exception */
28 #if defined(WIN32)
29 #  include "mmap_win.h"
30 #else
31 #  include <sys/mman.h>
32 #endif
33
34 #ifdef __GNUC__
35 #  define UNUSED(x) UNUSED_ ## x __attribute__((__unused__))
36 #else
37 #  define UNUSED(x) UNUSED_ ## x
38 #endif
39
40 #undef HAVE_MALLOC_STATS
41 #define USE_MALLOC_USABLE_SIZE  /* internal, when we have malloc_usable_size() */
42
43 #if defined(__linux__) || (defined(__FreeBSD_kernel__) && !defined(__FreeBSD__)) || defined(__GLIBC__)
44 #  include <malloc.h>
45 #  define HAVE_MALLOC_STATS
46 #elif defined(__FreeBSD__)
47 #  include <malloc_np.h>
48 #elif defined(__APPLE__)
49 #  include <malloc/malloc.h>
50 #  define malloc_usable_size malloc_size
51 #elif defined(WIN32)
52 #  include <malloc.h>
53 #  define malloc_usable_size _msize
54 #elif defined(__HAIKU__)
55 #  include <malloc.h>
56 size_t malloc_usable_size(void *ptr);
57 #else
58 #  pragma message "We don't know how to use malloc_usable_size on your platform"
59 #  undef USE_MALLOC_USABLE_SIZE
60 #endif
61
62 /* Blame Microsoft for LLP64 and no inttypes.h, quick workaround needed: */
63 #if defined(WIN64)
64 #  define SIZET_FORMAT "%I64u"
65 #  define SIZET_ARG(a) ((unsigned long long)(a))
66 #else
67 #  define SIZET_FORMAT "%lu"
68 #  define SIZET_ARG(a) ((unsigned long)(a))
69 #endif
70
71 #define SIZET_ALIGN_4(len) ((len + 3) & ~(size_t)3)
72
73 #ifdef __GNUC__
74 #  define LIKELY(x)       __builtin_expect(!!(x), 1)
75 #  define UNLIKELY(x)     __builtin_expect(!!(x), 0)
76 #else
77 #  define LIKELY(x)       (x)
78 #  define UNLIKELY(x)     (x)
79 #endif
80
81 #if !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__NetBSD__)
82 // Needed for memalign on Linux and _aligned_alloc on Windows.
83
84 #  include <malloc.h>
85 #else
86 // Apple's malloc is 16-byte aligned, and does not have malloc.h, so include
87 // stdilb instead.
88 #  include <stdlib.h>
89 #endif
90
91 /* visual studio 2012 does not define inline for C */
92 #ifdef _MSC_VER
93 #  define MEM_INLINE static __inline
94 #else
95 #  define MEM_INLINE static inline
96 #endif
97
98 #define IS_POW2(a) (((a) & ((a) - 1)) == 0)
99
100 /* Extra padding which needs to be applied on MemHead to make it aligned. */
101 #define MEMHEAD_ALIGN_PADDING(alignment) ((size_t)alignment - (sizeof(MemHeadAligned) % (size_t)alignment))
102
103 /* Real pointer returned by the malloc or aligned_alloc. */
104 #define MEMHEAD_REAL_PTR(memh) ((char *)memh - MEMHEAD_ALIGN_PADDING(memh->alignment))
105
106 #include "mallocn_inline.h"
107
108 void *aligned_malloc(size_t size, size_t alignment);
109 void aligned_free(void *ptr);
110
111 /* Prototypes for counted allocator functions */
112 size_t MEM_lockfree_allocN_len(const void *vmemh) ATTR_WARN_UNUSED_RESULT;
113 void MEM_lockfree_freeN(void *vmemh);
114 void *MEM_lockfree_dupallocN(const void *vmemh) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
115 void *MEM_lockfree_reallocN_id(void *vmemh, size_t len, const char *UNUSED(str))  ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(2);
116 void *MEM_lockfree_recallocN_id(void *vmemh, size_t len, const char *UNUSED(str))  ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(2);
117 void *MEM_lockfree_callocN(size_t len, const char *UNUSED(str))  ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2);
118 void *MEM_lockfree_calloc_arrayN(size_t len, size_t size, const char *UNUSED(str))  ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1,2) ATTR_NONNULL(3);
119 void *MEM_lockfree_mallocN(size_t len, const char *UNUSED(str)) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2);
120 void *MEM_lockfree_malloc_arrayN(size_t len, size_t size, const char *UNUSED(str)) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1,2) ATTR_NONNULL(3);
121 void *MEM_lockfree_mallocN_aligned(size_t len, size_t alignment, const char *UNUSED(str)) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(3);
122 void *MEM_lockfree_mapallocN(size_t len, const char *UNUSED(str)) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2);
123 void MEM_lockfree_printmemlist_pydict(void);
124 void MEM_lockfree_printmemlist(void);
125 void MEM_lockfree_callbackmemlist(void (*func)(void *));
126 void MEM_lockfree_printmemlist_stats(void);
127 void MEM_lockfree_set_error_callback(void (*func)(const char *));
128 bool MEM_lockfree_consistency_check(void);
129 void MEM_lockfree_set_lock_callback(void (*lock)(void), void (*unlock)(void));
130 void MEM_lockfree_set_memory_debug(void);
131 size_t MEM_lockfree_get_memory_in_use(void);
132 size_t MEM_lockfree_get_mapped_memory_in_use(void);
133 unsigned int MEM_lockfree_get_memory_blocks_in_use(void);
134 void MEM_lockfree_reset_peak_memory(void);
135 size_t MEM_lockfree_get_peak_memory(void) ATTR_WARN_UNUSED_RESULT;
136 #ifndef NDEBUG
137 const char *MEM_lockfree_name_ptr(void *vmemh);
138 #endif
139
140 /* Prototypes for fully guarded allocator functions */
141 size_t MEM_guarded_allocN_len(const void *vmemh) ATTR_WARN_UNUSED_RESULT;
142 void MEM_guarded_freeN(void *vmemh);
143 void *MEM_guarded_dupallocN(const void *vmemh) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
144 void *MEM_guarded_reallocN_id(void *vmemh, size_t len, const char *UNUSED(str)) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(2);
145 void *MEM_guarded_recallocN_id(void *vmemh, size_t len, const char *UNUSED(str)) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(2);
146 void *MEM_guarded_callocN(size_t len, const char *UNUSED(str)) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2);
147 void *MEM_guarded_calloc_arrayN(size_t len, size_t size, const char *UNUSED(str)) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1,2) ATTR_NONNULL(3);
148 void *MEM_guarded_mallocN(size_t len, const char *UNUSED(str)) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2);
149 void *MEM_guarded_malloc_arrayN(size_t len, size_t size, const char *UNUSED(str)) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1,2) ATTR_NONNULL(3);
150 void *MEM_guarded_mallocN_aligned(size_t len, size_t alignment, const char *UNUSED(str)) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(3);
151 void *MEM_guarded_mapallocN(size_t len, const char *UNUSED(str)) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2);
152 void MEM_guarded_printmemlist_pydict(void);
153 void MEM_guarded_printmemlist(void);
154 void MEM_guarded_callbackmemlist(void (*func)(void *));
155 void MEM_guarded_printmemlist_stats(void);
156 void MEM_guarded_set_error_callback(void (*func)(const char *));
157 bool MEM_guarded_consistency_check(void);
158 void MEM_guarded_set_lock_callback(void (*lock)(void), void (*unlock)(void));
159 void MEM_guarded_set_memory_debug(void);
160 size_t MEM_guarded_get_memory_in_use(void);
161 size_t MEM_guarded_get_mapped_memory_in_use(void);
162 unsigned int MEM_guarded_get_memory_blocks_in_use(void);
163 void MEM_guarded_reset_peak_memory(void);
164 size_t MEM_guarded_get_peak_memory(void) ATTR_WARN_UNUSED_RESULT;
165 #ifndef NDEBUG
166 const char *MEM_guarded_name_ptr(void *vmemh);
167 #endif
168
169 #endif  /* __MALLOCN_INTERN_H__ */