4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License, Version 1.0 only
6 * (the "License"). You may not use this file except in compliance
9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10 * or http://www.opensolaris.org/os/licensing.
11 * See the License for the specific language governing permissions
12 * and limitations under the License.
14 * When distributing Covered Code, include this CDDL HEADER in each
15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16 * If applicable, add the following below this CDDL HEADER, with the
17 * fields enclosed by brackets "[]" replaced with your own identifying
18 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
24 * Use is subject to license terms.
27 #ifndef _LIBSPL_UMEM_H
28 #define _LIBSPL_UMEM_H
31 * XXX: We should use the real portable umem library if it is detected
32 * at configure time. However, if the library is not available, we can
33 * use a trivial malloc based implementation. This obviously impacts
34 * performance, but unless you are using a full userspace build of zpool for
35 * something other than ztest, you are likely not going to notice or care.
37 * https://labs.omniti.com/trac/portableumem
51 * Flags for umem_alloc/umem_free
53 #define UMEM_DEFAULT 0x0000 /* normal -- may fail */
54 #define UMEM_NOFAIL 0x0100 /* Never fails */
57 * Flags for umem_cache_create()
59 #define UMC_NOTOUCH 0x00010000
60 #define UMC_NODEBUG 0x00020000
61 #define UMC_NOMAGAZINE 0x00040000
62 #define UMC_NOHASH 0x00080000
64 #define UMEM_CACHE_NAMELEN 31
66 typedef int umem_nofail_callback_t(void);
67 typedef int umem_constructor_t(void *, void *, int);
68 typedef void umem_destructor_t(void *, void *);
69 typedef void umem_reclaim_t(void *);
71 typedef struct umem_cache {
72 char cache_name[UMEM_CACHE_NAMELEN + 1];
75 umem_constructor_t *cache_constructor;
76 umem_destructor_t *cache_destructor;
77 umem_reclaim_t *cache_reclaim;
84 umem_alloc(size_t size, int flags)
90 } while (ptr == NULL && (flags & UMEM_NOFAIL));
96 umem_alloc_aligned(size_t size, size_t align, int flags)
102 rc = posix_memalign(&ptr, align, size);
103 } while (rc == ENOMEM && (flags & UMEM_NOFAIL));
106 fprintf(stderr, "%s: invalid memory alignment (%zd)\n",
108 if (flags & UMEM_NOFAIL)
117 umem_zalloc(size_t size, int flags)
121 ptr = umem_alloc(size, flags);
123 memset(ptr, 0, size);
129 umem_free(void *ptr, size_t size)
135 umem_nofail_callback(umem_nofail_callback_t *cb)
138 static inline umem_cache_t *
140 char *name, size_t bufsize, size_t align,
141 umem_constructor_t *constructor,
142 umem_destructor_t *destructor,
143 umem_reclaim_t *reclaim,
144 void *priv, void *vmp, int cflags)
148 cp = umem_alloc(sizeof (umem_cache_t), UMEM_DEFAULT);
150 strlcpy(cp->cache_name, name, UMEM_CACHE_NAMELEN);
151 cp->cache_bufsize = bufsize;
152 cp->cache_align = align;
153 cp->cache_constructor = constructor;
154 cp->cache_destructor = destructor;
155 cp->cache_reclaim = reclaim;
156 cp->cache_private = priv;
157 cp->cache_arena = vmp;
158 cp->cache_cflags = cflags;
165 umem_cache_destroy(umem_cache_t *cp)
167 umem_free(cp, sizeof (umem_cache_t));
171 umem_cache_alloc(umem_cache_t *cp, int flags)
175 if (cp->cache_align != 0)
176 ptr = umem_alloc_aligned(
177 cp->cache_bufsize, cp->cache_align, flags);
179 ptr = umem_alloc(cp->cache_bufsize, flags);
181 if (ptr && cp->cache_constructor)
182 cp->cache_constructor(ptr, cp->cache_private, UMEM_DEFAULT);
188 umem_cache_free(umem_cache_t *cp, void *ptr)
190 if (cp->cache_destructor)
191 cp->cache_destructor(ptr, cp->cache_private);
193 umem_free(ptr, cp->cache_bufsize);
197 umem_cache_reap_now(umem_cache_t *cp)