Initial import from FreeBSD RELENG_4:
[dragonfly.git] / contrib / isc-dhcp / includes / omapip / alloc.h
1 /* alloc.h
2
3    Definitions for the object management API protocol memory allocation... */
4
5 /*
6  * Copyright (c) 1996-2001 Internet Software Consortium.
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of The Internet Software Consortium nor the names
19  *    of its contributors may be used to endorse or promote products derived
20  *    from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE INTERNET SOFTWARE CONSORTIUM AND
23  * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
24  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26  * DISCLAIMED.  IN NO EVENT SHALL THE INTERNET SOFTWARE CONSORTIUM OR
27  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
30  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
31  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
33  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  * This software has been written for the Internet Software Consortium
37  * by Ted Lemon in cooperation with Vixie Enterprises and Nominum, Inc.
38  * To learn more about the Internet Software Consortium, see
39  * ``http://www.isc.org/''.  To learn more about Vixie Enterprises,
40  * see ``http://www.vix.com''.   To learn more about Nominum, Inc., see
41  * ``http://www.nominum.com''.
42  */
43
44 isc_result_t omapi_buffer_new (omapi_buffer_t **, const char *, int);
45 isc_result_t omapi_buffer_reference (omapi_buffer_t **,
46                                      omapi_buffer_t *, const char *, int);
47 isc_result_t omapi_buffer_dereference (omapi_buffer_t **, const char *, int);
48
49 #if defined (DEBUG_MEMORY_LEAKAGE) || defined (DEBUG_MALLOC_POOL) || \
50                 defined (DEBUG_MEMORY_LEAKAGE_ON_EXIT)
51 #define DMDOFFSET (sizeof (struct dmalloc_preamble))
52 #define DMLFSIZE 16
53 #define DMUFSIZE 16
54 #define DMDSIZE (DMDOFFSET + DMLFSIZE + DMUFSIZE)
55
56 struct dmalloc_preamble {
57         struct dmalloc_preamble *prev, *next;
58         const char *file;
59         int line;
60         size_t size;
61         unsigned long generation;
62         unsigned char low_fence [DMLFSIZE];
63 };
64 #else
65 #define DMDOFFSET 0
66 #define DMDSIZE 0
67 #endif
68
69 /* rc_history flags... */
70 #define RC_LEASE        1
71 #define RC_MISC         2
72
73 #if defined (DEBUG_RC_HISTORY)
74 #if !defined (RC_HISTORY_MAX)
75 # define RC_HISTORY_MAX 256
76 #endif
77
78 #if !defined (RC_HISTORY_FLAGS)
79 # define RC_HISTORY_FLAGS (RC_LEASE | RC_MISC)
80 #endif
81
82 struct rc_history_entry {
83         const char *file;
84         int line;
85         void *reference;
86         void *addr;
87         int refcnt;
88 };
89
90 #define rc_register(x, l, r, y, z, d, f) do { \
91                 if (RC_HISTORY_FLAGS & ~(f)) { \
92                         rc_history [rc_history_index].file = (x); \
93                         rc_history [rc_history_index].line = (l); \
94                         rc_history [rc_history_index].reference = (r); \
95                         rc_history [rc_history_index].addr = (y); \
96                         rc_history [rc_history_index].refcnt = (z); \
97                         rc_history_next (d); \
98                 } \
99         } while (0)
100 #define rc_register_mdl(r, y, z, d, f) \
101         rc_register (__FILE__, __LINE__, r, y, z, d, f)
102 #else
103 #define rc_register(file, line, reference, addr, refcnt, d, f)
104 #define rc_register_mdl(reference, addr, refcnt, d, f)
105 #endif
106
107 #if defined (DEBUG_MEMORY_LEAKAGE) || defined (DEBUG_MALLOC_POOL) || \
108                 defined (DEBUG_MEMORY_LEAKAGE_ON_EXIT)
109 extern struct dmalloc_preamble *dmalloc_list;
110 extern unsigned long dmalloc_outstanding;
111 extern unsigned long dmalloc_longterm;
112 extern unsigned long dmalloc_generation;
113 extern unsigned long dmalloc_cutoff_generation;
114 #endif
115
116 #if defined (DEBUG_RC_HISTORY)
117 extern struct rc_history_entry rc_history [RC_HISTORY_MAX];
118 extern int rc_history_index;
119 extern int rc_history_count;
120 #endif