xref: /freebsd/sys/compat/linuxkpi/common/include/linux/slab.h (revision b197d4b893974c9eb4d7b38704c6d5c486235d6f)
1 /*-
2  * Copyright (c) 2010 Isilon Systems, Inc.
3  * Copyright (c) 2010 iX Systems, Inc.
4  * Copyright (c) 2010 Panasas, Inc.
5  * Copyright (c) 2013-2021 Mellanox Technologies, Ltd.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice unmodified, this list of conditions, and the following
13  *    disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31 #ifndef	_LINUXKPI_LINUX_SLAB_H_
32 #define	_LINUXKPI_LINUX_SLAB_H_
33 
34 #include <sys/types.h>
35 #include <sys/malloc.h>
36 #include <sys/limits.h>
37 
38 #include <linux/compat.h>
39 #include <linux/types.h>
40 #include <linux/gfp.h>
41 #include <linux/llist.h>
42 #include <linux/overflow.h>
43 
44 MALLOC_DECLARE(M_KMALLOC);
45 
46 #define	kvmalloc(size, flags)		kmalloc(size, flags)
47 #define	kvzalloc(size, flags)		kmalloc(size, (flags) | __GFP_ZERO)
48 #define	kvcalloc(n, size, flags)	kvmalloc_array(n, size, (flags) | __GFP_ZERO)
49 #define	kzalloc(size, flags)		kmalloc(size, (flags) | __GFP_ZERO)
50 #define	kzalloc_node(size, flags, node)	kmalloc_node(size, (flags) | __GFP_ZERO, node)
51 #define	kfree_const(ptr)		kfree(ptr)
52 #define	vzalloc(size)			__vmalloc(size, GFP_KERNEL | __GFP_NOWARN | __GFP_ZERO, 0)
53 #define	vfree(arg)			kfree(arg)
54 #define	kvfree(arg)			kfree(arg)
55 #define	vmalloc_node(size, node)	__vmalloc_node(size, GFP_KERNEL, node)
56 #define	vmalloc_user(size)		__vmalloc(size, GFP_KERNEL | __GFP_ZERO, 0)
57 #define	vmalloc(size)			__vmalloc(size, GFP_KERNEL, 0)
58 #define	__kmalloc(...)			kmalloc(__VA_ARGS__)
59 
60 /*
61  * Prefix some functions with linux_ to avoid namespace conflict
62  * with the OpenSolaris code in the kernel.
63  */
64 #define	kmem_cache		linux_kmem_cache
65 #define	kmem_cache_create(...)	linux_kmem_cache_create(__VA_ARGS__)
66 #define	kmem_cache_alloc(...)	lkpi_kmem_cache_alloc(__VA_ARGS__)
67 #define	kmem_cache_zalloc(...)	lkpi_kmem_cache_zalloc(__VA_ARGS__)
68 #define	kmem_cache_free(...)	lkpi_kmem_cache_free(__VA_ARGS__)
69 #define	kmem_cache_destroy(...) linux_kmem_cache_destroy(__VA_ARGS__)
70 #define	kmem_cache_shrink(x)	(0)
71 
72 #define	KMEM_CACHE(__struct, flags)					\
73 	linux_kmem_cache_create(#__struct, sizeof(struct __struct),	\
74 	__alignof(struct __struct), (flags), NULL)
75 
76 typedef void linux_kmem_ctor_t (void *);
77 
78 struct linux_kmem_cache;
79 
80 #define	SLAB_HWCACHE_ALIGN	(1 << 0)
81 #define	SLAB_TYPESAFE_BY_RCU	(1 << 1)
82 #define	SLAB_RECLAIM_ACCOUNT	(1 << 2)
83 
84 #define	SLAB_DESTROY_BY_RCU \
85 	SLAB_TYPESAFE_BY_RCU
86 
87 #define	ARCH_KMALLOC_MINALIGN \
88 	__alignof(unsigned long long)
89 
90 /* drm-kmod 5.4 compat */
91 #define kfree_async(ptr)	kfree(ptr);
92 
93 static inline gfp_t
94 linux_check_m_flags(gfp_t flags)
95 {
96 	const gfp_t m = M_NOWAIT | M_WAITOK;
97 
98 	/* make sure either M_NOWAIT or M_WAITOK is set */
99 	if ((flags & m) == 0)
100 		flags |= M_NOWAIT;
101 	else if ((flags & m) == m)
102 		flags &= ~M_WAITOK;
103 
104 	/* mask away LinuxKPI specific flags */
105 	return (flags & GFP_NATIVE_MASK);
106 }
107 
108 static inline void *
109 kmalloc(size_t size, gfp_t flags)
110 {
111 	return (malloc(MAX(size, sizeof(struct llist_node)), M_KMALLOC,
112 	    linux_check_m_flags(flags)));
113 }
114 
115 static inline void *
116 kmalloc_node(size_t size, gfp_t flags, int node)
117 {
118 	return (malloc_domainset(size, M_KMALLOC,
119 	    linux_get_vm_domain_set(node), linux_check_m_flags(flags)));
120 }
121 
122 static inline void *
123 kcalloc(size_t n, size_t size, gfp_t flags)
124 {
125 	flags |= __GFP_ZERO;
126 	return (mallocarray(n, size, M_KMALLOC, linux_check_m_flags(flags)));
127 }
128 
129 static inline void *
130 kcalloc_node(size_t n, size_t size, gfp_t flags, int node)
131 {
132 	flags |= __GFP_ZERO;
133 	return (mallocarray_domainset(n, size, M_KMALLOC,
134 	    linux_get_vm_domain_set(node), linux_check_m_flags(flags)));
135 }
136 
137 static inline void *
138 __vmalloc(size_t size, gfp_t flags, int other)
139 {
140 	return (malloc(size, M_KMALLOC, linux_check_m_flags(flags)));
141 }
142 
143 static inline void *
144 __vmalloc_node(size_t size, gfp_t flags, int node)
145 {
146 	return (malloc_domainset(size, M_KMALLOC,
147 	    linux_get_vm_domain_set(node), linux_check_m_flags(flags)));
148 }
149 
150 static inline void *
151 vmalloc_32(size_t size)
152 {
153 	return (contigmalloc(size, M_KMALLOC, M_WAITOK, 0, UINT_MAX, 1, 1));
154 }
155 
156 static inline void *
157 kmalloc_array(size_t n, size_t size, gfp_t flags)
158 {
159 	return (mallocarray(n, size, M_KMALLOC, linux_check_m_flags(flags)));
160 }
161 
162 static inline void *
163 kmalloc_array_node(size_t n, size_t size, gfp_t flags, int node)
164 {
165 	return (mallocarray_domainset(n, size, M_KMALLOC,
166 	    linux_get_vm_domain_set(node), linux_check_m_flags(flags)));
167 }
168 
169 static inline void *
170 kvmalloc_array(size_t n, size_t size, gfp_t flags)
171 {
172 	return (mallocarray(n, size, M_KMALLOC, linux_check_m_flags(flags)));
173 }
174 
175 static inline void *
176 krealloc(void *ptr, size_t size, gfp_t flags)
177 {
178 	return (realloc(ptr, size, M_KMALLOC, linux_check_m_flags(flags)));
179 }
180 
181 extern void linux_kfree_async(void *);
182 
183 static inline void
184 kfree(const void *ptr)
185 {
186 	if (curthread->td_critnest != 0)
187 		linux_kfree_async(__DECONST(void *, ptr));
188 	else
189 		free(__DECONST(void *, ptr), M_KMALLOC);
190 }
191 
192 static __inline void
193 kfree_sensitive(const void *ptr)
194 {
195 	zfree(__DECONST(void *, ptr), M_KMALLOC);
196 }
197 
198 static inline size_t
199 ksize(const void *ptr)
200 {
201 	return (malloc_usable_size(ptr));
202 }
203 
204 extern struct linux_kmem_cache *linux_kmem_cache_create(const char *name,
205     size_t size, size_t align, unsigned flags, linux_kmem_ctor_t *ctor);
206 extern void *lkpi_kmem_cache_alloc(struct linux_kmem_cache *, gfp_t);
207 extern void *lkpi_kmem_cache_zalloc(struct linux_kmem_cache *, gfp_t);
208 extern void lkpi_kmem_cache_free(struct linux_kmem_cache *, void *);
209 extern void linux_kmem_cache_destroy(struct linux_kmem_cache *);
210 
211 #endif					/* _LINUXKPI_LINUX_SLAB_H_ */
212