Split extern in6* declarations for libc vs the kernel.
[dragonfly.git] / sys / sys / malloc.h
CommitLineData
984263bc
MD
1/*
2 * Copyright (c) 1987, 1993
3 * The Regents of the University of California. All rights reserved.
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. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the University of
16 * California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 * @(#)malloc.h 8.5 (Berkeley) 5/3/95
34 * $FreeBSD: src/sys/sys/malloc.h,v 1.48.2.2 2002/03/16 02:19:16 archie Exp $
59302080 35 * $DragonFly: src/sys/sys/malloc.h,v 1.23 2006/09/04 07:00:58 dillon Exp $
984263bc
MD
36 */
37
38#ifndef _SYS_MALLOC_H_
39#define _SYS_MALLOC_H_
40
03d6a592
MD
41#ifndef _SYS_TYPES_H_
42#include <sys/types.h>
43#endif
44#ifndef _MACHINE_TYPES_H_
45#include <machine/types.h> /* vm_paddr_t and __* types */
46#endif
47
bba6a44d
MD
48#ifndef _MACHINE_PARAM_H_
49#include <machine/param.h> /* for SMP_MAXCPU */
50#endif
3bf43adc 51
05220613 52#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
3bf43adc 53
03aa8d99
MD
54#ifndef _MACHINE_VMPARAM_H_
55#include <machine/vmparam.h> /* for VM_MIN_KERNEL_ADDRESS */
56#endif
57
05220613
MD
58#endif /* _KERNEL */
59
984263bc
MD
60/*
61 * flags to malloc.
62 */
dc1fd4b3
MD
63#define M_RNOWAIT 0x0001 /* do not block */
64#define M_WAITOK 0x0002 /* wait for resources / alloc from cache */
97482992 65#define M_ZERO 0x0100 /* bzero() the allocation */
dc1fd4b3 66#define M_USE_RESERVE 0x0200 /* can eat into free list reserve */
8cb2bf45 67#define M_NULLOK 0x0400 /* ok to return NULL */
ebe4a7b3 68#define M_PASSIVE_ZERO 0x0800 /* (internal to the slab code only) */
dc1fd4b3
MD
69#define M_USE_INTERRUPT_RESERVE \
70 0x1000 /* can exhaust free list entirely */
dc1fd4b3
MD
71
72/*
73 * M_NOWAIT has to be a set of flags for equivalence to prior use.
74 *
dc1fd4b3
MD
75 * M_SYSALLOC should be used for any critical infrastructure allocations
76 * made by the kernel proper.
77 *
c397c465
MD
78 * M_INTNOWAIT should be used for any critical infrastructure allocations
79 * made by interrupts. Such allocations can still fail but will not fail
80 * as often as M_NOWAIT.
81 *
82 * NOTE ON DRAGONFLY USE OF M_NOWAIT. In FreeBSD M_NOWAIT allocations
83 * almost always succeed. In DragonFly, however, there is a good chance
84 * that an allocation will fail. M_NOWAIT should only be used when
85 * allocations can fail without any serious detriment to the system.
dc1fd4b3 86 *
c397c465
MD
87 * Note that allocations made from (preempted) interrupts will attempt to
88 * use pages from the VM PAGE CACHE (PQ_CACHE) (i.e. those associated with
89 * objects). This is automatic.
dc1fd4b3
MD
90 */
91
8cb2bf45
JS
92#define M_INTNOWAIT (M_RNOWAIT | M_NULLOK | \
93 M_USE_RESERVE | M_USE_INTERRUPT_RESERVE)
94#define M_SYSNOWAIT (M_RNOWAIT | M_NULLOK | M_USE_RESERVE)
95#define M_INTWAIT (M_WAITOK | M_USE_RESERVE | M_USE_INTERRUPT_RESERVE)
96#define M_SYSWAIT (M_WAITOK | M_USE_RESERVE)
dc1fd4b3 97
8cb2bf45
JS
98#define M_NOWAIT M_INTNOWAIT
99#define M_SYSALLOC M_SYSWAIT
984263bc
MD
100
101#define M_MAGIC 877983977 /* time when first defined :-) */
102
bba6a44d
MD
103/*
104 * The malloc tracking structure. Note that per-cpu entries must be
105 * aggregated for accurate statistics, they do not actually break the
106 * stats down by cpu (e.g. the cpu freeing memory will subtract from
107 * its slot, not the originating cpu's slot).
108 *
109 * SMP_MAXCPU is used so modules which use malloc remain compatible
110 * between UP and SMP.
111 */
984263bc
MD
112struct malloc_type {
113 struct malloc_type *ks_next; /* next in list */
bba6a44d
MD
114 long ks_memuse[SMP_MAXCPU]; /* total memory held in bytes */
115 long ks_loosememuse; /* (inaccurate) aggregate memuse */
984263bc
MD
116 long ks_limit; /* most that are allowed to exist */
117 long ks_size; /* sizes of this thing that are allocated */
bba6a44d 118 long ks_inuse[SMP_MAXCPU]; /* # of allocs currently in use */
05220613 119 __int64_t ks_calls; /* total packets of this type ever allocated */
984263bc 120 long ks_maxused; /* maximum number ever used */
05220613 121 __uint32_t ks_magic; /* if it's not magic, don't touch it */
984263bc 122 const char *ks_shortdesc; /* short description */
05220613
MD
123 __uint16_t ks_limblocks; /* number of times blocked for hitting limit */
124 __uint16_t ks_mapblocks; /* number of times blocked for kernel map */
bba6a44d 125 long ks_reserved[4]; /* future use (module compatibility) */
984263bc
MD
126};
127
c35323b6
MD
128typedef struct malloc_type *malloc_type_t;
129
05220613 130#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
a108bf71 131
05220613
MD
132#define MALLOC_DEFINE(type, shortdesc, longdesc) \
133 struct malloc_type type[1] = { \
58661e79 134 { NULL, { 0 }, 0, 0, 0, { 0 }, 0, 0, M_MAGIC, shortdesc, 0, 0, { 0 } } \
05220613 135 }; \
984263bc
MD
136 SYSINIT(type##_init, SI_SUB_KMEM, SI_ORDER_ANY, malloc_init, type); \
137 SYSUNINIT(type##_uninit, SI_SUB_KMEM, SI_ORDER_ANY, malloc_uninit, type)
138
05220613
MD
139#else
140
141#define MALLOC_DEFINE(type, shortdesc, longdesc) \
142 struct malloc_type type[1] = { \
143 { NULL, { 0 }, 0, 0, 0, { 0 }, 0, 0, M_MAGIC, shortdesc, 0, 0 } \
144 };
145
146#endif
147
984263bc
MD
148#define MALLOC_DECLARE(type) \
149 extern struct malloc_type type[1]
150
05220613
MD
151#ifdef _KERNEL
152
984263bc
MD
153MALLOC_DECLARE(M_CACHE);
154MALLOC_DECLARE(M_DEVBUF);
155MALLOC_DECLARE(M_TEMP);
156
157MALLOC_DECLARE(M_IP6OPT); /* for INET6 */
158MALLOC_DECLARE(M_IP6NDP); /* for INET6 */
984263bc 159
05220613 160#endif /* _KERNEL */
a108bf71 161
984263bc
MD
162/*
163 * Array of descriptors that describe the contents of each page
164 */
165struct kmemusage {
bba6a44d 166 short ku_cpu; /* cpu index */
984263bc 167 union {
05220613
MD
168 __int16_t freecnt;/* for small allocations, free pieces in page */
169 __int16_t pagecnt;/* for large allocations, pages alloced */
984263bc
MD
170 } ku_un;
171};
172#define ku_freecnt ku_un.freecnt
173#define ku_pagecnt ku_un.pagecnt
174
a108bf71
MD
175#ifdef _KERNEL
176
05220613
MD
177#define MINALLOCSIZE sizeof(void *)
178
984263bc
MD
179/*
180 * Turn virtual addresses into kmem map indices
181 */
074dcfe8 182#define btokup(addr) (&kmemusage[((caddr_t)(addr) - (caddr_t)VM_MIN_KERNEL_ADDRESS) >> PAGE_SHIFT])
984263bc
MD
183
184/*
185 * Deprecated macro versions of not-quite-malloc() and free().
186 */
187#define MALLOC(space, cast, size, type, flags) \
188 (space) = (cast)malloc((u_long)(size), (type), (flags))
189#define FREE(addr, type) free((addr), (type))
190
191/*
192 * XXX this should be declared in <sys/uio.h>, but that tends to fail
193 * because <sys/uio.h> is included in a header before the source file
194 * has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined.
195 */
196MALLOC_DECLARE(M_IOV);
197
198/* XXX struct malloc_type is unused for contig*(). */
b153f746
RG
199void contigfree (void *addr, unsigned long size,
200 struct malloc_type *type);
201void *contigmalloc (unsigned long size, struct malloc_type *type,
6ef943a3 202 int flags, vm_paddr_t low, vm_paddr_t high,
b153f746
RG
203 unsigned long alignment, unsigned long boundary);
204void free (void *addr, struct malloc_type *type);
205void *malloc (unsigned long size, struct malloc_type *type, int flags);
206void malloc_init (void *);
207void malloc_uninit (void *);
208void *realloc (void *addr, unsigned long size,
209 struct malloc_type *type, int flags);
210void *reallocf (void *addr, unsigned long size,
211 struct malloc_type *type, int flags);
59302080 212char *kstrdup (const char *, struct malloc_type *);
a108bf71 213
984263bc
MD
214#endif /* _KERNEL */
215
216#endif /* !_SYS_MALLOC_H_ */