This commit was generated by cvs2svn to track changes on a CVS vendor
[unix-history] / sys / sys / malloc.h
CommitLineData
15637ed4
RG
1/*
2 * Copyright (c) 1987 Regents of the University of California.
3 * 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 *
01e1b05c
RG
33 * from: @(#)malloc.h 7.25 (Berkeley) 5/15/91
34 * $Id$
15637ed4
RG
35 */
36
37#ifndef _MALLOC_H_
38#define _MALLOC_H_
39
40#define KMEMSTATS
41
42/*
43 * flags to malloc
44 */
45#define M_WAITOK 0x0000
46#define M_NOWAIT 0x0001
47
48/*
49 * Types of memory to be allocated
50 */
51#define M_FREE 0 /* should be on free list */
52#define M_MBUF 1 /* mbuf */
53#define M_DEVBUF 2 /* device driver memory */
54#define M_SOCKET 3 /* socket structure */
55#define M_PCB 4 /* protocol control block */
56#define M_RTABLE 5 /* routing tables */
57#define M_HTABLE 6 /* IMP host tables */
58#define M_FTABLE 7 /* fragment reassembly header */
59#define M_ZOMBIE 8 /* zombie proc status */
60#define M_IFADDR 9 /* interface address */
61#define M_SOOPTS 10 /* socket options */
62#define M_SONAME 11 /* socket name */
63#define M_NAMEI 12 /* namei path name buffer */
64#define M_GPROF 13 /* kernel profiling buffer */
65#define M_IOCTLOPS 14 /* ioctl data buffer */
66#define M_SUPERBLK 15 /* super block data */
67#define M_CRED 16 /* credentials */
68#define M_PGRP 17 /* process group header */
69#define M_SESSION 18 /* session header */
70#define M_IOV 19 /* large iov's */
71#define M_MOUNT 20 /* vfs mount struct */
72#define M_FHANDLE 21 /* network file handle */
73#define M_NFSREQ 22 /* NFS request header */
74#define M_NFSMNT 23 /* NFS mount structure */
75#define M_VNODE 24 /* Dynamically allocated vnodes */
76#define M_CACHE 25 /* Dynamically allocated cache entries */
77#define M_DQUOT 26 /* UFS quota entries */
78#define M_UFSMNT 27 /* UFS mount structure */
79#define M_MAPMEM 28 /* mapped memory descriptors */
80#define M_SHM 29 /* SVID compatible shared memory segments */
81#define M_VMMAP 30 /* VM map structures */
82#define M_VMMAPENT 31 /* VM map entry structures */
83#define M_VMOBJ 32 /* VM object structure */
84#define M_VMOBJHASH 33 /* VM object hash structure */
85#define M_VMPMAP 34 /* VM pmap */
86#define M_VMPVENT 35 /* VM phys-virt mapping entry */
87#define M_VMPAGER 36 /* XXX: VM pager struct */
88#define M_VMPGDATA 37 /* XXX: VM pager private data */
89#define M_FILE 38 /* Open file structure */
90#define M_FILEDESC 39 /* Open file descriptor table */
91#define M_LOCKF 40 /* Byte-range locking structures */
92#define M_PROC 41 /* Proc structures */
93#define M_SUBPROC 42 /* Proc sub-structures */
584fddaa 94#define M_ISOFSMNT 48 /* isofs mount structures */
15637ed4
RG
95#define M_TEMP 49 /* misc temporary data buffers */
96#define M_PCFSMNT 50 /* PCFS mount structure */
97#define M_PCFSFAT 51 /* PCFS fat table */
98#define M_LAST 52
99
100#define INITKMEMNAMES { \
101 "free", /* 0 M_FREE */ \
102 "mbuf", /* 1 M_MBUF */ \
103 "devbuf", /* 2 M_DEVBUF */ \
104 "socket", /* 3 M_SOCKET */ \
105 "pcb", /* 4 M_PCB */ \
106 "routetbl", /* 5 M_RTABLE */ \
107 "hosttbl", /* 6 M_HTABLE */ \
108 "fragtbl", /* 7 M_FTABLE */ \
109 "zombie", /* 8 M_ZOMBIE */ \
110 "ifaddr", /* 9 M_IFADDR */ \
111 "soopts", /* 10 M_SOOPTS */ \
112 "soname", /* 11 M_SONAME */ \
113 "namei", /* 12 M_NAMEI */ \
114 "gprof", /* 13 M_GPROF */ \
115 "ioctlops", /* 14 M_IOCTLOPS */ \
116 "superblk", /* 15 M_SUPERBLK */ \
117 "cred", /* 16 M_CRED */ \
118 "pgrp", /* 17 M_PGRP */ \
119 "session", /* 18 M_SESSION */ \
120 "iov", /* 19 M_IOV */ \
121 "mount", /* 20 M_MOUNT */ \
122 "fhandle", /* 21 M_FHANDLE */ \
123 "NFS req", /* 22 M_NFSREQ */ \
124 "NFS mount", /* 23 M_NFSMNT */ \
125 "vnodes", /* 24 M_VNODE */ \
126 "namecache", /* 25 M_CACHE */ \
127 "UFS quota", /* 26 M_DQUOT */ \
128 "UFS mount", /* 27 M_UFSMNT */ \
129 "mapmem", /* 28 M_MAPMEM */ \
130 "shm", /* 29 M_SHM */ \
131 "VM map", /* 30 M_VMMAP */ \
132 "VM mapent", /* 31 M_VMMAPENT */ \
133 "VM object", /* 32 M_VMOBJ */ \
134 "VM objhash", /* 33 M_VMOBJHASH */ \
135 "VM pmap", /* 34 M_VMPMAP */ \
136 "VM pvmap", /* 35 M_VMPVENT */ \
137 "VM pager", /* 36 M_VMPAGER */ \
138 "VM pgdata", /* 37 M_VMPGDATA */ \
139 "file", /* 38 M_FILE */ \
140 "file desc", /* 39 M_FILEDESC */ \
141 "lockf", /* 40 M_LOCKF */ \
142 "proc", /* 41 M_PROC */ \
143 "subproc", /* 42 M_PROC */ \
584fddaa
JH
144 0, 0, 0, 0, 0, \
145 "isofs mount", /* 48 M_ISOFSMNT */ \
15637ed4
RG
146 "temp", /* 49 M_TEMP */ \
147 "PCFS mount", /* 50 M_PCFSMNT */ \
148 "PCFS fat", /* 51 M_PCFSFAT */ \
149}
150
151struct kmemstats {
152 long ks_inuse; /* # of packets of this type currently in use */
153 long ks_calls; /* total packets of this type ever allocated */
154 long ks_memuse; /* total memory held in bytes */
155 u_short ks_limblocks; /* number of times blocked for hitting limit */
156 u_short ks_mapblocks; /* number of times blocked for kernel map */
157 long ks_maxused; /* maximum number ever used */
158 long ks_limit; /* most that are allowed to exist */
159};
160
161/*
162 * Array of descriptors that describe the contents of each page
163 */
164struct kmemusage {
165 short ku_indx; /* bucket index */
166 union {
167 u_short freecnt;/* for small allocations, free pieces in page */
168 u_short pagecnt;/* for large allocations, pages alloced */
169 } ku_un;
170};
171#define ku_freecnt ku_un.freecnt
172#define ku_pagecnt ku_un.pagecnt
173
174/*
175 * Set of buckets for each size of memory block that is retained
176 */
177struct kmembuckets {
178 caddr_t kb_next; /* list of free blocks */
179 long kb_calls; /* total calls to allocate this size */
180 long kb_total; /* total number of blocks allocated */
181 long kb_totalfree; /* # of free elements in this bucket */
182 long kb_elmpercl; /* # of elements in this sized allocation */
183 long kb_highwat; /* high water mark */
184 long kb_couldfree; /* over high water mark and could free */
185};
186
187#ifdef KERNEL
188#define MINALLOCSIZE (1 << MINBUCKET)
189#define BUCKETINDX(size) \
190 (size) <= (MINALLOCSIZE * 128) \
191 ? (size) <= (MINALLOCSIZE * 8) \
192 ? (size) <= (MINALLOCSIZE * 2) \
193 ? (size) <= (MINALLOCSIZE * 1) \
194 ? (MINBUCKET + 0) \
195 : (MINBUCKET + 1) \
196 : (size) <= (MINALLOCSIZE * 4) \
197 ? (MINBUCKET + 2) \
198 : (MINBUCKET + 3) \
199 : (size) <= (MINALLOCSIZE* 32) \
200 ? (size) <= (MINALLOCSIZE * 16) \
201 ? (MINBUCKET + 4) \
202 : (MINBUCKET + 5) \
203 : (size) <= (MINALLOCSIZE * 64) \
204 ? (MINBUCKET + 6) \
205 : (MINBUCKET + 7) \
206 : (size) <= (MINALLOCSIZE * 2048) \
207 ? (size) <= (MINALLOCSIZE * 512) \
208 ? (size) <= (MINALLOCSIZE * 256) \
209 ? (MINBUCKET + 8) \
210 : (MINBUCKET + 9) \
211 : (size) <= (MINALLOCSIZE * 1024) \
212 ? (MINBUCKET + 10) \
213 : (MINBUCKET + 11) \
214 : (size) <= (MINALLOCSIZE * 8192) \
215 ? (size) <= (MINALLOCSIZE * 4096) \
216 ? (MINBUCKET + 12) \
217 : (MINBUCKET + 13) \
218 : (size) <= (MINALLOCSIZE * 16384) \
219 ? (MINBUCKET + 14) \
220 : (MINBUCKET + 15)
221
222/*
223 * Turn virtual addresses into kmem map indicies
224 */
225#define kmemxtob(alloc) (kmembase + (alloc) * NBPG)
226#define btokmemx(addr) (((caddr_t)(addr) - kmembase) / NBPG)
227#define btokup(addr) (&kmemusage[((caddr_t)(addr) - kmembase) >> CLSHIFT])
228
229/*
230 * Macro versions for the usual cases of malloc/free
231 */
232#ifdef KMEMSTATS
233#define MALLOC(space, cast, size, type, flags) \
234 (space) = (cast)malloc((u_long)(size), type, flags)
235#define FREE(addr, type) free((caddr_t)(addr), type)
236
237#else /* do not collect statistics */
238#define MALLOC(space, cast, size, type, flags) { \
239 register struct kmembuckets *kbp = &bucket[BUCKETINDX(size)]; \
240 long s = splimp(); \
241 if (kbp->kb_next == NULL) { \
242 (space) = (cast)malloc((u_long)(size), type, flags); \
243 } else { \
244 (space) = (cast)kbp->kb_next; \
245 kbp->kb_next = *(caddr_t *)(space); \
246 } \
247 splx(s); \
248}
249
250#define FREE(addr, type) { \
251 register struct kmembuckets *kbp; \
252 register struct kmemusage *kup = btokup(addr); \
253 long s = splimp(); \
254 if (1 << kup->ku_indx > MAXALLOCSAVE) { \
255 free((caddr_t)(addr), type); \
256 } else { \
257 kbp = &bucket[kup->ku_indx]; \
258 *(caddr_t *)(addr) = kbp->kb_next; \
259 kbp->kb_next = (caddr_t)(addr); \
260 } \
261 splx(s); \
262}
263#endif /* do not collect statistics */
264
265extern struct kmemstats kmemstats[];
266extern struct kmemusage *kmemusage;
267extern char *kmembase;
268extern struct kmembuckets bucket[];
269extern void *malloc __P((unsigned long size, int type, int flags));
270extern void free __P((void *addr, int type));
271#endif /* KERNEL */
272#endif /* !_MALLOC_H_ */