Lock-free memory allocator
[blender.git] / intern / guardedalloc / intern / mallocn_intern.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2013 by Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Sergey Sharybin
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file guardedalloc/intern/mallocn_intern.h
29  *  \ingroup MEM
30  */
31
32 #ifndef __MALLOCN_INTERN_H__
33 #define __MALLOCN_INTERN_H__
34
35 /* mmap exception */
36 #if defined(WIN32)
37 #  include "mmap_win.h"
38 #else
39 #  include <sys/mman.h>
40 #endif
41
42 #if defined(_MSC_VER)
43 #  define __func__ __FUNCTION__
44 #endif
45
46 #ifdef __GNUC__
47 #  define UNUSED(x) UNUSED_ ## x __attribute__((__unused__))
48 #else
49 #  define UNUSED(x) UNUSED_ ## x
50 #endif
51
52 #undef HAVE_MALLOC_STATS
53
54 #if defined(__linux__)
55 #  include <malloc.h>
56 #  define HAVE_MALLOC_STATS
57 #elif defined(__APPLE__)
58 #  define malloc_usable_size malloc_size
59 #elif defined(WIN32)
60 #  include <malloc.h>
61 #  define malloc_usable_size _msize
62 #else
63 #  error "We don't know how to use malloc_usable_size on your platform"
64 #endif
65
66 /* Blame Microsoft for LLP64 and no inttypes.h, quick workaround needed: */
67 #if defined(WIN64)
68 #  define SIZET_FORMAT "%I64u"
69 #  define SIZET_ARG(a) ((unsigned long long)(a))
70 #else
71 #  define SIZET_FORMAT "%lu"
72 #  define SIZET_ARG(a) ((unsigned long)(a))
73 #endif
74
75 #define SIZET_ALIGN_4(len) ((len + 3) & ~(size_t)3)
76
77 /* Prototypes for counted allocator functions */
78 size_t MEM_lockfree_allocN_len(const void *vmemh) ATTR_WARN_UNUSED_RESULT;
79 void MEM_lockfree_freeN(void *vmemh);
80 void *MEM_lockfree_dupallocN(const void *vmemh) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
81 void *MEM_lockfree_reallocN_id(void *vmemh, size_t len, const char *UNUSED(str))  ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(2);
82 void *MEM_lockfree_recallocN_id(void *vmemh, size_t len, const char *UNUSED(str))  ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(2);
83 void *MEM_lockfree_callocN(size_t len, const char *UNUSED(str))  ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2);
84 void *MEM_lockfree_mallocN(size_t len, const char *UNUSED(str)) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2);
85 void *MEM_lockfree_mapallocN(size_t len, const char *UNUSED(str)) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2);
86 void MEM_lockfree_printmemlist_pydict(void);
87 void MEM_lockfree_printmemlist(void);
88 void MEM_lockfree_callbackmemlist(void (*func)(void *));
89 void MEM_lockfree_printmemlist_stats(void);
90 void MEM_lockfree_set_error_callback(void (*func)(const char *));
91 bool MEM_lockfree_check_memory_integrity(void);
92 void MEM_lockfree_set_lock_callback(void (*lock)(void), void (*unlock)(void));
93 void MEM_lockfree_set_memory_debug(void);
94 uintptr_t MEM_lockfree_get_memory_in_use(void);
95 uintptr_t MEM_lockfree_get_mapped_memory_in_use(void);
96 unsigned int MEM_lockfree_get_memory_blocks_in_use(void);
97 void MEM_lockfree_reset_peak_memory(void);
98 uintptr_t MEM_lockfree_get_peak_memory(void) ATTR_WARN_UNUSED_RESULT;
99 #ifndef NDEBUG
100 const char *MEM_lockfree_name_ptr(void *vmemh);
101 #endif
102
103 /* Prototypes for fully guarded allocator functions */
104 size_t MEM_guarded_allocN_len(const void *vmemh) ATTR_WARN_UNUSED_RESULT;
105 void MEM_guarded_freeN(void *vmemh);
106 void *MEM_guarded_dupallocN(const void *vmemh) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
107 void *MEM_guarded_reallocN_id(void *vmemh, size_t len, const char *UNUSED(str)) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(2);
108 void *MEM_guarded_recallocN_id(void *vmemh, size_t len, const char *UNUSED(str)) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(2);
109 void *MEM_guarded_callocN(size_t len, const char *UNUSED(str)) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2);
110 void *MEM_guarded_mallocN(size_t len, const char *UNUSED(str)) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2);
111 void *MEM_guarded_mapallocN(size_t len, const char *UNUSED(str)) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2);
112 void MEM_guarded_printmemlist_pydict(void);
113 void MEM_guarded_printmemlist(void);
114 void MEM_guarded_callbackmemlist(void (*func)(void *));
115 void MEM_guarded_printmemlist_stats(void);
116 void MEM_guarded_set_error_callback(void (*func)(const char *));
117 bool MEM_guarded_check_memory_integrity(void);
118 void MEM_guarded_set_lock_callback(void (*lock)(void), void (*unlock)(void));
119 void MEM_guarded_set_memory_debug(void);
120 uintptr_t MEM_guarded_get_memory_in_use(void);
121 uintptr_t MEM_guarded_get_mapped_memory_in_use(void);
122 unsigned int MEM_guarded_get_memory_blocks_in_use(void);
123 void MEM_guarded_reset_peak_memory(void);
124 uintptr_t MEM_guarded_get_peak_memory(void) ATTR_WARN_UNUSED_RESULT;
125 #ifndef NDEBUG
126 const char *MEM_guarded_name_ptr(void *vmemh);
127 #endif
128
129 #endif  /* __MALLOCN_INTERN_H__ */