malloc.h revision 119129 
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 119129 2003-08-19 16:41:12Z sam $
35 */
36
37#ifndef _SYS_MALLOC_H_
38#define	_SYS_MALLOC_H_
39
40#include <sys/queue.h>
41#include <sys/_lock.h>
42#include <sys/_mutex.h>
43
44#define	MINALLOCSIZE	UMA_SMALLEST_UNIT
45
46/*
47 * flags to malloc.
48 */
49#define	M_NOWAIT	0x0001		/* do not block */
50#define	M_WAITOK	0x0002		/* ok to block */
51#define	M_ZERO		0x0100		/* bzero the allocation */
52#define	M_NOVM		0x0200		/* don't ask VM for pages */
53#define	M_USE_RESERVE	0x0400		/* can alloc out of reserve memory */
54
55#define	M_MAGIC		877983977	/* time when first defined :-) */
56
57struct malloc_type {
58	struct malloc_type *ks_next;	/* next in list */
59	u_long 	ks_memuse;	/* total memory held in bytes */
60	u_long	ks_size;	/* sizes of this thing that are allocated */
61	u_long	ks_inuse;	/* # of packets of this type currently in use */
62	uint64_t ks_calls;	/* total packets of this type ever allocated */
63	u_long	ks_maxused;	/* maximum number ever used */
64	u_long	ks_magic;	/* if it's not magic, don't touch it */
65	const char *ks_shortdesc;	/* short description */
66	struct mtx ks_mtx;	/* lock for stats */
67};
68
69#ifdef _KERNEL
70#define	MALLOC_DEFINE(type, shortdesc, longdesc) \
71	struct malloc_type type[1] = { \
72		{ NULL, 0, 0, 0, 0, 0, M_MAGIC, shortdesc, {} } \
73	}; \
74	SYSINIT(type##_init, SI_SUB_KMEM, SI_ORDER_SECOND, malloc_init, type); \
75	SYSUNINIT(type##_uninit, SI_SUB_KMEM, SI_ORDER_ANY, malloc_uninit, type)
76
77#define	MALLOC_DECLARE(type) \
78	extern struct malloc_type type[1]
79
80MALLOC_DECLARE(M_CACHE);
81MALLOC_DECLARE(M_DEVBUF);
82MALLOC_DECLARE(M_TEMP);
83
84MALLOC_DECLARE(M_IP6OPT); /* for INET6 */
85MALLOC_DECLARE(M_IP6NDP); /* for INET6 */
86
87/*
88 * Deprecated macro versions of not-quite-malloc() and free().
89 */
90#define	MALLOC(space, cast, size, type, flags) \
91	((space) = (cast)malloc((u_long)(size), (type), (flags)))
92#define	FREE(addr, type) free((addr), (type))
93
94/*
95 * XXX this should be declared in <sys/uio.h>, but that tends to fail
96 * because <sys/uio.h> is included in a header before the source file
97 * has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined.
98 */
99MALLOC_DECLARE(M_IOV);
100
101extern struct mtx malloc_mtx;
102
103/* XXX struct malloc_type is unused for contig*(). */
104void	contigfree(void *addr, unsigned long size, struct malloc_type *type);
105void	*contigmalloc(unsigned long size, struct malloc_type *type, int flags,
106	    vm_paddr_t low, vm_paddr_t high, unsigned long alignment,
107	    unsigned long boundary);
108void	free(void *addr, struct malloc_type *type);
109void	*malloc(unsigned long size, struct malloc_type *type, int flags);
110void	malloc_init(void *);
111int	malloc_last_fail(void);
112void	malloc_uninit(void *);
113void	*realloc(void *addr, unsigned long size, struct malloc_type *type,
114	    int flags);
115void	*reallocf(void *addr, unsigned long size, struct malloc_type *type,
116	    int flags);
117#endif /* _KERNEL */
118
119#endif /* !_SYS_MALLOC_H_ */
120