* s/FreeBSD/DragonFly at the boot2 prompt.
[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 $
05220613 35 * $DragonFly: src/sys/sys/malloc.h,v 1.15 2003/11/21 22:46:13 dillon Exp $
984263bc
MD
36 */
37
38#ifndef _SYS_MALLOC_H_
39#define _SYS_MALLOC_H_
40
bba6a44d
MD
41#ifndef _MACHINE_PARAM_H_
42#include <machine/param.h> /* for SMP_MAXCPU */
43#endif
3bf43adc 44
05220613 45#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
3bf43adc 46
03aa8d99
MD
47#ifndef _MACHINE_VMPARAM_H_
48#include <machine/vmparam.h> /* for VM_MIN_KERNEL_ADDRESS */
49#endif
50
984263bc
MD
51#define splmem splhigh
52
e2565a42
MD
53#ifndef _MACHINE_TYPES_H_
54#include <machine/types.h> /* vm_paddr_t */
55#endif
56
05220613
MD
57#endif /* _KERNEL */
58
984263bc
MD
59/*
60 * flags to malloc.
61 */
97482992
HP
62#define M_NOWAIT 0x0001 /* do not block */
63#define M_WAITOK 0x0002 /* wait for resources */
64#define M_ZERO 0x0100 /* bzero() the allocation */
65#define M_USE_RESERVE 0x0200 /* can alloc out of reserve memory */
a108bf71 66#define M_NULLOK 0x0400 /* ok to return NULL in M_WAITOK case */
ebe4a7b3 67#define M_PASSIVE_ZERO 0x0800 /* (internal to the slab code only) */
984263bc
MD
68
69#define M_MAGIC 877983977 /* time when first defined :-) */
70
bba6a44d
MD
71/*
72 * The malloc tracking structure. Note that per-cpu entries must be
73 * aggregated for accurate statistics, they do not actually break the
74 * stats down by cpu (e.g. the cpu freeing memory will subtract from
75 * its slot, not the originating cpu's slot).
76 *
77 * SMP_MAXCPU is used so modules which use malloc remain compatible
78 * between UP and SMP.
79 */
984263bc
MD
80struct malloc_type {
81 struct malloc_type *ks_next; /* next in list */
bba6a44d
MD
82 long ks_memuse[SMP_MAXCPU]; /* total memory held in bytes */
83 long ks_loosememuse; /* (inaccurate) aggregate memuse */
984263bc
MD
84 long ks_limit; /* most that are allowed to exist */
85 long ks_size; /* sizes of this thing that are allocated */
bba6a44d 86 long ks_inuse[SMP_MAXCPU]; /* # of allocs currently in use */
05220613 87 __int64_t ks_calls; /* total packets of this type ever allocated */
984263bc 88 long ks_maxused; /* maximum number ever used */
05220613 89 __uint32_t ks_magic; /* if it's not magic, don't touch it */
984263bc 90 const char *ks_shortdesc; /* short description */
05220613
MD
91 __uint16_t ks_limblocks; /* number of times blocked for hitting limit */
92 __uint16_t ks_mapblocks; /* number of times blocked for kernel map */
bba6a44d 93 long ks_reserved[4]; /* future use (module compatibility) */
984263bc
MD
94};
95
05220613 96#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
a108bf71 97
05220613
MD
98#define MALLOC_DEFINE(type, shortdesc, longdesc) \
99 struct malloc_type type[1] = { \
100 { NULL, { 0 }, 0, 0, 0, { 0 }, 0, 0, M_MAGIC, shortdesc, 0, 0 } \
101 }; \
984263bc
MD
102 SYSINIT(type##_init, SI_SUB_KMEM, SI_ORDER_ANY, malloc_init, type); \
103 SYSUNINIT(type##_uninit, SI_SUB_KMEM, SI_ORDER_ANY, malloc_uninit, type)
104
05220613
MD
105#else
106
107#define MALLOC_DEFINE(type, shortdesc, longdesc) \
108 struct malloc_type type[1] = { \
109 { NULL, { 0 }, 0, 0, 0, { 0 }, 0, 0, M_MAGIC, shortdesc, 0, 0 } \
110 };
111
112#endif
113
984263bc
MD
114#define MALLOC_DECLARE(type) \
115 extern struct malloc_type type[1]
116
05220613
MD
117#ifdef _KERNEL
118
984263bc
MD
119MALLOC_DECLARE(M_CACHE);
120MALLOC_DECLARE(M_DEVBUF);
121MALLOC_DECLARE(M_TEMP);
122
123MALLOC_DECLARE(M_IP6OPT); /* for INET6 */
124MALLOC_DECLARE(M_IP6NDP); /* for INET6 */
984263bc 125
05220613 126#endif /* _KERNEL */
a108bf71 127
984263bc
MD
128/*
129 * Array of descriptors that describe the contents of each page
130 */
131struct kmemusage {
bba6a44d 132 short ku_cpu; /* cpu index */
984263bc 133 union {
05220613
MD
134 __int16_t freecnt;/* for small allocations, free pieces in page */
135 __int16_t pagecnt;/* for large allocations, pages alloced */
984263bc
MD
136 } ku_un;
137};
138#define ku_freecnt ku_un.freecnt
139#define ku_pagecnt ku_un.pagecnt
140
a108bf71
MD
141#ifdef _KERNEL
142
05220613
MD
143#define MINALLOCSIZE sizeof(void *)
144
984263bc
MD
145/*
146 * Turn virtual addresses into kmem map indices
147 */
074dcfe8 148#define btokup(addr) (&kmemusage[((caddr_t)(addr) - (caddr_t)VM_MIN_KERNEL_ADDRESS) >> PAGE_SHIFT])
984263bc
MD
149
150/*
151 * Deprecated macro versions of not-quite-malloc() and free().
152 */
153#define MALLOC(space, cast, size, type, flags) \
154 (space) = (cast)malloc((u_long)(size), (type), (flags))
155#define FREE(addr, type) free((addr), (type))
156
157/*
158 * XXX this should be declared in <sys/uio.h>, but that tends to fail
159 * because <sys/uio.h> is included in a header before the source file
160 * has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined.
161 */
162MALLOC_DECLARE(M_IOV);
163
164/* XXX struct malloc_type is unused for contig*(). */
b153f746
RG
165void contigfree (void *addr, unsigned long size,
166 struct malloc_type *type);
167void *contigmalloc (unsigned long size, struct malloc_type *type,
6ef943a3 168 int flags, vm_paddr_t low, vm_paddr_t high,
b153f746
RG
169 unsigned long alignment, unsigned long boundary);
170void free (void *addr, struct malloc_type *type);
171void *malloc (unsigned long size, struct malloc_type *type, int flags);
172void malloc_init (void *);
173void malloc_uninit (void *);
174void *realloc (void *addr, unsigned long size,
175 struct malloc_type *type, int flags);
176void *reallocf (void *addr, unsigned long size,
177 struct malloc_type *type, int flags);
a108bf71 178
984263bc
MD
179#endif /* _KERNEL */
180
181#endif /* !_SYS_MALLOC_H_ */