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>.
6 * UCRL-CODE-235197
7 *
8 * This file is part of the SPL, Solaris Porting Layer.
9 *
10 * The SPL is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the
12 * Free Software Foundation; either version 2 of the License, or (at your
13 * option) any later version.
14 *
15 * The SPL is distributed in the hope that it will be useful, but WITHOUT
16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
17 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 * for more details.
19 *
20 * You should have received a copy of the GNU General Public License along
21 * with the SPL. If not, see <http://www.gnu.org/licenses/>.
22 */
23
24 #include <linux/percpu_compat.h>
25 #include <sys/kmem.h>
26 #include <sys/kmem_cache.h>
27 #include <sys/taskq.h>
28 #include <sys/timer.h>
29 #include <sys/vmem.h>
30 #include <sys/wait.h>
31 #include <sys/string.h>
32 #include <linux/slab.h>
33 #include <linux/swap.h>
34 #include <linux/prefetch.h>
35
36 /*
37 * Within the scope of spl-kmem.c file the kmem_cache_* definitions
38 * are removed to allow access to the real Linux slab allocator.
39 */
40 #undef kmem_cache_destroy
41 #undef kmem_cache_create
42 #undef kmem_cache_alloc
43 #undef kmem_cache_free
44
45
46 /*
47 * Linux 3.16 replaced smp_mb__{before,after}_{atomic,clear}_{dec,inc,bit}()
48 * with smp_mb__{before,after}_atomic() because they were redundant. This is
49 * only used inside our SLAB allocator, so we implement an internal wrapper
50 * here to give us smp_mb__{before,after}_atomic() on older kernels.
51 */
52 #ifndef smp_mb__before_atomic
53 #define smp_mb__before_atomic(x) smp_mb__before_clear_bit(x)
54 #endif
55
56 #ifndef smp_mb__after_atomic
57 #define smp_mb__after_atomic(x) smp_mb__after_clear_bit(x)
58 #endif
59
60 /* BEGIN CSTYLED */
61
62 /*
63 * Cache magazines are an optimization designed to minimize the cost of
64 * allocating memory. They do this by keeping a per-cpu cache of recently
65 * freed objects, which can then be reallocated without taking a lock. This
66 * can improve performance on highly contended caches. However, because
67 * objects in magazines will prevent otherwise empty slabs from being
68 * immediately released this may not be ideal for low memory machines.
69 *
70 * For this reason spl_kmem_cache_magazine_size can be used to set a maximum
71 * magazine size. When this value is set to 0 the magazine size will be
72 * automatically determined based on the object size. Otherwise magazines
73 * will be limited to 2-256 objects per magazine (i.e per cpu). Magazines
74 * may never be entirely disabled in this implementation.
75 */
76 unsigned int spl_kmem_cache_magazine_size = 0;
77 module_param(spl_kmem_cache_magazine_size, uint, 0444);
78 MODULE_PARM_DESC(spl_kmem_cache_magazine_size,
79 "Default magazine size (2-256), set automatically (0)");
80
81 /*
82 * The default behavior is to report the number of objects remaining in the
83 * cache. This allows the Linux VM to repeatedly reclaim objects from the
84 * cache when memory is low satisfy other memory allocations. Alternately,
85 * setting this value to KMC_RECLAIM_ONCE limits how aggressively the cache
86 * is reclaimed. This may increase the likelihood of out of memory events.
87 */
88 unsigned int spl_kmem_cache_reclaim = 0 /* KMC_RECLAIM_ONCE */;
89 module_param(spl_kmem_cache_reclaim, uint, 0644);
90 MODULE_PARM_DESC(spl_kmem_cache_reclaim, "Single reclaim pass (0x1)");
91
92 unsigned int spl_kmem_cache_obj_per_slab = SPL_KMEM_CACHE_OBJ_PER_SLAB;
93 module_param(spl_kmem_cache_obj_per_slab, uint, 0644);
94 MODULE_PARM_DESC(spl_kmem_cache_obj_per_slab, "Number of objects per slab");
95
96 unsigned int spl_kmem_cache_max_size = SPL_KMEM_CACHE_MAX_SIZE;
97 module_param(spl_kmem_cache_max_size, uint, 0644);
98 MODULE_PARM_DESC(spl_kmem_cache_max_size, "Maximum size of slab in MB");
99
100 /*
101 * For small objects the Linux slab allocator should be used to make the most
102 * efficient use of the memory. However, large objects are not supported by
103 * the Linux slab and therefore the SPL implementation is preferred. A cutoff
104 * of 16K was determined to be optimal for architectures using 4K pages and
105 * to also work well on architecutres using larger 64K page sizes.
106 */
107 unsigned int spl_kmem_cache_slab_limit = 16384;
108 module_param(spl_kmem_cache_slab_limit, uint, 0644);
109 MODULE_PARM_DESC(spl_kmem_cache_slab_limit,
110 "Objects less than N bytes use the Linux slab");
111
112 /*
113 * The number of threads available to allocate new slabs for caches. This
114 * should not need to be tuned but it is available for performance analysis.
115 */
116 unsigned int spl_kmem_cache_kmem_threads = 4;
117 module_param(spl_kmem_cache_kmem_threads, uint, 0444);
118 MODULE_PARM_DESC(spl_kmem_cache_kmem_threads,
119 "Number of spl_kmem_cache threads");
120 /* END CSTYLED */
121
122 /*
123 * Slab allocation interfaces
124 *
125 * While the Linux slab implementation was inspired by the Solaris
126 * implementation I cannot use it to emulate the Solaris APIs. I
127 * require two features which are not provided by the Linux slab.
128 *
129 * 1) Constructors AND destructors. Recent versions of the Linux
130 * kernel have removed support for destructors. This is a deal
131 * breaker for the SPL which contains particularly expensive
132 * initializers for mutex's, condition variables, etc. We also
133 * require a minimal level of cleanup for these data types unlike
134 * many Linux data types which do need to be explicitly destroyed.
135 *
136 * 2) Virtual address space backed slab. Callers of the Solaris slab
137 * expect it to work well for both small are very large allocations.
138 * Because of memory fragmentation the Linux slab which is backed
139 * by kmalloc'ed memory performs very badly when confronted with
140 * large numbers of large allocations. Basing the slab on the
141 * virtual address space removes the need for contiguous pages
142 * and greatly improve performance for large allocations.
143 *
144 * For these reasons, the SPL has its own slab implementation with
145 * the needed features. It is not as highly optimized as either the
146 * Solaris or Linux slabs, but it should get me most of what is
147 * needed until it can be optimized or obsoleted by another approach.
148 *
149 * One serious concern I do have about this method is the relatively
150 * small virtual address space on 32bit arches. This will seriously
151 * constrain the size of the slab caches and their performance.
152 */
153
154 struct list_head spl_kmem_cache_list; /* List of caches */
155 struct rw_semaphore spl_kmem_cache_sem; /* Cache list lock */
156 taskq_t *spl_kmem_cache_taskq; /* Task queue for aging / reclaim */
157
158 static void spl_cache_shrink(spl_kmem_cache_t *skc, void *obj);
159
160 static void *
kv_alloc(spl_kmem_cache_t * skc,int size,int flags)161 kv_alloc(spl_kmem_cache_t *skc, int size, int flags)
162 {
163 gfp_t lflags = kmem_flags_convert(flags);
164 void *ptr;
165
166 ptr = spl_vmalloc(size, lflags | __GFP_HIGHMEM);
167
168 /* Resulting allocated memory will be page aligned */
169 ASSERT(IS_P2ALIGNED(ptr, PAGE_SIZE));
170
171 return (ptr);
172 }
173
174 static void
kv_free(spl_kmem_cache_t * skc,void * ptr,int size)175 kv_free(spl_kmem_cache_t *skc, void *ptr, int size)
176 {
177 ASSERT(IS_P2ALIGNED(ptr, PAGE_SIZE));
178
179 /*
180 * The Linux direct reclaim path uses this out of band value to
181 * determine if forward progress is being made. Normally this is
182 * incremented by kmem_freepages() which is part of the various
183 * Linux slab implementations. However, since we are using none
184 * of that infrastructure we are responsible for incrementing it.
185 */
186 if (current->reclaim_state)
187 #ifdef HAVE_RECLAIM_STATE_RECLAIMED
188 current->reclaim_state->reclaimed += size >> PAGE_SHIFT;
189 #else
190 current->reclaim_state->reclaimed_slab += size >> PAGE_SHIFT;
191 #endif
192 vfree(ptr);
193 }
194
195 /*
196 * Required space for each aligned sks.
197 */
198 static inline uint32_t
spl_sks_size(spl_kmem_cache_t * skc)199 spl_sks_size(spl_kmem_cache_t *skc)
200 {
201 return (P2ROUNDUP_TYPED(sizeof (spl_kmem_slab_t),
202 skc->skc_obj_align, uint32_t));
203 }
204
205 /*
206 * Required space for each aligned object.
207 */
208 static inline uint32_t
spl_obj_size(spl_kmem_cache_t * skc)209 spl_obj_size(spl_kmem_cache_t *skc)
210 {
211 uint32_t align = skc->skc_obj_align;
212
213 return (P2ROUNDUP_TYPED(skc->skc_obj_size, align, uint32_t) +
214 P2ROUNDUP_TYPED(sizeof (spl_kmem_obj_t), align, uint32_t));
215 }
216
217 uint64_t
spl_kmem_cache_inuse(kmem_cache_t * cache)218 spl_kmem_cache_inuse(kmem_cache_t *cache)
219 {
220 return (cache->skc_obj_total);
221 }
222 EXPORT_SYMBOL(spl_kmem_cache_inuse);
223
224 uint64_t
spl_kmem_cache_entry_size(kmem_cache_t * cache)225 spl_kmem_cache_entry_size(kmem_cache_t *cache)
226 {
227 return (cache->skc_obj_size);
228 }
229 EXPORT_SYMBOL(spl_kmem_cache_entry_size);
230
231 /*
232 * Lookup the spl_kmem_object_t for an object given that object.
233 */
234 static inline spl_kmem_obj_t *
spl_sko_from_obj(spl_kmem_cache_t * skc,void * obj)235 spl_sko_from_obj(spl_kmem_cache_t *skc, void *obj)
236 {
237 return (obj + P2ROUNDUP_TYPED(skc->skc_obj_size,
238 skc->skc_obj_align, uint32_t));
239 }
240
241 /*
242 * It's important that we pack the spl_kmem_obj_t structure and the
243 * actual objects in to one large address space to minimize the number
244 * of calls to the allocator. It is far better to do a few large
245 * allocations and then subdivide it ourselves. Now which allocator
246 * we use requires balancing a few trade offs.
247 *
248 * For small objects we use kmem_alloc() because as long as you are
249 * only requesting a small number of pages (ideally just one) its cheap.
250 * However, when you start requesting multiple pages with kmem_alloc()
251 * it gets increasingly expensive since it requires contiguous pages.
252 * For this reason we shift to vmem_alloc() for slabs of large objects
253 * which removes the need for contiguous pages. We do not use
254 * vmem_alloc() in all cases because there is significant locking
255 * overhead in __get_vm_area_node(). This function takes a single
256 * global lock when acquiring an available virtual address range which
257 * serializes all vmem_alloc()'s for all slab caches. Using slightly
258 * different allocation functions for small and large objects should
259 * give us the best of both worlds.
260 *
261 * +------------------------+
262 * | spl_kmem_slab_t --+-+ |
263 * | skc_obj_size <-+ | |
264 * | spl_kmem_obj_t | |
265 * | skc_obj_size <---+ |
266 * | spl_kmem_obj_t | |
267 * | ... v |
268 * +------------------------+
269 */
270 static spl_kmem_slab_t *
spl_slab_alloc(spl_kmem_cache_t * skc,int flags)271 spl_slab_alloc(spl_kmem_cache_t *skc, int flags)
272 {
273 spl_kmem_slab_t *sks;
274 void *base;
275 uint32_t obj_size;
276
277 base = kv_alloc(skc, skc->skc_slab_size, flags);
278 if (base == NULL)
279 return (NULL);
280
281 sks = (spl_kmem_slab_t *)base;
282 sks->sks_magic = SKS_MAGIC;
283 sks->sks_objs = skc->skc_slab_objs;
284 sks->sks_age = jiffies;
285 sks->sks_cache = skc;
286 INIT_LIST_HEAD(&sks->sks_list);
287 INIT_LIST_HEAD(&sks->sks_free_list);
288 sks->sks_ref = 0;
289 obj_size = spl_obj_size(skc);
290
291 for (int i = 0; i < sks->sks_objs; i++) {
292 void *obj = base + spl_sks_size(skc) + (i * obj_size);
293
294 ASSERT(IS_P2ALIGNED(obj, skc->skc_obj_align));
295 spl_kmem_obj_t *sko = spl_sko_from_obj(skc, obj);
296 sko->sko_addr = obj;
297 sko->sko_magic = SKO_MAGIC;
298 sko->sko_slab = sks;
299 INIT_LIST_HEAD(&sko->sko_list);
300 list_add_tail(&sko->sko_list, &sks->sks_free_list);
301 }
302
303 return (sks);
304 }
305
306 /*
307 * Remove a slab from complete or partial list, it must be called with
308 * the 'skc->skc_lock' held but the actual free must be performed
309 * outside the lock to prevent deadlocking on vmem addresses.
310 */
311 static void
spl_slab_free(spl_kmem_slab_t * sks,struct list_head * sks_list,struct list_head * sko_list)312 spl_slab_free(spl_kmem_slab_t *sks,
313 struct list_head *sks_list, struct list_head *sko_list)
314 {
315 spl_kmem_cache_t *skc;
316
317 ASSERT(sks->sks_magic == SKS_MAGIC);
318 ASSERT(sks->sks_ref == 0);
319
320 skc = sks->sks_cache;
321 ASSERT(skc->skc_magic == SKC_MAGIC);
322
323 /*
324 * Update slab/objects counters in the cache, then remove the
325 * slab from the skc->skc_partial_list. Finally add the slab
326 * and all its objects in to the private work lists where the
327 * destructors will be called and the memory freed to the system.
328 */
329 skc->skc_obj_total -= sks->sks_objs;
330 skc->skc_slab_total--;
331 list_del(&sks->sks_list);
332 list_add(&sks->sks_list, sks_list);
333 list_splice_init(&sks->sks_free_list, sko_list);
334 }
335
336 /*
337 * Reclaim empty slabs at the end of the partial list.
338 */
339 static void
spl_slab_reclaim(spl_kmem_cache_t * skc)340 spl_slab_reclaim(spl_kmem_cache_t *skc)
341 {
342 spl_kmem_slab_t *sks = NULL, *m = NULL;
343 spl_kmem_obj_t *sko = NULL, *n = NULL;
344 LIST_HEAD(sks_list);
345 LIST_HEAD(sko_list);
346
347 /*
348 * Empty slabs and objects must be moved to a private list so they
349 * can be safely freed outside the spin lock. All empty slabs are
350 * at the end of skc->skc_partial_list, therefore once a non-empty
351 * slab is found we can stop scanning.
352 */
353 spin_lock(&skc->skc_lock);
354 list_for_each_entry_safe_reverse(sks, m,
355 &skc->skc_partial_list, sks_list) {
356
357 if (sks->sks_ref > 0)
358 break;
359
360 spl_slab_free(sks, &sks_list, &sko_list);
361 }
362 spin_unlock(&skc->skc_lock);
363
364 /*
365 * The following two loops ensure all the object destructors are run,
366 * and the slabs themselves are freed. This is all done outside the
367 * skc->skc_lock since this allows the destructor to sleep, and
368 * allows us to perform a conditional reschedule when a freeing a
369 * large number of objects and slabs back to the system.
370 */
371
372 list_for_each_entry_safe(sko, n, &sko_list, sko_list) {
373 ASSERT(sko->sko_magic == SKO_MAGIC);
374 }
375
376 list_for_each_entry_safe(sks, m, &sks_list, sks_list) {
377 ASSERT(sks->sks_magic == SKS_MAGIC);
378 kv_free(skc, sks, skc->skc_slab_size);
379 }
380 }
381
382 static spl_kmem_emergency_t *
spl_emergency_search(struct rb_root * root,void * obj)383 spl_emergency_search(struct rb_root *root, void *obj)
384 {
385 struct rb_node *node = root->rb_node;
386 spl_kmem_emergency_t *ske;
387 unsigned long address = (unsigned long)obj;
388
389 while (node) {
390 ske = container_of(node, spl_kmem_emergency_t, ske_node);
391
392 if (address < ske->ske_obj)
393 node = node->rb_left;
394 else if (address > ske->ske_obj)
395 node = node->rb_right;
396 else
397 return (ske);
398 }
399
400 return (NULL);
401 }
402
403 static int
spl_emergency_insert(struct rb_root * root,spl_kmem_emergency_t * ske)404 spl_emergency_insert(struct rb_root *root, spl_kmem_emergency_t *ske)
405 {
406 struct rb_node **new = &(root->rb_node), *parent = NULL;
407 spl_kmem_emergency_t *ske_tmp;
408 unsigned long address = ske->ske_obj;
409
410 while (*new) {
411 ske_tmp = container_of(*new, spl_kmem_emergency_t, ske_node);
412
413 parent = *new;
414 if (address < ske_tmp->ske_obj)
415 new = &((*new)->rb_left);
416 else if (address > ske_tmp->ske_obj)
417 new = &((*new)->rb_right);
418 else
419 return (0);
420 }
421
422 rb_link_node(&ske->ske_node, parent, new);
423 rb_insert_color(&ske->ske_node, root);
424
425 return (1);
426 }
427
428 /*
429 * Allocate a single emergency object and track it in a red black tree.
430 */
431 static int
spl_emergency_alloc(spl_kmem_cache_t * skc,int flags,void ** obj)432 spl_emergency_alloc(spl_kmem_cache_t *skc, int flags, void **obj)
433 {
434 gfp_t lflags = kmem_flags_convert(flags);
435 spl_kmem_emergency_t *ske;
436 int order = get_order(skc->skc_obj_size);
437 int empty;
438
439 /* Last chance use a partial slab if one now exists */
440 spin_lock(&skc->skc_lock);
441 empty = list_empty(&skc->skc_partial_list);
442 spin_unlock(&skc->skc_lock);
443 if (!empty)
444 return (-EEXIST);
445
446 ske = kmalloc(sizeof (*ske), lflags);
447 if (ske == NULL)
448 return (-ENOMEM);
449
450 ske->ske_obj = __get_free_pages(lflags, order);
451 if (ske->ske_obj == 0) {
452 kfree(ske);
453 return (-ENOMEM);
454 }
455
456 spin_lock(&skc->skc_lock);
457 empty = spl_emergency_insert(&skc->skc_emergency_tree, ske);
458 if (likely(empty)) {
459 skc->skc_obj_total++;
460 skc->skc_obj_emergency++;
461 if (skc->skc_obj_emergency > skc->skc_obj_emergency_max)
462 skc->skc_obj_emergency_max = skc->skc_obj_emergency;
463 }
464 spin_unlock(&skc->skc_lock);
465
466 if (unlikely(!empty)) {
467 free_pages(ske->ske_obj, order);
468 kfree(ske);
469 return (-EINVAL);
470 }
471
472 *obj = (void *)ske->ske_obj;
473
474 return (0);
475 }
476
477 /*
478 * Locate the passed object in the red black tree and free it.
479 */
480 static int
spl_emergency_free(spl_kmem_cache_t * skc,void * obj)481 spl_emergency_free(spl_kmem_cache_t *skc, void *obj)
482 {
483 spl_kmem_emergency_t *ske;
484 int order = get_order(skc->skc_obj_size);
485
486 spin_lock(&skc->skc_lock);
487 ske = spl_emergency_search(&skc->skc_emergency_tree, obj);
488 if (ske) {
489 rb_erase(&ske->ske_node, &skc->skc_emergency_tree);
490 skc->skc_obj_emergency--;
491 skc->skc_obj_total--;
492 }
493 spin_unlock(&skc->skc_lock);
494
495 if (ske == NULL)
496 return (-ENOENT);
497
498 free_pages(ske->ske_obj, order);
499 kfree(ske);
500
501 return (0);
502 }
503
504 /*
505 * Release objects from the per-cpu magazine back to their slab. The flush
506 * argument contains the max number of entries to remove from the magazine.
507 */
508 static void
spl_cache_flush(spl_kmem_cache_t * skc,spl_kmem_magazine_t * skm,int flush)509 spl_cache_flush(spl_kmem_cache_t *skc, spl_kmem_magazine_t *skm, int flush)
510 {
511 spin_lock(&skc->skc_lock);
512
513 ASSERT(skc->skc_magic == SKC_MAGIC);
514 ASSERT(skm->skm_magic == SKM_MAGIC);
515
516 int count = MIN(flush, skm->skm_avail);
517 for (int i = 0; i < count; i++)
518 spl_cache_shrink(skc, skm->skm_objs[i]);
519
520 skm->skm_avail -= count;
521 memmove(skm->skm_objs, &(skm->skm_objs[count]),
522 sizeof (void *) * skm->skm_avail);
523
524 spin_unlock(&skc->skc_lock);
525 }
526
527 /*
528 * Size a slab based on the size of each aligned object plus spl_kmem_obj_t.
529 * When on-slab we want to target spl_kmem_cache_obj_per_slab. However,
530 * for very small objects we may end up with more than this so as not
531 * to waste space in the minimal allocation of a single page.
532 */
533 static int
spl_slab_size(spl_kmem_cache_t * skc,uint32_t * objs,uint32_t * size)534 spl_slab_size(spl_kmem_cache_t *skc, uint32_t *objs, uint32_t *size)
535 {
536 uint32_t sks_size, obj_size, max_size, tgt_size, tgt_objs;
537
538 sks_size = spl_sks_size(skc);
539 obj_size = spl_obj_size(skc);
540 max_size = (spl_kmem_cache_max_size * 1024 * 1024);
541 tgt_size = (spl_kmem_cache_obj_per_slab * obj_size + sks_size);
542
543 if (tgt_size <= max_size) {
544 tgt_objs = (tgt_size - sks_size) / obj_size;
545 } else {
546 tgt_objs = (max_size - sks_size) / obj_size;
547 tgt_size = (tgt_objs * obj_size) + sks_size;
548 }
549
550 if (tgt_objs == 0)
551 return (-ENOSPC);
552
553 *objs = tgt_objs;
554 *size = tgt_size;
555
556 return (0);
557 }
558
559 /*
560 * Make a guess at reasonable per-cpu magazine size based on the size of
561 * each object and the cost of caching N of them in each magazine. Long
562 * term this should really adapt based on an observed usage heuristic.
563 */
564 static int
spl_magazine_size(spl_kmem_cache_t * skc)565 spl_magazine_size(spl_kmem_cache_t *skc)
566 {
567 uint32_t obj_size = spl_obj_size(skc);
568 int size;
569
570 if (spl_kmem_cache_magazine_size > 0)
571 return (MAX(MIN(spl_kmem_cache_magazine_size, 256), 2));
572
573 /* Per-magazine sizes below assume a 4Kib page size */
574 if (obj_size > (PAGE_SIZE * 256))
575 size = 4; /* Minimum 4Mib per-magazine */
576 else if (obj_size > (PAGE_SIZE * 32))
577 size = 16; /* Minimum 2Mib per-magazine */
578 else if (obj_size > (PAGE_SIZE))
579 size = 64; /* Minimum 256Kib per-magazine */
580 else if (obj_size > (PAGE_SIZE / 4))
581 size = 128; /* Minimum 128Kib per-magazine */
582 else
583 size = 256;
584
585 return (size);
586 }
587
588 /*
589 * Allocate a per-cpu magazine to associate with a specific core.
590 */
591 static spl_kmem_magazine_t *
spl_magazine_alloc(spl_kmem_cache_t * skc,int cpu)592 spl_magazine_alloc(spl_kmem_cache_t *skc, int cpu)
593 {
594 spl_kmem_magazine_t *skm;
595 int size = sizeof (spl_kmem_magazine_t) +
596 sizeof (void *) * skc->skc_mag_size;
597
598 skm = kmalloc_node(size, GFP_KERNEL, cpu_to_node(cpu));
599 if (skm) {
600 skm->skm_magic = SKM_MAGIC;
601 skm->skm_avail = 0;
602 skm->skm_size = skc->skc_mag_size;
603 skm->skm_refill = skc->skc_mag_refill;
604 skm->skm_cache = skc;
605 skm->skm_cpu = cpu;
606 }
607
608 return (skm);
609 }
610
611 /*
612 * Free a per-cpu magazine associated with a specific core.
613 */
614 static void
spl_magazine_free(spl_kmem_magazine_t * skm)615 spl_magazine_free(spl_kmem_magazine_t *skm)
616 {
617 ASSERT(skm->skm_magic == SKM_MAGIC);
618 ASSERT(skm->skm_avail == 0);
619 kfree(skm);
620 }
621
622 /*
623 * Create all pre-cpu magazines of reasonable sizes.
624 */
625 static int
spl_magazine_create(spl_kmem_cache_t * skc)626 spl_magazine_create(spl_kmem_cache_t *skc)
627 {
628 int i = 0;
629
630 ASSERT((skc->skc_flags & KMC_SLAB) == 0);
631
632 skc->skc_mag = kzalloc(sizeof (spl_kmem_magazine_t *) *
633 num_possible_cpus(), kmem_flags_convert(KM_SLEEP));
634 skc->skc_mag_size = spl_magazine_size(skc);
635 skc->skc_mag_refill = (skc->skc_mag_size + 1) / 2;
636
637 for_each_possible_cpu(i) {
638 skc->skc_mag[i] = spl_magazine_alloc(skc, i);
639 if (!skc->skc_mag[i]) {
640 for (i--; i >= 0; i--)
641 spl_magazine_free(skc->skc_mag[i]);
642
643 kfree(skc->skc_mag);
644 return (-ENOMEM);
645 }
646 }
647
648 return (0);
649 }
650
651 /*
652 * Destroy all pre-cpu magazines.
653 */
654 static void
spl_magazine_destroy(spl_kmem_cache_t * skc)655 spl_magazine_destroy(spl_kmem_cache_t *skc)
656 {
657 spl_kmem_magazine_t *skm;
658 int i = 0;
659
660 ASSERT((skc->skc_flags & KMC_SLAB) == 0);
661
662 for_each_possible_cpu(i) {
663 skm = skc->skc_mag[i];
664 spl_cache_flush(skc, skm, skm->skm_avail);
665 spl_magazine_free(skm);
666 }
667
668 kfree(skc->skc_mag);
669 }
670
671 /*
672 * Create a object cache based on the following arguments:
673 * name cache name
674 * size cache object size
675 * align cache object alignment
676 * ctor cache object constructor
677 * dtor cache object destructor
678 * reclaim cache object reclaim
679 * priv cache private data for ctor/dtor/reclaim
680 * vmp unused must be NULL
681 * flags
682 * KMC_KVMEM Force kvmem backed SPL cache
683 * KMC_SLAB Force Linux slab backed cache
684 * KMC_NODEBUG Disable debugging (unsupported)
685 */
686 spl_kmem_cache_t *
spl_kmem_cache_create(char * name,size_t size,size_t align,spl_kmem_ctor_t ctor,spl_kmem_dtor_t dtor,void * reclaim,void * priv,void * vmp,int flags)687 spl_kmem_cache_create(char *name, size_t size, size_t align,
688 spl_kmem_ctor_t ctor, spl_kmem_dtor_t dtor, void *reclaim,
689 void *priv, void *vmp, int flags)
690 {
691 gfp_t lflags = kmem_flags_convert(KM_SLEEP);
692 spl_kmem_cache_t *skc;
693 int rc;
694
695 /*
696 * Unsupported flags
697 */
698 ASSERT(vmp == NULL);
699 ASSERT(reclaim == NULL);
700
701 might_sleep();
702
703 skc = kzalloc(sizeof (*skc), lflags);
704 if (skc == NULL)
705 return (NULL);
706
707 skc->skc_magic = SKC_MAGIC;
708 skc->skc_name_size = strlen(name) + 1;
709 skc->skc_name = (char *)kmalloc(skc->skc_name_size, lflags);
710 if (skc->skc_name == NULL) {
711 kfree(skc);
712 return (NULL);
713 }
714 strncpy(skc->skc_name, name, skc->skc_name_size);
715
716 skc->skc_ctor = ctor;
717 skc->skc_dtor = dtor;
718 skc->skc_private = priv;
719 skc->skc_vmp = vmp;
720 skc->skc_linux_cache = NULL;
721 skc->skc_flags = flags;
722 skc->skc_obj_size = size;
723 skc->skc_obj_align = SPL_KMEM_CACHE_ALIGN;
724 atomic_set(&skc->skc_ref, 0);
725
726 INIT_LIST_HEAD(&skc->skc_list);
727 INIT_LIST_HEAD(&skc->skc_complete_list);
728 INIT_LIST_HEAD(&skc->skc_partial_list);
729 skc->skc_emergency_tree = RB_ROOT;
730 spin_lock_init(&skc->skc_lock);
731 init_waitqueue_head(&skc->skc_waitq);
732 skc->skc_slab_fail = 0;
733 skc->skc_slab_create = 0;
734 skc->skc_slab_destroy = 0;
735 skc->skc_slab_total = 0;
736 skc->skc_slab_alloc = 0;
737 skc->skc_slab_max = 0;
738 skc->skc_obj_total = 0;
739 skc->skc_obj_alloc = 0;
740 skc->skc_obj_max = 0;
741 skc->skc_obj_deadlock = 0;
742 skc->skc_obj_emergency = 0;
743 skc->skc_obj_emergency_max = 0;
744
745 rc = percpu_counter_init_common(&skc->skc_linux_alloc, 0,
746 GFP_KERNEL);
747 if (rc != 0) {
748 kfree(skc);
749 return (NULL);
750 }
751
752 /*
753 * Verify the requested alignment restriction is sane.
754 */
755 if (align) {
756 VERIFY(ISP2(align));
757 VERIFY3U(align, >=, SPL_KMEM_CACHE_ALIGN);
758 VERIFY3U(align, <=, PAGE_SIZE);
759 skc->skc_obj_align = align;
760 }
761
762 /*
763 * When no specific type of slab is requested (kmem, vmem, or
764 * linuxslab) then select a cache type based on the object size
765 * and default tunables.
766 */
767 if (!(skc->skc_flags & (KMC_SLAB | KMC_KVMEM))) {
768 if (spl_kmem_cache_slab_limit &&
769 size <= (size_t)spl_kmem_cache_slab_limit) {
770 /*
771 * Objects smaller than spl_kmem_cache_slab_limit can
772 * use the Linux slab for better space-efficiency.
773 */
774 skc->skc_flags |= KMC_SLAB;
775 } else {
776 /*
777 * All other objects are considered large and are
778 * placed on kvmem backed slabs.
779 */
780 skc->skc_flags |= KMC_KVMEM;
781 }
782 }
783
784 /*
785 * Given the type of slab allocate the required resources.
786 */
787 if (skc->skc_flags & KMC_KVMEM) {
788 rc = spl_slab_size(skc,
789 &skc->skc_slab_objs, &skc->skc_slab_size);
790 if (rc)
791 goto out;
792
793 rc = spl_magazine_create(skc);
794 if (rc)
795 goto out;
796 } else {
797 unsigned long slabflags = 0;
798
799 if (size > (SPL_MAX_KMEM_ORDER_NR_PAGES * PAGE_SIZE)) {
800 rc = EINVAL;
801 goto out;
802 }
803
804 #if defined(SLAB_USERCOPY)
805 /*
806 * Required for PAX-enabled kernels if the slab is to be
807 * used for copying between user and kernel space.
808 */
809 slabflags |= SLAB_USERCOPY;
810 #endif
811
812 #if defined(HAVE_KMEM_CACHE_CREATE_USERCOPY)
813 /*
814 * Newer grsec patchset uses kmem_cache_create_usercopy()
815 * instead of SLAB_USERCOPY flag
816 */
817 skc->skc_linux_cache = kmem_cache_create_usercopy(
818 skc->skc_name, size, align, slabflags, 0, size, NULL);
819 #else
820 skc->skc_linux_cache = kmem_cache_create(
821 skc->skc_name, size, align, slabflags, NULL);
822 #endif
823 if (skc->skc_linux_cache == NULL) {
824 rc = ENOMEM;
825 goto out;
826 }
827 }
828
829 down_write(&spl_kmem_cache_sem);
830 list_add_tail(&skc->skc_list, &spl_kmem_cache_list);
831 up_write(&spl_kmem_cache_sem);
832
833 return (skc);
834 out:
835 kfree(skc->skc_name);
836 percpu_counter_destroy(&skc->skc_linux_alloc);
837 kfree(skc);
838 return (NULL);
839 }
840 EXPORT_SYMBOL(spl_kmem_cache_create);
841
842 /*
843 * Register a move callback for cache defragmentation.
844 * XXX: Unimplemented but harmless to stub out for now.
845 */
846 void
spl_kmem_cache_set_move(spl_kmem_cache_t * skc,kmem_cbrc_t (move)(void *,void *,size_t,void *))847 spl_kmem_cache_set_move(spl_kmem_cache_t *skc,
848 kmem_cbrc_t (move)(void *, void *, size_t, void *))
849 {
850 ASSERT(move != NULL);
851 }
852 EXPORT_SYMBOL(spl_kmem_cache_set_move);
853
854 /*
855 * Destroy a cache and all objects associated with the cache.
856 */
857 void
spl_kmem_cache_destroy(spl_kmem_cache_t * skc)858 spl_kmem_cache_destroy(spl_kmem_cache_t *skc)
859 {
860 DECLARE_WAIT_QUEUE_HEAD(wq);
861 taskqid_t id;
862
863 ASSERT(skc->skc_magic == SKC_MAGIC);
864 ASSERT(skc->skc_flags & (KMC_KVMEM | KMC_SLAB));
865
866 down_write(&spl_kmem_cache_sem);
867 list_del_init(&skc->skc_list);
868 up_write(&spl_kmem_cache_sem);
869
870 /* Cancel any and wait for any pending delayed tasks */
871 VERIFY(!test_and_set_bit(KMC_BIT_DESTROY, &skc->skc_flags));
872
873 spin_lock(&skc->skc_lock);
874 id = skc->skc_taskqid;
875 spin_unlock(&skc->skc_lock);
876
877 taskq_cancel_id(spl_kmem_cache_taskq, id);
878
879 /*
880 * Wait until all current callers complete, this is mainly
881 * to catch the case where a low memory situation triggers a
882 * cache reaping action which races with this destroy.
883 */
884 wait_event(wq, atomic_read(&skc->skc_ref) == 0);
885
886 if (skc->skc_flags & KMC_KVMEM) {
887 spl_magazine_destroy(skc);
888 spl_slab_reclaim(skc);
889 } else {
890 ASSERT(skc->skc_flags & KMC_SLAB);
891 kmem_cache_destroy(skc->skc_linux_cache);
892 }
893
894 spin_lock(&skc->skc_lock);
895
896 /*
897 * Validate there are no objects in use and free all the
898 * spl_kmem_slab_t, spl_kmem_obj_t, and object buffers.
899 */
900 ASSERT3U(skc->skc_slab_alloc, ==, 0);
901 ASSERT3U(skc->skc_obj_alloc, ==, 0);
902 ASSERT3U(skc->skc_slab_total, ==, 0);
903 ASSERT3U(skc->skc_obj_total, ==, 0);
904 ASSERT3U(skc->skc_obj_emergency, ==, 0);
905 ASSERT(list_empty(&skc->skc_complete_list));
906
907 ASSERT3U(percpu_counter_sum(&skc->skc_linux_alloc), ==, 0);
908 percpu_counter_destroy(&skc->skc_linux_alloc);
909
910 spin_unlock(&skc->skc_lock);
911
912 kfree(skc->skc_name);
913 kfree(skc);
914 }
915 EXPORT_SYMBOL(spl_kmem_cache_destroy);
916
917 /*
918 * Allocate an object from a slab attached to the cache. This is used to
919 * repopulate the per-cpu magazine caches in batches when they run low.
920 */
921 static void *
spl_cache_obj(spl_kmem_cache_t * skc,spl_kmem_slab_t * sks)922 spl_cache_obj(spl_kmem_cache_t *skc, spl_kmem_slab_t *sks)
923 {
924 spl_kmem_obj_t *sko;
925
926 ASSERT(skc->skc_magic == SKC_MAGIC);
927 ASSERT(sks->sks_magic == SKS_MAGIC);
928
929 sko = list_entry(sks->sks_free_list.next, spl_kmem_obj_t, sko_list);
930 ASSERT(sko->sko_magic == SKO_MAGIC);
931 ASSERT(sko->sko_addr != NULL);
932
933 /* Remove from sks_free_list */
934 list_del_init(&sko->sko_list);
935
936 sks->sks_age = jiffies;
937 sks->sks_ref++;
938 skc->skc_obj_alloc++;
939
940 /* Track max obj usage statistics */
941 if (skc->skc_obj_alloc > skc->skc_obj_max)
942 skc->skc_obj_max = skc->skc_obj_alloc;
943
944 /* Track max slab usage statistics */
945 if (sks->sks_ref == 1) {
946 skc->skc_slab_alloc++;
947
948 if (skc->skc_slab_alloc > skc->skc_slab_max)
949 skc->skc_slab_max = skc->skc_slab_alloc;
950 }
951
952 return (sko->sko_addr);
953 }
954
955 /*
956 * Generic slab allocation function to run by the global work queues.
957 * It is responsible for allocating a new slab, linking it in to the list
958 * of partial slabs, and then waking any waiters.
959 */
960 static int
__spl_cache_grow(spl_kmem_cache_t * skc,int flags)961 __spl_cache_grow(spl_kmem_cache_t *skc, int flags)
962 {
963 spl_kmem_slab_t *sks;
964
965 fstrans_cookie_t cookie = spl_fstrans_mark();
966 sks = spl_slab_alloc(skc, flags);
967 spl_fstrans_unmark(cookie);
968
969 spin_lock(&skc->skc_lock);
970 if (sks) {
971 skc->skc_slab_total++;
972 skc->skc_obj_total += sks->sks_objs;
973 list_add_tail(&sks->sks_list, &skc->skc_partial_list);
974
975 smp_mb__before_atomic();
976 clear_bit(KMC_BIT_DEADLOCKED, &skc->skc_flags);
977 smp_mb__after_atomic();
978 }
979 spin_unlock(&skc->skc_lock);
980
981 return (sks == NULL ? -ENOMEM : 0);
982 }
983
984 static void
spl_cache_grow_work(void * data)985 spl_cache_grow_work(void *data)
986 {
987 spl_kmem_alloc_t *ska = (spl_kmem_alloc_t *)data;
988 spl_kmem_cache_t *skc = ska->ska_cache;
989
990 int error = __spl_cache_grow(skc, ska->ska_flags);
991
992 atomic_dec(&skc->skc_ref);
993 smp_mb__before_atomic();
994 clear_bit(KMC_BIT_GROWING, &skc->skc_flags);
995 smp_mb__after_atomic();
996 if (error == 0)
997 wake_up_all(&skc->skc_waitq);
998
999 kfree(ska);
1000 }
1001
1002 /*
1003 * Returns non-zero when a new slab should be available.
1004 */
1005 static int
spl_cache_grow_wait(spl_kmem_cache_t * skc)1006 spl_cache_grow_wait(spl_kmem_cache_t *skc)
1007 {
1008 return (!test_bit(KMC_BIT_GROWING, &skc->skc_flags));
1009 }
1010
1011 /*
1012 * No available objects on any slabs, create a new slab. Note that this
1013 * functionality is disabled for KMC_SLAB caches which are backed by the
1014 * Linux slab.
1015 */
1016 static int
spl_cache_grow(spl_kmem_cache_t * skc,int flags,void ** obj)1017 spl_cache_grow(spl_kmem_cache_t *skc, int flags, void **obj)
1018 {
1019 int remaining, rc = 0;
1020
1021 ASSERT0(flags & ~KM_PUBLIC_MASK);
1022 ASSERT(skc->skc_magic == SKC_MAGIC);
1023 ASSERT((skc->skc_flags & KMC_SLAB) == 0);
1024
1025 *obj = NULL;
1026
1027 /*
1028 * Since we can't sleep attempt an emergency allocation to satisfy
1029 * the request. The only alterative is to fail the allocation but
1030 * it's preferable try. The use of KM_NOSLEEP is expected to be rare.
1031 */
1032 if (flags & KM_NOSLEEP)
1033 return (spl_emergency_alloc(skc, flags, obj));
1034
1035 might_sleep();
1036
1037 /*
1038 * Before allocating a new slab wait for any reaping to complete and
1039 * then return so the local magazine can be rechecked for new objects.
1040 */
1041 if (test_bit(KMC_BIT_REAPING, &skc->skc_flags)) {
1042 rc = spl_wait_on_bit(&skc->skc_flags, KMC_BIT_REAPING,
1043 TASK_UNINTERRUPTIBLE);
1044 return (rc ? rc : -EAGAIN);
1045 }
1046
1047 /*
1048 * Note: It would be nice to reduce the overhead of context switch
1049 * and improve NUMA locality, by trying to allocate a new slab in the
1050 * current process context with KM_NOSLEEP flag.
1051 *
1052 * However, this can't be applied to vmem/kvmem due to a bug that
1053 * spl_vmalloc() doesn't honor gfp flags in page table allocation.
1054 */
1055
1056 /*
1057 * This is handled by dispatching a work request to the global work
1058 * queue. This allows us to asynchronously allocate a new slab while
1059 * retaining the ability to safely fall back to a smaller synchronous
1060 * allocations to ensure forward progress is always maintained.
1061 */
1062 if (test_and_set_bit(KMC_BIT_GROWING, &skc->skc_flags) == 0) {
1063 spl_kmem_alloc_t *ska;
1064
1065 ska = kmalloc(sizeof (*ska), kmem_flags_convert(flags));
1066 if (ska == NULL) {
1067 clear_bit_unlock(KMC_BIT_GROWING, &skc->skc_flags);
1068 smp_mb__after_atomic();
1069 wake_up_all(&skc->skc_waitq);
1070 return (-ENOMEM);
1071 }
1072
1073 atomic_inc(&skc->skc_ref);
1074 ska->ska_cache = skc;
1075 ska->ska_flags = flags;
1076 taskq_init_ent(&ska->ska_tqe);
1077 taskq_dispatch_ent(spl_kmem_cache_taskq,
1078 spl_cache_grow_work, ska, 0, &ska->ska_tqe);
1079 }
1080
1081 /*
1082 * The goal here is to only detect the rare case where a virtual slab
1083 * allocation has deadlocked. We must be careful to minimize the use
1084 * of emergency objects which are more expensive to track. Therefore,
1085 * we set a very long timeout for the asynchronous allocation and if
1086 * the timeout is reached the cache is flagged as deadlocked. From
1087 * this point only new emergency objects will be allocated until the
1088 * asynchronous allocation completes and clears the deadlocked flag.
1089 */
1090 if (test_bit(KMC_BIT_DEADLOCKED, &skc->skc_flags)) {
1091 rc = spl_emergency_alloc(skc, flags, obj);
1092 } else {
1093 remaining = wait_event_timeout(skc->skc_waitq,
1094 spl_cache_grow_wait(skc), HZ / 10);
1095
1096 if (!remaining) {
1097 spin_lock(&skc->skc_lock);
1098 if (test_bit(KMC_BIT_GROWING, &skc->skc_flags)) {
1099 set_bit(KMC_BIT_DEADLOCKED, &skc->skc_flags);
1100 skc->skc_obj_deadlock++;
1101 }
1102 spin_unlock(&skc->skc_lock);
1103 }
1104
1105 rc = -ENOMEM;
1106 }
1107
1108 return (rc);
1109 }
1110
1111 /*
1112 * Refill a per-cpu magazine with objects from the slabs for this cache.
1113 * Ideally the magazine can be repopulated using existing objects which have
1114 * been released, however if we are unable to locate enough free objects new
1115 * slabs of objects will be created. On success NULL is returned, otherwise
1116 * the address of a single emergency object is returned for use by the caller.
1117 */
1118 static void *
spl_cache_refill(spl_kmem_cache_t * skc,spl_kmem_magazine_t * skm,int flags)1119 spl_cache_refill(spl_kmem_cache_t *skc, spl_kmem_magazine_t *skm, int flags)
1120 {
1121 spl_kmem_slab_t *sks;
1122 int count = 0, rc, refill;
1123 void *obj = NULL;
1124
1125 ASSERT(skc->skc_magic == SKC_MAGIC);
1126 ASSERT(skm->skm_magic == SKM_MAGIC);
1127
1128 refill = MIN(skm->skm_refill, skm->skm_size - skm->skm_avail);
1129 spin_lock(&skc->skc_lock);
1130
1131 while (refill > 0) {
1132 /* No slabs available we may need to grow the cache */
1133 if (list_empty(&skc->skc_partial_list)) {
1134 spin_unlock(&skc->skc_lock);
1135
1136 local_irq_enable();
1137 rc = spl_cache_grow(skc, flags, &obj);
1138 local_irq_disable();
1139
1140 /* Emergency object for immediate use by caller */
1141 if (rc == 0 && obj != NULL)
1142 return (obj);
1143
1144 if (rc)
1145 goto out;
1146
1147 /* Rescheduled to different CPU skm is not local */
1148 if (skm != skc->skc_mag[smp_processor_id()])
1149 goto out;
1150
1151 /*
1152 * Potentially rescheduled to the same CPU but
1153 * allocations may have occurred from this CPU while
1154 * we were sleeping so recalculate max refill.
1155 */
1156 refill = MIN(refill, skm->skm_size - skm->skm_avail);
1157
1158 spin_lock(&skc->skc_lock);
1159 continue;
1160 }
1161
1162 /* Grab the next available slab */
1163 sks = list_entry((&skc->skc_partial_list)->next,
1164 spl_kmem_slab_t, sks_list);
1165 ASSERT(sks->sks_magic == SKS_MAGIC);
1166 ASSERT(sks->sks_ref < sks->sks_objs);
1167 ASSERT(!list_empty(&sks->sks_free_list));
1168
1169 /*
1170 * Consume as many objects as needed to refill the requested
1171 * cache. We must also be careful not to overfill it.
1172 */
1173 while (sks->sks_ref < sks->sks_objs && refill-- > 0 &&
1174 ++count) {
1175 ASSERT(skm->skm_avail < skm->skm_size);
1176 ASSERT(count < skm->skm_size);
1177 skm->skm_objs[skm->skm_avail++] =
1178 spl_cache_obj(skc, sks);
1179 }
1180
1181 /* Move slab to skc_complete_list when full */
1182 if (sks->sks_ref == sks->sks_objs) {
1183 list_del(&sks->sks_list);
1184 list_add(&sks->sks_list, &skc->skc_complete_list);
1185 }
1186 }
1187
1188 spin_unlock(&skc->skc_lock);
1189 out:
1190 return (NULL);
1191 }
1192
1193 /*
1194 * Release an object back to the slab from which it came.
1195 */
1196 static void
spl_cache_shrink(spl_kmem_cache_t * skc,void * obj)1197 spl_cache_shrink(spl_kmem_cache_t *skc, void *obj)
1198 {
1199 spl_kmem_slab_t *sks = NULL;
1200 spl_kmem_obj_t *sko = NULL;
1201
1202 ASSERT(skc->skc_magic == SKC_MAGIC);
1203
1204 sko = spl_sko_from_obj(skc, obj);
1205 ASSERT(sko->sko_magic == SKO_MAGIC);
1206 sks = sko->sko_slab;
1207 ASSERT(sks->sks_magic == SKS_MAGIC);
1208 ASSERT(sks->sks_cache == skc);
1209 list_add(&sko->sko_list, &sks->sks_free_list);
1210
1211 sks->sks_age = jiffies;
1212 sks->sks_ref--;
1213 skc->skc_obj_alloc--;
1214
1215 /*
1216 * Move slab to skc_partial_list when no longer full. Slabs
1217 * are added to the head to keep the partial list is quasi-full
1218 * sorted order. Fuller at the head, emptier at the tail.
1219 */
1220 if (sks->sks_ref == (sks->sks_objs - 1)) {
1221 list_del(&sks->sks_list);
1222 list_add(&sks->sks_list, &skc->skc_partial_list);
1223 }
1224
1225 /*
1226 * Move empty slabs to the end of the partial list so
1227 * they can be easily found and freed during reclamation.
1228 */
1229 if (sks->sks_ref == 0) {
1230 list_del(&sks->sks_list);
1231 list_add_tail(&sks->sks_list, &skc->skc_partial_list);
1232 skc->skc_slab_alloc--;
1233 }
1234 }
1235
1236 /*
1237 * Allocate an object from the per-cpu magazine, or if the magazine
1238 * is empty directly allocate from a slab and repopulate the magazine.
1239 */
1240 void *
spl_kmem_cache_alloc(spl_kmem_cache_t * skc,int flags)1241 spl_kmem_cache_alloc(spl_kmem_cache_t *skc, int flags)
1242 {
1243 spl_kmem_magazine_t *skm;
1244 void *obj = NULL;
1245
1246 ASSERT0(flags & ~KM_PUBLIC_MASK);
1247 ASSERT(skc->skc_magic == SKC_MAGIC);
1248 ASSERT(!test_bit(KMC_BIT_DESTROY, &skc->skc_flags));
1249
1250 /*
1251 * Allocate directly from a Linux slab. All optimizations are left
1252 * to the underlying cache we only need to guarantee that KM_SLEEP
1253 * callers will never fail.
1254 */
1255 if (skc->skc_flags & KMC_SLAB) {
1256 struct kmem_cache *slc = skc->skc_linux_cache;
1257 do {
1258 obj = kmem_cache_alloc(slc, kmem_flags_convert(flags));
1259 } while ((obj == NULL) && !(flags & KM_NOSLEEP));
1260
1261 if (obj != NULL) {
1262 /*
1263 * Even though we leave everything up to the
1264 * underlying cache we still keep track of
1265 * how many objects we've allocated in it for
1266 * better debuggability.
1267 */
1268 percpu_counter_inc(&skc->skc_linux_alloc);
1269 }
1270 goto ret;
1271 }
1272
1273 local_irq_disable();
1274
1275 restart:
1276 /*
1277 * Safe to update per-cpu structure without lock, but
1278 * in the restart case we must be careful to reacquire
1279 * the local magazine since this may have changed
1280 * when we need to grow the cache.
1281 */
1282 skm = skc->skc_mag[smp_processor_id()];
1283 ASSERT(skm->skm_magic == SKM_MAGIC);
1284
1285 if (likely(skm->skm_avail)) {
1286 /* Object available in CPU cache, use it */
1287 obj = skm->skm_objs[--skm->skm_avail];
1288 } else {
1289 obj = spl_cache_refill(skc, skm, flags);
1290 if ((obj == NULL) && !(flags & KM_NOSLEEP))
1291 goto restart;
1292
1293 local_irq_enable();
1294 goto ret;
1295 }
1296
1297 local_irq_enable();
1298 ASSERT(obj);
1299 ASSERT(IS_P2ALIGNED(obj, skc->skc_obj_align));
1300
1301 ret:
1302 /* Pre-emptively migrate object to CPU L1 cache */
1303 if (obj) {
1304 if (obj && skc->skc_ctor)
1305 skc->skc_ctor(obj, skc->skc_private, flags);
1306 else
1307 prefetchw(obj);
1308 }
1309
1310 return (obj);
1311 }
1312 EXPORT_SYMBOL(spl_kmem_cache_alloc);
1313
1314 /*
1315 * Free an object back to the local per-cpu magazine, there is no
1316 * guarantee that this is the same magazine the object was originally
1317 * allocated from. We may need to flush entire from the magazine
1318 * back to the slabs to make space.
1319 */
1320 void
spl_kmem_cache_free(spl_kmem_cache_t * skc,void * obj)1321 spl_kmem_cache_free(spl_kmem_cache_t *skc, void *obj)
1322 {
1323 spl_kmem_magazine_t *skm;
1324 unsigned long flags;
1325 int do_reclaim = 0;
1326 int do_emergency = 0;
1327
1328 ASSERT(skc->skc_magic == SKC_MAGIC);
1329 ASSERT(!test_bit(KMC_BIT_DESTROY, &skc->skc_flags));
1330
1331 /*
1332 * Run the destructor
1333 */
1334 if (skc->skc_dtor)
1335 skc->skc_dtor(obj, skc->skc_private);
1336
1337 /*
1338 * Free the object from the Linux underlying Linux slab.
1339 */
1340 if (skc->skc_flags & KMC_SLAB) {
1341 kmem_cache_free(skc->skc_linux_cache, obj);
1342 percpu_counter_dec(&skc->skc_linux_alloc);
1343 return;
1344 }
1345
1346 /*
1347 * While a cache has outstanding emergency objects all freed objects
1348 * must be checked. However, since emergency objects will never use
1349 * a virtual address these objects can be safely excluded as an
1350 * optimization.
1351 */
1352 if (!is_vmalloc_addr(obj)) {
1353 spin_lock(&skc->skc_lock);
1354 do_emergency = (skc->skc_obj_emergency > 0);
1355 spin_unlock(&skc->skc_lock);
1356
1357 if (do_emergency && (spl_emergency_free(skc, obj) == 0))
1358 return;
1359 }
1360
1361 local_irq_save(flags);
1362
1363 /*
1364 * Safe to update per-cpu structure without lock, but
1365 * no remote memory allocation tracking is being performed
1366 * it is entirely possible to allocate an object from one
1367 * CPU cache and return it to another.
1368 */
1369 skm = skc->skc_mag[smp_processor_id()];
1370 ASSERT(skm->skm_magic == SKM_MAGIC);
1371
1372 /*
1373 * Per-CPU cache full, flush it to make space for this object,
1374 * this may result in an empty slab which can be reclaimed once
1375 * interrupts are re-enabled.
1376 */
1377 if (unlikely(skm->skm_avail >= skm->skm_size)) {
1378 spl_cache_flush(skc, skm, skm->skm_refill);
1379 do_reclaim = 1;
1380 }
1381
1382 /* Available space in cache, use it */
1383 skm->skm_objs[skm->skm_avail++] = obj;
1384
1385 local_irq_restore(flags);
1386
1387 if (do_reclaim)
1388 spl_slab_reclaim(skc);
1389 }
1390 EXPORT_SYMBOL(spl_kmem_cache_free);
1391
1392 /*
1393 * Depending on how many and which objects are released it may simply
1394 * repopulate the local magazine which will then need to age-out. Objects
1395 * which cannot fit in the magazine will be released back to their slabs
1396 * which will also need to age out before being released. This is all just
1397 * best effort and we do not want to thrash creating and destroying slabs.
1398 */
1399 void
spl_kmem_cache_reap_now(spl_kmem_cache_t * skc)1400 spl_kmem_cache_reap_now(spl_kmem_cache_t *skc)
1401 {
1402 ASSERT(skc->skc_magic == SKC_MAGIC);
1403 ASSERT(!test_bit(KMC_BIT_DESTROY, &skc->skc_flags));
1404
1405 if (skc->skc_flags & KMC_SLAB)
1406 return;
1407
1408 atomic_inc(&skc->skc_ref);
1409
1410 /*
1411 * Prevent concurrent cache reaping when contended.
1412 */
1413 if (test_and_set_bit(KMC_BIT_REAPING, &skc->skc_flags))
1414 goto out;
1415
1416 /* Reclaim from the magazine and free all now empty slabs. */
1417 unsigned long irq_flags;
1418 local_irq_save(irq_flags);
1419 spl_kmem_magazine_t *skm = skc->skc_mag[smp_processor_id()];
1420 spl_cache_flush(skc, skm, skm->skm_avail);
1421 local_irq_restore(irq_flags);
1422
1423 spl_slab_reclaim(skc);
1424 clear_bit_unlock(KMC_BIT_REAPING, &skc->skc_flags);
1425 smp_mb__after_atomic();
1426 wake_up_bit(&skc->skc_flags, KMC_BIT_REAPING);
1427 out:
1428 atomic_dec(&skc->skc_ref);
1429 }
1430 EXPORT_SYMBOL(spl_kmem_cache_reap_now);
1431
1432 /*
1433 * This is stubbed out for code consistency with other platforms. There
1434 * is existing logic to prevent concurrent reaping so while this is ugly
1435 * it should do no harm.
1436 */
1437 int
spl_kmem_cache_reap_active(void)1438 spl_kmem_cache_reap_active(void)
1439 {
1440 return (0);
1441 }
1442 EXPORT_SYMBOL(spl_kmem_cache_reap_active);
1443
1444 /*
1445 * Reap all free slabs from all registered caches.
1446 */
1447 void
spl_kmem_reap(void)1448 spl_kmem_reap(void)
1449 {
1450 spl_kmem_cache_t *skc = NULL;
1451
1452 down_read(&spl_kmem_cache_sem);
1453 list_for_each_entry(skc, &spl_kmem_cache_list, skc_list) {
1454 spl_kmem_cache_reap_now(skc);
1455 }
1456 up_read(&spl_kmem_cache_sem);
1457 }
1458 EXPORT_SYMBOL(spl_kmem_reap);
1459
1460 int
spl_kmem_cache_init(void)1461 spl_kmem_cache_init(void)
1462 {
1463 init_rwsem(&spl_kmem_cache_sem);
1464 INIT_LIST_HEAD(&spl_kmem_cache_list);
1465 spl_kmem_cache_taskq = taskq_create("spl_kmem_cache",
1466 spl_kmem_cache_kmem_threads, maxclsyspri,
1467 spl_kmem_cache_kmem_threads * 8, INT_MAX,
1468 TASKQ_PREPOPULATE | TASKQ_DYNAMIC);
1469
1470 return (0);
1471 }
1472
1473 void
spl_kmem_cache_fini(void)1474 spl_kmem_cache_fini(void)
1475 {
1476 taskq_destroy(spl_kmem_cache_taskq);
1477 }
1478