Create 'k' versions of the kernel malloc API.
[dragonfly.git] / sys / sys / malloc.h
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 $
35  * $DragonFly: src/sys/sys/malloc.h,v 1.24 2006/09/04 23:03:38 dillon Exp $
36  */
37
38 #ifndef _SYS_MALLOC_H_
39 #define _SYS_MALLOC_H_
40
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
48 #ifndef _MACHINE_PARAM_H_
49 #include <machine/param.h>      /* for SMP_MAXCPU */
50 #endif
51
52 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
53
54 #ifndef _MACHINE_VMPARAM_H_
55 #include <machine/vmparam.h>    /* for VM_MIN_KERNEL_ADDRESS */
56 #endif
57
58 #endif  /* _KERNEL */
59
60 /*
61  * flags to malloc.
62  */
63 #define M_RNOWAIT       0x0001  /* do not block */
64 #define M_WAITOK        0x0002  /* wait for resources / alloc from cache */
65 #define M_ZERO          0x0100  /* bzero() the allocation */
66 #define M_USE_RESERVE   0x0200  /* can eat into free list reserve */
67 #define M_NULLOK        0x0400  /* ok to return NULL */
68 #define M_PASSIVE_ZERO  0x0800  /* (internal to the slab code only) */
69 #define M_USE_INTERRUPT_RESERVE \
70                         0x1000  /* can exhaust free list entirely */
71
72 /*
73  * M_NOWAIT has to be a set of flags for equivalence to prior use. 
74  *
75  * M_SYSALLOC should be used for any critical infrastructure allocations
76  * made by the kernel proper.
77  *
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.
86  *
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.
90  */
91
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)
97
98 #define M_NOWAIT        M_INTNOWAIT
99 #define M_SYSALLOC      M_SYSWAIT
100
101 #define M_MAGIC         877983977       /* time when first defined :-) */
102
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  */
112 struct malloc_type {
113         struct malloc_type *ks_next;    /* next in list */
114         long    ks_memuse[SMP_MAXCPU];  /* total memory held in bytes */
115         long    ks_loosememuse;         /* (inaccurate) aggregate memuse */
116         long    ks_limit;       /* most that are allowed to exist */
117         long    ks_size;        /* sizes of this thing that are allocated */
118         long    ks_inuse[SMP_MAXCPU]; /* # of allocs currently in use */
119         __int64_t ks_calls;     /* total packets of this type ever allocated */
120         long    ks_maxused;     /* maximum number ever used */
121         __uint32_t ks_magic;    /* if it's not magic, don't touch it */
122         const char *ks_shortdesc;       /* short description */
123         __uint16_t ks_limblocks; /* number of times blocked for hitting limit */
124         __uint16_t ks_mapblocks; /* number of times blocked for kernel map */
125         long    ks_reserved[4]; /* future use (module compatibility) */
126 };
127
128 typedef struct malloc_type      *malloc_type_t;
129
130 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
131
132 #define MALLOC_DEFINE(type, shortdesc, longdesc)        \
133         struct malloc_type type[1] = {                  \
134             { NULL, { 0 }, 0, 0, 0, { 0 }, 0, 0, M_MAGIC, shortdesc, 0, 0, { 0 } } \
135         };                                                                  \
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
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
148 #define MALLOC_DECLARE(type) \
149         extern struct malloc_type type[1]
150
151 #ifdef _KERNEL
152
153 MALLOC_DECLARE(M_CACHE);
154 MALLOC_DECLARE(M_DEVBUF);
155 MALLOC_DECLARE(M_TEMP);
156
157 MALLOC_DECLARE(M_IP6OPT); /* for INET6 */
158 MALLOC_DECLARE(M_IP6NDP); /* for INET6 */
159
160 #endif /* _KERNEL */
161
162 /*
163  * Array of descriptors that describe the contents of each page
164  */
165 struct kmemusage {
166         short ku_cpu;           /* cpu index */
167         union {
168                 __int16_t freecnt;/* for small allocations, free pieces in page */
169                 __int16_t pagecnt;/* for large allocations, pages alloced */
170         } ku_un;
171 };
172 #define ku_freecnt ku_un.freecnt
173 #define ku_pagecnt ku_un.pagecnt
174
175 #ifdef _KERNEL
176
177 #define MINALLOCSIZE    sizeof(void *)
178
179 /*
180  * Turn virtual addresses into kmem map indices
181  */
182 #define btokup(addr)    (&kmemusage[((caddr_t)(addr) - (caddr_t)VM_MIN_KERNEL_ADDRESS) >> PAGE_SHIFT])
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  */
196 MALLOC_DECLARE(M_IOV);
197
198 /* XXX struct malloc_type is unused for contig*(). */
199 void    contigfree (void *addr, unsigned long size,
200                         struct malloc_type *type);
201 void    *contigmalloc (unsigned long size, struct malloc_type *type,
202                            int flags, vm_paddr_t low, vm_paddr_t high,
203                            unsigned long alignment, unsigned long boundary);
204 void    malloc_init (void *);
205 void    malloc_uninit (void *);
206
207 /*
208  * XXX remove the old malloc functions once all references to them have
209  * been renamed to the new kmalloc functions.
210  */
211 #if !defined(KMALLOC_ONLY)
212 void    *malloc (unsigned long size, struct malloc_type *type, int flags);
213 void    *realloc (void *addr, unsigned long size,
214                       struct malloc_type *type, int flags);
215 void    free (void *addr, struct malloc_type *type);
216 #endif
217
218 void    *kmalloc (unsigned long size, struct malloc_type *type, int flags);
219 void    *krealloc (void *addr, unsigned long size,
220                       struct malloc_type *type, int flags);
221 void    kfree (void *addr, struct malloc_type *type);
222 char    *kstrdup (const char *, struct malloc_type *);
223
224 #endif /* _KERNEL */
225
226 #endif /* !_SYS_MALLOC_H_ */