Make vmstat -m understand the new per-cpu aggregation for
[dragonfly.git] / sys / sys / malloc.h
CommitLineData
984263bc
MD
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: src/sys/sys/malloc.h,v 1.48.2.2 2002/03/16 02:19:16 archie Exp $
bba6a44d 35 * $DragonFly: src/sys/sys/malloc.h,v 1.9 2003/10/18 05:48:44 dillon Exp $
984263bc
MD
36 */
37
38#ifndef _SYS_MALLOC_H_
39#define _SYS_MALLOC_H_
40
a108bf71
MD
41#ifdef _KERNEL
42
bba6a44d
MD
43#ifndef _MACHINE_PARAM_H_
44#include <machine/param.h> /* for SMP_MAXCPU */
45#endif
03aa8d99
MD
46#ifndef _MACHINE_VMPARAM_H_
47#include <machine/vmparam.h> /* for VM_MIN_KERNEL_ADDRESS */
48#endif
49
984263bc
MD
50#define splmem splhigh
51
a108bf71
MD
52#endif
53
54#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
55
984263bc
MD
56/*
57 * flags to malloc.
58 */
97482992
HP
59#define M_NOWAIT 0x0001 /* do not block */
60#define M_WAITOK 0x0002 /* wait for resources */
61#define M_ZERO 0x0100 /* bzero() the allocation */
62#define M_USE_RESERVE 0x0200 /* can alloc out of reserve memory */
a108bf71 63#define M_NULLOK 0x0400 /* ok to return NULL in M_WAITOK case */
984263bc
MD
64
65#define M_MAGIC 877983977 /* time when first defined :-) */
66
bba6a44d
MD
67/*
68 * The malloc tracking structure. Note that per-cpu entries must be
69 * aggregated for accurate statistics, they do not actually break the
70 * stats down by cpu (e.g. the cpu freeing memory will subtract from
71 * its slot, not the originating cpu's slot).
72 *
73 * SMP_MAXCPU is used so modules which use malloc remain compatible
74 * between UP and SMP.
75 */
984263bc
MD
76struct malloc_type {
77 struct malloc_type *ks_next; /* next in list */
bba6a44d
MD
78 long ks_memuse[SMP_MAXCPU]; /* total memory held in bytes */
79 long ks_loosememuse; /* (inaccurate) aggregate memuse */
984263bc
MD
80 long ks_limit; /* most that are allowed to exist */
81 long ks_size; /* sizes of this thing that are allocated */
bba6a44d 82 long ks_inuse[SMP_MAXCPU]; /* # of allocs currently in use */
984263bc
MD
83 int64_t ks_calls; /* total packets of this type ever allocated */
84 long ks_maxused; /* maximum number ever used */
85 u_long ks_magic; /* if it's not magic, don't touch it */
86 const char *ks_shortdesc; /* short description */
87 u_short ks_limblocks; /* number of times blocked for hitting limit */
88 u_short ks_mapblocks; /* number of times blocked for kernel map */
bba6a44d 89 long ks_reserved[4]; /* future use (module compatibility) */
984263bc
MD
90};
91
a108bf71
MD
92#endif
93
984263bc
MD
94#ifdef _KERNEL
95#define MALLOC_DEFINE(type, shortdesc, longdesc) \
96 struct malloc_type type[1] = { \
bba6a44d 97 { NULL, { 0 }, 0, 0, 0, { 0 }, 0, 0, M_MAGIC, shortdesc, 0, 0 } \
984263bc
MD
98 }; \
99 SYSINIT(type##_init, SI_SUB_KMEM, SI_ORDER_ANY, malloc_init, type); \
100 SYSUNINIT(type##_uninit, SI_SUB_KMEM, SI_ORDER_ANY, malloc_uninit, type)
101
102#define MALLOC_DECLARE(type) \
103 extern struct malloc_type type[1]
104
105MALLOC_DECLARE(M_CACHE);
106MALLOC_DECLARE(M_DEVBUF);
107MALLOC_DECLARE(M_TEMP);
108
109MALLOC_DECLARE(M_IP6OPT); /* for INET6 */
110MALLOC_DECLARE(M_IP6NDP); /* for INET6 */
111#endif /* _KERNEL */
112
a108bf71
MD
113#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
114
984263bc
MD
115/*
116 * Array of descriptors that describe the contents of each page
117 */
118struct kmemusage {
bba6a44d 119#ifdef NO_SLAB_ALLOCATOR
984263bc 120 short ku_indx; /* bucket index */
bba6a44d
MD
121#else
122 short ku_cpu; /* cpu index */
123#endif
984263bc
MD
124 union {
125 u_short freecnt;/* for small allocations, free pieces in page */
126 u_short pagecnt;/* for large allocations, pages alloced */
127 } ku_un;
128};
129#define ku_freecnt ku_un.freecnt
130#define ku_pagecnt ku_un.pagecnt
131
132/*
133 * Set of buckets for each size of memory block that is retained
134 */
135struct kmembuckets {
136 caddr_t kb_next; /* list of free blocks */
137 caddr_t kb_last; /* last free block */
138 int64_t kb_calls; /* total calls to allocate this size */
139 long kb_total; /* total number of blocks allocated */
140 long kb_elmpercl; /* # of elements in this sized allocation */
141 long kb_totalfree; /* # of free elements in this bucket */
142 long kb_highwat; /* high water mark */
143 long kb_couldfree; /* over high water mark and could free */
144};
145
984263bc
MD
146#define MINALLOCSIZE (1 << MINBUCKET)
147#define BUCKETINDX(size) \
148 ((size) <= (MINALLOCSIZE * 128) \
149 ? (size) <= (MINALLOCSIZE * 8) \
150 ? (size) <= (MINALLOCSIZE * 2) \
151 ? (size) <= (MINALLOCSIZE * 1) \
152 ? (MINBUCKET + 0) \
153 : (MINBUCKET + 1) \
154 : (size) <= (MINALLOCSIZE * 4) \
155 ? (MINBUCKET + 2) \
156 : (MINBUCKET + 3) \
157 : (size) <= (MINALLOCSIZE* 32) \
158 ? (size) <= (MINALLOCSIZE * 16) \
159 ? (MINBUCKET + 4) \
160 : (MINBUCKET + 5) \
161 : (size) <= (MINALLOCSIZE * 64) \
162 ? (MINBUCKET + 6) \
163 : (MINBUCKET + 7) \
164 : (size) <= (MINALLOCSIZE * 2048) \
165 ? (size) <= (MINALLOCSIZE * 512) \
166 ? (size) <= (MINALLOCSIZE * 256) \
167 ? (MINBUCKET + 8) \
168 : (MINBUCKET + 9) \
169 : (size) <= (MINALLOCSIZE * 1024) \
170 ? (MINBUCKET + 10) \
171 : (MINBUCKET + 11) \
172 : (size) <= (MINALLOCSIZE * 8192) \
173 ? (size) <= (MINALLOCSIZE * 4096) \
174 ? (MINBUCKET + 12) \
175 : (MINBUCKET + 13) \
176 : (size) <= (MINALLOCSIZE * 16384) \
177 ? (MINBUCKET + 14) \
178 : (MINBUCKET + 15))
179
a108bf71
MD
180#endif
181
182#ifdef _KERNEL
183
984263bc
MD
184/*
185 * Turn virtual addresses into kmem map indices
186 */
074dcfe8 187#if defined(USE_KMEM_MAP)
984263bc
MD
188#define kmemxtob(alloc) (kmembase + (alloc) * PAGE_SIZE)
189#define btokmemx(addr) (((caddr_t)(addr) - kmembase) / PAGE_SIZE)
190#define btokup(addr) (&kmemusage[((caddr_t)(addr) - kmembase) >> PAGE_SHIFT])
074dcfe8
MD
191#else
192#define btokup(addr) (&kmemusage[((caddr_t)(addr) - (caddr_t)VM_MIN_KERNEL_ADDRESS) >> PAGE_SHIFT])
03aa8d99 193#endif
984263bc
MD
194
195/*
196 * Deprecated macro versions of not-quite-malloc() and free().
197 */
198#define MALLOC(space, cast, size, type, flags) \
199 (space) = (cast)malloc((u_long)(size), (type), (flags))
200#define FREE(addr, type) free((addr), (type))
201
202/*
203 * XXX this should be declared in <sys/uio.h>, but that tends to fail
204 * because <sys/uio.h> is included in a header before the source file
205 * has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined.
206 */
207MALLOC_DECLARE(M_IOV);
208
209/* XXX struct malloc_type is unused for contig*(). */
b153f746
RG
210void contigfree (void *addr, unsigned long size,
211 struct malloc_type *type);
212void *contigmalloc (unsigned long size, struct malloc_type *type,
984263bc 213 int flags, unsigned long low, unsigned long high,
b153f746
RG
214 unsigned long alignment, unsigned long boundary);
215void free (void *addr, struct malloc_type *type);
216void *malloc (unsigned long size, struct malloc_type *type, int flags);
217void malloc_init (void *);
218void malloc_uninit (void *);
219void *realloc (void *addr, unsigned long size,
220 struct malloc_type *type, int flags);
221void *reallocf (void *addr, unsigned long size,
222 struct malloc_type *type, int flags);
a108bf71 223
984263bc
MD
224#endif /* _KERNEL */
225
226#endif /* !_SYS_MALLOC_H_ */