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 #ifndef _LINUXKPI_LINUX_SLAB_H_
30 #define _LINUXKPI_LINUX_SLAB_H_
31
32 #include <sys/types.h>
33 #include <sys/malloc.h>
34 #include <sys/limits.h>
35
36 #include <linux/compat.h>
37 #include <linux/types.h>
38 #include <linux/gfp.h>
39 #include <linux/llist.h>
40 #include <linux/overflow.h>
41
42 MALLOC_DECLARE(M_KMALLOC);
43
44 #define kvmalloc(size, flags) kmalloc(size, flags)
45 #define kvzalloc(size, flags) kmalloc(size, (flags) | __GFP_ZERO)
46 #define kvcalloc(n, size, flags) kvmalloc_array(n, size, (flags) | __GFP_ZERO)
47 #define kzalloc(size, flags) kmalloc(size, (flags) | __GFP_ZERO)
48 #define kzalloc_node(size, flags, node) kmalloc_node(size, (flags) | __GFP_ZERO, node)
49 #define kfree_const(ptr) kfree(ptr)
50 #define vzalloc(size) __vmalloc(size, GFP_KERNEL | __GFP_NOWARN | __GFP_ZERO, 0)
51 #define vfree(arg) kfree(arg)
52 #define kvfree(arg) kfree(arg)
53 #define vmalloc_node(size, node) __vmalloc_node(size, GFP_KERNEL, node)
54 #define vmalloc_user(size) __vmalloc(size, GFP_KERNEL | __GFP_ZERO, 0)
55 #define vmalloc(size) __vmalloc(size, GFP_KERNEL, 0)
56 #define __kmalloc(...) kmalloc(__VA_ARGS__)
57
58 /*
59 * Prefix some functions with linux_ to avoid namespace conflict
60 * with the OpenSolaris code in the kernel.
61 */
62 #define kmem_cache linux_kmem_cache
63 #define kmem_cache_create(...) linux_kmem_cache_create(__VA_ARGS__)
64 #define kmem_cache_alloc(...) lkpi_kmem_cache_alloc(__VA_ARGS__)
65 #define kmem_cache_zalloc(...) lkpi_kmem_cache_zalloc(__VA_ARGS__)
66 #define kmem_cache_free(...) lkpi_kmem_cache_free(__VA_ARGS__)
67 #define kmem_cache_destroy(...) linux_kmem_cache_destroy(__VA_ARGS__)
68 #define kmem_cache_shrink(x) (0)
69
70 #define KMEM_CACHE(__struct, flags) \
71 linux_kmem_cache_create(#__struct, sizeof(struct __struct), \
72 __alignof(struct __struct), (flags), NULL)
73
74 typedef void linux_kmem_ctor_t (void *);
75
76 struct linux_kmem_cache;
77
78 #define SLAB_HWCACHE_ALIGN (1 << 0)
79 #define SLAB_TYPESAFE_BY_RCU (1 << 1)
80 #define SLAB_RECLAIM_ACCOUNT (1 << 2)
81
82 #define SLAB_DESTROY_BY_RCU \
83 SLAB_TYPESAFE_BY_RCU
84
85 #define ARCH_KMALLOC_MINALIGN \
86 __alignof(unsigned long long)
87
88 /* drm-kmod 5.4 compat */
89 #define kfree_async(ptr) kfree(ptr);
90
91 #define ZERO_OR_NULL_PTR(x) ((x) == NULL)
92
93 static inline gfp_t
linux_check_m_flags(gfp_t flags)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 *
kmalloc(size_t size,gfp_t flags)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 *
kmalloc_node(size_t size,gfp_t flags,int node)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 *
kcalloc(size_t n,size_t size,gfp_t flags)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 *
kcalloc_node(size_t n,size_t size,gfp_t flags,int node)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 *
__vmalloc(size_t size,gfp_t flags,int other)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 *
__vmalloc_node(size_t size,gfp_t flags,int node)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 *
vmalloc_32(size_t size)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 *
kmalloc_array(size_t n,size_t size,gfp_t flags)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 *
kmalloc_array_node(size_t n,size_t size,gfp_t flags,int node)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 *
kvmalloc_array(size_t n,size_t size,gfp_t flags)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 *
krealloc(void * ptr,size_t size,gfp_t flags)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 static inline void *
krealloc_array(void * ptr,size_t n,size_t size,gfp_t flags)182 krealloc_array(void *ptr, size_t n, size_t size, gfp_t flags)
183 {
184 if (WOULD_OVERFLOW(n, size)) {
185 return NULL;
186 }
187
188 return (realloc(ptr, n * size, M_KMALLOC, linux_check_m_flags(flags)));
189 }
190
191 extern void linux_kfree_async(void *);
192
193 static inline void
kfree(const void * ptr)194 kfree(const void *ptr)
195 {
196 if (curthread->td_critnest != 0)
197 linux_kfree_async(__DECONST(void *, ptr));
198 else
199 free(__DECONST(void *, ptr), M_KMALLOC);
200 }
201
202 static __inline void
kfree_sensitive(const void * ptr)203 kfree_sensitive(const void *ptr)
204 {
205 zfree(__DECONST(void *, ptr), M_KMALLOC);
206 }
207
208 static inline size_t
ksize(const void * ptr)209 ksize(const void *ptr)
210 {
211 return (malloc_usable_size(ptr));
212 }
213
214 extern struct linux_kmem_cache *linux_kmem_cache_create(const char *name,
215 size_t size, size_t align, unsigned flags, linux_kmem_ctor_t *ctor);
216 extern void *lkpi_kmem_cache_alloc(struct linux_kmem_cache *, gfp_t);
217 extern void *lkpi_kmem_cache_zalloc(struct linux_kmem_cache *, gfp_t);
218 extern void lkpi_kmem_cache_free(struct linux_kmem_cache *, void *);
219 extern void linux_kmem_cache_destroy(struct linux_kmem_cache *);
220 void linux_kmem_cache_free_rcu_callback(struct rcu_head *head);
221 void linux_kmem_cache_free_rcu(struct linux_kmem_cache *, void *);
222
223 #endif /* _LINUXKPI_LINUX_SLAB_H_ */
224