malloc.h revision 13642
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.3 (Berkeley) 1/12/94
34 * $Id: malloc.h,v 1.10 1995/12/02 20:40:12 phk Exp $
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_MSDOSFSMNT	59	/* MSDOSFS mount structure */
112#define M_MSDOSFSNODE	60	/* MSDOSFS vnode private part */
113#define M_MSDOSFSFAT	61	/* MSDOSFS file allocation table */
114#define M_DEVFSMNT	62	/* DEVFS mount structure */
115#define M_DEVFSBACK	63	/* DEVFS Back node */
116#define M_DEVFSFRONT	64	/* DEVFS Front node */
117#define M_DEVFSNODE	65	/* DEVFS node */
118#define	M_TEMP		74	/* misc temporary data buffers */
119#define M_TTYS		75	/* tty data structures */
120#define M_GZIP		76	/* Gzip trees */
121#define M_IPFW		77	/* IpFw/IpAcct chain's */
122#define M_DEVL		78	/* isa_device lists in userconfig() */
123#define M_PKTCLASS	79	/* structures used in packet classifier */
124#define	M_SYSCTL	80	/* sysctl internal magic */
125#define	M_LAST		81	/* Must be last type + 1 */
126
127#define INITKMEMNAMES { \
128	"free",		/* 0 M_FREE */ \
129	"mbuf",		/* 1 M_MBUF */ \
130	"devbuf",	/* 2 M_DEVBUF */ \
131	"socket",	/* 3 M_SOCKET */ \
132	"pcb",		/* 4 M_PCB */ \
133	"routetbl",	/* 5 M_RTABLE */ \
134	"hosttbl",	/* 6 M_HTABLE */ \
135	"fragtbl",	/* 7 M_FTABLE */ \
136	"zombie",	/* 8 M_ZOMBIE */ \
137	"ifaddr",	/* 9 M_IFADDR */ \
138	"soopts",	/* 10 M_SOOPTS */ \
139	"soname",	/* 11 M_SONAME */ \
140	"namei",	/* 12 M_NAMEI */ \
141	"gprof",	/* 13 M_GPROF */ \
142	"ioctlops",	/* 14 M_IOCTLOPS */ \
143	"mapmem",	/* 15 M_MAPMEM */ \
144	"cred",		/* 16 M_CRED */ \
145	"pgrp",		/* 17 M_PGRP */ \
146	"session",	/* 18 M_SESSION */ \
147	"iov",		/* 19 M_IOV */ \
148	"mount",	/* 20 M_MOUNT */ \
149	"fhandle",	/* 21 M_FHANDLE */ \
150	"NFS req",	/* 22 M_NFSREQ */ \
151	"NFS mount",	/* 23 M_NFSMNT */ \
152	"NFS node",	/* 24 M_NFSNODE */ \
153	"vnodes",	/* 25 M_VNODE */ \
154	"namecache",	/* 26 M_CACHE */ \
155	"UFS quota",	/* 27 M_DQUOT */ \
156	"UFS mount",	/* 28 M_UFSMNT */ \
157	"shm",		/* 29 M_SHM */ \
158	"VM map",	/* 30 M_VMMAP */ \
159	"VM mapent",	/* 31 M_VMMAPENT */ \
160	"VM object",	/* 32 M_VMOBJ */ \
161	"VM objhash",	/* 33 M_VMOBJHASH */ \
162	"VM pmap",	/* 34 M_VMPMAP */ \
163	"VM pvmap",	/* 35 M_VMPVENT */ \
164	"VM pager",	/* 36 M_VMPAGER */ \
165	"VM pgdata",	/* 37 M_VMPGDATA */ \
166	"file",		/* 38 M_FILE */ \
167	"file desc",	/* 39 M_FILEDESC */ \
168	"lockf",	/* 40 M_LOCKF */ \
169	"proc",		/* 41 M_PROC */ \
170	"subproc",	/* 42 M_SUBPROC */ \
171	"LFS segment",	/* 43 M_SEGMENT */ \
172	"LFS node",	/* 44 M_LFSNODE */ \
173	"FFS node",	/* 45 M_FFSNODE */ \
174	"MFS node",	/* 46 M_MFSNODE */ \
175	"NQNFS Lease",	/* 47 M_NQLEASE */ \
176	"NQNFS Host",	/* 48 M_NQMHOST */ \
177	"Export Host",	/* 49 M_NETADDR */ \
178	"NFS srvsock",	/* 50 M_NFSSVC */ \
179	"NFS uid",	/* 51 M_NFSUID */ \
180	"NFS daemon",	/* 52 M_NFSD */ \
181	"ip_moptions",	/* 53 M_IPMOPTS */ \
182	"in_multi",	/* 54 M_IPMADDR */ \
183	"ether_multi",	/* 55 M_IFMADDR */ \
184	"mrt",		/* 56 M_MRTABLE */ \
185	"ISOFS mount",	/* 57 M_ISOFSMNT */ \
186	"ISOFS node",	/* 58 M_ISOFSNODE */ \
187	"MSDOSFS mount",/* 59 M_MSDOSFSMNT */ \
188	"MSDOSFS node",	/* 60 M_MSDOSFSNODE */ \
189	"MSDOSFS FAT",  /* 61 M_MSDOSFSFAR */ \
190	"DEVFS mount",	/* 62 M_DEVFSMNT */ \
191	"DEVFS back",	/* 63 M_DEVFSBACK */ \
192	"DEVFS front",	/* 64 M_DEVFSFRONT */ \
193	"DEVFS node",	/* 65 M_DEVFSNODE */ \
194	NULL, \
195	NULL, NULL, NULL, NULL, NULL, \
196	NULL, NULL, \
197	"temp",		/* 74 M_TEMP */ \
198	"ttys",		/* 75 M_TTYS */ \
199	"Gzip trees",	/* 76 M_GZIP */ \
200	"IpFw/IpAcct",	/* 77 M_IPFW */ \
201	"isa_devlist",	/* 78 M_DEVL */ \
202	"PktClass",	/* 79 M_PKTCLASS */ \
203	"sysctl",	/* 80 M_SYSCTL */ \
204}
205
206struct kmemstats {
207	long	ks_inuse;	/* # of packets of this type currently in use */
208	long	ks_calls;	/* total packets of this type ever allocated */
209	long 	ks_memuse;	/* total memory held in bytes */
210	u_short	ks_limblocks;	/* number of times blocked for hitting limit */
211	u_short	ks_mapblocks;	/* number of times blocked for kernel map */
212	long	ks_maxused;	/* maximum number ever used */
213	long	ks_limit;	/* most that are allowed to exist */
214	long	ks_size;	/* sizes of this thing that are allocated */
215	long	ks_spare;
216};
217
218/*
219 * Array of descriptors that describe the contents of each page
220 */
221struct kmemusage {
222	short ku_indx;		/* bucket index */
223	union {
224		u_short freecnt;/* for small allocations, free pieces in page */
225		u_short pagecnt;/* for large allocations, pages alloced */
226	} ku_un;
227};
228#define ku_freecnt ku_un.freecnt
229#define ku_pagecnt ku_un.pagecnt
230
231/*
232 * Set of buckets for each size of memory block that is retained
233 */
234struct kmembuckets {
235	caddr_t kb_next;	/* list of free blocks */
236	caddr_t kb_last;	/* last free block */
237	long	kb_calls;	/* total calls to allocate this size */
238	long	kb_total;	/* total number of blocks allocated */
239	long	kb_totalfree;	/* # of free elements in this bucket */
240	long	kb_elmpercl;	/* # of elements in this sized allocation */
241	long	kb_highwat;	/* high water mark */
242	long	kb_couldfree;	/* over high water mark and could free */
243};
244
245#ifdef KERNEL
246#define	MINALLOCSIZE	(1 << MINBUCKET)
247#define BUCKETINDX(size) \
248	(size) <= (MINALLOCSIZE * 128) \
249		? (size) <= (MINALLOCSIZE * 8) \
250			? (size) <= (MINALLOCSIZE * 2) \
251				? (size) <= (MINALLOCSIZE * 1) \
252					? (MINBUCKET + 0) \
253					: (MINBUCKET + 1) \
254				: (size) <= (MINALLOCSIZE * 4) \
255					? (MINBUCKET + 2) \
256					: (MINBUCKET + 3) \
257			: (size) <= (MINALLOCSIZE* 32) \
258				? (size) <= (MINALLOCSIZE * 16) \
259					? (MINBUCKET + 4) \
260					: (MINBUCKET + 5) \
261				: (size) <= (MINALLOCSIZE * 64) \
262					? (MINBUCKET + 6) \
263					: (MINBUCKET + 7) \
264		: (size) <= (MINALLOCSIZE * 2048) \
265			? (size) <= (MINALLOCSIZE * 512) \
266				? (size) <= (MINALLOCSIZE * 256) \
267					? (MINBUCKET + 8) \
268					: (MINBUCKET + 9) \
269				: (size) <= (MINALLOCSIZE * 1024) \
270					? (MINBUCKET + 10) \
271					: (MINBUCKET + 11) \
272			: (size) <= (MINALLOCSIZE * 8192) \
273				? (size) <= (MINALLOCSIZE * 4096) \
274					? (MINBUCKET + 12) \
275					: (MINBUCKET + 13) \
276				: (size) <= (MINALLOCSIZE * 16384) \
277					? (MINBUCKET + 14) \
278					: (MINBUCKET + 15)
279
280/*
281 * Turn virtual addresses into kmem map indices
282 */
283#define kmemxtob(alloc)	(kmembase + (alloc) * NBPG)
284#define btokmemx(addr)	(((caddr_t)(addr) - kmembase) / NBPG)
285#define btokup(addr)	(&kmemusage[((caddr_t)(addr) - kmembase) >> CLSHIFT])
286
287/*
288 * Macro versions for the usual cases of malloc/free
289 */
290#if defined(KMEMSTATS) || defined(DIAGNOSTIC)
291#define	MALLOC(space, cast, size, type, flags) \
292	(space) = (cast)malloc((u_long)(size), type, flags)
293#define FREE(addr, type) free((addr), type)
294
295#else /* do not collect statistics */
296#define	MALLOC(space, cast, size, type, flags) { \
297	register struct kmembuckets *kbp = &bucket[BUCKETINDX(size)]; \
298	long s = splimp(); \
299	if (kbp->kb_next == NULL) { \
300		(space) = (cast)malloc((u_long)(size), type, flags); \
301	} else { \
302		(space) = (cast)kbp->kb_next; \
303		kbp->kb_next = *(caddr_t *)(space); \
304	} \
305	splx(s); \
306}
307
308#define FREE(addr, type) { \
309	register struct kmembuckets *kbp; \
310	register struct kmemusage *kup = btokup(addr); \
311	long s = splimp(); \
312	if (1 << kup->ku_indx > MAXALLOCSAVE) { \
313		free((addr), type); \
314	} else { \
315		kbp = &bucket[kup->ku_indx]; \
316		if (kbp->kb_next == NULL) \
317			kbp->kb_next = (caddr_t)(addr); \
318		else \
319			*(caddr_t *)(kbp->kb_last) = (caddr_t)(addr); \
320		*(caddr_t *)(addr) = NULL; \
321		kbp->kb_last = (caddr_t)(addr); \
322	} \
323	splx(s); \
324}
325#endif /* do not collect statistics */
326
327extern struct kmemstats kmemstats[];
328extern struct kmemusage *kmemusage;
329extern char *kmembase;
330extern struct kmembuckets bucket[];
331
332void	*contigmalloc __P((unsigned long size, int type, int flags,
333			   unsigned long low, unsigned long high,
334			   unsigned long alignment, unsigned long boundary));
335void	free __P((void *addr, int type));
336void	*malloc __P((unsigned long size, int type, int flags));
337#endif /* KERNEL */
338
339#endif /* !_SYS_MALLOC_H_ */
340