xref: /freebsd/sys/compat/linuxkpi/common/include/linux/slab.h (revision 18054d0220cfc8df9c9568c437bd6fbb59d53c3c)
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 
71 #define	KMEM_CACHE(__struct, flags)					\
72 	linux_kmem_cache_create(#__struct, sizeof(struct __struct),	\
73 	__alignof(struct __struct), (flags), NULL)
74 
75 typedef void linux_kmem_ctor_t (void *);
76 
77 struct linux_kmem_cache;
78 
79 #define	SLAB_HWCACHE_ALIGN	(1 << 0)
80 #define	SLAB_TYPESAFE_BY_RCU	(1 << 1)
81 #define	SLAB_RECLAIM_ACCOUNT	(1 << 2)
82 
83 #define	SLAB_DESTROY_BY_RCU \
84 	SLAB_TYPESAFE_BY_RCU
85 
86 #define	ARCH_KMALLOC_MINALIGN \
87 	__alignof(unsigned long long)
88 
89 /* drm-kmod 5.4 compat */
90 #define kfree_async(ptr)	kfree(ptr);
91 
92 static inline gfp_t
93 linux_check_m_flags(gfp_t flags)
94 {
95 	const gfp_t m = M_NOWAIT | M_WAITOK;
96 
97 	/* make sure either M_NOWAIT or M_WAITOK is set */
98 	if ((flags & m) == 0)
99 		flags |= M_NOWAIT;
100 	else if ((flags & m) == m)
101 		flags &= ~M_WAITOK;
102 
103 	/* mask away LinuxKPI specific flags */
104 	return (flags & GFP_NATIVE_MASK);
105 }
106 
107 static inline void *
108 kmalloc(size_t size, gfp_t flags)
109 {
110 	return (malloc(MAX(size, sizeof(struct llist_node)), M_KMALLOC,
111 	    linux_check_m_flags(flags)));
112 }
113 
114 static inline void *
115 kmalloc_node(size_t size, gfp_t flags, int node)
116 {
117 	return (malloc_domainset(size, M_KMALLOC,
118 	    linux_get_vm_domain_set(node), linux_check_m_flags(flags)));
119 }
120 
121 static inline void *
122 kcalloc(size_t n, size_t size, gfp_t flags)
123 {
124 	flags |= __GFP_ZERO;
125 	return (mallocarray(n, size, M_KMALLOC, linux_check_m_flags(flags)));
126 }
127 
128 static inline void *
129 kcalloc_node(size_t n, size_t size, gfp_t flags, int node)
130 {
131 	flags |= __GFP_ZERO;
132 	return (mallocarray_domainset(n, size, M_KMALLOC,
133 	    linux_get_vm_domain_set(node), linux_check_m_flags(flags)));
134 }
135 
136 static inline void *
137 __vmalloc(size_t size, gfp_t flags, int other)
138 {
139 	return (malloc(size, M_KMALLOC, linux_check_m_flags(flags)));
140 }
141 
142 static inline void *
143 __vmalloc_node(size_t size, gfp_t flags, int node)
144 {
145 	return (malloc_domainset(size, M_KMALLOC,
146 	    linux_get_vm_domain_set(node), linux_check_m_flags(flags)));
147 }
148 
149 static inline void *
150 vmalloc_32(size_t size)
151 {
152 	return (contigmalloc(size, M_KMALLOC, M_WAITOK, 0, UINT_MAX, 1, 1));
153 }
154 
155 static inline void *
156 kmalloc_array(size_t n, size_t size, gfp_t flags)
157 {
158 	return (mallocarray(n, size, M_KMALLOC, linux_check_m_flags(flags)));
159 }
160 
161 static inline void *
162 kmalloc_array_node(size_t n, size_t size, gfp_t flags, int node)
163 {
164 	return (mallocarray_domainset(n, size, M_KMALLOC,
165 	    linux_get_vm_domain_set(node), linux_check_m_flags(flags)));
166 }
167 
168 static inline void *
169 kvmalloc_array(size_t n, size_t size, gfp_t flags)
170 {
171 	return (mallocarray(n, size, M_KMALLOC, linux_check_m_flags(flags)));
172 }
173 
174 static inline void *
175 krealloc(void *ptr, size_t size, gfp_t flags)
176 {
177 	return (realloc(ptr, size, M_KMALLOC, linux_check_m_flags(flags)));
178 }
179 
180 extern void linux_kfree_async(void *);
181 
182 static inline void
183 kfree(const void *ptr)
184 {
185 	if (curthread->td_critnest != 0)
186 		linux_kfree_async(__DECONST(void *, ptr));
187 	else
188 		free(__DECONST(void *, ptr), M_KMALLOC);
189 }
190 
191 static __inline void
192 kfree_sensitive(const void *ptr)
193 {
194 	zfree(__DECONST(void *, ptr), M_KMALLOC);
195 }
196 
197 static inline size_t
198 ksize(const void *ptr)
199 {
200 	return (malloc_usable_size(ptr));
201 }
202 
203 extern struct linux_kmem_cache *linux_kmem_cache_create(const char *name,
204     size_t size, size_t align, unsigned flags, linux_kmem_ctor_t *ctor);
205 extern void *lkpi_kmem_cache_alloc(struct linux_kmem_cache *, gfp_t);
206 extern void *lkpi_kmem_cache_zalloc(struct linux_kmem_cache *, gfp_t);
207 extern void lkpi_kmem_cache_free(struct linux_kmem_cache *, void *);
208 extern void linux_kmem_cache_destroy(struct linux_kmem_cache *);
209 
210 #endif					/* _LINUXKPI_LINUX_SLAB_H_ */
211