blob: 88e833986332e0bfb2c464d04308d8f5687b7abf [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001// SPDX-License-Identifier: GPL-2.0
Christoph Lameter039363f2012-07-06 15:25:10 -05002/*
3 * Slab allocator functions that are independent of the allocator strategy
4 *
5 * (C) 2012 Christoph Lameter <cl@linux.com>
6 */
7#include <linux/slab.h>
8
9#include <linux/mm.h>
10#include <linux/poison.h>
11#include <linux/interrupt.h>
12#include <linux/memory.h>
Alexey Dobriyan1c99ba22018-04-05 16:20:11 -070013#include <linux/cache.h>
Christoph Lameter039363f2012-07-06 15:25:10 -050014#include <linux/compiler.h>
Alexander Potapenkod3fb45f2021-02-25 17:19:11 -080015#include <linux/kfence.h>
Christoph Lameter039363f2012-07-06 15:25:10 -050016#include <linux/module.h>
Christoph Lameter20cea962012-07-06 15:25:13 -050017#include <linux/cpu.h>
18#include <linux/uaccess.h>
Glauber Costab7454ad2012-10-19 18:20:25 +040019#include <linux/seq_file.h>
20#include <linux/proc_fs.h>
Waiman Longfcf8a1e2019-07-11 20:56:38 -070021#include <linux/debugfs.h>
Andrey Konovalove86f8b092020-12-22 12:03:31 -080022#include <linux/kasan.h>
Christoph Lameter039363f2012-07-06 15:25:10 -050023#include <asm/cacheflush.h>
24#include <asm/tlbflush.h>
25#include <asm/page.h>
Glauber Costa2633d7a2012-12-18 14:22:34 -080026#include <linux/memcontrol.h>
Andrey Ryabinin928cec92014-08-06 16:04:44 -070027
28#define CREATE_TRACE_POINTS
Christoph Lameterf1b6eb62013-09-04 16:35:34 +000029#include <trace/events/kmem.h>
Christoph Lameter039363f2012-07-06 15:25:10 -050030
Long Li44405092020-08-06 23:18:28 -070031#include "internal.h"
32
Christoph Lameter97d06602012-07-06 15:25:11 -050033#include "slab.h"
34
35enum slab_state slab_state;
Christoph Lameter18004c52012-07-06 15:25:12 -050036LIST_HEAD(slab_caches);
37DEFINE_MUTEX(slab_mutex);
Christoph Lameter9b030cb2012-09-05 00:20:33 +000038struct kmem_cache *kmem_cache;
Christoph Lameter97d06602012-07-06 15:25:11 -050039
Kees Cook2d891fb2017-11-30 13:04:32 -080040#ifdef CONFIG_HARDENED_USERCOPY
41bool usercopy_fallback __ro_after_init =
42 IS_ENABLED(CONFIG_HARDENED_USERCOPY_FALLBACK);
43module_param(usercopy_fallback, bool, 0400);
44MODULE_PARM_DESC(usercopy_fallback,
45 "WARN instead of reject usercopy whitelist violations");
46#endif
47
Tejun Heo657dc2f2017-02-22 15:41:14 -080048static LIST_HEAD(slab_caches_to_rcu_destroy);
49static void slab_caches_to_rcu_destroy_workfn(struct work_struct *work);
50static DECLARE_WORK(slab_caches_to_rcu_destroy_work,
51 slab_caches_to_rcu_destroy_workfn);
52
Joonsoo Kim07f361b2014-10-09 15:26:00 -070053/*
Joonsoo Kim423c9292014-10-09 15:26:22 -070054 * Set of flags that will prevent slab merging
55 */
56#define SLAB_NEVER_MERGE (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER | \
Paul E. McKenney5f0d5a32017-01-18 02:53:44 -080057 SLAB_TRACE | SLAB_TYPESAFE_BY_RCU | SLAB_NOLEAKTRACE | \
Andrey Konovalove86f8b092020-12-22 12:03:31 -080058 SLAB_FAILSLAB | kasan_never_merge())
Joonsoo Kim423c9292014-10-09 15:26:22 -070059
Vladimir Davydov230e9fc2016-01-14 15:18:15 -080060#define SLAB_MERGE_SAME (SLAB_RECLAIM_ACCOUNT | SLAB_CACHE_DMA | \
Nicolas Boichat6d6ea1e2019-03-28 20:43:42 -070061 SLAB_CACHE_DMA32 | SLAB_ACCOUNT)
Joonsoo Kim423c9292014-10-09 15:26:22 -070062
63/*
64 * Merge control. If this is set then no merging of slab caches will occur.
Joonsoo Kim423c9292014-10-09 15:26:22 -070065 */
Kees Cook7660a6f2017-07-06 15:36:40 -070066static bool slab_nomerge = !IS_ENABLED(CONFIG_SLAB_MERGE_DEFAULT);
Joonsoo Kim423c9292014-10-09 15:26:22 -070067
68static int __init setup_slab_nomerge(char *str)
69{
Kees Cook7660a6f2017-07-06 15:36:40 -070070 slab_nomerge = true;
Joonsoo Kim423c9292014-10-09 15:26:22 -070071 return 1;
72}
73
74#ifdef CONFIG_SLUB
75__setup_param("slub_nomerge", slub_nomerge, setup_slab_nomerge, 0);
76#endif
77
78__setup("slab_nomerge", setup_slab_nomerge);
79
80/*
Joonsoo Kim07f361b2014-10-09 15:26:00 -070081 * Determine the size of a slab object
82 */
83unsigned int kmem_cache_size(struct kmem_cache *s)
84{
85 return s->object_size;
86}
87EXPORT_SYMBOL(kmem_cache_size);
88
Shuah Khan77be4b12012-08-16 00:09:46 -070089#ifdef CONFIG_DEBUG_VM
Alexey Dobriyanf4957d52018-04-05 16:20:37 -070090static int kmem_cache_sanity_check(const char *name, unsigned int size)
Shuah Khan77be4b12012-08-16 00:09:46 -070091{
Shuah Khan77be4b12012-08-16 00:09:46 -070092 if (!name || in_interrupt() || size < sizeof(void *) ||
93 size > KMALLOC_MAX_SIZE) {
94 pr_err("kmem_cache_create(%s) integrity check failed\n", name);
95 return -EINVAL;
96 }
97
Shuah Khan77be4b12012-08-16 00:09:46 -070098 WARN_ON(strchr(name, ' ')); /* It confuses parsers */
99 return 0;
100}
101#else
Alexey Dobriyanf4957d52018-04-05 16:20:37 -0700102static inline int kmem_cache_sanity_check(const char *name, unsigned int size)
Shuah Khan77be4b12012-08-16 00:09:46 -0700103{
104 return 0;
105}
106#endif
107
Christoph Lameter484748f2015-09-04 15:45:34 -0700108void __kmem_cache_free_bulk(struct kmem_cache *s, size_t nr, void **p)
109{
110 size_t i;
111
Jesper Dangaard Brouerca257192016-03-15 14:54:00 -0700112 for (i = 0; i < nr; i++) {
113 if (s)
114 kmem_cache_free(s, p[i]);
115 else
116 kfree(p[i]);
117 }
Christoph Lameter484748f2015-09-04 15:45:34 -0700118}
119
Jesper Dangaard Brouer865762a2015-11-20 15:57:58 -0800120int __kmem_cache_alloc_bulk(struct kmem_cache *s, gfp_t flags, size_t nr,
Christoph Lameter484748f2015-09-04 15:45:34 -0700121 void **p)
122{
123 size_t i;
124
125 for (i = 0; i < nr; i++) {
126 void *x = p[i] = kmem_cache_alloc(s, flags);
127 if (!x) {
128 __kmem_cache_free_bulk(s, i, p);
Jesper Dangaard Brouer865762a2015-11-20 15:57:58 -0800129 return 0;
Christoph Lameter484748f2015-09-04 15:45:34 -0700130 }
131 }
Jesper Dangaard Brouer865762a2015-11-20 15:57:58 -0800132 return i;
Christoph Lameter484748f2015-09-04 15:45:34 -0700133}
134
Christoph Lameter039363f2012-07-06 15:25:10 -0500135/*
Byongho Lee692ae742018-01-31 16:15:36 -0800136 * Figure out what the alignment of the objects will be given a set of
137 * flags, a user specified alignment and the size of the objects.
138 */
Alexey Dobriyanf4957d52018-04-05 16:20:37 -0700139static unsigned int calculate_alignment(slab_flags_t flags,
140 unsigned int align, unsigned int size)
Byongho Lee692ae742018-01-31 16:15:36 -0800141{
142 /*
143 * If the user wants hardware cache aligned objects then follow that
144 * suggestion if the object is sufficiently large.
145 *
146 * The hardware cache alignment cannot override the specified
147 * alignment though. If that is greater then use it.
148 */
149 if (flags & SLAB_HWCACHE_ALIGN) {
Alexey Dobriyanf4957d52018-04-05 16:20:37 -0700150 unsigned int ralign;
Byongho Lee692ae742018-01-31 16:15:36 -0800151
152 ralign = cache_line_size();
153 while (size <= ralign / 2)
154 ralign /= 2;
155 align = max(align, ralign);
156 }
157
158 if (align < ARCH_SLAB_MINALIGN)
159 align = ARCH_SLAB_MINALIGN;
160
161 return ALIGN(align, sizeof(void *));
162}
163
164/*
Joonsoo Kim423c9292014-10-09 15:26:22 -0700165 * Find a mergeable slab cache
166 */
167int slab_unmergeable(struct kmem_cache *s)
168{
169 if (slab_nomerge || (s->flags & SLAB_NEVER_MERGE))
170 return 1;
171
Joonsoo Kim423c9292014-10-09 15:26:22 -0700172 if (s->ctor)
173 return 1;
174
David Windsor8eb82842017-06-10 22:50:28 -0400175 if (s->usersize)
176 return 1;
177
Joonsoo Kim423c9292014-10-09 15:26:22 -0700178 /*
179 * We may have set a slab to be unmergeable during bootstrap.
180 */
181 if (s->refcount < 0)
182 return 1;
183
184 return 0;
185}
186
Alexey Dobriyanf4957d52018-04-05 16:20:37 -0700187struct kmem_cache *find_mergeable(unsigned int size, unsigned int align,
Alexey Dobriyand50112e2017-11-15 17:32:18 -0800188 slab_flags_t flags, const char *name, void (*ctor)(void *))
Joonsoo Kim423c9292014-10-09 15:26:22 -0700189{
190 struct kmem_cache *s;
191
Grygorii Maistrenkoc6e28892017-02-22 15:40:59 -0800192 if (slab_nomerge)
Joonsoo Kim423c9292014-10-09 15:26:22 -0700193 return NULL;
194
195 if (ctor)
196 return NULL;
197
198 size = ALIGN(size, sizeof(void *));
199 align = calculate_alignment(flags, align, size);
200 size = ALIGN(size, align);
Nikolay Borisov37540002021-02-24 12:00:58 -0800201 flags = kmem_cache_flags(size, flags, name);
Joonsoo Kim423c9292014-10-09 15:26:22 -0700202
Grygorii Maistrenkoc6e28892017-02-22 15:40:59 -0800203 if (flags & SLAB_NEVER_MERGE)
204 return NULL;
205
Roman Gushchinc7094402020-08-06 23:21:20 -0700206 list_for_each_entry_reverse(s, &slab_caches, list) {
Joonsoo Kim423c9292014-10-09 15:26:22 -0700207 if (slab_unmergeable(s))
208 continue;
209
210 if (size > s->size)
211 continue;
212
213 if ((flags & SLAB_MERGE_SAME) != (s->flags & SLAB_MERGE_SAME))
214 continue;
215 /*
216 * Check if alignment is compatible.
217 * Courtesy of Adrian Drzewiecki
218 */
219 if ((s->size & ~(align - 1)) != s->size)
220 continue;
221
222 if (s->size - size >= sizeof(void *))
223 continue;
224
Joonsoo Kim95069ac82014-11-13 15:19:25 -0800225 if (IS_ENABLED(CONFIG_SLAB) && align &&
226 (align > s->align || s->align % align))
227 continue;
228
Joonsoo Kim423c9292014-10-09 15:26:22 -0700229 return s;
230 }
231 return NULL;
232}
233
Vladimir Davydovc9a77a72015-11-05 18:45:08 -0800234static struct kmem_cache *create_cache(const char *name,
Shakeel Butt613a5eb2018-04-05 16:21:50 -0700235 unsigned int object_size, unsigned int align,
Alexey Dobriyan7bbdb812018-04-05 16:21:31 -0700236 slab_flags_t flags, unsigned int useroffset,
237 unsigned int usersize, void (*ctor)(void *),
Roman Gushchin98556092020-08-06 23:21:10 -0700238 struct kmem_cache *root_cache)
Vladimir Davydov794b1242014-04-07 15:39:26 -0700239{
240 struct kmem_cache *s;
241 int err;
242
David Windsor8eb82842017-06-10 22:50:28 -0400243 if (WARN_ON(useroffset + usersize > object_size))
244 useroffset = usersize = 0;
245
Vladimir Davydov794b1242014-04-07 15:39:26 -0700246 err = -ENOMEM;
247 s = kmem_cache_zalloc(kmem_cache, GFP_KERNEL);
248 if (!s)
249 goto out;
250
251 s->name = name;
Shakeel Butt613a5eb2018-04-05 16:21:50 -0700252 s->size = s->object_size = object_size;
Vladimir Davydov794b1242014-04-07 15:39:26 -0700253 s->align = align;
254 s->ctor = ctor;
David Windsor8eb82842017-06-10 22:50:28 -0400255 s->useroffset = useroffset;
256 s->usersize = usersize;
Vladimir Davydov794b1242014-04-07 15:39:26 -0700257
Vladimir Davydov794b1242014-04-07 15:39:26 -0700258 err = __kmem_cache_create(s, flags);
259 if (err)
260 goto out_free_cache;
261
262 s->refcount = 1;
263 list_add(&s->list, &slab_caches);
Vladimir Davydov794b1242014-04-07 15:39:26 -0700264out:
265 if (err)
266 return ERR_PTR(err);
267 return s;
268
269out_free_cache:
Vaishali Thakkar7c4da062015-02-10 14:09:40 -0800270 kmem_cache_free(kmem_cache, s);
Vladimir Davydov794b1242014-04-07 15:39:26 -0700271 goto out;
272}
Christoph Lameter45906852012-11-28 16:23:16 +0000273
Mike Rapoportf4969902018-12-06 23:13:00 +0200274/**
275 * kmem_cache_create_usercopy - Create a cache with a region suitable
276 * for copying to userspace
Christoph Lameter039363f2012-07-06 15:25:10 -0500277 * @name: A string which is used in /proc/slabinfo to identify this cache.
278 * @size: The size of objects to be created in this cache.
279 * @align: The required alignment for the objects.
280 * @flags: SLAB flags
David Windsor8eb82842017-06-10 22:50:28 -0400281 * @useroffset: Usercopy region offset
282 * @usersize: Usercopy region size
Christoph Lameter039363f2012-07-06 15:25:10 -0500283 * @ctor: A constructor for the objects.
284 *
Christoph Lameter039363f2012-07-06 15:25:10 -0500285 * Cannot be called within a interrupt, but can be interrupted.
286 * The @ctor is run when new pages are allocated by the cache.
287 *
288 * The flags are
289 *
290 * %SLAB_POISON - Poison the slab with a known test pattern (a5a5a5a5)
291 * to catch references to uninitialised memory.
292 *
Mike Rapoportf4969902018-12-06 23:13:00 +0200293 * %SLAB_RED_ZONE - Insert `Red` zones around the allocated memory to check
Christoph Lameter039363f2012-07-06 15:25:10 -0500294 * for buffer overruns.
295 *
296 * %SLAB_HWCACHE_ALIGN - Align the objects in this cache to a hardware
297 * cacheline. This can be beneficial if you're counting cycles as closely
298 * as davem.
Mike Rapoportf4969902018-12-06 23:13:00 +0200299 *
300 * Return: a pointer to the cache on success, NULL on failure.
Christoph Lameter039363f2012-07-06 15:25:10 -0500301 */
Glauber Costa2633d7a2012-12-18 14:22:34 -0800302struct kmem_cache *
Alexey Dobriyanf4957d52018-04-05 16:20:37 -0700303kmem_cache_create_usercopy(const char *name,
304 unsigned int size, unsigned int align,
Alexey Dobriyan7bbdb812018-04-05 16:21:31 -0700305 slab_flags_t flags,
306 unsigned int useroffset, unsigned int usersize,
David Windsor8eb82842017-06-10 22:50:28 -0400307 void (*ctor)(void *))
Christoph Lameter039363f2012-07-06 15:25:10 -0500308{
Alexandru Moise40911a72015-11-05 18:45:43 -0800309 struct kmem_cache *s = NULL;
Andrzej Hajda3dec16e2015-02-13 14:36:38 -0800310 const char *cache_name;
Vladimir Davydov3965fc32014-01-23 15:52:55 -0800311 int err;
Christoph Lameter039363f2012-07-06 15:25:10 -0500312
Pekka Enbergb9205362012-08-16 10:12:18 +0300313 mutex_lock(&slab_mutex);
Christoph Lameter686d5502012-09-05 00:20:33 +0000314
Vladimir Davydov794b1242014-04-07 15:39:26 -0700315 err = kmem_cache_sanity_check(name, size);
Andrew Morton3aa24f52014-10-09 15:25:58 -0700316 if (err) {
Vladimir Davydov3965fc32014-01-23 15:52:55 -0800317 goto out_unlock;
Andrew Morton3aa24f52014-10-09 15:25:58 -0700318 }
Christoph Lameter686d5502012-09-05 00:20:33 +0000319
Thomas Garniere70954f2016-12-12 16:41:38 -0800320 /* Refuse requests with allocator specific flags */
321 if (flags & ~SLAB_FLAGS_PERMITTED) {
322 err = -EINVAL;
323 goto out_unlock;
324 }
325
Glauber Costad8843922012-10-17 15:36:51 +0400326 /*
327 * Some allocators will constraint the set of valid flags to a subset
328 * of all flags. We expect them to define CACHE_CREATE_MASK in this
329 * case, and we'll just provide them with a sanitized version of the
330 * passed flags.
331 */
332 flags &= CACHE_CREATE_MASK;
Christoph Lameter686d5502012-09-05 00:20:33 +0000333
David Windsor8eb82842017-06-10 22:50:28 -0400334 /* Fail closed on bad usersize of useroffset values. */
335 if (WARN_ON(!usersize && useroffset) ||
336 WARN_ON(size < usersize || size - usersize < useroffset))
337 usersize = useroffset = 0;
338
339 if (!usersize)
340 s = __kmem_cache_alias(name, size, align, flags, ctor);
Vladimir Davydov794b1242014-04-07 15:39:26 -0700341 if (s)
Vladimir Davydov3965fc32014-01-23 15:52:55 -0800342 goto out_unlock;
Glauber Costa2633d7a2012-12-18 14:22:34 -0800343
Andrzej Hajda3dec16e2015-02-13 14:36:38 -0800344 cache_name = kstrdup_const(name, GFP_KERNEL);
Vladimir Davydov794b1242014-04-07 15:39:26 -0700345 if (!cache_name) {
346 err = -ENOMEM;
347 goto out_unlock;
348 }
Glauber Costa2633d7a2012-12-18 14:22:34 -0800349
Shakeel Butt613a5eb2018-04-05 16:21:50 -0700350 s = create_cache(cache_name, size,
Vladimir Davydovc9a77a72015-11-05 18:45:08 -0800351 calculate_alignment(flags, align, size),
Roman Gushchin98556092020-08-06 23:21:10 -0700352 flags, useroffset, usersize, ctor, NULL);
Vladimir Davydov794b1242014-04-07 15:39:26 -0700353 if (IS_ERR(s)) {
354 err = PTR_ERR(s);
Andrzej Hajda3dec16e2015-02-13 14:36:38 -0800355 kfree_const(cache_name);
Vladimir Davydov794b1242014-04-07 15:39:26 -0700356 }
Vladimir Davydov3965fc32014-01-23 15:52:55 -0800357
358out_unlock:
Christoph Lameter20cea962012-07-06 15:25:13 -0500359 mutex_unlock(&slab_mutex);
Vladimir Davydov03afc0e2014-06-04 16:07:20 -0700360
Dave Jonesba3253c2014-01-29 14:05:48 -0800361 if (err) {
Christoph Lameter686d5502012-09-05 00:20:33 +0000362 if (flags & SLAB_PANIC)
363 panic("kmem_cache_create: Failed to create slab '%s'. Error %d\n",
364 name, err);
365 else {
Joe Perches11705322016-03-17 14:19:50 -0700366 pr_warn("kmem_cache_create(%s) failed with error %d\n",
Christoph Lameter686d5502012-09-05 00:20:33 +0000367 name, err);
368 dump_stack();
369 }
Christoph Lameter686d5502012-09-05 00:20:33 +0000370 return NULL;
371 }
Christoph Lameter039363f2012-07-06 15:25:10 -0500372 return s;
Glauber Costa2633d7a2012-12-18 14:22:34 -0800373}
David Windsor8eb82842017-06-10 22:50:28 -0400374EXPORT_SYMBOL(kmem_cache_create_usercopy);
375
Mike Rapoportf4969902018-12-06 23:13:00 +0200376/**
377 * kmem_cache_create - Create a cache.
378 * @name: A string which is used in /proc/slabinfo to identify this cache.
379 * @size: The size of objects to be created in this cache.
380 * @align: The required alignment for the objects.
381 * @flags: SLAB flags
382 * @ctor: A constructor for the objects.
383 *
384 * Cannot be called within a interrupt, but can be interrupted.
385 * The @ctor is run when new pages are allocated by the cache.
386 *
387 * The flags are
388 *
389 * %SLAB_POISON - Poison the slab with a known test pattern (a5a5a5a5)
390 * to catch references to uninitialised memory.
391 *
392 * %SLAB_RED_ZONE - Insert `Red` zones around the allocated memory to check
393 * for buffer overruns.
394 *
395 * %SLAB_HWCACHE_ALIGN - Align the objects in this cache to a hardware
396 * cacheline. This can be beneficial if you're counting cycles as closely
397 * as davem.
398 *
399 * Return: a pointer to the cache on success, NULL on failure.
400 */
David Windsor8eb82842017-06-10 22:50:28 -0400401struct kmem_cache *
Alexey Dobriyanf4957d52018-04-05 16:20:37 -0700402kmem_cache_create(const char *name, unsigned int size, unsigned int align,
David Windsor8eb82842017-06-10 22:50:28 -0400403 slab_flags_t flags, void (*ctor)(void *))
404{
Kees Cook6d07d1c2017-06-14 16:12:04 -0700405 return kmem_cache_create_usercopy(name, size, align, flags, 0, 0,
David Windsor8eb82842017-06-10 22:50:28 -0400406 ctor);
407}
Christoph Lameter039363f2012-07-06 15:25:10 -0500408EXPORT_SYMBOL(kmem_cache_create);
Christoph Lameter97d06602012-07-06 15:25:11 -0500409
Tejun Heo657dc2f2017-02-22 15:41:14 -0800410static void slab_caches_to_rcu_destroy_workfn(struct work_struct *work)
Vladimir Davydovd5b3cf72015-02-10 14:11:47 -0800411{
Tejun Heo657dc2f2017-02-22 15:41:14 -0800412 LIST_HEAD(to_destroy);
Vladimir Davydovd5b3cf72015-02-10 14:11:47 -0800413 struct kmem_cache *s, *s2;
414
Tejun Heo657dc2f2017-02-22 15:41:14 -0800415 /*
Paul E. McKenney5f0d5a32017-01-18 02:53:44 -0800416 * On destruction, SLAB_TYPESAFE_BY_RCU kmem_caches are put on the
Tejun Heo657dc2f2017-02-22 15:41:14 -0800417 * @slab_caches_to_rcu_destroy list. The slab pages are freed
Randy Dunlap081a06f2020-08-11 18:33:19 -0700418 * through RCU and the associated kmem_cache are dereferenced
Tejun Heo657dc2f2017-02-22 15:41:14 -0800419 * while freeing the pages, so the kmem_caches should be freed only
420 * after the pending RCU operations are finished. As rcu_barrier()
421 * is a pretty slow operation, we batch all pending destructions
422 * asynchronously.
423 */
424 mutex_lock(&slab_mutex);
425 list_splice_init(&slab_caches_to_rcu_destroy, &to_destroy);
426 mutex_unlock(&slab_mutex);
Vladimir Davydovd5b3cf72015-02-10 14:11:47 -0800427
Tejun Heo657dc2f2017-02-22 15:41:14 -0800428 if (list_empty(&to_destroy))
429 return;
430
431 rcu_barrier();
432
433 list_for_each_entry_safe(s, s2, &to_destroy, list) {
Alexander Potapenkod3fb45f2021-02-25 17:19:11 -0800434 kfence_shutdown_cache(s);
Vladimir Davydovd5b3cf72015-02-10 14:11:47 -0800435#ifdef SLAB_SUPPORTS_SYSFS
Tejun Heobf5eb3d2017-02-22 15:41:11 -0800436 sysfs_slab_release(s);
Vladimir Davydovd5b3cf72015-02-10 14:11:47 -0800437#else
438 slab_kmem_cache_release(s);
439#endif
440 }
441}
442
Tejun Heo657dc2f2017-02-22 15:41:14 -0800443static int shutdown_cache(struct kmem_cache *s)
444{
Greg Thelenf9fa1d92017-02-24 15:00:05 -0800445 /* free asan quarantined objects */
446 kasan_cache_shutdown(s);
447
Tejun Heo657dc2f2017-02-22 15:41:14 -0800448 if (__kmem_cache_shutdown(s) != 0)
449 return -EBUSY;
450
451 list_del(&s->list);
Tejun Heo657dc2f2017-02-22 15:41:14 -0800452
Paul E. McKenney5f0d5a32017-01-18 02:53:44 -0800453 if (s->flags & SLAB_TYPESAFE_BY_RCU) {
Mikulas Patockad50d82f2018-06-27 23:26:09 -0700454#ifdef SLAB_SUPPORTS_SYSFS
455 sysfs_slab_unlink(s);
456#endif
Tejun Heo657dc2f2017-02-22 15:41:14 -0800457 list_add_tail(&s->list, &slab_caches_to_rcu_destroy);
458 schedule_work(&slab_caches_to_rcu_destroy_work);
459 } else {
Alexander Potapenkod3fb45f2021-02-25 17:19:11 -0800460 kfence_shutdown_cache(s);
Tejun Heo657dc2f2017-02-22 15:41:14 -0800461#ifdef SLAB_SUPPORTS_SYSFS
Mikulas Patockad50d82f2018-06-27 23:26:09 -0700462 sysfs_slab_unlink(s);
Tejun Heo657dc2f2017-02-22 15:41:14 -0800463 sysfs_slab_release(s);
464#else
465 slab_kmem_cache_release(s);
466#endif
467 }
468
469 return 0;
470}
471
Christoph Lameter41a21282014-05-06 12:50:08 -0700472void slab_kmem_cache_release(struct kmem_cache *s)
473{
Dmitry Safonov52b4b952016-02-17 13:11:37 -0800474 __kmem_cache_release(s);
Andrzej Hajda3dec16e2015-02-13 14:36:38 -0800475 kfree_const(s->name);
Christoph Lameter41a21282014-05-06 12:50:08 -0700476 kmem_cache_free(kmem_cache, s);
477}
478
Christoph Lameter945cf2b2012-09-04 23:18:33 +0000479void kmem_cache_destroy(struct kmem_cache *s)
480{
Vladimir Davydovd60fdcc2015-11-05 18:45:11 -0800481 int err;
Vladimir Davydovd5b3cf72015-02-10 14:11:47 -0800482
Sergey Senozhatsky3942d292015-09-08 15:00:50 -0700483 if (unlikely(!s))
484 return;
485
Christoph Lameter945cf2b2012-09-04 23:18:33 +0000486 mutex_lock(&slab_mutex);
Vladimir Davydovb8529902014-04-07 15:39:28 -0700487
Christoph Lameter945cf2b2012-09-04 23:18:33 +0000488 s->refcount--;
Vladimir Davydovb8529902014-04-07 15:39:28 -0700489 if (s->refcount)
490 goto out_unlock;
Christoph Lameter945cf2b2012-09-04 23:18:33 +0000491
Roman Gushchin10befea2020-08-06 23:21:27 -0700492 err = shutdown_cache(s);
Vladimir Davydovcd918c52015-11-05 18:45:14 -0800493 if (err) {
Joe Perches756a0252016-03-17 14:19:47 -0700494 pr_err("kmem_cache_destroy %s: Slab cache still has objects\n",
495 s->name);
Vladimir Davydovcd918c52015-11-05 18:45:14 -0800496 dump_stack();
497 }
Vladimir Davydovb8529902014-04-07 15:39:28 -0700498out_unlock:
499 mutex_unlock(&slab_mutex);
Christoph Lameter945cf2b2012-09-04 23:18:33 +0000500}
501EXPORT_SYMBOL(kmem_cache_destroy);
502
Vladimir Davydov03afc0e2014-06-04 16:07:20 -0700503/**
504 * kmem_cache_shrink - Shrink a cache.
505 * @cachep: The cache to shrink.
506 *
507 * Releases as many slabs as possible for a cache.
508 * To help debugging, a zero exit status indicates all slabs were released.
Mike Rapoporta862f682019-03-05 15:48:42 -0800509 *
510 * Return: %0 if all slabs were released, non-zero otherwise
Vladimir Davydov03afc0e2014-06-04 16:07:20 -0700511 */
512int kmem_cache_shrink(struct kmem_cache *cachep)
513{
514 int ret;
515
Vlastimil Babka7e1fa932021-02-24 12:01:12 -0800516
Alexander Potapenko55834c52016-05-20 16:59:11 -0700517 kasan_cache_shrink(cachep);
Tejun Heoc9fc5862017-02-22 15:41:27 -0800518 ret = __kmem_cache_shrink(cachep);
Vlastimil Babka7e1fa932021-02-24 12:01:12 -0800519
Vladimir Davydov03afc0e2014-06-04 16:07:20 -0700520 return ret;
521}
522EXPORT_SYMBOL(kmem_cache_shrink);
523
Denis Kirjanovfda90122015-11-05 18:44:59 -0800524bool slab_is_available(void)
Christoph Lameter97d06602012-07-06 15:25:11 -0500525{
526 return slab_state >= UP;
527}
Glauber Costab7454ad2012-10-19 18:20:25 +0400528
Paul E. McKenney8e7f37f2020-12-07 17:41:02 -0800529/**
530 * kmem_valid_obj - does the pointer reference a valid slab object?
531 * @object: pointer to query.
532 *
533 * Return: %true if the pointer is to a not-yet-freed object from
534 * kmalloc() or kmem_cache_alloc(), either %true or %false if the pointer
535 * is to an already-freed object, and %false otherwise.
536 */
537bool kmem_valid_obj(void *object)
538{
539 struct page *page;
540
541 /* Some arches consider ZERO_SIZE_PTR to be a valid address. */
542 if (object < (void *)PAGE_SIZE || !virt_addr_valid(object))
543 return false;
544 page = virt_to_head_page(object);
545 return PageSlab(page);
546}
547
548/**
549 * kmem_dump_obj - Print available slab provenance information
550 * @object: slab object for which to find provenance information.
551 *
552 * This function uses pr_cont(), so that the caller is expected to have
553 * printed out whatever preamble is appropriate. The provenance information
554 * depends on the type of object and on how much debugging is enabled.
555 * For a slab-cache object, the fact that it is a slab object is printed,
556 * and, if available, the slab name, return address, and stack trace from
557 * the allocation of that object.
558 *
559 * This function will splat if passed a pointer to a non-slab object.
560 * If you are not sure what type of object you have, you should instead
561 * use mem_dump_obj().
562 */
563void kmem_dump_obj(void *object)
564{
565 char *cp = IS_ENABLED(CONFIG_MMU) ? "" : "/vmalloc";
566 int i;
567 struct page *page;
568 unsigned long ptroffset;
569 struct kmem_obj_info kp = { };
570
571 if (WARN_ON_ONCE(!virt_addr_valid(object)))
572 return;
573 page = virt_to_head_page(object);
574 if (WARN_ON_ONCE(!PageSlab(page))) {
575 pr_cont(" non-slab memory.\n");
576 return;
577 }
578 kmem_obj_info(&kp, object, page);
579 if (kp.kp_slab_cache)
580 pr_cont(" slab%s %s", cp, kp.kp_slab_cache->name);
581 else
582 pr_cont(" slab%s", cp);
583 if (kp.kp_objp)
584 pr_cont(" start %px", kp.kp_objp);
585 if (kp.kp_data_offset)
586 pr_cont(" data offset %lu", kp.kp_data_offset);
587 if (kp.kp_objp) {
588 ptroffset = ((char *)object - (char *)kp.kp_objp) - kp.kp_data_offset;
589 pr_cont(" pointer offset %lu", ptroffset);
590 }
591 if (kp.kp_slab_cache && kp.kp_slab_cache->usersize)
592 pr_cont(" size %u", kp.kp_slab_cache->usersize);
593 if (kp.kp_ret)
594 pr_cont(" allocated at %pS\n", kp.kp_ret);
595 else
596 pr_cont("\n");
597 for (i = 0; i < ARRAY_SIZE(kp.kp_stack); i++) {
598 if (!kp.kp_stack[i])
599 break;
600 pr_info(" %pS\n", kp.kp_stack[i]);
601 }
602}
603
Christoph Lameter45530c42012-11-28 16:23:07 +0000604#ifndef CONFIG_SLOB
605/* Create a cache during boot when no slab services are available yet */
Alexey Dobriyan361d5752018-04-05 16:20:33 -0700606void __init create_boot_cache(struct kmem_cache *s, const char *name,
607 unsigned int size, slab_flags_t flags,
608 unsigned int useroffset, unsigned int usersize)
Christoph Lameter45530c42012-11-28 16:23:07 +0000609{
610 int err;
Vlastimil Babka59bb4792019-10-06 17:58:45 -0700611 unsigned int align = ARCH_KMALLOC_MINALIGN;
Christoph Lameter45530c42012-11-28 16:23:07 +0000612
613 s->name = name;
614 s->size = s->object_size = size;
Vlastimil Babka59bb4792019-10-06 17:58:45 -0700615
616 /*
617 * For power of two sizes, guarantee natural alignment for kmalloc
618 * caches, regardless of SL*B debugging options.
619 */
620 if (is_power_of_2(size))
621 align = max(align, size);
622 s->align = calculate_alignment(flags, align, size);
623
David Windsor8eb82842017-06-10 22:50:28 -0400624 s->useroffset = useroffset;
625 s->usersize = usersize;
Vladimir Davydovf7ce3192015-02-12 14:59:20 -0800626
Christoph Lameter45530c42012-11-28 16:23:07 +0000627 err = __kmem_cache_create(s, flags);
628
629 if (err)
Alexey Dobriyan361d5752018-04-05 16:20:33 -0700630 panic("Creation of kmalloc slab %s size=%u failed. Reason %d\n",
Christoph Lameter45530c42012-11-28 16:23:07 +0000631 name, size, err);
632
633 s->refcount = -1; /* Exempt from merging for now */
634}
635
Alexey Dobriyan55de8b92018-04-05 16:20:29 -0700636struct kmem_cache *__init create_kmalloc_cache(const char *name,
637 unsigned int size, slab_flags_t flags,
638 unsigned int useroffset, unsigned int usersize)
Christoph Lameter45530c42012-11-28 16:23:07 +0000639{
640 struct kmem_cache *s = kmem_cache_zalloc(kmem_cache, GFP_NOWAIT);
641
642 if (!s)
643 panic("Out of memory when creating slab %s\n", name);
644
David Windsor6c0c21a2017-06-10 22:50:47 -0400645 create_boot_cache(s, name, size, flags, useroffset, usersize);
Andrey Konovalov92850132021-02-25 17:19:55 -0800646 kasan_cache_create_kmalloc(s);
Christoph Lameter45530c42012-11-28 16:23:07 +0000647 list_add(&s->list, &slab_caches);
648 s->refcount = 1;
649 return s;
650}
651
Vlastimil Babkacc252ea2018-10-26 15:05:34 -0700652struct kmem_cache *
Arnd Bergmanna07057d2019-07-16 16:25:57 -0700653kmalloc_caches[NR_KMALLOC_TYPES][KMALLOC_SHIFT_HIGH + 1] __ro_after_init =
654{ /* initialization for https://bugs.llvm.org/show_bug.cgi?id=42570 */ };
Christoph Lameter9425c582013-01-10 19:12:17 +0000655EXPORT_SYMBOL(kmalloc_caches);
656
Christoph Lameterf97d5f62013-01-10 19:12:17 +0000657/*
Christoph Lameter2c59dd62013-01-10 19:14:19 +0000658 * Conversion table for small slabs sizes / 8 to the index in the
659 * kmalloc array. This is necessary for slabs < 192 since we have non power
660 * of two cache sizes there. The size of larger slabs can be determined using
661 * fls.
662 */
Alexey Dobriyand5f86652018-04-05 16:20:40 -0700663static u8 size_index[24] __ro_after_init = {
Christoph Lameter2c59dd62013-01-10 19:14:19 +0000664 3, /* 8 */
665 4, /* 16 */
666 5, /* 24 */
667 5, /* 32 */
668 6, /* 40 */
669 6, /* 48 */
670 6, /* 56 */
671 6, /* 64 */
672 1, /* 72 */
673 1, /* 80 */
674 1, /* 88 */
675 1, /* 96 */
676 7, /* 104 */
677 7, /* 112 */
678 7, /* 120 */
679 7, /* 128 */
680 2, /* 136 */
681 2, /* 144 */
682 2, /* 152 */
683 2, /* 160 */
684 2, /* 168 */
685 2, /* 176 */
686 2, /* 184 */
687 2 /* 192 */
688};
689
Alexey Dobriyanac914d02018-04-05 16:20:44 -0700690static inline unsigned int size_index_elem(unsigned int bytes)
Christoph Lameter2c59dd62013-01-10 19:14:19 +0000691{
692 return (bytes - 1) / 8;
693}
694
695/*
696 * Find the kmem_cache structure that serves a given size of
697 * allocation
698 */
699struct kmem_cache *kmalloc_slab(size_t size, gfp_t flags)
700{
Alexey Dobriyand5f86652018-04-05 16:20:40 -0700701 unsigned int index;
Christoph Lameter2c59dd62013-01-10 19:14:19 +0000702
703 if (size <= 192) {
704 if (!size)
705 return ZERO_SIZE_PTR;
706
707 index = size_index[size_index_elem(size)];
Dmitry Vyukov61448472018-10-26 15:03:12 -0700708 } else {
Yangtao Li221d7da2018-12-28 00:33:01 -0800709 if (WARN_ON_ONCE(size > KMALLOC_MAX_CACHE_SIZE))
Dmitry Vyukov61448472018-10-26 15:03:12 -0700710 return NULL;
Christoph Lameter2c59dd62013-01-10 19:14:19 +0000711 index = fls(size - 1);
Dmitry Vyukov61448472018-10-26 15:03:12 -0700712 }
Christoph Lameter2c59dd62013-01-10 19:14:19 +0000713
Vlastimil Babkacc252ea2018-10-26 15:05:34 -0700714 return kmalloc_caches[kmalloc_type(flags)][index];
Christoph Lameter2c59dd62013-01-10 19:14:19 +0000715}
716
Pengfei Licb5d9fb2019-11-30 17:49:21 -0800717#ifdef CONFIG_ZONE_DMA
718#define INIT_KMALLOC_INFO(__size, __short_size) \
719{ \
720 .name[KMALLOC_NORMAL] = "kmalloc-" #__short_size, \
721 .name[KMALLOC_RECLAIM] = "kmalloc-rcl-" #__short_size, \
722 .name[KMALLOC_DMA] = "dma-kmalloc-" #__short_size, \
723 .size = __size, \
724}
725#else
726#define INIT_KMALLOC_INFO(__size, __short_size) \
727{ \
728 .name[KMALLOC_NORMAL] = "kmalloc-" #__short_size, \
729 .name[KMALLOC_RECLAIM] = "kmalloc-rcl-" #__short_size, \
730 .size = __size, \
731}
732#endif
733
Christoph Lameter2c59dd62013-01-10 19:14:19 +0000734/*
Gavin Guo4066c332015-06-24 16:55:54 -0700735 * kmalloc_info[] is to make slub_debug=,kmalloc-xx option work at boot time.
736 * kmalloc_index() supports up to 2^26=64MB, so the final entry of the table is
737 * kmalloc-67108864.
738 */
Vlastimil Babkaaf3b5f82017-02-22 15:41:05 -0800739const struct kmalloc_info_struct kmalloc_info[] __initconst = {
Pengfei Licb5d9fb2019-11-30 17:49:21 -0800740 INIT_KMALLOC_INFO(0, 0),
741 INIT_KMALLOC_INFO(96, 96),
742 INIT_KMALLOC_INFO(192, 192),
743 INIT_KMALLOC_INFO(8, 8),
744 INIT_KMALLOC_INFO(16, 16),
745 INIT_KMALLOC_INFO(32, 32),
746 INIT_KMALLOC_INFO(64, 64),
747 INIT_KMALLOC_INFO(128, 128),
748 INIT_KMALLOC_INFO(256, 256),
749 INIT_KMALLOC_INFO(512, 512),
750 INIT_KMALLOC_INFO(1024, 1k),
751 INIT_KMALLOC_INFO(2048, 2k),
752 INIT_KMALLOC_INFO(4096, 4k),
753 INIT_KMALLOC_INFO(8192, 8k),
754 INIT_KMALLOC_INFO(16384, 16k),
755 INIT_KMALLOC_INFO(32768, 32k),
756 INIT_KMALLOC_INFO(65536, 64k),
757 INIT_KMALLOC_INFO(131072, 128k),
758 INIT_KMALLOC_INFO(262144, 256k),
759 INIT_KMALLOC_INFO(524288, 512k),
760 INIT_KMALLOC_INFO(1048576, 1M),
761 INIT_KMALLOC_INFO(2097152, 2M),
762 INIT_KMALLOC_INFO(4194304, 4M),
763 INIT_KMALLOC_INFO(8388608, 8M),
764 INIT_KMALLOC_INFO(16777216, 16M),
765 INIT_KMALLOC_INFO(33554432, 32M),
766 INIT_KMALLOC_INFO(67108864, 64M)
Gavin Guo4066c332015-06-24 16:55:54 -0700767};
768
769/*
Daniel Sanders34cc6992015-06-24 16:55:57 -0700770 * Patch up the size_index table if we have strange large alignment
771 * requirements for the kmalloc array. This is only the case for
772 * MIPS it seems. The standard arches will not generate any code here.
773 *
774 * Largest permitted alignment is 256 bytes due to the way we
775 * handle the index determination for the smaller caches.
776 *
777 * Make sure that nothing crazy happens if someone starts tinkering
778 * around with ARCH_KMALLOC_MINALIGN
Christoph Lameterf97d5f62013-01-10 19:12:17 +0000779 */
Daniel Sanders34cc6992015-06-24 16:55:57 -0700780void __init setup_kmalloc_cache_index_table(void)
Christoph Lameterf97d5f62013-01-10 19:12:17 +0000781{
Alexey Dobriyanac914d02018-04-05 16:20:44 -0700782 unsigned int i;
Christoph Lameterf97d5f62013-01-10 19:12:17 +0000783
Christoph Lameter2c59dd62013-01-10 19:14:19 +0000784 BUILD_BUG_ON(KMALLOC_MIN_SIZE > 256 ||
785 (KMALLOC_MIN_SIZE & (KMALLOC_MIN_SIZE - 1)));
786
787 for (i = 8; i < KMALLOC_MIN_SIZE; i += 8) {
Alexey Dobriyanac914d02018-04-05 16:20:44 -0700788 unsigned int elem = size_index_elem(i);
Christoph Lameter2c59dd62013-01-10 19:14:19 +0000789
790 if (elem >= ARRAY_SIZE(size_index))
791 break;
792 size_index[elem] = KMALLOC_SHIFT_LOW;
793 }
794
795 if (KMALLOC_MIN_SIZE >= 64) {
796 /*
797 * The 96 byte size cache is not used if the alignment
798 * is 64 byte.
799 */
800 for (i = 64 + 8; i <= 96; i += 8)
801 size_index[size_index_elem(i)] = 7;
802
803 }
804
805 if (KMALLOC_MIN_SIZE >= 128) {
806 /*
807 * The 192 byte sized cache is not used if the alignment
808 * is 128 byte. Redirect kmalloc to use the 256 byte cache
809 * instead.
810 */
811 for (i = 128 + 8; i <= 192; i += 8)
812 size_index[size_index_elem(i)] = 8;
813 }
Daniel Sanders34cc6992015-06-24 16:55:57 -0700814}
815
Vlastimil Babka12915232018-10-26 15:05:38 -0700816static void __init
Pengfei Li13657d02019-11-30 17:49:28 -0800817new_kmalloc_cache(int idx, enum kmalloc_cache_type type, slab_flags_t flags)
Christoph Lametera9730fc2015-06-29 09:28:08 -0500818{
Pengfei Licb5d9fb2019-11-30 17:49:21 -0800819 if (type == KMALLOC_RECLAIM)
Vlastimil Babka12915232018-10-26 15:05:38 -0700820 flags |= SLAB_RECLAIM_ACCOUNT;
Vlastimil Babka12915232018-10-26 15:05:38 -0700821
Pengfei Licb5d9fb2019-11-30 17:49:21 -0800822 kmalloc_caches[type][idx] = create_kmalloc_cache(
823 kmalloc_info[idx].name[type],
David Windsor6c0c21a2017-06-10 22:50:47 -0400824 kmalloc_info[idx].size, flags, 0,
825 kmalloc_info[idx].size);
Christoph Lametera9730fc2015-06-29 09:28:08 -0500826}
827
Daniel Sanders34cc6992015-06-24 16:55:57 -0700828/*
829 * Create the kmalloc array. Some of the regular kmalloc arrays
830 * may already have been created because they were needed to
831 * enable allocations for slab creation.
832 */
Alexey Dobriyand50112e2017-11-15 17:32:18 -0800833void __init create_kmalloc_caches(slab_flags_t flags)
Daniel Sanders34cc6992015-06-24 16:55:57 -0700834{
Pengfei Li13657d02019-11-30 17:49:28 -0800835 int i;
836 enum kmalloc_cache_type type;
Daniel Sanders34cc6992015-06-24 16:55:57 -0700837
Vlastimil Babka12915232018-10-26 15:05:38 -0700838 for (type = KMALLOC_NORMAL; type <= KMALLOC_RECLAIM; type++) {
839 for (i = KMALLOC_SHIFT_LOW; i <= KMALLOC_SHIFT_HIGH; i++) {
840 if (!kmalloc_caches[type][i])
841 new_kmalloc_cache(i, type, flags);
Chris Mason956e46e2013-05-08 15:56:28 -0400842
Vlastimil Babka12915232018-10-26 15:05:38 -0700843 /*
844 * Caches that are not of the two-to-the-power-of size.
845 * These have to be created immediately after the
846 * earlier power of two caches
847 */
848 if (KMALLOC_MIN_SIZE <= 32 && i == 6 &&
849 !kmalloc_caches[type][1])
850 new_kmalloc_cache(1, type, flags);
851 if (KMALLOC_MIN_SIZE <= 64 && i == 7 &&
852 !kmalloc_caches[type][2])
853 new_kmalloc_cache(2, type, flags);
854 }
Christoph Lameter8a965b32013-05-03 18:04:18 +0000855 }
856
Christoph Lameterf97d5f62013-01-10 19:12:17 +0000857 /* Kmalloc array is now usable */
858 slab_state = UP;
859
Christoph Lameterf97d5f62013-01-10 19:12:17 +0000860#ifdef CONFIG_ZONE_DMA
861 for (i = 0; i <= KMALLOC_SHIFT_HIGH; i++) {
Vlastimil Babkacc252ea2018-10-26 15:05:34 -0700862 struct kmem_cache *s = kmalloc_caches[KMALLOC_NORMAL][i];
Christoph Lameterf97d5f62013-01-10 19:12:17 +0000863
864 if (s) {
Vlastimil Babkacc252ea2018-10-26 15:05:34 -0700865 kmalloc_caches[KMALLOC_DMA][i] = create_kmalloc_cache(
Pengfei Licb5d9fb2019-11-30 17:49:21 -0800866 kmalloc_info[i].name[KMALLOC_DMA],
Pengfei Lidc0a7f72019-11-30 17:49:25 -0800867 kmalloc_info[i].size,
Vlastimil Babka49f2d242020-06-01 21:45:43 -0700868 SLAB_CACHE_DMA | flags, 0,
869 kmalloc_info[i].size);
Christoph Lameterf97d5f62013-01-10 19:12:17 +0000870 }
871 }
872#endif
873}
Christoph Lameter45530c42012-11-28 16:23:07 +0000874#endif /* !CONFIG_SLOB */
875
Long Li44405092020-08-06 23:18:28 -0700876gfp_t kmalloc_fix_flags(gfp_t flags)
877{
878 gfp_t invalid_mask = flags & GFP_SLAB_BUG_MASK;
879
880 flags &= ~GFP_SLAB_BUG_MASK;
881 pr_warn("Unexpected gfp: %#x (%pGg). Fixing up to gfp: %#x (%pGg). Fix your code!\n",
882 invalid_mask, &invalid_mask, flags, &flags);
883 dump_stack();
884
885 return flags;
886}
887
Vladimir Davydovcea371f2014-06-04 16:07:04 -0700888/*
889 * To avoid unnecessary overhead, we pass through large allocation requests
890 * directly to the page allocator. We use __GFP_COMP, because we will need to
891 * know the allocation order to free the pages properly in kfree.
892 */
Vladimir Davydov52383432014-06-04 16:06:39 -0700893void *kmalloc_order(size_t size, gfp_t flags, unsigned int order)
894{
Vlastimil Babka6a486c02019-10-06 17:58:42 -0700895 void *ret = NULL;
Vladimir Davydov52383432014-06-04 16:06:39 -0700896 struct page *page;
897
Long Li44405092020-08-06 23:18:28 -0700898 if (unlikely(flags & GFP_SLAB_BUG_MASK))
899 flags = kmalloc_fix_flags(flags);
900
Vladimir Davydov52383432014-06-04 16:06:39 -0700901 flags |= __GFP_COMP;
Vladimir Davydov49491482016-07-26 15:24:24 -0700902 page = alloc_pages(flags, order);
Vlastimil Babka6a486c02019-10-06 17:58:42 -0700903 if (likely(page)) {
904 ret = page_address(page);
Muchun Song96403bf2021-02-24 12:04:26 -0800905 mod_lruvec_page_state(page, NR_SLAB_UNRECLAIMABLE_B,
906 PAGE_SIZE << order);
Vlastimil Babka6a486c02019-10-06 17:58:42 -0700907 }
Andrey Konovalov01165232018-12-28 00:29:37 -0800908 ret = kasan_kmalloc_large(ret, size, flags);
Andrey Konovalova2f77572019-02-20 22:19:16 -0800909 /* As ret might get tagged, call kmemleak hook after KASAN. */
Andrey Konovalov53128242019-02-20 22:19:11 -0800910 kmemleak_alloc(ret, size, 1, flags);
Vladimir Davydov52383432014-06-04 16:06:39 -0700911 return ret;
912}
913EXPORT_SYMBOL(kmalloc_order);
914
Christoph Lameterf1b6eb62013-09-04 16:35:34 +0000915#ifdef CONFIG_TRACING
916void *kmalloc_order_trace(size_t size, gfp_t flags, unsigned int order)
917{
918 void *ret = kmalloc_order(size, flags, order);
919 trace_kmalloc(_RET_IP_, ret, size, PAGE_SIZE << order, flags);
920 return ret;
921}
922EXPORT_SYMBOL(kmalloc_order_trace);
923#endif
Christoph Lameter45530c42012-11-28 16:23:07 +0000924
Thomas Garnier7c00fce2016-07-26 15:21:56 -0700925#ifdef CONFIG_SLAB_FREELIST_RANDOM
926/* Randomize a generic freelist */
927static void freelist_randomize(struct rnd_state *state, unsigned int *list,
Alexey Dobriyan302d55d2018-04-05 16:21:46 -0700928 unsigned int count)
Thomas Garnier7c00fce2016-07-26 15:21:56 -0700929{
Thomas Garnier7c00fce2016-07-26 15:21:56 -0700930 unsigned int rand;
Alexey Dobriyan302d55d2018-04-05 16:21:46 -0700931 unsigned int i;
Thomas Garnier7c00fce2016-07-26 15:21:56 -0700932
933 for (i = 0; i < count; i++)
934 list[i] = i;
935
936 /* Fisher-Yates shuffle */
937 for (i = count - 1; i > 0; i--) {
938 rand = prandom_u32_state(state);
939 rand %= (i + 1);
940 swap(list[i], list[rand]);
941 }
942}
943
944/* Create a random sequence per cache */
945int cache_random_seq_create(struct kmem_cache *cachep, unsigned int count,
946 gfp_t gfp)
947{
948 struct rnd_state state;
949
950 if (count < 2 || cachep->random_seq)
951 return 0;
952
953 cachep->random_seq = kcalloc(count, sizeof(unsigned int), gfp);
954 if (!cachep->random_seq)
955 return -ENOMEM;
956
957 /* Get best entropy at this stage of boot */
958 prandom_seed_state(&state, get_random_long());
959
960 freelist_randomize(&state, cachep->random_seq, count);
961 return 0;
962}
963
964/* Destroy the per-cache random freelist sequence */
965void cache_random_seq_destroy(struct kmem_cache *cachep)
966{
967 kfree(cachep->random_seq);
968 cachep->random_seq = NULL;
969}
970#endif /* CONFIG_SLAB_FREELIST_RANDOM */
971
Yang Shi5b365772017-11-15 17:32:03 -0800972#if defined(CONFIG_SLAB) || defined(CONFIG_SLUB_DEBUG)
Wanpeng Lie9b4db22013-07-04 08:33:24 +0800973#ifdef CONFIG_SLAB
Joe Perches0825a6f2018-06-14 15:27:58 -0700974#define SLABINFO_RIGHTS (0600)
Wanpeng Lie9b4db22013-07-04 08:33:24 +0800975#else
Joe Perches0825a6f2018-06-14 15:27:58 -0700976#define SLABINFO_RIGHTS (0400)
Wanpeng Lie9b4db22013-07-04 08:33:24 +0800977#endif
978
Vladimir Davydovb0475012014-12-10 15:44:19 -0800979static void print_slabinfo_header(struct seq_file *m)
Glauber Costabcee6e22012-10-19 18:20:26 +0400980{
981 /*
982 * Output format version, so at least we can change it
983 * without _too_ many complaints.
984 */
985#ifdef CONFIG_DEBUG_SLAB
986 seq_puts(m, "slabinfo - version: 2.1 (statistics)\n");
987#else
988 seq_puts(m, "slabinfo - version: 2.1\n");
989#endif
Joe Perches756a0252016-03-17 14:19:47 -0700990 seq_puts(m, "# name <active_objs> <num_objs> <objsize> <objperslab> <pagesperslab>");
Glauber Costabcee6e22012-10-19 18:20:26 +0400991 seq_puts(m, " : tunables <limit> <batchcount> <sharedfactor>");
992 seq_puts(m, " : slabdata <active_slabs> <num_slabs> <sharedavail>");
993#ifdef CONFIG_DEBUG_SLAB
Joe Perches756a0252016-03-17 14:19:47 -0700994 seq_puts(m, " : globalstat <listallocs> <maxobjs> <grown> <reaped> <error> <maxfreeable> <nodeallocs> <remotefrees> <alienoverflow>");
Glauber Costabcee6e22012-10-19 18:20:26 +0400995 seq_puts(m, " : cpustat <allochit> <allocmiss> <freehit> <freemiss>");
996#endif
997 seq_putc(m, '\n');
998}
999
Vladimir Davydov1df3b262014-12-10 15:42:16 -08001000void *slab_start(struct seq_file *m, loff_t *pos)
Glauber Costab7454ad2012-10-19 18:20:25 +04001001{
Glauber Costab7454ad2012-10-19 18:20:25 +04001002 mutex_lock(&slab_mutex);
Roman Gushchinc7094402020-08-06 23:21:20 -07001003 return seq_list_start(&slab_caches, *pos);
Glauber Costab7454ad2012-10-19 18:20:25 +04001004}
1005
Wanpeng Li276a2432013-07-08 08:08:28 +08001006void *slab_next(struct seq_file *m, void *p, loff_t *pos)
Glauber Costab7454ad2012-10-19 18:20:25 +04001007{
Roman Gushchinc7094402020-08-06 23:21:20 -07001008 return seq_list_next(p, &slab_caches, pos);
Glauber Costab7454ad2012-10-19 18:20:25 +04001009}
1010
Wanpeng Li276a2432013-07-08 08:08:28 +08001011void slab_stop(struct seq_file *m, void *p)
Glauber Costab7454ad2012-10-19 18:20:25 +04001012{
1013 mutex_unlock(&slab_mutex);
1014}
1015
Vladimir Davydovb0475012014-12-10 15:44:19 -08001016static void cache_show(struct kmem_cache *s, struct seq_file *m)
Glauber Costa749c5412012-12-18 14:23:01 -08001017{
Glauber Costa0d7561c2012-10-19 18:20:27 +04001018 struct slabinfo sinfo;
1019
1020 memset(&sinfo, 0, sizeof(sinfo));
1021 get_slabinfo(s, &sinfo);
1022
1023 seq_printf(m, "%-17s %6lu %6lu %6u %4u %4d",
Roman Gushchin10befea2020-08-06 23:21:27 -07001024 s->name, sinfo.active_objs, sinfo.num_objs, s->size,
Glauber Costa0d7561c2012-10-19 18:20:27 +04001025 sinfo.objects_per_slab, (1 << sinfo.cache_order));
1026
1027 seq_printf(m, " : tunables %4u %4u %4u",
1028 sinfo.limit, sinfo.batchcount, sinfo.shared);
1029 seq_printf(m, " : slabdata %6lu %6lu %6lu",
1030 sinfo.active_slabs, sinfo.num_slabs, sinfo.shared_avail);
1031 slabinfo_show_stats(m, s);
1032 seq_putc(m, '\n');
Glauber Costab7454ad2012-10-19 18:20:25 +04001033}
1034
Vladimir Davydov1df3b262014-12-10 15:42:16 -08001035static int slab_show(struct seq_file *m, void *p)
Glauber Costa749c5412012-12-18 14:23:01 -08001036{
Roman Gushchinc7094402020-08-06 23:21:20 -07001037 struct kmem_cache *s = list_entry(p, struct kmem_cache, list);
Glauber Costa749c5412012-12-18 14:23:01 -08001038
Roman Gushchinc7094402020-08-06 23:21:20 -07001039 if (p == slab_caches.next)
Vladimir Davydov1df3b262014-12-10 15:42:16 -08001040 print_slabinfo_header(m);
Roman Gushchin10befea2020-08-06 23:21:27 -07001041 cache_show(s, m);
Vladimir Davydovb0475012014-12-10 15:44:19 -08001042 return 0;
Glauber Costa749c5412012-12-18 14:23:01 -08001043}
1044
Yang Shi852d8be2017-11-15 17:32:07 -08001045void dump_unreclaimable_slab(void)
1046{
Hui Su77143042020-12-14 19:03:47 -08001047 struct kmem_cache *s;
Yang Shi852d8be2017-11-15 17:32:07 -08001048 struct slabinfo sinfo;
1049
1050 /*
1051 * Here acquiring slab_mutex is risky since we don't prefer to get
1052 * sleep in oom path. But, without mutex hold, it may introduce a
1053 * risk of crash.
1054 * Use mutex_trylock to protect the list traverse, dump nothing
1055 * without acquiring the mutex.
1056 */
1057 if (!mutex_trylock(&slab_mutex)) {
1058 pr_warn("excessive unreclaimable slab but cannot dump stats\n");
1059 return;
1060 }
1061
1062 pr_info("Unreclaimable slab info:\n");
1063 pr_info("Name Used Total\n");
1064
Hui Su77143042020-12-14 19:03:47 -08001065 list_for_each_entry(s, &slab_caches, list) {
Roman Gushchin10befea2020-08-06 23:21:27 -07001066 if (s->flags & SLAB_RECLAIM_ACCOUNT)
Yang Shi852d8be2017-11-15 17:32:07 -08001067 continue;
1068
1069 get_slabinfo(s, &sinfo);
1070
1071 if (sinfo.num_objs > 0)
Roman Gushchin10befea2020-08-06 23:21:27 -07001072 pr_info("%-17s %10luKB %10luKB\n", s->name,
Yang Shi852d8be2017-11-15 17:32:07 -08001073 (sinfo.active_objs * s->size) / 1024,
1074 (sinfo.num_objs * s->size) / 1024);
1075 }
1076 mutex_unlock(&slab_mutex);
1077}
1078
Yafang Shaoa87425a2020-04-01 21:06:30 -07001079#if defined(CONFIG_MEMCG_KMEM)
Tejun Heobc2791f2017-02-22 15:41:21 -08001080int memcg_slab_show(struct seq_file *m, void *p)
1081{
Roman Gushchin4330a262020-08-06 23:21:03 -07001082 /*
1083 * Deprecated.
1084 * Please, take a look at tools/cgroup/slabinfo.py .
1085 */
Vladimir Davydovb0475012014-12-10 15:44:19 -08001086 return 0;
1087}
1088#endif
1089
Glauber Costab7454ad2012-10-19 18:20:25 +04001090/*
1091 * slabinfo_op - iterator that generates /proc/slabinfo
1092 *
1093 * Output layout:
1094 * cache-name
1095 * num-active-objs
1096 * total-objs
1097 * object size
1098 * num-active-slabs
1099 * total-slabs
1100 * num-pages-per-slab
1101 * + further values on SMP and with statistics enabled
1102 */
1103static const struct seq_operations slabinfo_op = {
Vladimir Davydov1df3b262014-12-10 15:42:16 -08001104 .start = slab_start,
Wanpeng Li276a2432013-07-08 08:08:28 +08001105 .next = slab_next,
1106 .stop = slab_stop,
Vladimir Davydov1df3b262014-12-10 15:42:16 -08001107 .show = slab_show,
Glauber Costab7454ad2012-10-19 18:20:25 +04001108};
1109
1110static int slabinfo_open(struct inode *inode, struct file *file)
1111{
1112 return seq_open(file, &slabinfo_op);
1113}
1114
Alexey Dobriyan97a32532020-02-03 17:37:17 -08001115static const struct proc_ops slabinfo_proc_ops = {
Alexey Dobriyand919b332020-04-06 20:09:01 -07001116 .proc_flags = PROC_ENTRY_PERMANENT,
Alexey Dobriyan97a32532020-02-03 17:37:17 -08001117 .proc_open = slabinfo_open,
1118 .proc_read = seq_read,
1119 .proc_write = slabinfo_write,
1120 .proc_lseek = seq_lseek,
1121 .proc_release = seq_release,
Glauber Costab7454ad2012-10-19 18:20:25 +04001122};
1123
1124static int __init slab_proc_init(void)
1125{
Alexey Dobriyan97a32532020-02-03 17:37:17 -08001126 proc_create("slabinfo", SLABINFO_RIGHTS, NULL, &slabinfo_proc_ops);
Glauber Costab7454ad2012-10-19 18:20:25 +04001127 return 0;
1128}
1129module_init(slab_proc_init);
Waiman Longfcf8a1e2019-07-11 20:56:38 -07001130
Yang Shi5b365772017-11-15 17:32:03 -08001131#endif /* CONFIG_SLAB || CONFIG_SLUB_DEBUG */
Andrey Ryabinin928cec92014-08-06 16:04:44 -07001132
1133static __always_inline void *__do_krealloc(const void *p, size_t new_size,
1134 gfp_t flags)
1135{
1136 void *ret;
William Kucharskifa9ba3aa2020-08-06 23:18:17 -07001137 size_t ks;
Andrey Ryabinin928cec92014-08-06 16:04:44 -07001138
Andrey Konovalovd12d9ad2021-02-25 17:20:23 -08001139 /* Don't use instrumented ksize to allow precise KASAN poisoning. */
1140 if (likely(!ZERO_OR_NULL_PTR(p))) {
1141 if (!kasan_check_byte(p))
1142 return NULL;
1143 ks = kfence_ksize(p) ?: __ksize(p);
1144 } else
1145 ks = 0;
Andrey Konovalov26a5ca72021-02-25 17:20:19 -08001146
Andrey Konovalovd12d9ad2021-02-25 17:20:23 -08001147 /* If the object still fits, repoison it precisely. */
Andrey Ryabinin0316bec2015-02-13 14:39:42 -08001148 if (ks >= new_size) {
Andrey Konovalov01165232018-12-28 00:29:37 -08001149 p = kasan_krealloc((void *)p, new_size, flags);
Andrey Ryabinin928cec92014-08-06 16:04:44 -07001150 return (void *)p;
Andrey Ryabinin0316bec2015-02-13 14:39:42 -08001151 }
Andrey Ryabinin928cec92014-08-06 16:04:44 -07001152
1153 ret = kmalloc_track_caller(new_size, flags);
Andrey Konovalovd12d9ad2021-02-25 17:20:23 -08001154 if (ret && p) {
1155 /* Disable KASAN checks as the object's redzone is accessed. */
1156 kasan_disable_current();
1157 memcpy(ret, kasan_reset_tag(p), ks);
1158 kasan_enable_current();
1159 }
Andrey Ryabinin928cec92014-08-06 16:04:44 -07001160
1161 return ret;
1162}
1163
1164/**
Andrey Ryabinin928cec92014-08-06 16:04:44 -07001165 * krealloc - reallocate memory. The contents will remain unchanged.
1166 * @p: object to reallocate memory for.
1167 * @new_size: how many bytes of memory are required.
1168 * @flags: the type of memory to allocate.
1169 *
1170 * The contents of the object pointed to are preserved up to the
Bartosz Golaszewski15d5de42020-12-14 19:03:50 -08001171 * lesser of the new and old sizes (__GFP_ZERO flag is effectively ignored).
1172 * If @p is %NULL, krealloc() behaves exactly like kmalloc(). If @new_size
1173 * is 0 and @p is not a %NULL pointer, the object pointed to is freed.
Mike Rapoporta862f682019-03-05 15:48:42 -08001174 *
1175 * Return: pointer to the allocated memory or %NULL in case of error
Andrey Ryabinin928cec92014-08-06 16:04:44 -07001176 */
1177void *krealloc(const void *p, size_t new_size, gfp_t flags)
1178{
1179 void *ret;
1180
1181 if (unlikely(!new_size)) {
1182 kfree(p);
1183 return ZERO_SIZE_PTR;
1184 }
1185
1186 ret = __do_krealloc(p, new_size, flags);
Andrey Konovalov772a2fa2018-12-28 00:30:35 -08001187 if (ret && kasan_reset_tag(p) != kasan_reset_tag(ret))
Andrey Ryabinin928cec92014-08-06 16:04:44 -07001188 kfree(p);
1189
1190 return ret;
1191}
1192EXPORT_SYMBOL(krealloc);
1193
1194/**
Waiman Long453431a2020-08-06 23:18:13 -07001195 * kfree_sensitive - Clear sensitive information in memory before freeing
Andrey Ryabinin928cec92014-08-06 16:04:44 -07001196 * @p: object to free memory of
1197 *
1198 * The memory of the object @p points to is zeroed before freed.
Waiman Long453431a2020-08-06 23:18:13 -07001199 * If @p is %NULL, kfree_sensitive() does nothing.
Andrey Ryabinin928cec92014-08-06 16:04:44 -07001200 *
1201 * Note: this function zeroes the whole allocated buffer which can be a good
1202 * deal bigger than the requested buffer size passed to kmalloc(). So be
1203 * careful when using this function in performance sensitive code.
1204 */
Waiman Long453431a2020-08-06 23:18:13 -07001205void kfree_sensitive(const void *p)
Andrey Ryabinin928cec92014-08-06 16:04:44 -07001206{
1207 size_t ks;
1208 void *mem = (void *)p;
1209
Andrey Ryabinin928cec92014-08-06 16:04:44 -07001210 ks = ksize(mem);
William Kucharskifa9ba3aa2020-08-06 23:18:17 -07001211 if (ks)
1212 memzero_explicit(mem, ks);
Andrey Ryabinin928cec92014-08-06 16:04:44 -07001213 kfree(mem);
1214}
Waiman Long453431a2020-08-06 23:18:13 -07001215EXPORT_SYMBOL(kfree_sensitive);
Andrey Ryabinin928cec92014-08-06 16:04:44 -07001216
Marco Elver10d1f8c2019-07-11 20:54:14 -07001217/**
1218 * ksize - get the actual amount of memory allocated for a given object
1219 * @objp: Pointer to the object
1220 *
1221 * kmalloc may internally round up allocations and return more memory
1222 * than requested. ksize() can be used to determine the actual amount of
1223 * memory allocated. The caller may use this additional memory, even though
1224 * a smaller amount of memory was initially specified with the kmalloc call.
1225 * The caller must guarantee that objp points to a valid object previously
1226 * allocated with either kmalloc() or kmem_cache_alloc(). The object
1227 * must not be freed during the duration of the call.
1228 *
1229 * Return: size of the actual memory used by @objp in bytes
1230 */
1231size_t ksize(const void *objp)
1232{
Marco Elver0d4ca4c2019-07-11 20:54:18 -07001233 size_t size;
1234
Marco Elver0d4ca4c2019-07-11 20:54:18 -07001235 /*
Andrey Konovalov611806b2021-02-24 12:05:50 -08001236 * We need to first check that the pointer to the object is valid, and
1237 * only then unpoison the memory. The report printed from ksize() is
1238 * more useful, then when it's printed later when the behaviour could
1239 * be undefined due to a potential use-after-free or double-free.
Marco Elver0d4ca4c2019-07-11 20:54:18 -07001240 *
Andrey Konovalov611806b2021-02-24 12:05:50 -08001241 * We use kasan_check_byte(), which is supported for the hardware
1242 * tag-based KASAN mode, unlike kasan_check_read/write().
1243 *
1244 * If the pointed to memory is invalid, we return 0 to avoid users of
Marco Elver0d4ca4c2019-07-11 20:54:18 -07001245 * ksize() writing to and potentially corrupting the memory region.
1246 *
1247 * We want to perform the check before __ksize(), to avoid potentially
1248 * crashing in __ksize() due to accessing invalid metadata.
1249 */
Andrey Konovalov611806b2021-02-24 12:05:50 -08001250 if (unlikely(ZERO_OR_NULL_PTR(objp)) || !kasan_check_byte(objp))
Marco Elver0d4ca4c2019-07-11 20:54:18 -07001251 return 0;
1252
Alexander Potapenkod3fb45f2021-02-25 17:19:11 -08001253 size = kfence_ksize(objp) ?: __ksize(objp);
Marco Elver10d1f8c2019-07-11 20:54:14 -07001254 /*
1255 * We assume that ksize callers could use whole allocated area,
1256 * so we need to unpoison this area.
1257 */
Andrey Konovalovcebd0eb2020-12-22 12:00:21 -08001258 kasan_unpoison_range(objp, size);
Marco Elver10d1f8c2019-07-11 20:54:14 -07001259 return size;
1260}
1261EXPORT_SYMBOL(ksize);
1262
Andrey Ryabinin928cec92014-08-06 16:04:44 -07001263/* Tracepoints definitions. */
1264EXPORT_TRACEPOINT_SYMBOL(kmalloc);
1265EXPORT_TRACEPOINT_SYMBOL(kmem_cache_alloc);
1266EXPORT_TRACEPOINT_SYMBOL(kmalloc_node);
1267EXPORT_TRACEPOINT_SYMBOL(kmem_cache_alloc_node);
1268EXPORT_TRACEPOINT_SYMBOL(kfree);
1269EXPORT_TRACEPOINT_SYMBOL(kmem_cache_free);
Howard McLauchlan4f6923fb2018-04-05 16:23:57 -07001270
1271int should_failslab(struct kmem_cache *s, gfp_t gfpflags)
1272{
1273 if (__should_failslab(s, gfpflags))
1274 return -ENOMEM;
1275 return 0;
1276}
1277ALLOW_ERROR_INJECTION(should_failslab, ERRNO);