Bump to libevent 2.1.11
[platform/upstream/libevent.git] / mm-internal.h
1 /*
2  * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  * 3. The name of the author may not be used to endorse or promote products
13  *    derived from this software without specific prior written permission.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26 #ifndef MM_INTERNAL_H_INCLUDED_
27 #define MM_INTERNAL_H_INCLUDED_
28
29 #include <sys/types.h>
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 #ifndef EVENT__DISABLE_MM_REPLACEMENT
36 /* Internal use only: Memory allocation functions. We give them nice short
37  * mm_names for our own use, but make sure that the symbols have longer names
38  * so they don't conflict with other libraries (like, say, libmm). */
39
40 /** Allocate uninitialized memory.
41  *
42  * @return On success, return a pointer to sz newly allocated bytes.
43  *     On failure, set errno to ENOMEM and return NULL.
44  *     If the argument sz is 0, simply return NULL.
45  */
46 EVENT2_EXPORT_SYMBOL
47 void *event_mm_malloc_(size_t sz);
48
49 /** Allocate memory initialized to zero.
50  *
51  * @return On success, return a pointer to (count * size) newly allocated
52  *     bytes, initialized to zero.
53  *     On failure, or if the product would result in an integer overflow,
54  *     set errno to ENOMEM and return NULL.
55  *     If either arguments are 0, simply return NULL.
56  */
57 EVENT2_EXPORT_SYMBOL
58 void *event_mm_calloc_(size_t count, size_t size);
59
60 /** Duplicate a string.
61  *
62  * @return On success, return a pointer to a newly allocated duplicate
63  *     of a string.
64  *     Set errno to ENOMEM and return NULL if a memory allocation error
65  *     occurs (or would occur) in the process.
66  *     If the argument str is NULL, set errno to EINVAL and return NULL.
67  */
68 EVENT2_EXPORT_SYMBOL
69 char *event_mm_strdup_(const char *str);
70
71 EVENT2_EXPORT_SYMBOL
72 void *event_mm_realloc_(void *p, size_t sz);
73 EVENT2_EXPORT_SYMBOL
74 void event_mm_free_(void *p);
75 #define mm_malloc(sz) event_mm_malloc_(sz)
76 #define mm_calloc(count, size) event_mm_calloc_((count), (size))
77 #define mm_strdup(s) event_mm_strdup_(s)
78 #define mm_realloc(p, sz) event_mm_realloc_((p), (sz))
79 #define mm_free(p) event_mm_free_(p)
80 #else
81 #define mm_malloc(sz) malloc(sz)
82 #define mm_calloc(n, sz) calloc((n), (sz))
83 #define mm_strdup(s) strdup(s)
84 #define mm_realloc(p, sz) realloc((p), (sz))
85 #define mm_free(p) free(p)
86 #endif
87
88 #ifdef __cplusplus
89 }
90 #endif
91
92 #endif