1252330Sjeff/*- 2252330Sjeff * Copyright (c)2006 YAMAMOTO Takashi, 3252330Sjeff * All rights reserved. 4252330Sjeff * 5252330Sjeff * Redistribution and use in source and binary forms, with or without 6252330Sjeff * modification, are permitted provided that the following conditions 7252330Sjeff * are met: 8252330Sjeff * 1. Redistributions of source code must retain the above copyright 9252330Sjeff * notice, this list of conditions and the following disclaimer. 10252330Sjeff * 2. Redistributions in binary form must reproduce the above copyright 11252330Sjeff * notice, this list of conditions and the following disclaimer in the 12252330Sjeff * documentation and/or other materials provided with the distribution. 13252330Sjeff * 14252330Sjeff * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15252330Sjeff * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16252330Sjeff * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17252330Sjeff * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18252330Sjeff * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19252330Sjeff * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20252330Sjeff * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21252330Sjeff * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22252330Sjeff * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23252330Sjeff * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24252330Sjeff * SUCH DAMAGE. 25252330Sjeff */ 26252330Sjeff/* From $NetBSD: vmem.h,v 1.20 2013/01/29 21:26:24 para Exp $ */ 27252330Sjeff 28252330Sjeff/* $FreeBSD$ */ 29252330Sjeff 30252330Sjeff#ifndef _SYS_VMEM_H_ 31252330Sjeff#define _SYS_VMEM_H_ 32252330Sjeff 33252330Sjeff#include <sys/types.h> 34252330Sjeff 35252330Sjeff#ifdef _KERNEL 36252330Sjeff 37252330Sjefftypedef struct vmem vmem_t; 38252330Sjeff 39252330Sjefftypedef uintptr_t vmem_addr_t; 40252330Sjefftypedef size_t vmem_size_t; 41252330Sjeff 42252330Sjeff#define VMEM_ADDR_MIN 0 43252330Sjeff#define VMEM_ADDR_MAX (~(vmem_addr_t)0) 44252330Sjeff 45252330Sjefftypedef int (vmem_import_t)(void *, vmem_size_t, int, vmem_addr_t *); 46252330Sjefftypedef void (vmem_release_t)(void *, vmem_addr_t, vmem_size_t); 47252330Sjefftypedef void (vmem_reclaim_t)(vmem_t *, int); 48252330Sjeff 49252330Sjeff/* 50252330Sjeff * Create a vmem: 51252330Sjeff * name - Name of the region 52252330Sjeff * base - Initial span start (optional) 53252330Sjeff * size - Initial span size 54252330Sjeff * quantum - Natural unit of allocation (ie PAGE_SIZE, 1, etc) 55252330Sjeff * qcache_max - Maximum size to quantum cache. This creates a UMA 56252330Sjeff * cache for each multiple of quantum up to qcache_max. 57252330Sjeff * flags - M_* flags 58252330Sjeff */ 59252330Sjeffvmem_t *vmem_create(const char *name, vmem_addr_t base, 60252330Sjeff vmem_size_t size, vmem_size_t quantum, vmem_size_t qcache_max, int flags); 61252330Sjeffvmem_t *vmem_init(vmem_t *vm, const char *name, vmem_addr_t base, 62252330Sjeff vmem_size_t size, vmem_size_t quantum, vmem_size_t qcache_max, int flags); 63252330Sjeffvoid vmem_destroy(vmem_t *); 64252330Sjeff 65252330Sjeff/* 66252330Sjeff * Set callbacks for bringing in dynamic regions: 67252330Sjeff * importfn - Backing store import routine. 68252330Sjeff * releasefn - Backing store release routine. 69252330Sjeff * arg - Backing store argument 70252330Sjeff * import_quantum - Size to import from backing store 71252330Sjeff */ 72252330Sjeff 73252330Sjeffvoid vmem_set_import(vmem_t *vm, vmem_import_t *importfn, 74252330Sjeff vmem_release_t *releasefn, void *arg, vmem_size_t import_quantum); 75252330Sjeff 76252330Sjeff/* 77252330Sjeff * Set a callback for reclaiming memory when space is exhausted: 78252330Sjeff */ 79252330Sjeffvoid vmem_set_reclaim(vmem_t *vm, vmem_reclaim_t *reclaimfn); 80252330Sjeff 81252330Sjeff/* 82252330Sjeff * Allocate and free linear regions from a vmem. Must specify 83252330Sjeff * BESTFIT or FIRSTFIT. Free is non-blocking. These routines 84252330Sjeff * respect the quantum caches. 85252330Sjeff */ 86252330Sjeffint vmem_alloc(vmem_t *vm, vmem_size_t size, int flags, vmem_addr_t *addrp); 87252330Sjeffvoid vmem_free(vmem_t *vm, vmem_addr_t addr, vmem_size_t size); 88252330Sjeff 89252330Sjeff/* 90252330Sjeff * Constrained allocate and free routines. These bypass the quantum cache. 91252330Sjeff * size - Size in units of 1, not quantum. 92252330Sjeff * align - Required alignment of the start of region 93252330Sjeff * phase - Offset from alignment 94252330Sjeff * nocross - Illegal boundary 95252330Sjeff * minaddr - Minimum allowed address for last byte 96252330Sjeff * maxaddr - Maximum allowed address for first byte 97252330Sjeff * flags - M_* flags 98252330Sjeff * addrp - result 99252330Sjeff */ 100252330Sjeffint vmem_xalloc(vmem_t *vm, vmem_size_t size, vmem_size_t align, 101252330Sjeff vmem_size_t phase, vmem_size_t nocross, vmem_addr_t minaddr, 102252330Sjeff vmem_addr_t maxaddr, int flags, vmem_addr_t *addrp); 103252330Sjeffvoid vmem_xfree(vmem_t *vm, vmem_addr_t addr, vmem_size_t size); 104252330Sjeff 105252330Sjeff/* 106252330Sjeff * Add a static region to a vmem after create. This won't be freed 107252330Sjeff * until the vmem is destroyed. 108252330Sjeff */ 109252330Sjeffint vmem_add(vmem_t *vm, vmem_addr_t addr, vmem_size_t size, int flags); 110252330Sjeff 111252330Sjeff/* 112252330Sjeff * Given roundup size to the vmem's native quantum size. 113252330Sjeff */ 114252330Sjeffvmem_size_t vmem_roundup_size(vmem_t *vm, vmem_size_t size); 115252330Sjeff 116252330Sjeff/* 117252330Sjeff * Report vmem utilization according to the requested type. 118252330Sjeff */ 119252330Sjeffvmem_size_t vmem_size(vmem_t *vm, int typemask); 120252330Sjeff 121252330Sjeffvoid vmem_whatis(vmem_addr_t addr, int (*fn)(const char *, ...) 122252330Sjeff __printflike(1, 2)); 123252330Sjeffvoid vmem_print(vmem_addr_t addr, const char *, int (*fn)(const char *, ...) 124252330Sjeff __printflike(1, 2)); 125252330Sjeffvoid vmem_printall(const char *, int (*fn)(const char *, ...) 126252330Sjeff __printflike(1, 2)); 127252330Sjeffvoid vmem_startup(void); 128252330Sjeff 129252330Sjeff/* vmem_size typemask */ 130252330Sjeff#define VMEM_ALLOC 0x01 131252330Sjeff#define VMEM_FREE 0x02 132252330Sjeff 133252330Sjeff#endif /* _KERNEL */ 134252330Sjeff 135252330Sjeff#endif /* !_SYS_VMEM_H_ */ 136