malloc.h revision 61680
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: head/sys/sys/malloc.h 61680 2000-06-14 17:11:47Z bde $
35 */
36
37#ifndef _SYS_MALLOC_H_
38#define	_SYS_MALLOC_H_
39
40#define splmem splhigh
41
42/*
43 * flags to malloc.
44 */
45#define	M_WAITOK	0x0000
46#define	M_NOWAIT	0x0001		/* do not block */
47#define	M_USE_RESERVE	0x0002		/* can alloc out of reserve memory */
48#define	M_ASLEEP	0x0004		/* async sleep on failure */
49
50#define	M_MAGIC		877983977	/* time when first defined :-) */
51
52struct malloc_type {
53	struct malloc_type *ks_next;	/* next in list */
54	long 	ks_memuse;	/* total memory held in bytes */
55	long	ks_limit;	/* most that are allowed to exist */
56	long	ks_size;	/* sizes of this thing that are allocated */
57	long	ks_inuse;	/* # of packets of this type currently in use */
58	int64_t	ks_calls;	/* total packets of this type ever allocated */
59	long	ks_maxused;	/* maximum number ever used */
60	u_long	ks_magic;	/* if it's not magic, don't touch it */
61	const char *ks_shortdesc;	/* short description */
62	u_short	ks_limblocks;	/* number of times blocked for hitting limit */
63	u_short	ks_mapblocks;	/* number of times blocked for kernel map */
64};
65
66#ifdef _KERNEL
67#define	MALLOC_DEFINE(type, shortdesc, longdesc) \
68	struct malloc_type type[1] = { \
69		{ NULL, 0, 0, 0, 0, 0, 0, M_MAGIC, shortdesc, 0, 0 } \
70	}; \
71	SYSINIT(type##_init, SI_SUB_KMEM, SI_ORDER_ANY, malloc_init, type); \
72	SYSUNINIT(type##_uninit, SI_SUB_KMEM, SI_ORDER_ANY, malloc_uninit, type)
73
74#define	MALLOC_DECLARE(type) \
75	extern struct malloc_type type[1]
76
77MALLOC_DECLARE(M_CACHE);
78MALLOC_DECLARE(M_DEVBUF);
79MALLOC_DECLARE(M_TEMP);
80
81MALLOC_DECLARE(M_IP6OPT); /* for INET6 */
82MALLOC_DECLARE(M_IP6NDP); /* for INET6 */
83#endif /* _KERNEL */
84
85/*
86 * Array of descriptors that describe the contents of each page
87 */
88struct kmemusage {
89	short ku_indx;		/* bucket index */
90	union {
91		u_short freecnt;/* for small allocations, free pieces in page */
92		u_short pagecnt;/* for large allocations, pages alloced */
93	} ku_un;
94};
95#define ku_freecnt ku_un.freecnt
96#define ku_pagecnt ku_un.pagecnt
97
98/*
99 * Set of buckets for each size of memory block that is retained
100 */
101struct kmembuckets {
102	caddr_t kb_next;	/* list of free blocks */
103	caddr_t kb_last;	/* last free block */
104	int64_t	kb_calls;	/* total calls to allocate this size */
105	long	kb_total;	/* total number of blocks allocated */
106	long	kb_elmpercl;	/* # of elements in this sized allocation */
107	long	kb_totalfree;	/* # of free elements in this bucket */
108	long	kb_highwat;	/* high water mark */
109	long	kb_couldfree;	/* over high water mark and could free */
110};
111
112#ifdef _KERNEL
113#define	MINALLOCSIZE	(1 << MINBUCKET)
114#define BUCKETINDX(size) \
115	((size) <= (MINALLOCSIZE * 128) \
116		? (size) <= (MINALLOCSIZE * 8) \
117			? (size) <= (MINALLOCSIZE * 2) \
118				? (size) <= (MINALLOCSIZE * 1) \
119					? (MINBUCKET + 0) \
120					: (MINBUCKET + 1) \
121				: (size) <= (MINALLOCSIZE * 4) \
122					? (MINBUCKET + 2) \
123					: (MINBUCKET + 3) \
124			: (size) <= (MINALLOCSIZE* 32) \
125				? (size) <= (MINALLOCSIZE * 16) \
126					? (MINBUCKET + 4) \
127					: (MINBUCKET + 5) \
128				: (size) <= (MINALLOCSIZE * 64) \
129					? (MINBUCKET + 6) \
130					: (MINBUCKET + 7) \
131		: (size) <= (MINALLOCSIZE * 2048) \
132			? (size) <= (MINALLOCSIZE * 512) \
133				? (size) <= (MINALLOCSIZE * 256) \
134					? (MINBUCKET + 8) \
135					: (MINBUCKET + 9) \
136				: (size) <= (MINALLOCSIZE * 1024) \
137					? (MINBUCKET + 10) \
138					: (MINBUCKET + 11) \
139			: (size) <= (MINALLOCSIZE * 8192) \
140				? (size) <= (MINALLOCSIZE * 4096) \
141					? (MINBUCKET + 12) \
142					: (MINBUCKET + 13) \
143				: (size) <= (MINALLOCSIZE * 16384) \
144					? (MINBUCKET + 14) \
145					: (MINBUCKET + 15))
146
147/*
148 * Turn virtual addresses into kmemusage pointers.
149 */
150#define btokup(addr)	(&kmemusage[((caddr_t)(addr) - kmembase) >> PAGE_SHIFT])
151
152/*
153 * Deprecated macro versions of not-quite-malloc() and free().
154 */
155#define	MALLOC(space, cast, size, type, flags) \
156	(space) = (cast)malloc((u_long)(size), (type), (flags))
157#define	FREE(addr, type) free((addr), (type))
158
159/*
160 * XXX this should be declared in <sys/uio.h>, but that tends to fail
161 * because <sys/uio.h> is included in a header before the source file
162 * has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined.
163 */
164MALLOC_DECLARE(M_IOV);
165
166/* XXX struct malloc_type is unused for contig*(). */
167void	contigfree __P((void *addr, unsigned long size,
168			struct malloc_type *type));
169void	*contigmalloc __P((unsigned long size, struct malloc_type *type,
170			   int flags, unsigned long low, unsigned long high,
171			   unsigned long alignment, unsigned long boundary));
172void	free __P((void *addr, struct malloc_type *type));
173void	*malloc __P((unsigned long size, struct malloc_type *type, int flags));
174void	malloc_init __P((void *));
175void	malloc_uninit __P((void *));
176#endif /* _KERNEL */
177
178#endif /* !_SYS_MALLOC_H_ */
179