malloc.h revision 22975 
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 * $Id$
35 */
36
37#ifndef _SYS_MALLOC_H_
38#define	_SYS_MALLOC_H_
39
40#define KMEMSTATS
41
42/*
43 * flags to malloc
44 */
45#define	M_WAITOK	0x0000
46#define	M_NOWAIT	0x0001
47#define M_KERNEL	0x0002
48
49/*
50 * Types of memory to be allocated
51 */
52#define	M_FREE		0	/* should be on free list */
53#define	M_MBUF		1	/* mbuf */
54#define	M_DEVBUF	2	/* device driver memory */
55#define	M_SOCKET	3	/* socket structure */
56#define	M_PCB		4	/* protocol control block */
57#define	M_RTABLE	5	/* routing tables */
58#define	M_HTABLE	6	/* IMP host tables */
59#define	M_FTABLE	7	/* fragment reassembly header */
60#define	M_ZOMBIE	8	/* zombie proc status */
61#define	M_IFADDR	9	/* interface address */
62#define	M_SOOPTS	10	/* socket options */
63#define	M_SONAME	11	/* socket name */
64#define	M_NAMEI		12	/* namei path name buffer */
65#define	M_GPROF		13	/* kernel profiling buffer */
66#define	M_IOCTLOPS	14	/* ioctl data buffer */
67#define	M_MAPMEM	15	/* mapped memory descriptors */
68#define	M_CRED		16	/* credentials */
69#define	M_PGRP		17	/* process group header */
70#define	M_SESSION	18	/* session header */
71#define	M_IOV		19	/* large iov's */
72#define	M_MOUNT		20	/* vfs mount struct */
73#define	M_FHANDLE	21	/* network file handle */
74#define	M_NFSREQ	22	/* NFS request header */
75#define	M_NFSMNT	23	/* NFS mount structure */
76#define	M_NFSNODE	24	/* NFS vnode private part */
77#define	M_VNODE		25	/* Dynamically allocated vnodes */
78#define	M_CACHE		26	/* Dynamically allocated cache entries */
79#define	M_DQUOT		27	/* UFS quota entries */
80#define	M_UFSMNT	28	/* UFS mount structure */
81#define	M_SHM		29	/* SVID compatible shared memory segments */
82#define	M_VMMAP		30	/* VM map structures */
83#define	M_VMMAPENT	31	/* VM map entry structures */
84#define	M_VMOBJ		32	/* VM object structure */
85#define	M_VMOBJHASH	33	/* VM object hash structure */
86#define	M_VMPMAP	34	/* VM pmap */
87#define	M_VMPVENT	35	/* VM phys-virt mapping entry */
88#define	M_VMPAGER	36	/* XXX: VM pager struct */
89#define	M_VMPGDATA	37	/* XXX: VM pager private data */
90#define	M_FILE		38	/* Open file structure */
91#define	M_FILEDESC	39	/* Open file descriptor table */
92#define	M_LOCKF		40	/* Byte-range locking structures */
93#define	M_PROC		41	/* Proc structures */
94#define	M_SUBPROC	42	/* Proc sub-structures */
95#define	M_SEGMENT	43	/* Segment for LFS */
96#define	M_LFSNODE	44	/* LFS vnode private part */
97#define	M_FFSNODE	45	/* FFS vnode private part */
98#define	M_MFSNODE	46	/* MFS vnode private part */
99#define	M_NQLEASE	47	/* Nqnfs lease */
100#define	M_NQMHOST	48	/* Nqnfs host address table */
101#define	M_NETADDR	49	/* Export host address structure */
102#define	M_NFSSVC	50	/* Nfs server structure */
103#define	M_NFSUID	51	/* Nfs uid mapping structure */
104#define	M_NFSD		52	/* Nfs server daemon structure */
105#define	M_IPMOPTS	53	/* internet multicast options */
106#define	M_IPMADDR	54	/* internet multicast address */
107#define	M_IFMADDR	55	/* link-level multicast address */
108#define	M_MRTABLE	56	/* multicast routing tables */
109#define M_ISOFSMNT	57	/* ISOFS mount structure */
110#define M_ISOFSNODE	58	/* ISOFS vnode private part */
111#define M_NFSRVDESC	59	/* NFS server socket descriptor */
112#define M_NFSDIROFF	60	/* NFS directory offset data */
113#define M_NFSBIGFH	61	/* NFS version 3 file handle */
114#define M_MSDOSFSMNT	67	/* MSDOSFS mount structure */
115#define M_MSDOSFSNODE	68	/* MSDOSFS vnode private part */
116#define M_MSDOSFSFAT	69	/* MSDOSFS file allocation table */
117#define M_DEVFSMNT	70	/* DEVFS mount structure */
118#define M_DEVFSBACK	71	/* DEVFS Back node */
119#define M_DEVFSFRONT	72	/* DEVFS Front node */
120#define M_DEVFSNODE	73	/* DEVFS node */
121#define	M_TEMP		74	/* misc temporary data buffers */
122#define M_TTYS		75	/* tty data structures */
123#define M_GZIP		76	/* Gzip trees */
124#define M_IPFW		77	/* IpFw/IpAcct chain's */
125#define M_DEVL		78	/* isa_device lists in userconfig() */
126#define M_PKTCLASS	79	/* structures used in packet classifier */
127#define	M_SYSCTL	80	/* sysctl internal magic */
128#define	M_SECA		81	/* security associations, key management */
129#define	M_BIOBUF	82	/* BIO buffer */
130#define	M_KTRACE	83	/* KTRACE */
131#define	M_SELECT	84	/* select() buffer */
132#define	M_GEOM_DEV	85	/* geometry device */
133#define	M_GEOM_MOD	86	/* geometry module */
134#define	M_GEOM_REQ	87	/* geometry request */
135#define	M_GEOM_MISC	88	/* geometry misc */
136#define M_VFSCONF	89	/* vfsconf structure */
137#define	M_LAST		90	/* Must be last type + 1 */
138
139#define INITKMEMNAMES { \
140	"free",		/* 0 M_FREE */ \
141	"mbuf",		/* 1 M_MBUF */ \
142	"devbuf",	/* 2 M_DEVBUF */ \
143	"socket",	/* 3 M_SOCKET */ \
144	"pcb",		/* 4 M_PCB */ \
145	"routetbl",	/* 5 M_RTABLE */ \
146	"hosttbl",	/* 6 M_HTABLE */ \
147	"fragtbl",	/* 7 M_FTABLE */ \
148	"zombie",	/* 8 M_ZOMBIE */ \
149	"ifaddr",	/* 9 M_IFADDR */ \
150	"soopts",	/* 10 M_SOOPTS */ \
151	"soname",	/* 11 M_SONAME */ \
152	"namei",	/* 12 M_NAMEI */ \
153	"gprof",	/* 13 M_GPROF */ \
154	"ioctlops",	/* 14 M_IOCTLOPS */ \
155	"mapmem",	/* 15 M_MAPMEM */ \
156	"cred",		/* 16 M_CRED */ \
157	"pgrp",		/* 17 M_PGRP */ \
158	"session",	/* 18 M_SESSION */ \
159	"iov",		/* 19 M_IOV */ \
160	"mount",	/* 20 M_MOUNT */ \
161	"fhandle",	/* 21 M_FHANDLE */ \
162	"NFS req",	/* 22 M_NFSREQ */ \
163	"NFS mount",	/* 23 M_NFSMNT */ \
164	"NFS node",	/* 24 M_NFSNODE */ \
165	"vnodes",	/* 25 M_VNODE */ \
166	"namecache",	/* 26 M_CACHE */ \
167	"UFS quota",	/* 27 M_DQUOT */ \
168	"UFS mount",	/* 28 M_UFSMNT */ \
169	"shm",		/* 29 M_SHM */ \
170	"VM map",	/* 30 M_VMMAP */ \
171	"VM mapent",	/* 31 M_VMMAPENT */ \
172	"VM object",	/* 32 M_VMOBJ */ \
173	"VM objhash",	/* 33 M_VMOBJHASH */ \
174	"VM pmap",	/* 34 M_VMPMAP */ \
175	"VM pvmap",	/* 35 M_VMPVENT */ \
176	"VM pager",	/* 36 M_VMPAGER */ \
177	"VM pgdata",	/* 37 M_VMPGDATA */ \
178	"file",		/* 38 M_FILE */ \
179	"file desc",	/* 39 M_FILEDESC */ \
180	"lockf",	/* 40 M_LOCKF */ \
181	"proc",		/* 41 M_PROC */ \
182	"subproc",	/* 42 M_SUBPROC */ \
183	"LFS segment",	/* 43 M_SEGMENT */ \
184	"LFS node",	/* 44 M_LFSNODE */ \
185	"FFS node",	/* 45 M_FFSNODE */ \
186	"MFS node",	/* 46 M_MFSNODE */ \
187	"NQNFS Lease",	/* 47 M_NQLEASE */ \
188	"NQNFS Host",	/* 48 M_NQMHOST */ \
189	"Export Host",	/* 49 M_NETADDR */ \
190	"NFS srvsock",	/* 50 M_NFSSVC */ \
191	"NFS uid",	/* 51 M_NFSUID */ \
192	"NFS daemon",	/* 52 M_NFSD */ \
193	"ip_moptions",	/* 53 M_IPMOPTS */ \
194	"in_multi",	/* 54 M_IPMADDR */ \
195	"ether_multi",	/* 55 M_IFMADDR */ \
196	"mrt",		/* 56 M_MRTABLE */ \
197	"ISOFS mount",	/* 57 M_ISOFSMNT */ \
198	"ISOFS node",	/* 58 M_ISOFSNODE */ \
199	"NFSV3 srvdesc",/* 59 M_NFSRVDESC */ \
200	"NFSV3 diroff",	/* 60 M_NFSDIROFF */ \
201	"NFSV3 bigfh",	/* 61 M_NFSBIGFH */ \
202	NULL, \
203	NULL, NULL, NULL, NULL, \
204	"MSDOSFS mount",/* 67 M_MSDOSFSMNT */ \
205	"MSDOSFS node",	/* 68 M_MSDOSFSNODE */ \
206	"MSDOSFS FAT",  /* 69 M_MSDOSFSFAR */ \
207	"DEVFS mount",	/* 70 M_DEVFSMNT */ \
208	"DEVFS back",	/* 71 M_DEVFSBACK */ \
209	"DEVFS front",	/* 72 M_DEVFSFRONT */ \
210	"DEVFS node",	/* 73 M_DEVFSNODE */ \
211	"temp",		/* 74 M_TEMP */ \
212	"ttys",		/* 75 M_TTYS */ \
213	"Gzip trees",	/* 76 M_GZIP */ \
214	"IpFw/IpAcct",	/* 77 M_IPFW */ \
215	"isa_devlist",	/* 78 M_DEVL */ \
216	"PktClass",	/* 79 M_PKTCLASS */ \
217	"sysctl",	/* 80 M_SYSCTL */ \
218	"key mgmt",	/* 81 M_SECA */ \
219	"BIO buffer",	/* 82 M_BIOBUF */ \
220	"KTRACE",	/* 83 M_KTRACE */ \
221	"select",	/* 84 M_SELECT */ \
222	"GEOM dev",	/* 85 M_GEOM_DEV */ \
223	"GEOM mod",	/* 86 M_GEOM_MOD */ \
224	"GEOM req",	/* 87 M_GEOM_REQ */ \
225	"GEOM misc",	/* 88 M_GEOM_MISC */ \
226	"VFS conf",	/* 89 M_VFSCONF */ \
227}
228
229struct kmemstats {
230	long	ks_inuse;	/* # of packets of this type currently in use */
231	long	ks_calls;	/* total packets of this type ever allocated */
232	long 	ks_memuse;	/* total memory held in bytes */
233	u_short	ks_limblocks;	/* number of times blocked for hitting limit */
234	u_short	ks_mapblocks;	/* number of times blocked for kernel map */
235	long	ks_maxused;	/* maximum number ever used */
236	long	ks_limit;	/* most that are allowed to exist */
237	long	ks_size;	/* sizes of this thing that are allocated */
238	long	ks_spare;
239};
240
241/*
242 * Array of descriptors that describe the contents of each page
243 */
244struct kmemusage {
245	short ku_indx;		/* bucket index */
246	union {
247		u_short freecnt;/* for small allocations, free pieces in page */
248		u_short pagecnt;/* for large allocations, pages alloced */
249	} ku_un;
250};
251#define ku_freecnt ku_un.freecnt
252#define ku_pagecnt ku_un.pagecnt
253
254/*
255 * Set of buckets for each size of memory block that is retained
256 */
257struct kmembuckets {
258	caddr_t kb_next;	/* list of free blocks */
259	caddr_t kb_last;	/* last free block */
260	long	kb_calls;	/* total calls to allocate this size */
261	long	kb_total;	/* total number of blocks allocated */
262	long	kb_totalfree;	/* # of free elements in this bucket */
263	long	kb_elmpercl;	/* # of elements in this sized allocation */
264	long	kb_highwat;	/* high water mark */
265	long	kb_couldfree;	/* over high water mark and could free */
266};
267
268#ifdef KERNEL
269#define	MINALLOCSIZE	(1 << MINBUCKET)
270#define BUCKETINDX(size) \
271	((size) <= (MINALLOCSIZE * 128) \
272		? (size) <= (MINALLOCSIZE * 8) \
273			? (size) <= (MINALLOCSIZE * 2) \
274				? (size) <= (MINALLOCSIZE * 1) \
275					? (MINBUCKET + 0) \
276					: (MINBUCKET + 1) \
277				: (size) <= (MINALLOCSIZE * 4) \
278					? (MINBUCKET + 2) \
279					: (MINBUCKET + 3) \
280			: (size) <= (MINALLOCSIZE* 32) \
281				? (size) <= (MINALLOCSIZE * 16) \
282					? (MINBUCKET + 4) \
283					: (MINBUCKET + 5) \
284				: (size) <= (MINALLOCSIZE * 64) \
285					? (MINBUCKET + 6) \
286					: (MINBUCKET + 7) \
287		: (size) <= (MINALLOCSIZE * 2048) \
288			? (size) <= (MINALLOCSIZE * 512) \
289				? (size) <= (MINALLOCSIZE * 256) \
290					? (MINBUCKET + 8) \
291					: (MINBUCKET + 9) \
292				: (size) <= (MINALLOCSIZE * 1024) \
293					? (MINBUCKET + 10) \
294					: (MINBUCKET + 11) \
295			: (size) <= (MINALLOCSIZE * 8192) \
296				? (size) <= (MINALLOCSIZE * 4096) \
297					? (MINBUCKET + 12) \
298					: (MINBUCKET + 13) \
299				: (size) <= (MINALLOCSIZE * 16384) \
300					? (MINBUCKET + 14) \
301					: (MINBUCKET + 15))
302
303/*
304 * Turn virtual addresses into kmem map indices
305 */
306#define kmemxtob(alloc)	(kmembase + (alloc) * PAGE_SIZE)
307#define btokmemx(addr)	(((caddr_t)(addr) - kmembase) / PAGE_SIZE)
308#define btokup(addr)	(&kmemusage[(caddr_t)(addr) - kmembase >> PAGE_SHIFT])
309
310/*
311 * Macro versions for the usual cases of malloc/free
312 */
313#if defined(KMEMSTATS) || defined(DIAGNOSTIC)
314#define	MALLOC(space, cast, size, type, flags) \
315	(space) = (cast)malloc((u_long)(size), type, flags)
316#define FREE(addr, type) free((addr), type)
317
318#else /* do not collect statistics */
319#define	MALLOC(space, cast, size, type, flags) { \
320	register struct kmembuckets *kbp = &bucket[BUCKETINDX(size)]; \
321	long s = splimp(); \
322	if (kbp->kb_next == NULL) { \
323		(space) = (cast)malloc((u_long)(size), type, flags); \
324	} else { \
325		(space) = (cast)kbp->kb_next; \
326		kbp->kb_next = *(caddr_t *)(space); \
327	} \
328	splx(s); \
329}
330
331#define FREE(addr, type) { \
332	register struct kmembuckets *kbp; \
333	register struct kmemusage *kup = btokup(addr); \
334	long s = splimp(); \
335	if (1 << kup->ku_indx > MAXALLOCSAVE) { \
336		free((addr), type); \
337	} else { \
338		kbp = &bucket[kup->ku_indx]; \
339		if (kbp->kb_next == NULL) \
340			kbp->kb_next = (caddr_t)(addr); \
341		else \
342			*(caddr_t *)(kbp->kb_last) = (caddr_t)(addr); \
343		*(caddr_t *)(addr) = NULL; \
344		kbp->kb_last = (caddr_t)(addr); \
345	} \
346	splx(s); \
347}
348#endif /* do not collect statistics */
349
350extern struct kmemstats kmemstats[];
351extern struct kmemusage *kmemusage;
352extern char *kmembase;
353extern struct kmembuckets bucket[];
354
355void	*contigmalloc __P((unsigned long size, int type, int flags,
356			   unsigned long low, unsigned long high,
357			   unsigned long alignment, unsigned long boundary));
358void	free __P((void *addr, int type));
359void	*malloc __P((unsigned long size, int type, int flags));
360#endif /* KERNEL */
361
362#endif /* !_SYS_MALLOC_H_ */
363