FreeBSD/Linux Kernel Cross Reference
sys/sys/vmem.h

     /*-
      * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
      *
      * Copyright (c)2006 YAMAMOTO Takashi,
      * All rights reserved.
      *
      * Redistribution and use in source and binary forms, with or without
      * modification, are permitted provided that the following conditions
      * are met:
     * 1. Redistributions of source code must retain the above copyright
     *    notice, this list of conditions and the following disclaimer.
     * 2. Redistributions in binary form must reproduce the above copyright
     *    notice, this list of conditions and the following disclaimer in the
     *    documentation and/or other materials provided with the distribution.
     *
     * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
     * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     * SUCH DAMAGE.
     */
    /* From $NetBSD: vmem.h,v 1.20 2013/01/29 21:26:24 para Exp $   */
    
    /* $FreeBSD: releng/12.0/sys/sys/vmem.h 326347 2017-11-28 23:40:54Z jeff $ */
    
    #ifndef _SYS_VMEM_H_
    #define _SYS_VMEM_H_
    
    #include <sys/types.h>
    
    #ifdef _KERNEL
    
    typedef struct vmem vmem_t;
    
    typedef uintptr_t       vmem_addr_t;
    typedef size_t          vmem_size_t;
    
    #define VMEM_ADDR_MIN   0
    #define VMEM_ADDR_MAX   (~(vmem_addr_t)0)
    
    typedef int (vmem_import_t)(void *, vmem_size_t, int, vmem_addr_t *);
    typedef void (vmem_release_t)(void *, vmem_addr_t, vmem_size_t);
    typedef void (vmem_reclaim_t)(vmem_t *, int);
    
    /*
     * Create a vmem:
     *      name            - Name of the region
     *      base            - Initial span start (optional)
     *      size            - Initial span size
     *      quantum         - Natural unit of allocation (ie PAGE_SIZE, 1, etc)
     *      qcache_max      - Maximum size to quantum cache.  This creates a UMA
     *                        cache for each multiple of quantum up to qcache_max.
     *      flags           - M_* flags
     */
    vmem_t *vmem_create(const char *name, vmem_addr_t base,
        vmem_size_t size, vmem_size_t quantum, vmem_size_t qcache_max, int flags);
    vmem_t *vmem_init(vmem_t *vm, const char *name, vmem_addr_t base,
        vmem_size_t size, vmem_size_t quantum, vmem_size_t qcache_max, int flags);
    void vmem_destroy(vmem_t *);
    
    /*
     * Set callbacks for bringing in dynamic regions:
     *      importfn        - Backing store import routine.
     *      releasefn       - Backing store release routine.
     *      arg             - Backing store argument
     *      import_quantum  - Size to import from backing store
     */
    
    void vmem_set_import(vmem_t *vm, vmem_import_t *importfn,
        vmem_release_t *releasefn, void *arg, vmem_size_t import_quantum);
    
    /*
     * Set a limit on the total size of a vmem.
     */
    
    void vmem_set_limit(vmem_t *vm, vmem_size_t limit);
    
    /*
     * Set a callback for reclaiming memory when space is exhausted:
     */
    void vmem_set_reclaim(vmem_t *vm, vmem_reclaim_t *reclaimfn);
    
    /*
     * Allocate and free linear regions from a vmem.  Must specify
     * BESTFIT or FIRSTFIT.  Free is non-blocking.  These routines
     * respect the quantum caches.
     */
    int vmem_alloc(vmem_t *vm, vmem_size_t size, int flags, vmem_addr_t *addrp);
    void vmem_free(vmem_t *vm, vmem_addr_t addr, vmem_size_t size);
    
    /*
     * Constrained allocate and free routines.  These bypass the quantum cache.
     *      size            - Size in units of 1, not quantum.
    *      align           - Required alignment of the start of region
    *      phase           - Offset from alignment
    *      nocross         - Illegal boundary
    *      minaddr         - Minimum allowed address for last byte
    *      maxaddr         - Maximum allowed address for first byte
    *      flags           - M_* flags
    *      addrp           - result
    */
   int vmem_xalloc(vmem_t *vm, vmem_size_t size, vmem_size_t align,
       vmem_size_t phase, vmem_size_t nocross, vmem_addr_t minaddr,
       vmem_addr_t maxaddr, int flags, vmem_addr_t *addrp);
   void vmem_xfree(vmem_t *vm, vmem_addr_t addr, vmem_size_t size);
   
   /*
    * Add a static region to a vmem after create.  This won't be freed
    * until the vmem is destroyed.
    */
   int vmem_add(vmem_t *vm, vmem_addr_t addr, vmem_size_t size, int flags);
   
   /*
    * Given roundup size to the vmem's native quantum size.
    */
   vmem_size_t vmem_roundup_size(vmem_t *vm, vmem_size_t size);
   
   /*
    * Report vmem utilization according to the requested type.
    */
   vmem_size_t vmem_size(vmem_t *vm, int typemask);
   
   void vmem_whatis(vmem_addr_t addr, int (*fn)(const char *, ...)
       __printflike(1, 2));
   void vmem_print(vmem_addr_t addr, const char *, int (*fn)(const char *, ...)
       __printflike(1, 2));
   void vmem_printall(const char *, int (*fn)(const char *, ...)
       __printflike(1, 2));
   void vmem_startup(void);
   
   /* vmem_size typemask */
   #define VMEM_ALLOC      0x01
   #define VMEM_FREE       0x02
   #define VMEM_MAXFREE    0x10
   
   #endif /* _KERNEL */
   
   #endif /* !_SYS_VMEM_H_ */

Cache object: 903f130af995a24dfc3dc0330516f83a