]> git.saurik.com Git - apple/xnu.git/blame - bsd/sys/malloc.h
xnu-344.2.tar.gz
[apple/xnu.git] / bsd / sys / malloc.h
CommitLineData
1c79356b 1/*
9bccf70c 2 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
1c79356b
A
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * The contents of this file constitute Original Code as defined in and
7 * are subject to the Apple Public Source License Version 1.1 (the
8 * "License"). You may not use this file except in compliance with the
9 * License. Please obtain a copy of the License at
10 * http://www.apple.com/publicsource and read it before using this file.
11 *
12 * This Original Code and all software distributed under the License are
13 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
14 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
15 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
17 * License for the specific language governing rights and limitations
18 * under the License.
19 *
20 * @APPLE_LICENSE_HEADER_END@
21 */
22/* Copyright (c) 1998, 1999 Apple Computer, Inc. All Rights Reserved */
23/* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
24/*
25 * Copyright (c) 1987, 1993
26 * The Regents of the University of California. All rights reserved.
27 *
28 * Redistribution and use in source and binary forms, with or without
29 * modification, are permitted provided that the following conditions
30 * are met:
31 * 1. Redistributions of source code must retain the above copyright
32 * notice, this list of conditions and the following disclaimer.
33 * 2. Redistributions in binary form must reproduce the above copyright
34 * notice, this list of conditions and the following disclaimer in the
35 * documentation and/or other materials provided with the distribution.
36 * 3. All advertising materials mentioning features or use of this software
37 * must display the following acknowledgement:
38 * This product includes software developed by the University of
39 * California, Berkeley and its contributors.
40 * 4. Neither the name of the University nor the names of its contributors
41 * may be used to endorse or promote products derived from this software
42 * without specific prior written permission.
43 *
44 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
45 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
46 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
47 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
48 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
49 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
50 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
51 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
52 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
53 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
54 * SUCH DAMAGE.
55 *
56 * @(#)malloc.h 8.5 (Berkeley) 5/3/95
57 */
58
59#ifndef _SYS_MALLOC_H_
60#define _SYS_MALLOC_H_
61
9bccf70c
A
62#include <sys/appleapiopts.h>
63
1c79356b
A
64#define KMEMSTATS
65
66/*
67 * flags to malloc
68 */
69#define M_WAITOK 0x0000
70#define M_NOWAIT 0x0001
71
72/*
73 * Types of memory to be allocated (not all are used by us)
74 */
75#define M_FREE 0 /* should be on free list */
76#define M_MBUF 1 /* mbuf */
77#define M_DEVBUF 2 /* device driver memory */
78#define M_SOCKET 3 /* socket structure */
79#define M_PCB 4 /* protocol control block */
80#define M_RTABLE 5 /* routing tables */
81#define M_HTABLE 6 /* IMP host tables */
82#define M_FTABLE 7 /* fragment reassembly header */
83#define M_ZOMBIE 8 /* zombie proc status */
84#define M_IFADDR 9 /* interface address */
85#define M_SOOPTS 10 /* socket options */
86#define M_SONAME 11 /* socket name */
87#define M_NAMEI 12 /* namei path name buffer */
88#define M_GPROF 13 /* kernel profiling buffer */
89#define M_IOCTLOPS 14 /* ioctl data buffer */
90#define M_MAPMEM 15 /* mapped memory descriptors */
91#define M_CRED 16 /* credentials */
92#define M_PGRP 17 /* process group header */
93#define M_SESSION 18 /* session header */
94#define M_IOV 19 /* large iov's */
95#define M_MOUNT 20 /* vfs mount struct */
96#define M_FHANDLE 21 /* network file handle */
97#define M_NFSREQ 22 /* NFS request header */
98#define M_NFSMNT 23 /* NFS mount structure */
99#define M_NFSNODE 24 /* NFS vnode private part */
100#define M_VNODE 25 /* Dynamically allocated vnodes */
101#define M_CACHE 26 /* Dynamically allocated cache entries */
102#define M_DQUOT 27 /* UFS quota entries */
103#define M_UFSMNT 28 /* UFS mount structure */
104#define M_SHM 29 /* SVID compatible shared memory segments */
105#define M_VMMAP 30 /* VM map structures */
106#define M_VMMAPENT 31 /* VM map entry structures */
107#define M_VMOBJ 32 /* VM object structure */
108#define M_VMOBJHASH 33 /* VM object hash structure */
109#define M_VMPMAP 34 /* VM pmap */
110#define M_VMPVENT 35 /* VM phys-virt mapping entry */
111#define M_VMPAGER 36 /* XXX: VM pager struct */
112#define M_VMPGDATA 37 /* XXX: VM pager private data */
113#define M_FILE 38 /* Open file structure */
114#define M_FILEDESC 39 /* Open file descriptor table */
115#define M_LOCKF 40 /* Byte-range locking structures */
116#define M_PROC 41 /* Proc structures */
117#define M_SUBPROC 42 /* Proc sub-structures */
118#define M_SEGMENT 43 /* Segment for LFS */
119#define M_LFSNODE 44 /* LFS vnode private part */
120#define M_FFSNODE 45 /* FFS vnode private part */
121#define M_MFSNODE 46 /* MFS vnode private part */
122#define M_NQLEASE 47 /* Nqnfs lease */
123#define M_NQMHOST 48 /* Nqnfs host address table */
124#define M_NETADDR 49 /* Export host address structure */
125#define M_NFSSVC 50 /* Nfs server structure */
126#define M_NFSUID 51 /* Nfs uid mapping structure */
127#define M_NFSD 52 /* Nfs server daemon structure */
128#define M_IPMOPTS 53 /* internet multicast options */
129#define M_IPMADDR 54 /* internet multicast address */
130#define M_IFMADDR 55 /* link-level multicast address */
131#define M_MRTABLE 56 /* multicast routing tables */
132#define M_ISOFSMNT 57 /* ISOFS mount structure */
133#define M_ISOFSNODE 58 /* ISOFS vnode private part */
134#define M_NFSRVDESC 59 /* NFS server socket descriptor */
135#define M_NFSDIROFF 60 /* NFS directory offset data */
136#define M_NFSBIGFH 61 /* NFS version 3 file handle */
137#define M_MSDOSFSMNT 62 /* MSDOS FS mount structure */
138#define M_MSDOSFSFAT 63 /* MSDOS FS fat table */
139#define M_MSDOSFSNODE 64 /* MSDOS FS vnode private part */
140#define M_TTYS 65 /* allocated tty structures */
141#define M_EXEC 66 /* argument lists & other mem used by exec */
142#define M_MISCFSMNT 67 /* miscfs mount structures */
143#define M_MISCFSNODE 68 /* miscfs vnode private part */
144#define M_ADOSFSMNT 69 /* adosfs mount structures */
145#define M_ADOSFSNODE 70 /* adosfs vnode private part */
146#define M_ANODE 71 /* adosfs anode structures and tables. */
147#define M_BUFHDR 72 /* File buffer cache headers */
148#define M_OFILETABL 73 /* Open file descriptor table */
149#define M_MCLUST 74 /* mbuf cluster buffers */
150#define M_HFSMNT 75 /* HFS mount structure */
9bccf70c
A
151#define M_HFSNODE 76 /* HFS catalog node */
152#define M_HFSFORK 77 /* HFS file fork */
1c79356b
A
153#define M_VOLFSMNT 78 /* VOLFS mount structure */
154#define M_VOLFSNODE 79 /* VOLFS private node part */
155#define M_TEMP 80 /* misc temporary data buffers */
9bccf70c 156#define M_KTRACE M_TEMP /* ktrace buffers */
1c79356b
A
157#define M_SECA 81 /* security associations, key management */
158#define M_DEVFS 82
159#define M_IPFW 83 /* IP Forwarding/NAT */
9bccf70c
A
160#define M_UDFNODE 84 /* UDF inodes */
161#define M_UDFMNT 85 /* UDF mount structures */
162#define M_IP6NDP 86 /* IPv6 Neighbour Discovery*/
163#define M_IP6OPT 87 /* IPv6 options management */
164#define M_IP6MISC 88 /* IPv6 misc. memory */
165#define M_TSEGQ 89 /* TCP segment queue entry */
166#define M_IGMP 90
1c79356b 167
9bccf70c 168#define M_LAST 91 /* Must be last type + 1 */
1c79356b
A
169
170/* Strings corresponding to types of memory */
171/* Must be in synch with the #defines above */
172#define INITKMEMNAMES { \
173 "free", /* 0 M_FREE */ \
174 "mbuf", /* 1 M_MBUF */ \
175 "devbuf", /* 2 M_DEVBUF */ \
176 "socket", /* 3 M_SOCKET */ \
177 "pcb", /* 4 M_PCB */ \
178 "routetbl", /* 5 M_RTABLE */ \
179 "hosttbl", /* 6 M_HTABLE */ \
180 "fragtbl", /* 7 M_FTABLE */ \
181 "zombie", /* 8 M_ZOMBIE */ \
182 "ifaddr", /* 9 M_IFADDR */ \
183 "soopts", /* 10 M_SOOPTS */ \
184 "soname", /* 11 M_SONAME */ \
185 "namei", /* 12 M_NAMEI */ \
186 "gprof", /* 13 M_GPROF */ \
187 "ioctlops", /* 14 M_IOCTLOPS */ \
188 "mapmem", /* 15 M_MAPMEM */ \
189 "cred", /* 16 M_CRED */ \
190 "pgrp", /* 17 M_PGRP */ \
191 "session", /* 18 M_SESSION */ \
192 "iov", /* 19 M_IOV */ \
193 "mount", /* 20 M_MOUNT */ \
194 "fhandle", /* 21 M_FHANDLE */ \
195 "NFS req", /* 22 M_NFSREQ */ \
196 "NFS mount", /* 23 M_NFSMNT */ \
197 "NFS node", /* 24 M_NFSNODE */ \
198 "vnodes", /* 25 M_VNODE */ \
199 "namecache", /* 26 M_CACHE */ \
200 "UFS quota", /* 27 M_DQUOT */ \
201 "UFS mount", /* 28 M_UFSMNT */ \
202 "shm", /* 29 M_SHM */ \
203 "VM map", /* 30 M_VMMAP */ \
204 "VM mapent", /* 31 M_VMMAPENT */ \
205 "VM object", /* 32 M_VMOBJ */ \
206 "VM objhash", /* 33 M_VMOBJHASH */ \
207 "VM pmap", /* 34 M_VMPMAP */ \
208 "VM pvmap", /* 35 M_VMPVENT */ \
209 "VM pager", /* 36 M_VMPAGER */ \
210 "VM pgdata", /* 37 M_VMPGDATA */ \
211 "file", /* 38 M_FILE */ \
212 "file desc", /* 39 M_FILEDESC */ \
213 "lockf", /* 40 M_LOCKF */ \
214 "proc", /* 41 M_PROC */ \
215 "subproc", /* 42 M_SUBPROC */ \
216 "LFS segment", /* 43 M_SEGMENT */ \
217 "LFS node", /* 44 M_LFSNODE */ \
218 "FFS node", /* 45 M_FFSNODE */ \
219 "MFS node", /* 46 M_MFSNODE */ \
220 "NQNFS Lease", /* 47 M_NQLEASE */ \
221 "NQNFS Host", /* 48 M_NQMHOST */ \
222 "Export Host", /* 49 M_NETADDR */ \
223 "NFS srvsock", /* 50 M_NFSSVC */ \
224 "NFS uid", /* 51 M_NFSUID */ \
225 "NFS daemon", /* 52 M_NFSD */ \
226 "ip_moptions", /* 53 M_IPMOPTS */ \
227 "in_multi", /* 54 M_IPMADDR */ \
228 "ether_multi", /* 55 M_IFMADDR */ \
229 "mrt", /* 56 M_MRTABLE */ \
230 "ISOFS mount", /* 57 M_ISOFSMNT */ \
231 "ISOFS node", /* 58 M_ISOFSNODE */ \
232 "NFSV3 srvdesc",/* 59 M_NFSRVDESC */ \
233 "NFSV3 diroff", /* 60 M_NFSDIROFF */ \
234 "NFSV3 bigfh", /* 61 M_NFSBIGFH */ \
235 "MSDOSFS mount",/* 62 M_MSDOSFSMNT */ \
236 "MSDOSFS fat", /* 63 M_MSDOSFSFAT */ \
237 "MSDOSFS node", /* 64 M_MSDOSFSNODE */ \
238 "ttys", /* 65 M_TTYS */ \
239 "exec", /* 66 M_EXEC */ \
240 "miscfs mount", /* 67 M_MISCFSMNT */ \
241 "miscfs node", /* 68 M_MISCFSNODE */ \
242 "adosfs mount", /* 69 M_ADOSFSMNT */ \
243 "adosfs node", /* 70 M_ADOSFSNODE */ \
244 "adosfs anode", /* 71 M_ANODE */ \
245 "buf hdrs", /* 72 M_BUFHDR */ \
246 "ofile tabl", /* 73 M_OFILETABL */ \
247 "mbuf clust", /* 74 M_MCLUST */ \
248 "HFS mount", /* 75 M_HFSMNT */ \
9bccf70c
A
249 "HFS node", /* 76 M_HFSNODE */ \
250 "HFS fork", /* 77 M_HFSFORK */ \
1c79356b
A
251 "VOLFS mount", /* 78 M_VOLFSMNT */ \
252 "VOLFS node", /* 79 M_VOLFSNODE */ \
253 "temp", /* 80 M_TEMP */ \
254 "key mgmt", /* 81 M_SECA */ \
255 "DEVFS", /* 82 M_DEVFS */ \
256 "IpFw/IpAcct", /* 83 M_IPFW */ \
257 "UDF node", /* 84 M_UDFNODE */ \
258 "UDF mount" /* 85 M_UDFMNT */ \
259 "IPv6 NDP", /* 86 M_IP6NDP */ \
260 "IPv6 options", /* 87 M_IP6OPT */ \
9bccf70c
A
261 "IPv6 Misc" /* 88 M_IP6MISC */\
262 "TCP Segment Q" /* 89 M_TSEGQ */\
263 "IGMP state" /* 90 M_IGMP */\
1c79356b
A
264}
265
266struct kmemstats {
267 long ks_inuse; /* # of packets of this type currently
268 * in use */
269 long ks_calls; /* total packets of this type ever allocated */
270 long ks_memuse; /* total memory held in bytes */
271 u_short ks_limblocks; /* number of times blocked for hitting limit */
272 u_short ks_mapblocks; /* number of times blocked for kernel map */
273 long ks_maxused; /* maximum number ever used */
274 long ks_limit; /* most that are allowed to exist */
275 long ks_size; /* sizes of this thing that are allocated */
276 long ks_spare;
277};
278
279#ifdef KERNEL
9bccf70c 280#ifdef __APPLE_API_PRIVATE
1c79356b 281extern struct kmemstats kmemstats[];
9bccf70c 282#endif /* __APPLE_API_PRIVATE */
1c79356b
A
283
284/*
285 * The malloc/free primatives used
286 * by the BSD kernel code.
287 */
288#define MALLOC(space, cast, size, type, flags) \
289 (space) = (cast)_MALLOC(size, type, flags)
290
291#define FREE(addr, type) \
292 _FREE((void *)addr, type)
293
294#define MALLOC_ZONE(space, cast, size, type, flags) \
295 (space) = (cast)_MALLOC_ZONE(size, type, flags)
296
297#define FREE_ZONE(addr, size, type) \
298 _FREE_ZONE((void *)addr, size, type)
299
300extern void *_MALLOC __P((
301 size_t size,
302 int type,
303 int flags));
304
305extern void _FREE __P((
306 void *addr,
307 int type));
308
309extern void *_MALLOC_ZONE __P((
310 size_t size,
311 int type,
312 int flags));
313
314extern void _FREE_ZONE __P((
315 void *elem,
316 size_t size,
317 int type));
318
319#endif /* KERNEL */
320
321#endif /* _SYS_MALLOC_H_ */