1*5f518366SJeff Roberson /*- 2*5f518366SJeff Roberson * Copyright (c)2006 YAMAMOTO Takashi, 3*5f518366SJeff Roberson * All rights reserved. 4*5f518366SJeff Roberson * 5*5f518366SJeff Roberson * Redistribution and use in source and binary forms, with or without 6*5f518366SJeff Roberson * modification, are permitted provided that the following conditions 7*5f518366SJeff Roberson * are met: 8*5f518366SJeff Roberson * 1. Redistributions of source code must retain the above copyright 9*5f518366SJeff Roberson * notice, this list of conditions and the following disclaimer. 10*5f518366SJeff Roberson * 2. Redistributions in binary form must reproduce the above copyright 11*5f518366SJeff Roberson * notice, this list of conditions and the following disclaimer in the 12*5f518366SJeff Roberson * documentation and/or other materials provided with the distribution. 13*5f518366SJeff Roberson * 14*5f518366SJeff Roberson * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15*5f518366SJeff Roberson * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16*5f518366SJeff Roberson * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17*5f518366SJeff Roberson * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18*5f518366SJeff Roberson * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19*5f518366SJeff Roberson * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20*5f518366SJeff Roberson * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21*5f518366SJeff Roberson * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22*5f518366SJeff Roberson * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23*5f518366SJeff Roberson * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24*5f518366SJeff Roberson * SUCH DAMAGE. 25*5f518366SJeff Roberson */ 26*5f518366SJeff Roberson /* From $NetBSD: vmem.h,v 1.20 2013/01/29 21:26:24 para Exp $ */ 27*5f518366SJeff Roberson 28*5f518366SJeff Roberson /* $FreeBSD$ */ 29*5f518366SJeff Roberson 30*5f518366SJeff Roberson #ifndef _SYS_VMEM_H_ 31*5f518366SJeff Roberson #define _SYS_VMEM_H_ 32*5f518366SJeff Roberson 33*5f518366SJeff Roberson #include <sys/types.h> 34*5f518366SJeff Roberson 35*5f518366SJeff Roberson #ifdef _KERNEL 36*5f518366SJeff Roberson 37*5f518366SJeff Roberson typedef struct vmem vmem_t; 38*5f518366SJeff Roberson 39*5f518366SJeff Roberson typedef uintptr_t vmem_addr_t; 40*5f518366SJeff Roberson typedef size_t vmem_size_t; 41*5f518366SJeff Roberson 42*5f518366SJeff Roberson #define VMEM_ADDR_MIN 0 43*5f518366SJeff Roberson #define VMEM_ADDR_MAX (~(vmem_addr_t)0) 44*5f518366SJeff Roberson 45*5f518366SJeff Roberson typedef int (vmem_import_t)(void *, vmem_size_t, int, vmem_addr_t *); 46*5f518366SJeff Roberson typedef void (vmem_release_t)(void *, vmem_addr_t, vmem_size_t); 47*5f518366SJeff Roberson typedef void (vmem_reclaim_t)(vmem_t *, int); 48*5f518366SJeff Roberson 49*5f518366SJeff Roberson /* 50*5f518366SJeff Roberson * Create a vmem: 51*5f518366SJeff Roberson * name - Name of the region 52*5f518366SJeff Roberson * base - Initial span start (optional) 53*5f518366SJeff Roberson * size - Initial span size 54*5f518366SJeff Roberson * quantum - Natural unit of allocation (ie PAGE_SIZE, 1, etc) 55*5f518366SJeff Roberson * qcache_max - Maximum size to quantum cache. This creates a UMA 56*5f518366SJeff Roberson * cache for each multiple of quantum up to qcache_max. 57*5f518366SJeff Roberson * flags - M_* flags 58*5f518366SJeff Roberson */ 59*5f518366SJeff Roberson vmem_t *vmem_create(const char *name, vmem_addr_t base, 60*5f518366SJeff Roberson vmem_size_t size, vmem_size_t quantum, vmem_size_t qcache_max, int flags); 61*5f518366SJeff Roberson vmem_t *vmem_init(vmem_t *vm, const char *name, vmem_addr_t base, 62*5f518366SJeff Roberson vmem_size_t size, vmem_size_t quantum, vmem_size_t qcache_max, int flags); 63*5f518366SJeff Roberson void vmem_destroy(vmem_t *); 64*5f518366SJeff Roberson 65*5f518366SJeff Roberson /* 66*5f518366SJeff Roberson * Set callbacks for bringing in dynamic regions: 67*5f518366SJeff Roberson * importfn - Backing store import routine. 68*5f518366SJeff Roberson * releasefn - Backing store release routine. 69*5f518366SJeff Roberson * arg - Backing store argument 70*5f518366SJeff Roberson * import_quantum - Size to import from backing store 71*5f518366SJeff Roberson */ 72*5f518366SJeff Roberson 73*5f518366SJeff Roberson void vmem_set_import(vmem_t *vm, vmem_import_t *importfn, 74*5f518366SJeff Roberson vmem_release_t *releasefn, void *arg, vmem_size_t import_quantum); 75*5f518366SJeff Roberson 76*5f518366SJeff Roberson /* 77*5f518366SJeff Roberson * Set a callback for reclaiming memory when space is exhausted: 78*5f518366SJeff Roberson */ 79*5f518366SJeff Roberson void vmem_set_reclaim(vmem_t *vm, vmem_reclaim_t *reclaimfn); 80*5f518366SJeff Roberson 81*5f518366SJeff Roberson /* 82*5f518366SJeff Roberson * Allocate and free linear regions from a vmem. Must specify 83*5f518366SJeff Roberson * BESTFIT or FIRSTFIT. Free is non-blocking. These routines 84*5f518366SJeff Roberson * respect the quantum caches. 85*5f518366SJeff Roberson */ 86*5f518366SJeff Roberson int vmem_alloc(vmem_t *vm, vmem_size_t size, int flags, vmem_addr_t *addrp); 87*5f518366SJeff Roberson void vmem_free(vmem_t *vm, vmem_addr_t addr, vmem_size_t size); 88*5f518366SJeff Roberson 89*5f518366SJeff Roberson /* 90*5f518366SJeff Roberson * Constrained allocate and free routines. These bypass the quantum cache. 91*5f518366SJeff Roberson * size - Size in units of 1, not quantum. 92*5f518366SJeff Roberson * align - Required alignment of the start of region 93*5f518366SJeff Roberson * phase - Offset from alignment 94*5f518366SJeff Roberson * nocross - Illegal boundary 95*5f518366SJeff Roberson * minaddr - Minimum allowed address for last byte 96*5f518366SJeff Roberson * maxaddr - Maximum allowed address for first byte 97*5f518366SJeff Roberson * flags - M_* flags 98*5f518366SJeff Roberson * addrp - result 99*5f518366SJeff Roberson */ 100*5f518366SJeff Roberson int vmem_xalloc(vmem_t *vm, vmem_size_t size, vmem_size_t align, 101*5f518366SJeff Roberson vmem_size_t phase, vmem_size_t nocross, vmem_addr_t minaddr, 102*5f518366SJeff Roberson vmem_addr_t maxaddr, int flags, vmem_addr_t *addrp); 103*5f518366SJeff Roberson void vmem_xfree(vmem_t *vm, vmem_addr_t addr, vmem_size_t size); 104*5f518366SJeff Roberson 105*5f518366SJeff Roberson /* 106*5f518366SJeff Roberson * Add a static region to a vmem after create. This won't be freed 107*5f518366SJeff Roberson * until the vmem is destroyed. 108*5f518366SJeff Roberson */ 109*5f518366SJeff Roberson int vmem_add(vmem_t *vm, vmem_addr_t addr, vmem_size_t size, int flags); 110*5f518366SJeff Roberson 111*5f518366SJeff Roberson /* 112*5f518366SJeff Roberson * Given roundup size to the vmem's native quantum size. 113*5f518366SJeff Roberson */ 114*5f518366SJeff Roberson vmem_size_t vmem_roundup_size(vmem_t *vm, vmem_size_t size); 115*5f518366SJeff Roberson 116*5f518366SJeff Roberson /* 117*5f518366SJeff Roberson * Report vmem utilization according to the requested type. 118*5f518366SJeff Roberson */ 119*5f518366SJeff Roberson vmem_size_t vmem_size(vmem_t *vm, int typemask); 120*5f518366SJeff Roberson 121*5f518366SJeff Roberson void vmem_whatis(vmem_addr_t addr, int (*fn)(const char *, ...) 122*5f518366SJeff Roberson __printflike(1, 2)); 123*5f518366SJeff Roberson void vmem_print(vmem_addr_t addr, const char *, int (*fn)(const char *, ...) 124*5f518366SJeff Roberson __printflike(1, 2)); 125*5f518366SJeff Roberson void vmem_printall(const char *, int (*fn)(const char *, ...) 126*5f518366SJeff Roberson __printflike(1, 2)); 127*5f518366SJeff Roberson void vmem_startup(void); 128*5f518366SJeff Roberson 129*5f518366SJeff Roberson /* vmem_size typemask */ 130*5f518366SJeff Roberson #define VMEM_ALLOC 0x01 131*5f518366SJeff Roberson #define VMEM_FREE 0x02 132*5f518366SJeff Roberson 133*5f518366SJeff Roberson #endif /* _KERNEL */ 134*5f518366SJeff Roberson 135*5f518366SJeff Roberson #endif /* !_SYS_VMEM_H_ */ 136