xref: /f-stack/app/redis-5.0.5/src/zmalloc.h (revision 572c4311)
1 /* zmalloc - total amount of allocated memory aware version of malloc()
2  *
3  * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  *   * Redistributions of source code must retain the above copyright notice,
10  *     this list of conditions and the following disclaimer.
11  *   * Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  *   * Neither the name of Redis nor the names of its contributors may be used
15  *     to endorse or promote products derived from this software without
16  *     specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #ifndef __ZMALLOC_H
32 #define __ZMALLOC_H
33 
34 /* Double expansion needed for stringification of macro values. */
35 #define __xstr(s) __str(s)
36 #define __str(s) #s
37 
38 #if defined(USE_TCMALLOC)
39 #define ZMALLOC_LIB ("tcmalloc-" __xstr(TC_VERSION_MAJOR) "." __xstr(TC_VERSION_MINOR))
40 #include <google/tcmalloc.h>
41 #if (TC_VERSION_MAJOR == 1 && TC_VERSION_MINOR >= 6) || (TC_VERSION_MAJOR > 1)
42 #define HAVE_MALLOC_SIZE 1
43 #define zmalloc_size(p) tc_malloc_size(p)
44 #else
45 #error "Newer version of tcmalloc required"
46 #endif
47 
48 #elif defined(USE_JEMALLOC)
49 #define ZMALLOC_LIB ("jemalloc-" __xstr(JEMALLOC_VERSION_MAJOR) "." __xstr(JEMALLOC_VERSION_MINOR) "." __xstr(JEMALLOC_VERSION_BUGFIX))
50 #include <jemalloc/jemalloc.h>
51 #if (JEMALLOC_VERSION_MAJOR == 2 && JEMALLOC_VERSION_MINOR >= 1) || (JEMALLOC_VERSION_MAJOR > 2)
52 #define HAVE_MALLOC_SIZE 1
53 #define zmalloc_size(p) je_malloc_usable_size(p)
54 #else
55 #error "Newer version of jemalloc required"
56 #endif
57 
58 #elif defined(__APPLE__)
59 #include <malloc/malloc.h>
60 #define HAVE_MALLOC_SIZE 1
61 #define zmalloc_size(p) malloc_size(p)
62 #endif
63 
64 #ifndef ZMALLOC_LIB
65 #define ZMALLOC_LIB "libc"
66 #ifdef __GLIBC__
67 #include <malloc.h>
68 #define HAVE_MALLOC_SIZE 1
69 #define zmalloc_size(p) malloc_usable_size(p)
70 #endif
71 #endif
72 
73 /* We can enable the Redis defrag capabilities only if we are using Jemalloc
74  * and the version used is our special version modified for Redis having
75  * the ability to return per-allocation fragmentation hints. */
76 #if defined(USE_JEMALLOC) && defined(JEMALLOC_FRAG_HINT)
77 #define HAVE_DEFRAG
78 #endif
79 
80 void *zmalloc(size_t size);
81 void *zcalloc(size_t size);
82 void *zrealloc(void *ptr, size_t size);
83 void zfree(void *ptr);
84 char *zstrdup(const char *s);
85 size_t zmalloc_used_memory(void);
86 void zmalloc_set_oom_handler(void (*oom_handler)(size_t));
87 size_t zmalloc_get_rss(void);
88 int zmalloc_get_allocator_info(size_t *allocated, size_t *active, size_t *resident);
89 size_t zmalloc_get_private_dirty(long pid);
90 size_t zmalloc_get_smap_bytes_by_field(char *field, long pid);
91 size_t zmalloc_get_memory_size(void);
92 void zlibc_free(void *ptr);
93 
94 #ifdef HAVE_DEFRAG
95 void zfree_no_tcache(void *ptr);
96 void *zmalloc_no_tcache(size_t size);
97 #endif
98 
99 #ifndef HAVE_MALLOC_SIZE
100 size_t zmalloc_size(void *ptr);
101 size_t zmalloc_usable(void *ptr);
102 #else
103 #define zmalloc_usable(p) zmalloc_size(p)
104 #endif
105 
106 #ifdef REDIS_TEST
107 int zmalloc_test(int argc, char **argv);
108 #endif
109 
110 #endif /* __ZMALLOC_H */
111