Home | History | Annotate | Line # | Download | only in linux
slab.h revision 1.7
      1  1.7  riastrad /*	$NetBSD: slab.h,v 1.7 2021/12/19 12:00:48 riastradh Exp $	*/
      2  1.1  riastrad 
      3  1.1  riastrad /*-
      4  1.1  riastrad  * Copyright (c) 2013 The NetBSD Foundation, Inc.
      5  1.1  riastrad  * All rights reserved.
      6  1.1  riastrad  *
      7  1.1  riastrad  * This code is derived from software contributed to The NetBSD Foundation
      8  1.1  riastrad  * by Taylor R. Campbell.
      9  1.1  riastrad  *
     10  1.1  riastrad  * Redistribution and use in source and binary forms, with or without
     11  1.1  riastrad  * modification, are permitted provided that the following conditions
     12  1.1  riastrad  * are met:
     13  1.1  riastrad  * 1. Redistributions of source code must retain the above copyright
     14  1.1  riastrad  *    notice, this list of conditions and the following disclaimer.
     15  1.1  riastrad  * 2. Redistributions in binary form must reproduce the above copyright
     16  1.1  riastrad  *    notice, this list of conditions and the following disclaimer in the
     17  1.1  riastrad  *    documentation and/or other materials provided with the distribution.
     18  1.1  riastrad  *
     19  1.1  riastrad  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  1.1  riastrad  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  1.1  riastrad  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  1.1  riastrad  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  1.1  riastrad  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  1.1  riastrad  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  1.1  riastrad  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  1.1  riastrad  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  1.1  riastrad  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  1.1  riastrad  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  1.1  riastrad  * POSSIBILITY OF SUCH DAMAGE.
     30  1.1  riastrad  */
     31  1.1  riastrad 
     32  1.1  riastrad #ifndef _LINUX_SLAB_H_
     33  1.1  riastrad #define _LINUX_SLAB_H_
     34  1.1  riastrad 
     35  1.1  riastrad #include <sys/kmem.h>
     36  1.1  riastrad #include <sys/malloc.h>
     37  1.1  riastrad 
     38  1.1  riastrad #include <machine/limits.h>
     39  1.1  riastrad 
     40  1.1  riastrad #include <uvm/uvm_extern.h>	/* For PAGE_SIZE.  */
     41  1.1  riastrad 
     42  1.1  riastrad #include <linux/gfp.h>
     43  1.3  riastrad #include <linux/rcupdate.h>
     44  1.1  riastrad 
     45  1.4  riastrad #define	ARCH_KMALLOC_MINALIGN	4 /* XXX ??? */
     46  1.4  riastrad 
     47  1.1  riastrad /* XXX Should use kmem, but Linux kfree doesn't take the size.  */
     48  1.1  riastrad 
     49  1.1  riastrad static inline int
     50  1.1  riastrad linux_gfp_to_malloc(gfp_t gfp)
     51  1.1  riastrad {
     52  1.1  riastrad 	int flags = 0;
     53  1.1  riastrad 
     54  1.1  riastrad 	/* This has no meaning to us.  */
     55  1.1  riastrad 	gfp &= ~__GFP_NOWARN;
     56  1.1  riastrad 	gfp &= ~__GFP_RECLAIMABLE;
     57  1.1  riastrad 
     58  1.1  riastrad 	/* Pretend this was the same as not passing __GFP_WAIT.  */
     59  1.1  riastrad 	if (ISSET(gfp, __GFP_NORETRY)) {
     60  1.1  riastrad 		gfp &= ~__GFP_NORETRY;
     61  1.1  riastrad 		gfp &= ~__GFP_WAIT;
     62  1.1  riastrad 	}
     63  1.1  riastrad 
     64  1.1  riastrad 	if (ISSET(gfp, __GFP_ZERO)) {
     65  1.1  riastrad 		flags |= M_ZERO;
     66  1.1  riastrad 		gfp &= ~__GFP_ZERO;
     67  1.1  riastrad 	}
     68  1.1  riastrad 
     69  1.1  riastrad 	/*
     70  1.1  riastrad 	 * XXX Handle other cases as they arise -- prefer to fail early
     71  1.1  riastrad 	 * rather than allocate memory without respecting parameters we
     72  1.1  riastrad 	 * don't understand.
     73  1.1  riastrad 	 */
     74  1.1  riastrad 	KASSERT((gfp == GFP_ATOMIC) ||
     75  1.1  riastrad 	    ((gfp & ~__GFP_WAIT) == (GFP_KERNEL & ~__GFP_WAIT)));
     76  1.1  riastrad 
     77  1.1  riastrad 	if (ISSET(gfp, __GFP_WAIT)) {
     78  1.1  riastrad 		flags |= M_WAITOK;
     79  1.1  riastrad 		gfp &= ~__GFP_WAIT;
     80  1.1  riastrad 	} else {
     81  1.1  riastrad 		flags |= M_NOWAIT;
     82  1.1  riastrad 	}
     83  1.1  riastrad 
     84  1.1  riastrad 	return flags;
     85  1.1  riastrad }
     86  1.1  riastrad 
     87  1.1  riastrad /*
     88  1.1  riastrad  * XXX vmalloc and kmalloc both use malloc(9).  If you change this, be
     89  1.1  riastrad  * sure to update vmalloc in <linux/vmalloc.h> and kvfree in
     90  1.1  riastrad  * <linux/mm.h>.
     91  1.1  riastrad  */
     92  1.1  riastrad 
     93  1.1  riastrad static inline void *
     94  1.1  riastrad kmalloc(size_t size, gfp_t gfp)
     95  1.1  riastrad {
     96  1.1  riastrad 	return malloc(size, M_TEMP, linux_gfp_to_malloc(gfp));
     97  1.1  riastrad }
     98  1.1  riastrad 
     99  1.1  riastrad static inline void *
    100  1.1  riastrad kzalloc(size_t size, gfp_t gfp)
    101  1.1  riastrad {
    102  1.1  riastrad 	return malloc(size, M_TEMP, (linux_gfp_to_malloc(gfp) | M_ZERO));
    103  1.1  riastrad }
    104  1.1  riastrad 
    105  1.1  riastrad static inline void *
    106  1.1  riastrad kmalloc_array(size_t n, size_t size, gfp_t gfp)
    107  1.1  riastrad {
    108  1.1  riastrad 	if ((size != 0) && (n > (SIZE_MAX / size)))
    109  1.1  riastrad 		return NULL;
    110  1.1  riastrad 	return malloc((n * size), M_TEMP, linux_gfp_to_malloc(gfp));
    111  1.1  riastrad }
    112  1.1  riastrad 
    113  1.1  riastrad static inline void *
    114  1.1  riastrad kcalloc(size_t n, size_t size, gfp_t gfp)
    115  1.1  riastrad {
    116  1.1  riastrad 	return kmalloc_array(n, size, (gfp | __GFP_ZERO));
    117  1.1  riastrad }
    118  1.1  riastrad 
    119  1.1  riastrad static inline void *
    120  1.1  riastrad krealloc(void *ptr, size_t size, gfp_t gfp)
    121  1.1  riastrad {
    122  1.1  riastrad 	return realloc(ptr, size, M_TEMP, linux_gfp_to_malloc(gfp));
    123  1.1  riastrad }
    124  1.1  riastrad 
    125  1.1  riastrad static inline void
    126  1.1  riastrad kfree(void *ptr)
    127  1.1  riastrad {
    128  1.1  riastrad 	if (ptr != NULL)
    129  1.1  riastrad 		free(ptr, M_TEMP);
    130  1.1  riastrad }
    131  1.1  riastrad 
    132  1.3  riastrad #define	SLAB_HWCACHE_ALIGN	__BIT(0)
    133  1.3  riastrad #define	SLAB_RECLAIM_ACCOUNT	__BIT(1)
    134  1.3  riastrad #define	SLAB_TYPESAFE_BY_RCU	__BIT(2)
    135  1.1  riastrad 
    136  1.1  riastrad struct kmem_cache {
    137  1.1  riastrad 	pool_cache_t	kc_pool_cache;
    138  1.1  riastrad 	size_t		kc_size;
    139  1.1  riastrad 	void		(*kc_ctor)(void *);
    140  1.7  riastrad 	void		(*kc_dtor)(void *);
    141  1.1  riastrad };
    142  1.1  riastrad 
    143  1.3  riastrad /* XXX These should be in <sys/pool.h>.  */
    144  1.3  riastrad void *	pool_page_alloc(struct pool *, int);
    145  1.3  riastrad void	pool_page_free(struct pool *, void *);
    146  1.3  riastrad 
    147  1.3  riastrad static void
    148  1.3  riastrad pool_page_free_rcu(struct pool *pp, void *v)
    149  1.3  riastrad {
    150  1.3  riastrad 
    151  1.3  riastrad 	synchronize_rcu();
    152  1.3  riastrad 	pool_page_free(pp, v);
    153  1.3  riastrad }
    154  1.3  riastrad 
    155  1.3  riastrad static struct pool_allocator pool_allocator_kmem_rcu = {
    156  1.3  riastrad 	.pa_alloc = pool_page_alloc,
    157  1.3  riastrad 	.pa_free = pool_page_free_rcu,
    158  1.3  riastrad 	.pa_pagesz = 0,
    159  1.3  riastrad };
    160  1.3  riastrad 
    161  1.1  riastrad static int
    162  1.1  riastrad kmem_cache_ctor(void *cookie, void *ptr, int flags __unused)
    163  1.1  riastrad {
    164  1.1  riastrad 	struct kmem_cache *const kc = cookie;
    165  1.1  riastrad 
    166  1.1  riastrad 	if (kc->kc_ctor)
    167  1.1  riastrad 		(*kc->kc_ctor)(ptr);
    168  1.1  riastrad 
    169  1.1  riastrad 	return 0;
    170  1.1  riastrad }
    171  1.1  riastrad 
    172  1.7  riastrad static void
    173  1.7  riastrad kmem_cache_dtor(void *cookie, void *ptr)
    174  1.7  riastrad {
    175  1.7  riastrad 	struct kmem_cache *const kc = cookie;
    176  1.7  riastrad 
    177  1.7  riastrad 	if (kc->kc_dtor)
    178  1.7  riastrad 		(*kc->kc_dtor)(ptr);
    179  1.7  riastrad }
    180  1.7  riastrad 
    181  1.1  riastrad static inline struct kmem_cache *
    182  1.1  riastrad kmem_cache_create(const char *name, size_t size, size_t align,
    183  1.1  riastrad     unsigned long flags, void (*ctor)(void *))
    184  1.1  riastrad {
    185  1.3  riastrad 	struct pool_allocator *palloc = NULL;
    186  1.1  riastrad 	struct kmem_cache *kc;
    187  1.1  riastrad 
    188  1.1  riastrad 	if (ISSET(flags, SLAB_HWCACHE_ALIGN))
    189  1.1  riastrad 		align = roundup(MAX(1, align), CACHE_LINE_SIZE);
    190  1.3  riastrad 	if (ISSET(flags, SLAB_TYPESAFE_BY_RCU))
    191  1.3  riastrad 		palloc = &pool_allocator_kmem_rcu;
    192  1.1  riastrad 
    193  1.1  riastrad 	kc = kmem_alloc(sizeof(*kc), KM_SLEEP);
    194  1.3  riastrad 	kc->kc_pool_cache = pool_cache_init(size, align, 0, 0, name, palloc,
    195  1.6  riastrad 	    IPL_VM, &kmem_cache_ctor, NULL, kc);
    196  1.1  riastrad 	kc->kc_size = size;
    197  1.1  riastrad 	kc->kc_ctor = ctor;
    198  1.1  riastrad 
    199  1.1  riastrad 	return kc;
    200  1.1  riastrad }
    201  1.1  riastrad 
    202  1.7  riastrad /* XXX extension */
    203  1.7  riastrad static inline struct kmem_cache *
    204  1.7  riastrad kmem_cache_create_dtor(const char *name, size_t size, size_t align,
    205  1.7  riastrad     unsigned long flags, void (*ctor)(void *), void (*dtor)(void *))
    206  1.7  riastrad {
    207  1.7  riastrad 	struct pool_allocator *palloc = NULL;
    208  1.7  riastrad 	struct kmem_cache *kc;
    209  1.7  riastrad 
    210  1.7  riastrad 	if (ISSET(flags, SLAB_HWCACHE_ALIGN))
    211  1.7  riastrad 		align = roundup(MAX(1, align), CACHE_LINE_SIZE);
    212  1.7  riastrad 	if (ISSET(flags, SLAB_TYPESAFE_BY_RCU))
    213  1.7  riastrad 		palloc = &pool_allocator_kmem_rcu;
    214  1.7  riastrad 
    215  1.7  riastrad 	kc = kmem_alloc(sizeof(*kc), KM_SLEEP);
    216  1.7  riastrad 	kc->kc_pool_cache = pool_cache_init(size, align, 0, 0, name, palloc,
    217  1.7  riastrad 	    IPL_VM, &kmem_cache_ctor, &kmem_cache_dtor, kc);
    218  1.7  riastrad 	kc->kc_size = size;
    219  1.7  riastrad 	kc->kc_ctor = ctor;
    220  1.7  riastrad 	kc->kc_dtor = dtor;
    221  1.7  riastrad 
    222  1.7  riastrad 	return kc;
    223  1.7  riastrad }
    224  1.7  riastrad 
    225  1.3  riastrad #define	KMEM_CACHE(T, F)						      \
    226  1.3  riastrad 	kmem_cache_create(#T, sizeof(struct T), __alignof__(struct T),	      \
    227  1.3  riastrad 	    (F), NULL)
    228  1.3  riastrad 
    229  1.1  riastrad static inline void
    230  1.1  riastrad kmem_cache_destroy(struct kmem_cache *kc)
    231  1.1  riastrad {
    232  1.1  riastrad 
    233  1.1  riastrad 	pool_cache_destroy(kc->kc_pool_cache);
    234  1.1  riastrad 	kmem_free(kc, sizeof(*kc));
    235  1.1  riastrad }
    236  1.1  riastrad 
    237  1.1  riastrad static inline void *
    238  1.1  riastrad kmem_cache_alloc(struct kmem_cache *kc, gfp_t gfp)
    239  1.1  riastrad {
    240  1.1  riastrad 	int flags = 0;
    241  1.1  riastrad 	void *ptr;
    242  1.1  riastrad 
    243  1.1  riastrad 	if (gfp & __GFP_WAIT)
    244  1.5  riastrad 		flags |= PR_WAITOK;
    245  1.5  riastrad 	else
    246  1.1  riastrad 		flags |= PR_NOWAIT;
    247  1.1  riastrad 
    248  1.1  riastrad 	ptr = pool_cache_get(kc->kc_pool_cache, flags);
    249  1.1  riastrad 	if (ptr == NULL)
    250  1.1  riastrad 		return NULL;
    251  1.1  riastrad 
    252  1.1  riastrad 	if (ISSET(gfp, __GFP_ZERO))
    253  1.1  riastrad 		(void)memset(ptr, 0, kc->kc_size);
    254  1.1  riastrad 
    255  1.1  riastrad 	return ptr;
    256  1.1  riastrad }
    257  1.1  riastrad 
    258  1.1  riastrad static inline void *
    259  1.1  riastrad kmem_cache_zalloc(struct kmem_cache *kc, gfp_t gfp)
    260  1.1  riastrad {
    261  1.1  riastrad 
    262  1.1  riastrad 	return kmem_cache_alloc(kc, (gfp | __GFP_ZERO));
    263  1.1  riastrad }
    264  1.1  riastrad 
    265  1.1  riastrad static inline void
    266  1.1  riastrad kmem_cache_free(struct kmem_cache *kc, void *ptr)
    267  1.1  riastrad {
    268  1.1  riastrad 
    269  1.1  riastrad 	pool_cache_put(kc->kc_pool_cache, ptr);
    270  1.1  riastrad }
    271  1.1  riastrad 
    272  1.2  riastrad static inline void
    273  1.2  riastrad kmem_cache_shrink(struct kmem_cache *kc)
    274  1.2  riastrad {
    275  1.2  riastrad 
    276  1.2  riastrad 	pool_cache_reclaim(kc->kc_pool_cache);
    277  1.2  riastrad }
    278  1.2  riastrad 
    279  1.1  riastrad #endif  /* _LINUX_SLAB_H_ */
    280