include/os/freebsd/spl/sys/kmem.h

   1 /*
   2  * Copyright (c) 2007 Pawel Jakub Dawidek <pjd@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _OPENSOLARIS_SYS_KMEM_H_
  30 #define _OPENSOLARIS_SYS_KMEM_H_
  31
  32 #ifdef _KERNEL
  33 #include <sys/param.h>
  34 #include <sys/malloc.h>
  35 #include <sys/vmem.h>
  36 #include <sys/counter.h>
  37
  38 #include <vm/uma.h>
  39 #include <vm/vm.h>
  40 #include <vm/vm_extern.h>
  41
  42 MALLOC_DECLARE(M_SOLARIS);
  43
  44 #define POINTER_IS_VALID(p)     (!((uintptr_t)(p) & 0x3))
  45 #define POINTER_INVALIDATE(pp)  (*(pp) = (void *)((uintptr_t)(*(pp)) | 0x1))
  46
  47 #define KM_SLEEP                M_WAITOK
  48 #define KM_PUSHPAGE             M_WAITOK
  49 #define KM_NOSLEEP              M_NOWAIT
  50 #define KM_NORMALPRI            0
  51 #define KMC_NODEBUG             UMA_ZONE_NODUMP
  52
  53 typedef struct vmem vmem_t;
  54
  55 extern char     *kmem_asprintf(const char *, ...)
  56     __attribute__((format(printf, 1, 2)));
  57 extern char *kmem_vasprintf(const char *fmt, va_list ap)
  58     __attribute__((format(printf, 1, 0)));
  59
  60 extern int kmem_scnprintf(char *restrict str, size_t size,
  61     const char *restrict fmt, ...);
  62
  63 typedef struct kmem_cache {
  64         char            kc_name[32];
  65 #if !defined(KMEM_DEBUG)
  66         uma_zone_t      kc_zone;
  67 #else
  68         size_t          kc_size;
  69 #endif
  70         int             (*kc_constructor)(void *, void *, int);
  71         void            (*kc_destructor)(void *, void *);
  72         void            *kc_private;
  73 } kmem_cache_t;
  74
  75 extern uint64_t spl_kmem_cache_inuse(kmem_cache_t *cache);
  76 extern uint64_t spl_kmem_cache_entry_size(kmem_cache_t *cache);
  77
  78 __attribute__((malloc, alloc_size(1)))
  79 void *zfs_kmem_alloc(size_t size, int kmflags);
  80 void zfs_kmem_free(void *buf, size_t size);
  81 uint64_t kmem_size(void);
  82 kmem_cache_t *kmem_cache_create(const char *name, size_t bufsize, size_t align,
  83     int (*constructor)(void *, void *, int), void (*destructor)(void *, void *),
  84     void (*reclaim)(void *) __unused, void *private, vmem_t *vmp, int cflags);
  85 void kmem_cache_destroy(kmem_cache_t *cache);
  86 __attribute__((malloc))
  87 void *kmem_cache_alloc(kmem_cache_t *cache, int flags);
  88 void kmem_cache_free(kmem_cache_t *cache, void *buf);
  89 boolean_t kmem_cache_reap_active(void);
  90 void kmem_cache_reap_soon(kmem_cache_t *);
  91 void kmem_reap(void);
  92 int kmem_debugging(void);
  93 void *calloc(size_t n, size_t s);
  94
  95
  96 #define kmem_cache_reap_now kmem_cache_reap_soon
  97 #define freemem                         vm_free_count()
  98 #define minfree                         vm_cnt.v_free_min
  99 #define kmem_alloc(size, kmflags)       zfs_kmem_alloc((size), (kmflags))
 100 #define kmem_zalloc(size, kmflags)                              \
 101         zfs_kmem_alloc((size), (kmflags) | M_ZERO)
 102 #define kmem_free(buf, size)            zfs_kmem_free((buf), (size))
 103
 104 #endif  /* _KERNEL */
 105
 106 #ifdef _STANDALONE
 107 /*
 108  * At the moment, we just need it for the type. We redirect the alloc/free
 109  * routines to the usual Free and Malloc in that environment.
 110  */
 111 typedef int kmem_cache_t;
 112 #endif /* _STANDALONE */
 113
 114 #endif  /* _OPENSOLARIS_SYS_KMEM_H_ */