xref: /netbsd/sys/sys/vmem.h (revision 6550d01e)
1 /*	$NetBSD: vmem.h,v 1.12 2009/02/18 13:31:59 yamt Exp $	*/
2 
3 /*-
4  * Copyright (c)2006 YAMAMOTO Takashi,
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef _SYS_VMEM_H_
30 #define	_SYS_VMEM_H_
31 
32 #include <sys/types.h>
33 
34 #if !defined(_KERNEL)
35 #include <stdbool.h>
36 #endif /* !defined(_KERNEL) */
37 
38 typedef struct vmem vmem_t;
39 
40 typedef unsigned int vm_flag_t;
41 
42 typedef	uintptr_t vmem_addr_t;
43 typedef size_t vmem_size_t;
44 #define	VMEM_ADDR_NULL	0
45 
46 vmem_t *vmem_create(const char *, vmem_addr_t, vmem_size_t, vmem_size_t,
47     vmem_addr_t (*)(vmem_t *, vmem_size_t, vmem_size_t *, vm_flag_t),
48     void (*)(vmem_t *, vmem_addr_t, vmem_size_t), vmem_t *, vmem_size_t,
49     vm_flag_t, int);
50 void vmem_destroy(vmem_t *);
51 vmem_addr_t vmem_alloc(vmem_t *, vmem_size_t, vm_flag_t);
52 void vmem_free(vmem_t *, vmem_addr_t, vmem_size_t);
53 vmem_addr_t vmem_xalloc(vmem_t *, vmem_size_t, vmem_size_t, vmem_size_t,
54     vmem_size_t, vmem_addr_t, vmem_addr_t, vm_flag_t);
55 void vmem_xfree(vmem_t *, vmem_addr_t, vmem_size_t);
56 vmem_addr_t vmem_add(vmem_t *, vmem_addr_t, vmem_size_t, vm_flag_t);
57 vmem_size_t vmem_roundup_size(vmem_t *, vmem_size_t);
58 bool vmem_reap(vmem_t *);
59 void vmem_rehash_start(void);
60 void vmem_whatis(uintptr_t, void (*)(const char *, ...));
61 void vmem_print(uintptr_t, const char *, void (*)(const char *, ...));
62 void vmem_printall(const char *, void (*)(const char *, ...));
63 
64 /* vm_flag_t */
65 #define	VM_SLEEP	0x00000001
66 #define	VM_NOSLEEP	0x00000002
67 #define	VM_INSTANTFIT	0x00001000
68 #define	VM_BESTFIT	0x00002000
69 
70 #endif /* !_SYS_VMEM_H_ */
71