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