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