util.h revision a4f124f59fa5f702231432a7e5fa45140ba81e2a
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 */
17a4f124f59fa5f702231432a7e5fa45140ba81e2aJason Evans#define	JEMALLOC_ARG_CONCAT(...) __VA_ARGS__
18cd9a1346e96f71bdecdc654ea50fc62d76371e74Jason Evans
19cd9a1346e96f71bdecdc654ea50fc62d76371e74Jason Evans/*
209225a1991a58190207cca2ff3cdba966bb322dd5Jason Evans * Silence compiler warnings due to uninitialized values.  This is used
219225a1991a58190207cca2ff3cdba966bb322dd5Jason Evans * wherever the compiler fails to recognize that the variable is never used
229225a1991a58190207cca2ff3cdba966bb322dd5Jason Evans * uninitialized.
239225a1991a58190207cca2ff3cdba966bb322dd5Jason Evans */
249225a1991a58190207cca2ff3cdba966bb322dd5Jason Evans#ifdef JEMALLOC_CC_SILENCE
259225a1991a58190207cca2ff3cdba966bb322dd5Jason Evans#  define JEMALLOC_CC_SILENCE_INIT(v) = v
269225a1991a58190207cca2ff3cdba966bb322dd5Jason Evans#else
279225a1991a58190207cca2ff3cdba966bb322dd5Jason Evans#  define JEMALLOC_CC_SILENCE_INIT(v)
289225a1991a58190207cca2ff3cdba966bb322dd5Jason Evans#endif
299225a1991a58190207cca2ff3cdba966bb322dd5Jason Evans
309225a1991a58190207cca2ff3cdba966bb322dd5Jason Evans/*
31d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans * Define a custom assert() in order to reduce the chances of deadlock during
32d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans * assertion failure.
33d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans */
34d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#ifndef assert
35d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#define	assert(e) do {							\
36d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	if (config_debug && !(e)) {					\
37d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		malloc_printf(						\
38d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		    "<jemalloc>: %s:%d: Failed assertion: \"%s\"\n",	\
39d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		    __FILE__, __LINE__, #e);				\
40d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		abort();						\
41d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	}								\
42d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans} while (0)
43d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#endif
44d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
45d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#ifndef not_reached
46d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#define	not_reached() do {						\
47d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	if (config_debug) {						\
48d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		malloc_printf(						\
49d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		    "<jemalloc>: %s:%d: Unreachable code reached\n",	\
50d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		    __FILE__, __LINE__);				\
51d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		abort();						\
52d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	}								\
53d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans} while (0)
54d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#endif
55d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
56d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#ifndef not_implemented
57d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#define	not_implemented() do {						\
58d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	if (config_debug) {						\
59d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		malloc_printf("<jemalloc>: %s:%d: Not implemented\n",	\
60d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		    __FILE__, __LINE__);				\
61d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		abort();						\
62d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	}								\
63d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans} while (0)
64d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#endif
65d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
6686abd0dcd8e478759fe409d338d11558c4cec427Jason Evans#ifndef assert_not_implemented
67d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#define	assert_not_implemented(e) do {					\
68d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	if (config_debug && !(e))					\
69d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans		not_implemented();					\
70d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans} while (0)
7186abd0dcd8e478759fe409d338d11558c4cec427Jason Evans#endif
72d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
736556e28be15d9acd8f3835fb9fad90145e1edbffJason Evans/* Use to assert a particular configuration, e.g., cassert(config_debug). */
746556e28be15d9acd8f3835fb9fad90145e1edbffJason Evans#define	cassert(c) do {							\
756556e28be15d9acd8f3835fb9fad90145e1edbffJason Evans	if ((c) == false)						\
766556e28be15d9acd8f3835fb9fad90145e1edbffJason Evans		not_reached();						\
776556e28be15d9acd8f3835fb9fad90145e1edbffJason Evans} while (0)
786556e28be15d9acd8f3835fb9fad90145e1edbffJason Evans
79d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#endif /* JEMALLOC_H_TYPES */
80d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans/******************************************************************************/
81d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#ifdef JEMALLOC_H_STRUCTS
82d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
83d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#endif /* JEMALLOC_H_STRUCTS */
84d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans/******************************************************************************/
85d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#ifdef JEMALLOC_H_EXTERNS
86d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
872a83ed0284e92c7ba4bd4efe9df149ac724b2f26Jason Evansint	buferror(int err, char *buf, size_t buflen);
8841b6afb834b1f5250223678c52bd4f013d4234f6Jason Evansuintmax_t	malloc_strtoumax(const char *nptr, char **endptr, int base);
89889ec59bd3ae3190fb715e64d8d15b6a1b47314aJason Evansvoid	malloc_write(const char *s);
90d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
91d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans/*
92d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans * malloc_vsnprintf() supports a subset of snprintf(3) that avoids floating
93d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans * point math.
94d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans */
95d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evansint	malloc_vsnprintf(char *str, size_t size, const char *format,
96d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans    va_list ap);
97d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evansint	malloc_snprintf(char *str, size_t size, const char *format, ...)
98d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans    JEMALLOC_ATTR(format(printf, 3, 4));
99d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evansvoid	malloc_vcprintf(void (*write_cb)(void *, const char *), void *cbopaque,
100d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans    const char *format, va_list ap);
101d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evansvoid malloc_cprintf(void (*write)(void *, const char *), void *cbopaque,
102d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans    const char *format, ...) JEMALLOC_ATTR(format(printf, 3, 4));
103d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evansvoid	malloc_printf(const char *format, ...)
104d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans    JEMALLOC_ATTR(format(printf, 1, 2));
105d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
106d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#endif /* JEMALLOC_H_EXTERNS */
107d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans/******************************************************************************/
108d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#ifdef JEMALLOC_H_INLINES
109d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
110d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#ifndef JEMALLOC_ENABLE_INLINE
111d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evanssize_t	pow2_ceil(size_t x);
112a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommeyvoid	set_errno(int errnum);
113a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommeyint	get_errno(void);
114d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#endif
115d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
116d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#if (defined(JEMALLOC_ENABLE_INLINE) || defined(JEMALLOC_UTIL_C_))
117d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans/* Compute the smallest power of 2 that is >= x. */
118d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason EvansJEMALLOC_INLINE size_t
119d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evanspow2_ceil(size_t x)
120d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans{
121d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
122d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	x--;
123d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	x |= x >> 1;
124d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	x |= x >> 2;
125d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	x |= x >> 4;
126d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	x |= x >> 8;
127d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	x |= x >> 16;
128d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#if (LG_SIZEOF_PTR == 3)
129d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	x |= x >> 32;
130d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#endif
131d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	x++;
132d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans	return (x);
133d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans}
134d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
135a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommey/* Sets error code */
136a14bce85e885f83c96116cc5438ae52d740f3727Mike HommeyJEMALLOC_INLINE void
137a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommeyset_errno(int errnum)
138a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommey{
139a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommey
140a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommey#ifdef _WIN32
141a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommey	SetLastError(errnum);
142a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommey#else
143a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommey	errno = errnum;
144a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommey#endif
145a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommey}
146a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommey
147a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommey/* Get last error code */
148a14bce85e885f83c96116cc5438ae52d740f3727Mike HommeyJEMALLOC_INLINE int
149a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommeyget_errno(void)
150a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommey{
151a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommey
152a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommey#ifdef _WIN32
1537cdea3973cab8640d1f44c7638ed5e30ed18be24Mike Hommey	return (GetLastError());
154a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommey#else
1557cdea3973cab8640d1f44c7638ed5e30ed18be24Mike Hommey	return (errno);
156a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommey#endif
157a14bce85e885f83c96116cc5438ae52d740f3727Mike Hommey}
158d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#endif
159d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans
160d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans#endif /* JEMALLOC_H_INLINES */
161d81e4bdd5c991bd5642c8b859ef1f752b51cd9beJason Evans/******************************************************************************/
162