15f518366SJeff Roberson /*- 2*c4e20cadSPedro F. Giffuni * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3*c4e20cadSPedro F. Giffuni * 45f518366SJeff Roberson * Copyright (c)2006 YAMAMOTO Takashi, 55f518366SJeff Roberson * All rights reserved. 65f518366SJeff Roberson * 75f518366SJeff Roberson * Redistribution and use in source and binary forms, with or without 85f518366SJeff Roberson * modification, are permitted provided that the following conditions 95f518366SJeff Roberson * are met: 105f518366SJeff Roberson * 1. Redistributions of source code must retain the above copyright 115f518366SJeff Roberson * notice, this list of conditions and the following disclaimer. 125f518366SJeff Roberson * 2. Redistributions in binary form must reproduce the above copyright 135f518366SJeff Roberson * notice, this list of conditions and the following disclaimer in the 145f518366SJeff Roberson * documentation and/or other materials provided with the distribution. 155f518366SJeff Roberson * 165f518366SJeff Roberson * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 175f518366SJeff Roberson * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 185f518366SJeff Roberson * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 195f518366SJeff Roberson * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 205f518366SJeff Roberson * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 215f518366SJeff Roberson * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 225f518366SJeff Roberson * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 235f518366SJeff Roberson * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 245f518366SJeff Roberson * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 255f518366SJeff Roberson * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 265f518366SJeff Roberson * SUCH DAMAGE. 275f518366SJeff Roberson */ 285f518366SJeff Roberson /* From $NetBSD: vmem.h,v 1.20 2013/01/29 21:26:24 para Exp $ */ 295f518366SJeff Roberson 305f518366SJeff Roberson /* $FreeBSD$ */ 315f518366SJeff Roberson 325f518366SJeff Roberson #ifndef _SYS_VMEM_H_ 335f518366SJeff Roberson #define _SYS_VMEM_H_ 345f518366SJeff Roberson 355f518366SJeff Roberson #include <sys/types.h> 365f518366SJeff Roberson 375f518366SJeff Roberson #ifdef _KERNEL 385f518366SJeff Roberson 395f518366SJeff Roberson typedef struct vmem vmem_t; 405f518366SJeff Roberson 415f518366SJeff Roberson typedef uintptr_t vmem_addr_t; 425f518366SJeff Roberson typedef size_t vmem_size_t; 435f518366SJeff Roberson 445f518366SJeff Roberson #define VMEM_ADDR_MIN 0 455f518366SJeff Roberson #define VMEM_ADDR_MAX (~(vmem_addr_t)0) 465f518366SJeff Roberson 475f518366SJeff Roberson typedef int (vmem_import_t)(void *, vmem_size_t, int, vmem_addr_t *); 485f518366SJeff Roberson typedef void (vmem_release_t)(void *, vmem_addr_t, vmem_size_t); 495f518366SJeff Roberson typedef void (vmem_reclaim_t)(vmem_t *, int); 505f518366SJeff Roberson 515f518366SJeff Roberson /* 525f518366SJeff Roberson * Create a vmem: 535f518366SJeff Roberson * name - Name of the region 545f518366SJeff Roberson * base - Initial span start (optional) 555f518366SJeff Roberson * size - Initial span size 565f518366SJeff Roberson * quantum - Natural unit of allocation (ie PAGE_SIZE, 1, etc) 575f518366SJeff Roberson * qcache_max - Maximum size to quantum cache. This creates a UMA 585f518366SJeff Roberson * cache for each multiple of quantum up to qcache_max. 595f518366SJeff Roberson * flags - M_* flags 605f518366SJeff Roberson */ 615f518366SJeff Roberson vmem_t *vmem_create(const char *name, vmem_addr_t base, 625f518366SJeff Roberson vmem_size_t size, vmem_size_t quantum, vmem_size_t qcache_max, int flags); 635f518366SJeff Roberson vmem_t *vmem_init(vmem_t *vm, const char *name, vmem_addr_t base, 645f518366SJeff Roberson vmem_size_t size, vmem_size_t quantum, vmem_size_t qcache_max, int flags); 655f518366SJeff Roberson void vmem_destroy(vmem_t *); 665f518366SJeff Roberson 675f518366SJeff Roberson /* 685f518366SJeff Roberson * Set callbacks for bringing in dynamic regions: 695f518366SJeff Roberson * importfn - Backing store import routine. 705f518366SJeff Roberson * releasefn - Backing store release routine. 715f518366SJeff Roberson * arg - Backing store argument 725f518366SJeff Roberson * import_quantum - Size to import from backing store 735f518366SJeff Roberson */ 745f518366SJeff Roberson 755f518366SJeff Roberson void vmem_set_import(vmem_t *vm, vmem_import_t *importfn, 765f518366SJeff Roberson vmem_release_t *releasefn, void *arg, vmem_size_t import_quantum); 775f518366SJeff Roberson 785f518366SJeff Roberson /* 795f518366SJeff Roberson * Set a callback for reclaiming memory when space is exhausted: 805f518366SJeff Roberson */ 815f518366SJeff Roberson void vmem_set_reclaim(vmem_t *vm, vmem_reclaim_t *reclaimfn); 825f518366SJeff Roberson 835f518366SJeff Roberson /* 845f518366SJeff Roberson * Allocate and free linear regions from a vmem. Must specify 855f518366SJeff Roberson * BESTFIT or FIRSTFIT. Free is non-blocking. These routines 865f518366SJeff Roberson * respect the quantum caches. 875f518366SJeff Roberson */ 885f518366SJeff Roberson int vmem_alloc(vmem_t *vm, vmem_size_t size, int flags, vmem_addr_t *addrp); 895f518366SJeff Roberson void vmem_free(vmem_t *vm, vmem_addr_t addr, vmem_size_t size); 905f518366SJeff Roberson 915f518366SJeff Roberson /* 925f518366SJeff Roberson * Constrained allocate and free routines. These bypass the quantum cache. 935f518366SJeff Roberson * size - Size in units of 1, not quantum. 945f518366SJeff Roberson * align - Required alignment of the start of region 955f518366SJeff Roberson * phase - Offset from alignment 965f518366SJeff Roberson * nocross - Illegal boundary 975f518366SJeff Roberson * minaddr - Minimum allowed address for last byte 985f518366SJeff Roberson * maxaddr - Maximum allowed address for first byte 995f518366SJeff Roberson * flags - M_* flags 1005f518366SJeff Roberson * addrp - result 1015f518366SJeff Roberson */ 1025f518366SJeff Roberson int vmem_xalloc(vmem_t *vm, vmem_size_t size, vmem_size_t align, 1035f518366SJeff Roberson vmem_size_t phase, vmem_size_t nocross, vmem_addr_t minaddr, 1045f518366SJeff Roberson vmem_addr_t maxaddr, int flags, vmem_addr_t *addrp); 1055f518366SJeff Roberson void vmem_xfree(vmem_t *vm, vmem_addr_t addr, vmem_size_t size); 1065f518366SJeff Roberson 1075f518366SJeff Roberson /* 1085f518366SJeff Roberson * Add a static region to a vmem after create. This won't be freed 1095f518366SJeff Roberson * until the vmem is destroyed. 1105f518366SJeff Roberson */ 1115f518366SJeff Roberson int vmem_add(vmem_t *vm, vmem_addr_t addr, vmem_size_t size, int flags); 1125f518366SJeff Roberson 1135f518366SJeff Roberson /* 1145f518366SJeff Roberson * Given roundup size to the vmem's native quantum size. 1155f518366SJeff Roberson */ 1165f518366SJeff Roberson vmem_size_t vmem_roundup_size(vmem_t *vm, vmem_size_t size); 1175f518366SJeff Roberson 1185f518366SJeff Roberson /* 1195f518366SJeff Roberson * Report vmem utilization according to the requested type. 1205f518366SJeff Roberson */ 1215f518366SJeff Roberson vmem_size_t vmem_size(vmem_t *vm, int typemask); 1225f518366SJeff Roberson 1235f518366SJeff Roberson void vmem_whatis(vmem_addr_t addr, int (*fn)(const char *, ...) 1245f518366SJeff Roberson __printflike(1, 2)); 1255f518366SJeff Roberson void vmem_print(vmem_addr_t addr, const char *, int (*fn)(const char *, ...) 1265f518366SJeff Roberson __printflike(1, 2)); 1275f518366SJeff Roberson void vmem_printall(const char *, int (*fn)(const char *, ...) 1285f518366SJeff Roberson __printflike(1, 2)); 1295f518366SJeff Roberson void vmem_startup(void); 1305f518366SJeff Roberson 1315f518366SJeff Roberson /* vmem_size typemask */ 1325f518366SJeff Roberson #define VMEM_ALLOC 0x01 1335f518366SJeff Roberson #define VMEM_FREE 0x02 1342e9ccb32SAlexander Motin #define VMEM_MAXFREE 0x10 1355f518366SJeff Roberson 1365f518366SJeff Roberson #endif /* _KERNEL */ 1375f518366SJeff Roberson 1385f518366SJeff Roberson #endif /* !_SYS_VMEM_H_ */ 139