Home | History | Annotate | Line # | Download | only in sys
      1 /*	$NetBSD: vmem.h,v 1.25 2023/12/03 19:34:08 thorpej 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 #else /* defined(_KERNEL) */
     36 #include <stdbool.h>
     37 #endif /* defined(_KERNEL) */
     38 
     39 typedef struct vmem vmem_t;
     40 
     41 typedef unsigned int vm_flag_t;
     42 
     43 typedef	uintptr_t vmem_addr_t;
     44 typedef size_t vmem_size_t;
     45 #define	VMEM_ADDR_MIN	0
     46 #define	VMEM_ADDR_MAX	(~(vmem_addr_t)0)
     47 
     48 typedef int	(vmem_import_t)(vmem_t *, vmem_size_t, vm_flag_t,
     49 		    vmem_addr_t *);
     50 typedef void	(vmem_release_t)(vmem_t *, vmem_addr_t, vmem_size_t);
     51 
     52 typedef int	(vmem_ximport_t)(vmem_t *, vmem_size_t, vmem_size_t *,
     53 		    vm_flag_t, vmem_addr_t *);
     54 
     55 extern vmem_t *kmem_arena;
     56 extern vmem_t *kmem_meta_arena;
     57 extern vmem_t *kmem_va_arena;
     58 
     59 void		vmem_subsystem_init(vmem_t *vm);
     60 
     61 vmem_t *	vmem_create(const char *, vmem_addr_t, vmem_size_t, vmem_size_t,
     62 		    vmem_import_t *, vmem_release_t *, vmem_t *, vmem_size_t,
     63 		    vm_flag_t, int);
     64 vmem_t *	vmem_xcreate(const char *, vmem_addr_t, vmem_size_t,
     65 		    vmem_size_t, vmem_ximport_t *, vmem_release_t *, vmem_t *,
     66 		    vmem_size_t, vm_flag_t, int);
     67 void		vmem_destroy(vmem_t *);
     68 int		vmem_alloc(vmem_t *, vmem_size_t, vm_flag_t, vmem_addr_t *);
     69 void		vmem_free(vmem_t *, vmem_addr_t, vmem_size_t);
     70 int		vmem_xalloc(vmem_t *, vmem_size_t, vmem_size_t, vmem_size_t,
     71 		    vmem_size_t, vmem_addr_t, vmem_addr_t, vm_flag_t,
     72 		    vmem_addr_t *);
     73 int		vmem_xalloc_addr(vmem_t *, vmem_addr_t, vmem_size_t, vm_flag_t);
     74 void		vmem_xfree(vmem_t *, vmem_addr_t, vmem_size_t);
     75 void		vmem_xfreeall(vmem_t *);
     76 int		vmem_add(vmem_t *, vmem_addr_t, vmem_size_t, vm_flag_t);
     77 vmem_size_t	vmem_roundup_size(vmem_t *, vmem_size_t);
     78 vmem_size_t	vmem_size(vmem_t *, int typemask);
     79 void		vmem_rehash_start(void);
     80 void		vmem_whatis(uintptr_t, void (*)(const char *, ...)
     81 		    __printflike(1, 2));
     82 void		vmem_print(uintptr_t, const char *, void (*)(const char *, ...)
     83 		    __printflike(1, 2));
     84 void		vmem_printall(const char *, void (*)(const char *, ...)
     85 		    __printflike(1, 2));
     86 
     87 /* vm_flag_t */
     88 #define	VM_SLEEP	0x00000001
     89 #define	VM_NOSLEEP	0x00000002
     90 #define	VM_INSTANTFIT	0x00001000
     91 #define	VM_BESTFIT	0x00002000
     92 #define	VM_BOOTSTRAP	0x00010000
     93 #define	VM_POPULATING	0x00040000
     94 #define	VM_LARGEIMPORT	0x00080000
     95 #define	VM_XIMPORT	0x00100000
     96 #define	VM_PRIVTAGS	0x00200000
     97 
     98 /* vmem_size typemask */
     99 #define VMEM_ALLOC	0x01
    100 #define VMEM_FREE	0x02
    101 
    102 #endif /* !_SYS_VMEM_H_ */
    103