util.h revision cd9a1346e96f71bdecdc654ea50fc62d76371e74
1d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans/******************************************************************************/
2d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#ifdef JEMALLOC_H_TYPES
3d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
4d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans/* Size of stack-allocated buffer passed to buferror(). */
5d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#define	BUFERROR_BUF		64
6d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
7d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans/*
8cd9a1346e96f71bdecdc654ea50fc62d76371e74Jason Evans * Size of stack-allocated buffer used by malloc_{,v,vc}printf().  This must be
9cd9a1346e96f71bdecdc654ea50fc62d76371e74Jason Evans * large enough for all possible uses within jemalloc.
10824d34e5b7f5cf00bf472ec79f7ec1c6e3474114Jason Evans */
11824d34e5b7f5cf00bf472ec79f7ec1c6e3474114Jason Evans#define	MALLOC_PRINTF_BUFSIZE	4096
12824d34e5b7f5cf00bf472ec79f7ec1c6e3474114Jason Evans
13824d34e5b7f5cf00bf472ec79f7ec1c6e3474114Jason Evans/*
14cd9a1346e96f71bdecdc654ea50fc62d76371e74Jason Evans * Wrap a cpp argument that contains commas such that it isn't broken up into
15cd9a1346e96f71bdecdc654ea50fc62d76371e74Jason Evans * multiple arguments.
16cd9a1346e96f71bdecdc654ea50fc62d76371e74Jason Evans */
17cd9a1346e96f71bdecdc654ea50fc62d76371e74Jason Evans#define JEMALLOC_CONCAT(...) __VA_ARGS__
18cd9a1346e96f71bdecdc654ea50fc62d76371e74Jason Evans
19cd9a1346e96f71bdecdc654ea50fc62d76371e74Jason Evans/*
20d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans * Define a custom assert() in order to reduce the chances of deadlock during
21d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans * assertion failure.
22d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans */
23d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#ifndef assert
24d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#define	assert(e) do {							\
25d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	if (config_debug && !(e)) {					\
26d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		malloc_printf(						\
27d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		    "<jemalloc>: %s:%d: Failed assertion: \"%s\"\n",	\
28d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		    __FILE__, __LINE__, #e);				\
29d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		abort();						\
30d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	}								\
31d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans} while (0)
32d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#endif
33d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
34d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans/* Use to assert a particular configuration, e.g., cassert(config_debug). */
35d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#define	cassert(c) do {							\
36d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	if ((c) == false)						\
37d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		assert(false);						\
38d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans} while (0)
39d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
40d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#ifndef not_reached
41d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#define	not_reached() do {						\
42d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	if (config_debug) {						\
43d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		malloc_printf(						\
44d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		    "<jemalloc>: %s:%d: Unreachable code reached\n",	\
45d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		    __FILE__, __LINE__);				\
46d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		abort();						\
47d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	}								\
48d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans} while (0)
49d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#endif
50d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
51d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#ifndef not_implemented
52d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#define	not_implemented() do {						\
53d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	if (config_debug) {						\
54d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		malloc_printf("<jemalloc>: %s:%d: Not implemented\n",	\
55d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		    __FILE__, __LINE__);				\
56d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		abort();						\
57d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	}								\
58d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans} while (0)
59d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#endif
60d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
61d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#define	assert_not_implemented(e) do {					\
62d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	if (config_debug && !(e))					\
63d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		not_implemented();					\
64d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans} while (0)
65d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
66d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#endif /* JEMALLOC_H_TYPES */
67d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans/******************************************************************************/
68d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#ifdef JEMALLOC_H_STRUCTS
69d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
70d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#endif /* JEMALLOC_H_STRUCTS */
71d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans/******************************************************************************/
72d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#ifdef JEMALLOC_H_EXTERNS
73d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
74d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evansextern void	(*je_malloc_message)(void *wcbopaque, const char *s);
75d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
76d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evansint	buferror(int errnum, char *buf, size_t buflen);
77d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
78d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans/*
79d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans * malloc_vsnprintf() supports a subset of snprintf(3) that avoids floating
80d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans * point math.
81d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans */
82d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evansint	malloc_vsnprintf(char *str, size_t size, const char *format,
83d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans    va_list ap);
84d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evansint	malloc_snprintf(char *str, size_t size, const char *format, ...)
85d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans    JEMALLOC_ATTR(format(printf, 3, 4));
86d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evansvoid	malloc_vcprintf(void (*write_cb)(void *, const char *), void *cbopaque,
87d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans    const char *format, va_list ap);
88d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evansvoid malloc_cprintf(void (*write)(void *, const char *), void *cbopaque,
89d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans    const char *format, ...) JEMALLOC_ATTR(format(printf, 3, 4));
90d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evansvoid	malloc_printf(const char *format, ...)
91d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans    JEMALLOC_ATTR(format(printf, 1, 2));
92d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
93d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#endif /* JEMALLOC_H_EXTERNS */
94d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans/******************************************************************************/
95d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#ifdef JEMALLOC_H_INLINES
96d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
97d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#ifndef JEMALLOC_ENABLE_INLINE
98d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evanssize_t	pow2_ceil(size_t x);
99d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evansvoid	malloc_write(const char *s);
100d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#endif
101d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
102d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#if (defined(JEMALLOC_ENABLE_INLINE) || defined(JEMALLOC_UTIL_C_))
103d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans/* Compute the smallest power of 2 that is >= x. */
104d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason EvansJEMALLOC_INLINE size_t
105d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evanspow2_ceil(size_t x)
106d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans{
107d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
108d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	x--;
109d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	x |= x >> 1;
110d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	x |= x >> 2;
111d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	x |= x >> 4;
112d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	x |= x >> 8;
113d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	x |= x >> 16;
114d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#if (LG_SIZEOF_PTR == 3)
115d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	x |= x >> 32;
116d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#endif
117d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	x++;
118d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	return (x);
119d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans}
120d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
121d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans/*
122d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans * Wrapper around malloc_message() that avoids the need for
123d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans * je_malloc_message(...) throughout the code.
124d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans */
125d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason EvansJEMALLOC_INLINE void
126d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evansmalloc_write(const char *s)
127d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans{
128d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
129d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	je_malloc_message(NULL, s);
130d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans}
131d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
132d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#endif
133d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
134d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#endif /* JEMALLOC_H_INLINES */
135d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans/******************************************************************************/
136