malloc.h revision 31559
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: malloc.h,v 1.34 1997/12/05 18:58:13 bde 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#define	M_MAGIC		877983977	/* time when first defined :-) */
50
51struct malloc_type {
52	struct malloc_type *ks_next;	/* next in list */
53	long 	ks_memuse;	/* total memory held in bytes */
54	long	ks_limit;	/* most that are allowed to exist */
55	long	ks_size;	/* sizes of this thing that are allocated */
56	long	ks_inuse;	/* # of packets of this type currently in use */
57	long	ks_calls;	/* total packets of this type ever allocated */
58	long	ks_maxused;	/* maximum number ever used */
59	u_long	ks_magic;	/* if it's not magic, don't touch it */
60	const char *ks_shortdesc;	/* short description */
61	u_short	ks_limblocks;	/* number of times blocked for hitting limit */
62	u_short	ks_mapblocks;	/* number of times blocked for kernel map */
63};
64
65#define	MALLOC_DEFINE(type, shortdesc, longdesc) \
66	struct malloc_type type[1] = { \
67		{ NULL, 0, 0, 0, 0, 0, 0, M_MAGIC, shortdesc, 0, 0 } \
68	}; \
69	struct __hack
70
71#define	MALLOC_DECLARE(type) \
72	extern struct malloc_type type[1]; \
73	struct __hack
74
75#ifdef MALLOC_INSTANTIATE
76#define	MALLOC_MAKE_TYPE(type, shortdesc, longdesc) \
77	MALLOC_DEFINE(type, shortdesc, longdesc)
78#else
79#define	MALLOC_MAKE_TYPE(type, shortdesc, longdesc) \
80	MALLOC_DECLARE(type)
81#endif
82
83MALLOC_MAKE_TYPE(M_CACHE, "namecache", "Dynamically allocated cache entries");
84MALLOC_MAKE_TYPE(M_DEVBUF, "devbuf", "device driver memory");
85MALLOC_MAKE_TYPE(M_TEMP, "temp", "misc temporary data buffers");
86
87/*
88 * Array of descriptors that describe the contents of each page
89 */
90struct kmemusage {
91	short ku_indx;		/* bucket index */
92	union {
93		u_short freecnt;/* for small allocations, free pieces in page */
94		u_short pagecnt;/* for large allocations, pages alloced */
95	} ku_un;
96};
97#define ku_freecnt ku_un.freecnt
98#define ku_pagecnt ku_un.pagecnt
99
100/*
101 * Set of buckets for each size of memory block that is retained
102 */
103struct kmembuckets {
104	caddr_t kb_next;	/* list of free blocks */
105	caddr_t kb_last;	/* last free block */
106	long	kb_total;	/* total number of blocks allocated */
107	long	kb_elmpercl;	/* # of elements in this sized allocation */
108	long	kb_totalfree;	/* # of free elements in this bucket */
109	long	kb_calls;	/* total calls to allocate this size */
110	long	kb_highwat;	/* high water mark */
111	long	kb_couldfree;	/* over high water mark and could free */
112};
113
114#ifdef KERNEL
115
116#include <vm/vm_zone.h>
117
118#define	MINALLOCSIZE	(1 << MINBUCKET)
119#define BUCKETINDX(size) \
120	((size) <= (MINALLOCSIZE * 128) \
121		? (size) <= (MINALLOCSIZE * 8) \
122			? (size) <= (MINALLOCSIZE * 2) \
123				? (size) <= (MINALLOCSIZE * 1) \
124					? (MINBUCKET + 0) \
125					: (MINBUCKET + 1) \
126				: (size) <= (MINALLOCSIZE * 4) \
127					? (MINBUCKET + 2) \
128					: (MINBUCKET + 3) \
129			: (size) <= (MINALLOCSIZE* 32) \
130				? (size) <= (MINALLOCSIZE * 16) \
131					? (MINBUCKET + 4) \
132					: (MINBUCKET + 5) \
133				: (size) <= (MINALLOCSIZE * 64) \
134					? (MINBUCKET + 6) \
135					: (MINBUCKET + 7) \
136		: (size) <= (MINALLOCSIZE * 2048) \
137			? (size) <= (MINALLOCSIZE * 512) \
138				? (size) <= (MINALLOCSIZE * 256) \
139					? (MINBUCKET + 8) \
140					: (MINBUCKET + 9) \
141				: (size) <= (MINALLOCSIZE * 1024) \
142					? (MINBUCKET + 10) \
143					: (MINBUCKET + 11) \
144			: (size) <= (MINALLOCSIZE * 8192) \
145				? (size) <= (MINALLOCSIZE * 4096) \
146					? (MINBUCKET + 12) \
147					: (MINBUCKET + 13) \
148				: (size) <= (MINALLOCSIZE * 16384) \
149					? (MINBUCKET + 14) \
150					: (MINBUCKET + 15))
151
152/*
153 * Turn virtual addresses into kmem map indices
154 */
155#define kmemxtob(alloc)	(kmembase + (alloc) * PAGE_SIZE)
156#define btokmemx(addr)	(((caddr_t)(addr) - kmembase) / PAGE_SIZE)
157#define btokup(addr)	(&kmemusage[(caddr_t)(addr) - kmembase >> PAGE_SHIFT])
158
159/*
160 * Macro versions for the usual cases of malloc/free
161 */
162#if defined(KMEMSTATS) || defined(DIAGNOSTIC)
163#define	MALLOC(space, cast, size, type, flags) \
164	(space) = (cast)malloc((u_long)(size), type, flags)
165#define FREE(addr, type) free((addr), type)
166
167#else /* do not collect statistics */
168#define	MALLOC(space, cast, size, type, flags) do { \
169	register struct kmembuckets *kbp = &bucket[BUCKETINDX(size)]; \
170	long s = splimp(); \
171	if (kbp->kb_next == NULL) { \
172		(space) = (cast)malloc((u_long)(size), type, flags); \
173	} else { \
174		(space) = (cast)kbp->kb_next; \
175		kbp->kb_next = *(caddr_t *)(space); \
176	} \
177	splx(s); \
178} while (0)
179
180#define	FREE(addr, type) do { \
181	register struct kmembuckets *kbp; \
182	register struct kmemusage *kup = btokup(addr); \
183	long s = splimp(); \
184	if (1 << kup->ku_indx > MAXALLOCSAVE) { \
185		free((addr), type); \
186	} else { \
187		kbp = &bucket[kup->ku_indx]; \
188		if (kbp->kb_next == NULL) \
189			kbp->kb_next = (caddr_t)(addr); \
190		else \
191			*(caddr_t *)(kbp->kb_last) = (caddr_t)(addr); \
192		*(caddr_t *)(addr) = NULL; \
193		kbp->kb_last = (caddr_t)(addr); \
194	} \
195	splx(s); \
196} while (0)
197
198extern struct kmemusage *kmemusage;
199extern char *kmembase;
200extern struct kmembuckets bucket[];
201#endif /* do not collect statistics */
202
203/*
204 * XXX this should be declared in <sys/uio.h>, but that tends to fail
205 * because <sys/uio.h> is included in a header before the source file
206 * has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined.
207 */
208MALLOC_DECLARE(M_IOV);
209
210void	*contigmalloc __P((unsigned long size, struct malloc_type *type,
211			   int flags,
212			   unsigned long low, unsigned long high,
213			   unsigned long alignment, unsigned long boundary));
214void	free __P((void *addr, struct malloc_type *type));
215void	*malloc __P((unsigned long size, struct malloc_type *type, int flags));
216#endif /* KERNEL */
217
218#endif /* !_SYS_MALLOC_H_ */
219