]> git.proxmox.com Git - mirror_spl-debian.git/blame - include/sys/kmem.h
Atomic64 compatibility for 32-bit systems without kernel support.
[mirror_spl-debian.git] / include / sys / kmem.h
CommitLineData
715f6251 1/*
2 * This file is part of the SPL: Solaris Porting Layer.
3 *
4 * Copyright (c) 2008 Lawrence Livermore National Security, LLC.
5 * Produced at Lawrence Livermore National Laboratory
6 * Written by:
7 * Brian Behlendorf <behlendorf1@llnl.gov>,
8 * Herb Wartens <wartens2@llnl.gov>,
9 * Jim Garlick <garlick@llnl.gov>
10 * UCRL-CODE-235197
11 *
12 * This is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * This is distributed in the hope that it will be useful, but WITHOUT
18 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
19 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
20 * for more details.
21 *
22 * You should have received a copy of the GNU General Public License along
23 * with this program; if not, write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 */
26
09b414e8 27#ifndef _SPL_KMEM_H
28#define _SPL_KMEM_H
f1ca4da6 29
30#ifdef __cplusplus
31extern "C" {
32#endif
33
f1ca4da6 34#undef DEBUG_KMEM_UNIMPLEMENTED
35
f1b59d26 36#include <linux/module.h>
f1ca4da6 37#include <linux/slab.h>
79b31f36 38#include <linux/vmalloc.h>
baf2979e 39#include <linux/mm_compat.h>
f1ca4da6 40#include <linux/spinlock.h>
d6a26c6a 41#include <linux/rwsem.h>
42#include <linux/hash.h>
43#include <linux/ctype.h>
d04c8a56 44#include <asm/atomic.h>
57d86234 45#include <sys/types.h>
937879f1 46#include <sys/debug.h>
36b313da 47#include <sys/vmsystm.h>
550f1705 48
f1ca4da6 49/*
50 * Memory allocation interfaces
51 */
c89fdee4 52#define KM_SLEEP GFP_KERNEL
f1ca4da6 53#define KM_NOSLEEP GFP_ATOMIC
54#undef KM_PANIC /* No linux analog */
a0f6da3d 55#define KM_PUSHPAGE (KM_SLEEP | __GFP_HIGH)
f1ca4da6 56#define KM_VMFLAGS GFP_LEVEL_MASK
57#define KM_FLAGS __GFP_BITS_MASK
58
3d061e9d 59/*
60 * Used internally, the kernel does not need to support this flag
61 */
62#ifndef __GFP_ZERO
a0f6da3d 63# define __GFP_ZERO 0x8000
3d061e9d 64#endif
65
c89fdee4
BB
66/*
67 * __GFP_NOFAIL looks like it will be removed from the kernel perhaps as
68 * early as 2.6.32. To avoid this issue when it occurs in upstream kernels
69 * we retry the allocation here as long as it is not __GFP_WAIT (GFP_ATOMIC).
70 * I would prefer the caller handle the failure case cleanly but we are
71 * trying to emulate Solaris and those are not the Solaris semantics.
72 */
73static inline void *
74kmalloc_nofail(size_t size, gfp_t flags)
75{
76 void *ptr;
77
78 do {
79 ptr = kmalloc(size, flags);
80 } while (ptr == NULL && (flags & __GFP_WAIT));
81
82 return ptr;
83}
84
85static inline void *
86kzalloc_nofail(size_t size, gfp_t flags)
87{
88 void *ptr;
89
90 do {
91 ptr = kzalloc(size, flags);
92 } while (ptr == NULL && (flags & __GFP_WAIT));
93
94 return ptr;
95}
96
97#ifdef HAVE_KMALLOC_NODE
98static inline void *
99kmalloc_node_nofail(size_t size, gfp_t flags, int node)
100{
101 void *ptr;
102
103 do {
104 ptr = kmalloc_node(size, flags, node);
105 } while (ptr == NULL && (flags & __GFP_WAIT));
106
107 return ptr;
108}
109#endif /* HAVE_KMALLOC_NODE */
110
f1ca4da6 111#ifdef DEBUG_KMEM
d04c8a56 112# ifdef HAVE_ATOMIC64_T
a0f6da3d 113
c19c06f3 114extern atomic64_t kmem_alloc_used;
a0f6da3d 115extern unsigned long long kmem_alloc_max;
c19c06f3 116extern atomic64_t vmem_alloc_used;
a0f6da3d 117extern unsigned long long vmem_alloc_max;
118
d04c8a56
BB
119# define kmem_alloc_used_add(size) atomic64_add(size, &kmem_alloc_used)
120# define kmem_alloc_used_sub(size) atomic64_sub(size, &kmem_alloc_used)
121# define kmem_alloc_used_read() atomic64_read(&kmem_alloc_used)
122# define kmem_alloc_used_set(size) atomic64_set(&kmem_alloc_used, size)
123# define vmem_alloc_used_add(size) atomic64_add(size, &vmem_alloc_used)
124# define vmem_alloc_used_sub(size) atomic64_sub(size, &vmem_alloc_used)
125# define vmem_alloc_used_read() atomic64_read(&vmem_alloc_used)
126# define vmem_alloc_used_set(size) atomic64_set(&vmem_alloc_used, size)
127
128# else
129
130extern atomic_t kmem_alloc_used;
131extern unsigned long long kmem_alloc_max;
132extern atomic_t vmem_alloc_used;
133extern unsigned long long vmem_alloc_max;
134
135# define kmem_alloc_used_add(size) atomic_add(size, &kmem_alloc_used)
136# define kmem_alloc_used_sub(size) atomic_sub(size, &kmem_alloc_used)
137# define kmem_alloc_used_read() atomic_read(&kmem_alloc_used)
138# define kmem_alloc_used_set(size) atomic_set(&kmem_alloc_used, size)
139# define vmem_alloc_used_add(size) atomic_add(size, &vmem_alloc_used)
140# define vmem_alloc_used_sub(size) atomic_sub(size, &vmem_alloc_used)
141# define vmem_alloc_used_read() atomic_read(&vmem_alloc_used)
142# define vmem_alloc_used_set(size) atomic_set(&vmem_alloc_used, size)
143
144# endif /* _LP64 */
145
a0f6da3d 146# define kmem_alloc(size, flags) __kmem_alloc((size), (flags), 0, 0)
147# define kmem_zalloc(size, flags) __kmem_alloc((size), ((flags) | \
148 __GFP_ZERO), 0, 0)
149
150/* The node alloc functions are only used by the SPL code itself */
151# ifdef HAVE_KMALLOC_NODE
152# define kmem_alloc_node(size, flags, node) __kmem_alloc((size), (flags), 1, \
153 node)
154# else
155# define kmem_alloc_node(size, flags, node) __kmem_alloc((size), (flags), 0, 0)
156# endif
157
158# define vmem_zalloc(size, flags) vmem_alloc((size), ((flags) | \
159 __GFP_ZERO))
160
161# ifdef DEBUG_KMEM_TRACKING
162
163extern void *kmem_alloc_track(size_t size, int flags, const char *func,
164 int line, int node_alloc, int node);
165extern void kmem_free_track(void *ptr, size_t size);
166extern void *vmem_alloc_track(size_t size, int flags, const char *func,
167 int line);
168extern void vmem_free_track(void *ptr, size_t size);
169
170# define __kmem_alloc(size, flags, na, node) kmem_alloc_track((size), \
171 (flags), __FUNCTION__, \
172 __LINE__, (na), (node))
173# define kmem_free(ptr, size) kmem_free_track((ptr), (size))
174# define vmem_alloc(size, flags) vmem_alloc_track((size), \
175 (flags),__FUNCTION__, \
176 __LINE__)
177# define vmem_free(ptr, size) vmem_free_track((ptr), (size))
178
179# else /* DEBUG_KMEM_TRACKING */
180
181extern void *kmem_alloc_debug(size_t size, int flags, const char *func,
182 int line, int node_alloc, int node);
183extern void kmem_free_debug(void *ptr, size_t size);
184extern void *vmem_alloc_debug(size_t size, int flags, const char *func,
185 int line);
186extern void vmem_free_debug(void *ptr, size_t size);
187
188# define __kmem_alloc(size, flags, na, node) kmem_alloc_debug((size), \
189 (flags), __FUNCTION__, \
190 __LINE__, (na), (node))
191# define kmem_free(ptr, size) kmem_free_debug((ptr), (size))
192# define vmem_alloc(size, flags) vmem_alloc_debug((size), \
193 (flags), __FUNCTION__, \
194 __LINE__)
195# define vmem_free(ptr, size) vmem_free_debug((ptr), (size))
196
197# endif /* DEBUG_KMEM_TRACKING */
ff449ac4 198
c6dc93d6 199#else /* DEBUG_KMEM */
f1ca4da6 200
c89fdee4
BB
201# define kmem_alloc(size, flags) kmalloc_nofail((size), (flags))
202# define kmem_zalloc(size, flags) kzalloc_nofail((size), (flags))
a1cf80b4 203# define kmem_free(ptr, size) ((void)(size), kfree(ptr))
a0f6da3d 204
205# ifdef HAVE_KMALLOC_NODE
206# define kmem_alloc_node(size, flags, node) \
c89fdee4 207 kmalloc_node_nofail((size), (flags), (node))
a0f6da3d 208# else
209# define kmem_alloc_node(size, flags, node) \
c89fdee4 210 kmalloc_nofail((size), (flags))
a0f6da3d 211# endif
212
a1cf80b4
BB
213# define vmem_alloc(size, flags) __vmalloc((size), ((flags) | \
214 __GFP_HIGHMEM), PAGE_KERNEL)
a0f6da3d 215# define vmem_zalloc(size, flags) \
79b31f36 216({ \
c6dc93d6 217 void *_ptr_ = __vmalloc((size),((flags)|__GFP_HIGHMEM),PAGE_KERNEL); \
218 if (_ptr_) \
219 memset(_ptr_, 0, (size)); \
220 _ptr_; \
79b31f36 221})
bb01879e 222# define vmem_free(ptr, size) ((void)(size), vfree(ptr))
79b31f36 223
f1ca4da6 224#endif /* DEBUG_KMEM */
225
f1ca4da6 226#ifdef DEBUG_KMEM_UNIMPLEMENTED
227static __inline__ void *
228kmem_alloc_tryhard(size_t size, size_t *alloc_size, int kmflags)
229{
230#error "kmem_alloc_tryhard() not implemented"
231}
232#endif /* DEBUG_KMEM_UNIMPLEMENTED */
233
234/*
235 * Slab allocation interfaces
236 */
ea3e6ca9
BB
237enum {
238 KMC_BIT_NOTOUCH = 0, /* Don't update ages */
239 KMC_BIT_NODEBUG = 1, /* Default behavior */
240 KMC_BIT_NOMAGAZINE = 2, /* XXX: Unsupported */
241 KMC_BIT_NOHASH = 3, /* XXX: Unsupported */
242 KMC_BIT_QCACHE = 4, /* XXX: Unsupported */
243 KMC_BIT_KMEM = 5, /* Use kmem cache */
244 KMC_BIT_VMEM = 6, /* Use vmem cache */
245 KMC_BIT_OFFSLAB = 7, /* Objects not on slab */
246 KMC_BIT_REAPING = 16, /* Reaping in progress */
247 KMC_BIT_DESTROY = 17, /* Destroy in progress */
248};
249
250#define KMC_NOTOUCH (1 << KMC_BIT_NOTOUCH)
251#define KMC_NODEBUG (1 << KMC_BIT_NODEBUG)
252#define KMC_NOMAGAZINE (1 << KMC_BIT_NOMAGAZINE)
253#define KMC_NOHASH (1 << KMC_BIT_NOHASH)
254#define KMC_QCACHE (1 << KMC_BIT_QCACHE)
255#define KMC_KMEM (1 << KMC_BIT_KMEM)
256#define KMC_VMEM (1 << KMC_BIT_VMEM)
257#define KMC_OFFSLAB (1 << KMC_BIT_OFFSLAB)
258#define KMC_REAPING (1 << KMC_BIT_REAPING)
259#define KMC_DESTROY (1 << KMC_BIT_DESTROY)
260
261#define KMC_REAP_CHUNK INT_MAX
262#define KMC_DEFAULT_SEEKS 1
f1ca4da6 263
f1ca4da6 264#ifdef DEBUG_KMEM_UNIMPLEMENTED
265static __inline__ void kmem_init(void) {
266#error "kmem_init() not implemented"
267}
268
269static __inline__ void kmem_thread_init(void) {
270#error "kmem_thread_init() not implemented"
271}
272
273static __inline__ void kmem_mp_init(void) {
274#error "kmem_mp_init() not implemented"
275}
276
277static __inline__ void kmem_reap_idspace(void) {
278#error "kmem_reap_idspace() not implemented"
279}
280
281static __inline__ size_t kmem_avail(void) {
282#error "kmem_avail() not implemented"
283}
284
285static __inline__ size_t kmem_maxavail(void) {
286#error "kmem_maxavail() not implemented"
287}
288
2fb9b26a 289static __inline__ uint64_t kmem_cache_stat(spl_kmem_cache_t *cache) {
f1ca4da6 290#error "kmem_cache_stat() not implemented"
291}
292#endif /* DEBUG_KMEM_UNIMPLEMENTED */
293
294/* XXX - Used by arc.c to adjust its memory footprint. We may want
295 * to use this hook in the future to adjust behavior based on
296 * debug levels. For now it's safe to always return 0.
297 */
298static __inline__ int
299kmem_debugging(void)
300{
301 return 0;
302}
303
c19c06f3 304extern int kmem_set_warning(int flag);
305
ff449ac4 306extern struct list_head spl_kmem_cache_list;
307extern struct rw_semaphore spl_kmem_cache_sem;
2fb9b26a 308
4afaaefa 309#define SKM_MAGIC 0x2e2e2e2e
2fb9b26a 310#define SKO_MAGIC 0x20202020
311#define SKS_MAGIC 0x22222222
312#define SKC_MAGIC 0x2c2c2c2c
313
37db7d8c
BB
314#define SPL_KMEM_CACHE_DELAY 15 /* Minimum slab release age */
315#define SPL_KMEM_CACHE_REAP 0 /* Default reap everything */
ea3e6ca9
BB
316#define SPL_KMEM_CACHE_OBJ_PER_SLAB 32 /* Target objects per slab */
317#define SPL_KMEM_CACHE_OBJ_PER_SLAB_MIN 8 /* Minimum objects per slab */
318#define SPL_KMEM_CACHE_ALIGN 8 /* Default object alignment */
2fb9b26a 319
320typedef int (*spl_kmem_ctor_t)(void *, void *, int);
321typedef void (*spl_kmem_dtor_t)(void *, void *);
322typedef void (*spl_kmem_reclaim_t)(void *);
323
4afaaefa 324typedef struct spl_kmem_magazine {
9b1b8e4c 325 uint32_t skm_magic; /* Sanity magic */
4afaaefa 326 uint32_t skm_avail; /* Available objects */
327 uint32_t skm_size; /* Magazine size */
328 uint32_t skm_refill; /* Batch refill size */
9b1b8e4c
BB
329 struct spl_kmem_cache *skm_cache; /* Owned by cache */
330 struct delayed_work skm_work; /* Magazine reclaim work */
4afaaefa 331 unsigned long skm_age; /* Last cache access */
332 void *skm_objs[0]; /* Object pointers */
333} spl_kmem_magazine_t;
334
2fb9b26a 335typedef struct spl_kmem_obj {
336 uint32_t sko_magic; /* Sanity magic */
2fb9b26a 337 void *sko_addr; /* Buffer address */
338 struct spl_kmem_slab *sko_slab; /* Owned by slab */
339 struct list_head sko_list; /* Free object list linkage */
2fb9b26a 340} spl_kmem_obj_t;
341
342typedef struct spl_kmem_slab {
343 uint32_t sks_magic; /* Sanity magic */
344 uint32_t sks_objs; /* Objects per slab */
345 struct spl_kmem_cache *sks_cache; /* Owned by cache */
346 struct list_head sks_list; /* Slab list linkage */
347 struct list_head sks_free_list; /* Free object list */
348 unsigned long sks_age; /* Last modify jiffie */
4afaaefa 349 uint32_t sks_ref; /* Ref count used objects */
2fb9b26a 350} spl_kmem_slab_t;
351
352typedef struct spl_kmem_cache {
ea3e6ca9
BB
353 uint32_t skc_magic; /* Sanity magic */
354 uint32_t skc_name_size; /* Name length */
355 char *skc_name; /* Name string */
4afaaefa 356 spl_kmem_magazine_t *skc_mag[NR_CPUS]; /* Per-CPU warm cache */
357 uint32_t skc_mag_size; /* Magazine size */
358 uint32_t skc_mag_refill; /* Magazine refill count */
ea3e6ca9
BB
359 spl_kmem_ctor_t skc_ctor; /* Constructor */
360 spl_kmem_dtor_t skc_dtor; /* Destructor */
361 spl_kmem_reclaim_t skc_reclaim; /* Reclaimator */
362 void *skc_private; /* Private data */
363 void *skc_vmp; /* Unused */
31a033ec 364 unsigned long skc_flags; /* Flags */
2fb9b26a 365 uint32_t skc_obj_size; /* Object size */
48e0606a 366 uint32_t skc_obj_align; /* Object alignment */
a1502d76 367 uint32_t skc_slab_objs; /* Objects per slab */
ea3e6ca9
BB
368 uint32_t skc_slab_size; /* Slab size */
369 uint32_t skc_delay; /* Slab reclaim interval */
37db7d8c 370 uint32_t skc_reap; /* Slab reclaim count */
ea3e6ca9
BB
371 atomic_t skc_ref; /* Ref count callers */
372 struct delayed_work skc_work; /* Slab reclaim work */
ea3e6ca9 373 struct list_head skc_list; /* List of caches linkage */
2fb9b26a 374 struct list_head skc_complete_list;/* Completely alloc'ed */
375 struct list_head skc_partial_list; /* Partially alloc'ed */
d46630e0 376 spinlock_t skc_lock; /* Cache lock */
2fb9b26a 377 uint64_t skc_slab_fail; /* Slab alloc failures */
378 uint64_t skc_slab_create;/* Slab creates */
379 uint64_t skc_slab_destroy;/* Slab destroys */
d46630e0 380 uint64_t skc_slab_total; /* Slab total current */
ea3e6ca9 381 uint64_t skc_slab_alloc; /* Slab alloc current */
d46630e0 382 uint64_t skc_slab_max; /* Slab max historic */
383 uint64_t skc_obj_total; /* Obj total current */
384 uint64_t skc_obj_alloc; /* Obj alloc current */
385 uint64_t skc_obj_max; /* Obj max historic */
2fb9b26a 386} spl_kmem_cache_t;
7afde631 387#define kmem_cache_t spl_kmem_cache_t
2fb9b26a 388
389extern spl_kmem_cache_t *
390spl_kmem_cache_create(char *name, size_t size, size_t align,
391 spl_kmem_ctor_t ctor, spl_kmem_dtor_t dtor, spl_kmem_reclaim_t reclaim,
f1ca4da6 392 void *priv, void *vmp, int flags);
393
2fb9b26a 394extern void spl_kmem_cache_destroy(spl_kmem_cache_t *skc);
395extern void *spl_kmem_cache_alloc(spl_kmem_cache_t *skc, int flags);
396extern void spl_kmem_cache_free(spl_kmem_cache_t *skc, void *obj);
397extern void spl_kmem_cache_reap_now(spl_kmem_cache_t *skc);
398extern void spl_kmem_reap(void);
f1ca4da6 399
d1ff2312 400int spl_kmem_init_kallsyms_lookup(void);
2fb9b26a 401int spl_kmem_init(void);
402void spl_kmem_fini(void);
5d86345d 403
f1ca4da6 404#define kmem_cache_create(name,size,align,ctor,dtor,rclm,priv,vmp,flags) \
2fb9b26a 405 spl_kmem_cache_create(name,size,align,ctor,dtor,rclm,priv,vmp,flags)
406#define kmem_cache_destroy(skc) spl_kmem_cache_destroy(skc)
407#define kmem_cache_alloc(skc, flags) spl_kmem_cache_alloc(skc, flags)
408#define kmem_cache_free(skc, obj) spl_kmem_cache_free(skc, obj)
409#define kmem_cache_reap_now(skc) spl_kmem_cache_reap_now(skc)
410#define kmem_reap() spl_kmem_reap()
a1502d76 411#define kmem_virt(ptr) (((ptr) >= (void *)VMALLOC_START) && \
412 ((ptr) < (void *)VMALLOC_END))
f1ca4da6 413
414#ifdef __cplusplus
415}
416#endif
417
09b414e8 418#endif /* _SPL_KMEM_H */