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