mm/slab_common.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   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>
  13 #include <linux/cache.h>
  14 #include <linux/compiler.h>
  15 #include <linux/module.h>
  16 #include <linux/cpu.h>
  17 #include <linux/uaccess.h>
  18 #include <linux/seq_file.h>
  19 #include <linux/proc_fs.h>
  20 #include <linux/debugfs.h>
  21 #include <linux/kasan.h>
  22 #include <asm/cacheflush.h>
  23 #include <asm/tlbflush.h>
  24 #include <asm/page.h>
  25 #include <linux/memcontrol.h>
  26
  27 #define CREATE_TRACE_POINTS
  28 #include <trace/events/kmem.h>
  29
  30 #include "internal.h"
  31
  32 #include "slab.h"
  33
  34 enum slab_state slab_state;
  35 LIST_HEAD(slab_caches);
  36 DEFINE_MUTEX(slab_mutex);
  37 struct kmem_cache *kmem_cache;
  38
  39 #ifdef CONFIG_HARDENED_USERCOPY
  40 bool usercopy_fallback __ro_after_init =
  41                 IS_ENABLED(CONFIG_HARDENED_USERCOPY_FALLBACK);
  42 module_param(usercopy_fallback, bool, 0400);
  43 MODULE_PARM_DESC(usercopy_fallback,
  44                 "WARN instead of reject usercopy whitelist violations");
  45 #endif
  46
  47 static LIST_HEAD(slab_caches_to_rcu_destroy);
  48 static void slab_caches_to_rcu_destroy_workfn(struct work_struct *work);
  49 static DECLARE_WORK(slab_caches_to_rcu_destroy_work,
  50                     slab_caches_to_rcu_destroy_workfn);
  51
  52 /*
  53  * Set of flags that will prevent slab merging
  54  */
  55 #define SLAB_NEVER_MERGE (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER | \
  56                 SLAB_TRACE | SLAB_TYPESAFE_BY_RCU | SLAB_NOLEAKTRACE | \
  57                 SLAB_FAILSLAB | kasan_never_merge())
  58
  59 #define SLAB_MERGE_SAME (SLAB_RECLAIM_ACCOUNT | SLAB_CACHE_DMA | \
  60                          SLAB_CACHE_DMA32 | SLAB_ACCOUNT)
  61
  62 /*
  63  * Merge control. If this is set then no merging of slab caches will occur.
  64  */
  65 static bool slab_nomerge = !IS_ENABLED(CONFIG_SLAB_MERGE_DEFAULT);
  66
  67 static int __init setup_slab_nomerge(char *str)
  68 {
  69         slab_nomerge = true;
  70         return 1;
  71 }
  72
  73 #ifdef CONFIG_SLUB
  74 __setup_param("slub_nomerge", slub_nomerge, setup_slab_nomerge, 0);
  75 #endif
  76
  77 __setup("slab_nomerge", setup_slab_nomerge);
  78
  79 /*
  80  * Determine the size of a slab object
  81  */
  82 unsigned int kmem_cache_size(struct kmem_cache *s)
  83 {
  84         return s->object_size;
  85 }
  86 EXPORT_SYMBOL(kmem_cache_size);
  87
  88 #ifdef CONFIG_DEBUG_VM
  89 static int kmem_cache_sanity_check(const char *name, unsigned int size)
  90 {
  91         if (!name || in_interrupt() || size < sizeof(void *) ||
  92                 size > KMALLOC_MAX_SIZE) {
  93                 pr_err("kmem_cache_create(%s) integrity check failed\n", name);
  94                 return -EINVAL;
  95         }
  96
  97         WARN_ON(strchr(name, ' '));     /* It confuses parsers */
  98         return 0;
  99 }
 100 #else
 101 static inline int kmem_cache_sanity_check(const char *name, unsigned int size)
 102 {
 103         return 0;
 104 }
 105 #endif
 106
 107 void __kmem_cache_free_bulk(struct kmem_cache *s, size_t nr, void **p)
 108 {
 109         size_t i;
 110
 111         for (i = 0; i < nr; i++) {
 112                 if (s)
 113                         kmem_cache_free(s, p[i]);
 114                 else
 115                         kfree(p[i]);
 116         }
 117 }
 118
 119 int __kmem_cache_alloc_bulk(struct kmem_cache *s, gfp_t flags, size_t nr,
 120                                                                 void **p)
 121 {
 122         size_t i;
 123
 124         for (i = 0; i < nr; i++) {
 125                 void *x = p[i] = kmem_cache_alloc(s, flags);
 126                 if (!x) {
 127                         __kmem_cache_free_bulk(s, i, p);
 128                         return 0;
 129                 }
 130         }
 131         return i;
 132 }
 133
 134 /*
 135  * Figure out what the alignment of the objects will be given a set of
 136  * flags, a user specified alignment and the size of the objects.
 137  */
 138 static unsigned int calculate_alignment(slab_flags_t flags,
 139                 unsigned int align, unsigned int size)
 140 {
 141         /*
 142          * If the user wants hardware cache aligned objects then follow that
 143          * suggestion if the object is sufficiently large.
 144          *
 145          * The hardware cache alignment cannot override the specified
 146          * alignment though. If that is greater then use it.
 147          */
 148         if (flags & SLAB_HWCACHE_ALIGN) {
 149                 unsigned int ralign;
 150
 151                 ralign = cache_line_size();
 152                 while (size <= ralign / 2)
 153                         ralign /= 2;
 154                 align = max(align, ralign);
 155         }
 156
 157         if (align < ARCH_SLAB_MINALIGN)
 158                 align = ARCH_SLAB_MINALIGN;
 159
 160         return ALIGN(align, sizeof(void *));
 161 }
 162
 163 /*
 164  * Find a mergeable slab cache
 165  */
 166 int slab_unmergeable(struct kmem_cache *s)
 167 {
 168         if (slab_nomerge || (s->flags & SLAB_NEVER_MERGE))
 169                 return 1;
 170
 171         if (s->ctor)
 172                 return 1;
 173
 174         if (s->usersize)
 175                 return 1;
 176
 177         /*
 178          * We may have set a slab to be unmergeable during bootstrap.
 179          */
 180         if (s->refcount < 0)
 181                 return 1;
 182
 183         return 0;
 184 }
 185
 186 struct kmem_cache *find_mergeable(unsigned int size, unsigned int align,
 187                 slab_flags_t flags, const char *name, void (*ctor)(void *))
 188 {
 189         struct kmem_cache *s;
 190
 191         if (slab_nomerge)
 192                 return NULL;
 193
 194         if (ctor)
 195                 return NULL;
 196
 197         size = ALIGN(size, sizeof(void *));
 198         align = calculate_alignment(flags, align, size);
 199         size = ALIGN(size, align);
 200         flags = kmem_cache_flags(size, flags, name);
 201
 202         if (flags & SLAB_NEVER_MERGE)
 203                 return NULL;
 204
 205         list_for_each_entry_reverse(s, &slab_caches, list) {
 206                 if (slab_unmergeable(s))
 207                         continue;
 208
 209                 if (size > s->size)
 210                         continue;
 211
 212                 if ((flags & SLAB_MERGE_SAME) != (s->flags & SLAB_MERGE_SAME))
 213                         continue;
 214                 /*
 215                  * Check if alignment is compatible.
 216                  * Courtesy of Adrian Drzewiecki
 217                  */
 218                 if ((s->size & ~(align - 1)) != s->size)
 219                         continue;
 220
 221                 if (s->size - size >= sizeof(void *))
 222                         continue;
 223
 224                 if (IS_ENABLED(CONFIG_SLAB) && align &&
 225                         (align > s->align || s->align % align))
 226                         continue;
 227
 228                 return s;
 229         }
 230         return NULL;
 231 }
 232
 233 static struct kmem_cache *create_cache(const char *name,
 234                 unsigned int object_size, unsigned int align,
 235                 slab_flags_t flags, unsigned int useroffset,
 236                 unsigned int usersize, void (*ctor)(void *),
 237                 struct kmem_cache *root_cache)
 238 {
 239         struct kmem_cache *s;
 240         int err;
 241
 242         if (WARN_ON(useroffset + usersize > object_size))
 243                 useroffset = usersize = 0;
 244
 245         err = -ENOMEM;
 246         s = kmem_cache_zalloc(kmem_cache, GFP_KERNEL);
 247         if (!s)
 248                 goto out;
 249
 250         s->name = name;
 251         s->size = s->object_size = object_size;
 252         s->align = align;
 253         s->ctor = ctor;
 254         s->useroffset = useroffset;
 255         s->usersize = usersize;
 256
 257         err = __kmem_cache_create(s, flags);
 258         if (err)
 259                 goto out_free_cache;
 260
 261         s->refcount = 1;
 262         list_add(&s->list, &slab_caches);
 263 out:
 264         if (err)
 265                 return ERR_PTR(err);
 266         return s;
 267
 268 out_free_cache:
 269         kmem_cache_free(kmem_cache, s);
 270         goto out;
 271 }
 272
 273 /**
 274  * kmem_cache_create_usercopy - Create a cache with a region suitable
 275  * for copying to userspace
 276  * @name: A string which is used in /proc/slabinfo to identify this cache.
 277  * @size: The size of objects to be created in this cache.
 278  * @align: The required alignment for the objects.
 279  * @flags: SLAB flags
 280  * @useroffset: Usercopy region offset
 281  * @usersize: Usercopy region size
 282  * @ctor: A constructor for the objects.
 283  *
 284  * Cannot be called within a interrupt, but can be interrupted.
 285  * The @ctor is run when new pages are allocated by the cache.
 286  *
 287  * The flags are
 288  *
 289  * %SLAB_POISON - Poison the slab with a known test pattern (a5a5a5a5)
 290  * to catch references to uninitialised memory.
 291  *
 292  * %SLAB_RED_ZONE - Insert `Red` zones around the allocated memory to check
 293  * for buffer overruns.
 294  *
 295  * %SLAB_HWCACHE_ALIGN - Align the objects in this cache to a hardware
 296  * cacheline.  This can be beneficial if you're counting cycles as closely
 297  * as davem.
 298  *
 299  * Return: a pointer to the cache on success, NULL on failure.
 300  */
 301 struct kmem_cache *
 302 kmem_cache_create_usercopy(const char *name,
 303                   unsigned int size, unsigned int align,
 304                   slab_flags_t flags,
 305                   unsigned int useroffset, unsigned int usersize,
 306                   void (*ctor)(void *))
 307 {
 308         struct kmem_cache *s = NULL;
 309         const char *cache_name;
 310         int err;
 311
 312         mutex_lock(&slab_mutex);
 313
 314         err = kmem_cache_sanity_check(name, size);
 315         if (err) {
 316                 goto out_unlock;
 317         }
 318
 319         /* Refuse requests with allocator specific flags */
 320         if (flags & ~SLAB_FLAGS_PERMITTED) {
 321                 err = -EINVAL;
 322                 goto out_unlock;
 323         }
 324
 325         /*
 326          * Some allocators will constraint the set of valid flags to a subset
 327          * of all flags. We expect them to define CACHE_CREATE_MASK in this
 328          * case, and we'll just provide them with a sanitized version of the
 329          * passed flags.
 330          */
 331         flags &= CACHE_CREATE_MASK;
 332
 333         /* Fail closed on bad usersize of useroffset values. */
 334         if (WARN_ON(!usersize && useroffset) ||
 335             WARN_ON(size < usersize || size - usersize < useroffset))
 336                 usersize = useroffset = 0;
 337
 338         if (!usersize)
 339                 s = __kmem_cache_alias(name, size, align, flags, ctor);
 340         if (s)
 341                 goto out_unlock;
 342
 343         cache_name = kstrdup_const(name, GFP_KERNEL);
 344         if (!cache_name) {
 345                 err = -ENOMEM;
 346                 goto out_unlock;
 347         }
 348
 349         s = create_cache(cache_name, size,
 350                          calculate_alignment(flags, align, size),
 351                          flags, useroffset, usersize, ctor, NULL);
 352         if (IS_ERR(s)) {
 353                 err = PTR_ERR(s);
 354                 kfree_const(cache_name);
 355         }
 356
 357 out_unlock:
 358         mutex_unlock(&slab_mutex);
 359
 360         if (err) {
 361                 if (flags & SLAB_PANIC)
 362                         panic("kmem_cache_create: Failed to create slab '%s'. Error %d\n",
 363                                 name, err);
 364                 else {
 365                         pr_warn("kmem_cache_create(%s) failed with error %d\n",
 366                                 name, err);
 367                         dump_stack();
 368                 }
 369                 return NULL;
 370         }
 371         return s;
 372 }
 373 EXPORT_SYMBOL(kmem_cache_create_usercopy);
 374
 375 /**
 376  * kmem_cache_create - Create a cache.
 377  * @name: A string which is used in /proc/slabinfo to identify this cache.
 378  * @size: The size of objects to be created in this cache.
 379  * @align: The required alignment for the objects.
 380  * @flags: SLAB flags
 381  * @ctor: A constructor for the objects.
 382  *
 383  * Cannot be called within a interrupt, but can be interrupted.
 384  * The @ctor is run when new pages are allocated by the cache.
 385  *
 386  * The flags are
 387  *
 388  * %SLAB_POISON - Poison the slab with a known test pattern (a5a5a5a5)
 389  * to catch references to uninitialised memory.
 390  *
 391  * %SLAB_RED_ZONE - Insert `Red` zones around the allocated memory to check
 392  * for buffer overruns.
 393  *
 394  * %SLAB_HWCACHE_ALIGN - Align the objects in this cache to a hardware
 395  * cacheline.  This can be beneficial if you're counting cycles as closely
 396  * as davem.
 397  *
 398  * Return: a pointer to the cache on success, NULL on failure.
 399  */
 400 struct kmem_cache *
 401 kmem_cache_create(const char *name, unsigned int size, unsigned int align,
 402                 slab_flags_t flags, void (*ctor)(void *))
 403 {
 404         return kmem_cache_create_usercopy(name, size, align, flags, 0, 0,
 405                                           ctor);
 406 }
 407 EXPORT_SYMBOL(kmem_cache_create);
 408
 409 static void slab_caches_to_rcu_destroy_workfn(struct work_struct *work)
 410 {
 411         LIST_HEAD(to_destroy);
 412         struct kmem_cache *s, *s2;
 413
 414         /*
 415          * On destruction, SLAB_TYPESAFE_BY_RCU kmem_caches are put on the
 416          * @slab_caches_to_rcu_destroy list.  The slab pages are freed
 417          * through RCU and the associated kmem_cache are dereferenced
 418          * while freeing the pages, so the kmem_caches should be freed only
 419          * after the pending RCU operations are finished.  As rcu_barrier()
 420          * is a pretty slow operation, we batch all pending destructions
 421          * asynchronously.
 422          */
 423         mutex_lock(&slab_mutex);
 424         list_splice_init(&slab_caches_to_rcu_destroy, &to_destroy);
 425         mutex_unlock(&slab_mutex);
 426
 427         if (list_empty(&to_destroy))
 428                 return;
 429
 430         rcu_barrier();
 431
 432         list_for_each_entry_safe(s, s2, &to_destroy, list) {
 433 #ifdef SLAB_SUPPORTS_SYSFS
 434                 sysfs_slab_release(s);
 435 #else
 436                 slab_kmem_cache_release(s);
 437 #endif
 438         }
 439 }
 440
 441 static int shutdown_cache(struct kmem_cache *s)
 442 {
 443         /* free asan quarantined objects */
 444         kasan_cache_shutdown(s);
 445
 446         if (__kmem_cache_shutdown(s) != 0)
 447                 return -EBUSY;
 448
 449         list_del(&s->list);
 450
 451         if (s->flags & SLAB_TYPESAFE_BY_RCU) {
 452 #ifdef SLAB_SUPPORTS_SYSFS
 453                 sysfs_slab_unlink(s);
 454 #endif
 455                 list_add_tail(&s->list, &slab_caches_to_rcu_destroy);
 456                 schedule_work(&slab_caches_to_rcu_destroy_work);
 457         } else {
 458 #ifdef SLAB_SUPPORTS_SYSFS
 459                 sysfs_slab_unlink(s);
 460                 sysfs_slab_release(s);
 461 #else
 462                 slab_kmem_cache_release(s);
 463 #endif
 464         }
 465
 466         return 0;
 467 }
 468
 469 void slab_kmem_cache_release(struct kmem_cache *s)
 470 {
 471         __kmem_cache_release(s);
 472         kfree_const(s->name);
 473         kmem_cache_free(kmem_cache, s);
 474 }
 475
 476 void kmem_cache_destroy(struct kmem_cache *s)
 477 {
 478         int err;
 479
 480         if (unlikely(!s))
 481                 return;
 482
 483         mutex_lock(&slab_mutex);
 484
 485         s->refcount--;
 486         if (s->refcount)
 487                 goto out_unlock;
 488
 489         err = shutdown_cache(s);
 490         if (err) {
 491                 pr_err("kmem_cache_destroy %s: Slab cache still has objects\n",
 492                        s->name);
 493                 dump_stack();
 494         }
 495 out_unlock:
 496         mutex_unlock(&slab_mutex);
 497 }
 498 EXPORT_SYMBOL(kmem_cache_destroy);
 499
 500 /**
 501  * kmem_cache_shrink - Shrink a cache.
 502  * @cachep: The cache to shrink.
 503  *
 504  * Releases as many slabs as possible for a cache.
 505  * To help debugging, a zero exit status indicates all slabs were released.
 506  *
 507  * Return: %0 if all slabs were released, non-zero otherwise
 508  */
 509 int kmem_cache_shrink(struct kmem_cache *cachep)
 510 {
 511         int ret;
 512
 513
 514         kasan_cache_shrink(cachep);
 515         ret = __kmem_cache_shrink(cachep);
 516
 517         return ret;
 518 }
 519 EXPORT_SYMBOL(kmem_cache_shrink);
 520
 521 bool slab_is_available(void)
 522 {
 523         return slab_state >= UP;
 524 }
 525
 526 /**
 527  * kmem_valid_obj - does the pointer reference a valid slab object?
 528  * @object: pointer to query.
 529  *
 530  * Return: %true if the pointer is to a not-yet-freed object from
 531  * kmalloc() or kmem_cache_alloc(), either %true or %false if the pointer
 532  * is to an already-freed object, and %false otherwise.
 533  */
 534 bool kmem_valid_obj(void *object)
 535 {
 536         struct page *page;
 537
 538         /* Some arches consider ZERO_SIZE_PTR to be a valid address. */
 539         if (object < (void *)PAGE_SIZE || !virt_addr_valid(object))
 540                 return false;
 541         page = virt_to_head_page(object);
 542         return PageSlab(page);
 543 }
 544
 545 /**
 546  * kmem_dump_obj - Print available slab provenance information
 547  * @object: slab object for which to find provenance information.
 548  *
 549  * This function uses pr_cont(), so that the caller is expected to have
 550  * printed out whatever preamble is appropriate.  The provenance information
 551  * depends on the type of object and on how much debugging is enabled.
 552  * For a slab-cache object, the fact that it is a slab object is printed,
 553  * and, if available, the slab name, return address, and stack trace from
 554  * the allocation of that object.
 555  *
 556  * This function will splat if passed a pointer to a non-slab object.
 557  * If you are not sure what type of object you have, you should instead
 558  * use mem_dump_obj().
 559  */
 560 void kmem_dump_obj(void *object)
 561 {
 562         char *cp = IS_ENABLED(CONFIG_MMU) ? "" : "/vmalloc";
 563         int i;
 564         struct page *page;
 565         unsigned long ptroffset;
 566         struct kmem_obj_info kp = { };
 567
 568         if (WARN_ON_ONCE(!virt_addr_valid(object)))
 569                 return;
 570         page = virt_to_head_page(object);
 571         if (WARN_ON_ONCE(!PageSlab(page))) {
 572                 pr_cont(" non-slab memory.\n");
 573                 return;
 574         }
 575         kmem_obj_info(&kp, object, page);
 576         if (kp.kp_slab_cache)
 577                 pr_cont(" slab%s %s", cp, kp.kp_slab_cache->name);
 578         else
 579                 pr_cont(" slab%s", cp);
 580         if (kp.kp_objp)
 581                 pr_cont(" start %px", kp.kp_objp);
 582         if (kp.kp_data_offset)
 583                 pr_cont(" data offset %lu", kp.kp_data_offset);
 584         if (kp.kp_objp) {
 585                 ptroffset = ((char *)object - (char *)kp.kp_objp) - kp.kp_data_offset;
 586                 pr_cont(" pointer offset %lu", ptroffset);
 587         }
 588         if (kp.kp_slab_cache && kp.kp_slab_cache->usersize)
 589                 pr_cont(" size %u", kp.kp_slab_cache->usersize);
 590         if (kp.kp_ret)
 591                 pr_cont(" allocated at %pS\n", kp.kp_ret);
 592         else
 593                 pr_cont("\n");
 594         for (i = 0; i < ARRAY_SIZE(kp.kp_stack); i++) {
 595                 if (!kp.kp_stack[i])
 596                         break;
 597                 pr_info("    %pS\n", kp.kp_stack[i]);
 598         }
 599 }
 600
 601 #ifndef CONFIG_SLOB
 602 /* Create a cache during boot when no slab services are available yet */
 603 void __init create_boot_cache(struct kmem_cache *s, const char *name,
 604                 unsigned int size, slab_flags_t flags,
 605                 unsigned int useroffset, unsigned int usersize)
 606 {
 607         int err;
 608         unsigned int align = ARCH_KMALLOC_MINALIGN;
 609
 610         s->name = name;
 611         s->size = s->object_size = size;
 612
 613         /*
 614          * For power of two sizes, guarantee natural alignment for kmalloc
 615          * caches, regardless of SL*B debugging options.
 616          */
 617         if (is_power_of_2(size))
 618                 align = max(align, size);
 619         s->align = calculate_alignment(flags, align, size);
 620
 621         s->useroffset = useroffset;
 622         s->usersize = usersize;
 623
 624         err = __kmem_cache_create(s, flags);
 625
 626         if (err)
 627                 panic("Creation of kmalloc slab %s size=%u failed. Reason %d\n",
 628                                         name, size, err);
 629
 630         s->refcount = -1;       /* Exempt from merging for now */
 631 }
 632
 633 struct kmem_cache *__init create_kmalloc_cache(const char *name,
 634                 unsigned int size, slab_flags_t flags,
 635                 unsigned int useroffset, unsigned int usersize)
 636 {
 637         struct kmem_cache *s = kmem_cache_zalloc(kmem_cache, GFP_NOWAIT);
 638
 639         if (!s)
 640                 panic("Out of memory when creating slab %s\n", name);
 641
 642         create_boot_cache(s, name, size, flags, useroffset, usersize);
 643         list_add(&s->list, &slab_caches);
 644         s->refcount = 1;
 645         return s;
 646 }
 647
 648 struct kmem_cache *
 649 kmalloc_caches[NR_KMALLOC_TYPES][KMALLOC_SHIFT_HIGH + 1] __ro_after_init =
 650 { /* initialization for https://bugs.llvm.org/show_bug.cgi?id=42570 */ };
 651 EXPORT_SYMBOL(kmalloc_caches);
 652
 653 /*
 654  * Conversion table for small slabs sizes / 8 to the index in the
 655  * kmalloc array. This is necessary for slabs < 192 since we have non power
 656  * of two cache sizes there. The size of larger slabs can be determined using
 657  * fls.
 658  */
 659 static u8 size_index[24] __ro_after_init = {
 660         3,      /* 8 */
 661         4,      /* 16 */
 662         5,      /* 24 */
 663         5,      /* 32 */
 664         6,      /* 40 */
 665         6,      /* 48 */
 666         6,      /* 56 */
 667         6,      /* 64 */
 668         1,      /* 72 */
 669         1,      /* 80 */
 670         1,      /* 88 */
 671         1,      /* 96 */
 672         7,      /* 104 */
 673         7,      /* 112 */
 674         7,      /* 120 */
 675         7,      /* 128 */
 676         2,      /* 136 */
 677         2,      /* 144 */
 678         2,      /* 152 */
 679         2,      /* 160 */
 680         2,      /* 168 */
 681         2,      /* 176 */
 682         2,      /* 184 */
 683         2       /* 192 */
 684 };
 685
 686 static inline unsigned int size_index_elem(unsigned int bytes)
 687 {
 688         return (bytes - 1) / 8;
 689 }
 690
 691 /*
 692  * Find the kmem_cache structure that serves a given size of
 693  * allocation
 694  */
 695 struct kmem_cache *kmalloc_slab(size_t size, gfp_t flags)
 696 {
 697         unsigned int index;
 698
 699         if (size <= 192) {
 700                 if (!size)
 701                         return ZERO_SIZE_PTR;
 702
 703                 index = size_index[size_index_elem(size)];
 704         } else {
 705                 if (WARN_ON_ONCE(size > KMALLOC_MAX_CACHE_SIZE))
 706                         return NULL;
 707                 index = fls(size - 1);
 708         }
 709
 710         return kmalloc_caches[kmalloc_type(flags)][index];
 711 }
 712
 713 #ifdef CONFIG_ZONE_DMA
 714 #define INIT_KMALLOC_INFO(__size, __short_size)                 \
 715 {                                                               \
 716         .name[KMALLOC_NORMAL]  = "kmalloc-" #__short_size,      \
 717         .name[KMALLOC_RECLAIM] = "kmalloc-rcl-" #__short_size,  \
 718         .name[KMALLOC_DMA]     = "dma-kmalloc-" #__short_size,  \
 719         .size = __size,                                         \
 720 }
 721 #else
 722 #define INIT_KMALLOC_INFO(__size, __short_size)                 \
 723 {                                                               \
 724         .name[KMALLOC_NORMAL]  = "kmalloc-" #__short_size,      \
 725         .name[KMALLOC_RECLAIM] = "kmalloc-rcl-" #__short_size,  \
 726         .size = __size,                                         \
 727 }
 728 #endif
 729
 730 /*
 731  * kmalloc_info[] is to make slub_debug=,kmalloc-xx option work at boot time.
 732  * kmalloc_index() supports up to 2^26=64MB, so the final entry of the table is
 733  * kmalloc-67108864.
 734  */
 735 const struct kmalloc_info_struct kmalloc_info[] __initconst = {
 736         INIT_KMALLOC_INFO(0, 0),
 737         INIT_KMALLOC_INFO(96, 96),
 738         INIT_KMALLOC_INFO(192, 192),
 739         INIT_KMALLOC_INFO(8, 8),
 740         INIT_KMALLOC_INFO(16, 16),
 741         INIT_KMALLOC_INFO(32, 32),
 742         INIT_KMALLOC_INFO(64, 64),
 743         INIT_KMALLOC_INFO(128, 128),
 744         INIT_KMALLOC_INFO(256, 256),
 745         INIT_KMALLOC_INFO(512, 512),
 746         INIT_KMALLOC_INFO(1024, 1k),
 747         INIT_KMALLOC_INFO(2048, 2k),
 748         INIT_KMALLOC_INFO(4096, 4k),
 749         INIT_KMALLOC_INFO(8192, 8k),
 750         INIT_KMALLOC_INFO(16384, 16k),
 751         INIT_KMALLOC_INFO(32768, 32k),
 752         INIT_KMALLOC_INFO(65536, 64k),
 753         INIT_KMALLOC_INFO(131072, 128k),
 754         INIT_KMALLOC_INFO(262144, 256k),
 755         INIT_KMALLOC_INFO(524288, 512k),
 756         INIT_KMALLOC_INFO(1048576, 1M),
 757         INIT_KMALLOC_INFO(2097152, 2M),
 758         INIT_KMALLOC_INFO(4194304, 4M),
 759         INIT_KMALLOC_INFO(8388608, 8M),
 760         INIT_KMALLOC_INFO(16777216, 16M),
 761         INIT_KMALLOC_INFO(33554432, 32M),
 762         INIT_KMALLOC_INFO(67108864, 64M)
 763 };
 764
 765 /*
 766  * Patch up the size_index table if we have strange large alignment
 767  * requirements for the kmalloc array. This is only the case for
 768  * MIPS it seems. The standard arches will not generate any code here.
 769  *
 770  * Largest permitted alignment is 256 bytes due to the way we
 771  * handle the index determination for the smaller caches.
 772  *
 773  * Make sure that nothing crazy happens if someone starts tinkering
 774  * around with ARCH_KMALLOC_MINALIGN
 775  */
 776 void __init setup_kmalloc_cache_index_table(void)
 777 {
 778         unsigned int i;
 779
 780         BUILD_BUG_ON(KMALLOC_MIN_SIZE > 256 ||
 781                 (KMALLOC_MIN_SIZE & (KMALLOC_MIN_SIZE - 1)));
 782
 783         for (i = 8; i < KMALLOC_MIN_SIZE; i += 8) {
 784                 unsigned int elem = size_index_elem(i);
 785
 786                 if (elem >= ARRAY_SIZE(size_index))
 787                         break;
 788                 size_index[elem] = KMALLOC_SHIFT_LOW;
 789         }
 790
 791         if (KMALLOC_MIN_SIZE >= 64) {
 792                 /*
 793                  * The 96 byte size cache is not used if the alignment
 794                  * is 64 byte.
 795                  */
 796                 for (i = 64 + 8; i <= 96; i += 8)
 797                         size_index[size_index_elem(i)] = 7;
 798
 799         }
 800
 801         if (KMALLOC_MIN_SIZE >= 128) {
 802                 /*
 803                  * The 192 byte sized cache is not used if the alignment
 804                  * is 128 byte. Redirect kmalloc to use the 256 byte cache
 805                  * instead.
 806                  */
 807                 for (i = 128 + 8; i <= 192; i += 8)
 808                         size_index[size_index_elem(i)] = 8;
 809         }
 810 }
 811
 812 static void __init
 813 new_kmalloc_cache(int idx, enum kmalloc_cache_type type, slab_flags_t flags)
 814 {
 815         if (type == KMALLOC_RECLAIM)
 816                 flags |= SLAB_RECLAIM_ACCOUNT;
 817
 818         kmalloc_caches[type][idx] = create_kmalloc_cache(
 819                                         kmalloc_info[idx].name[type],
 820                                         kmalloc_info[idx].size, flags, 0,
 821                                         kmalloc_info[idx].size);
 822 }
 823
 824 /*
 825  * Create the kmalloc array. Some of the regular kmalloc arrays
 826  * may already have been created because they were needed to
 827  * enable allocations for slab creation.
 828  */
 829 void __init create_kmalloc_caches(slab_flags_t flags)
 830 {
 831         int i;
 832         enum kmalloc_cache_type type;
 833
 834         for (type = KMALLOC_NORMAL; type <= KMALLOC_RECLAIM; type++) {
 835                 for (i = KMALLOC_SHIFT_LOW; i <= KMALLOC_SHIFT_HIGH; i++) {
 836                         if (!kmalloc_caches[type][i])
 837                                 new_kmalloc_cache(i, type, flags);
 838
 839                         /*
 840                          * Caches that are not of the two-to-the-power-of size.
 841                          * These have to be created immediately after the
 842                          * earlier power of two caches
 843                          */
 844                         if (KMALLOC_MIN_SIZE <= 32 && i == 6 &&
 845                                         !kmalloc_caches[type][1])
 846                                 new_kmalloc_cache(1, type, flags);
 847                         if (KMALLOC_MIN_SIZE <= 64 && i == 7 &&
 848                                         !kmalloc_caches[type][2])
 849                                 new_kmalloc_cache(2, type, flags);
 850                 }
 851         }
 852
 853         /* Kmalloc array is now usable */
 854         slab_state = UP;
 855
 856 #ifdef CONFIG_ZONE_DMA
 857         for (i = 0; i <= KMALLOC_SHIFT_HIGH; i++) {
 858                 struct kmem_cache *s = kmalloc_caches[KMALLOC_NORMAL][i];
 859
 860                 if (s) {
 861                         kmalloc_caches[KMALLOC_DMA][i] = create_kmalloc_cache(
 862                                 kmalloc_info[i].name[KMALLOC_DMA],
 863                                 kmalloc_info[i].size,
 864                                 SLAB_CACHE_DMA | flags, 0,
 865                                 kmalloc_info[i].size);
 866                 }
 867         }
 868 #endif
 869 }
 870 #endif /* !CONFIG_SLOB */
 871
 872 gfp_t kmalloc_fix_flags(gfp_t flags)
 873 {
 874         gfp_t invalid_mask = flags & GFP_SLAB_BUG_MASK;
 875
 876         flags &= ~GFP_SLAB_BUG_MASK;
 877         pr_warn("Unexpected gfp: %#x (%pGg). Fixing up to gfp: %#x (%pGg). Fix your code!\n",
 878                         invalid_mask, &invalid_mask, flags, &flags);
 879         dump_stack();
 880
 881         return flags;
 882 }
 883
 884 /*
 885  * To avoid unnecessary overhead, we pass through large allocation requests
 886  * directly to the page allocator. We use __GFP_COMP, because we will need to
 887  * know the allocation order to free the pages properly in kfree.
 888  */
 889 void *kmalloc_order(size_t size, gfp_t flags, unsigned int order)
 890 {
 891         void *ret = NULL;
 892         struct page *page;
 893
 894         if (unlikely(flags & GFP_SLAB_BUG_MASK))
 895                 flags = kmalloc_fix_flags(flags);
 896
 897         flags |= __GFP_COMP;
 898         page = alloc_pages(flags, order);
 899         if (likely(page)) {
 900                 ret = page_address(page);
 901                 mod_lruvec_page_state(page, NR_SLAB_UNRECLAIMABLE_B,
 902                                       PAGE_SIZE << order);
 903         }
 904         ret = kasan_kmalloc_large(ret, size, flags);
 905         /* As ret might get tagged, call kmemleak hook after KASAN. */
 906         kmemleak_alloc(ret, size, 1, flags);
 907         return ret;
 908 }
 909 EXPORT_SYMBOL(kmalloc_order);
 910
 911 #ifdef CONFIG_TRACING
 912 void *kmalloc_order_trace(size_t size, gfp_t flags, unsigned int order)
 913 {
 914         void *ret = kmalloc_order(size, flags, order);
 915         trace_kmalloc(_RET_IP_, ret, size, PAGE_SIZE << order, flags);
 916         return ret;
 917 }
 918 EXPORT_SYMBOL(kmalloc_order_trace);
 919 #endif
 920
 921 #ifdef CONFIG_SLAB_FREELIST_RANDOM
 922 /* Randomize a generic freelist */
 923 static void freelist_randomize(struct rnd_state *state, unsigned int *list,
 924                                unsigned int count)
 925 {
 926         unsigned int rand;
 927         unsigned int i;
 928
 929         for (i = 0; i < count; i++)
 930                 list[i] = i;
 931
 932         /* Fisher-Yates shuffle */
 933         for (i = count - 1; i > 0; i--) {
 934                 rand = prandom_u32_state(state);
 935                 rand %= (i + 1);
 936                 swap(list[i], list[rand]);
 937         }
 938 }
 939
 940 /* Create a random sequence per cache */
 941 int cache_random_seq_create(struct kmem_cache *cachep, unsigned int count,
 942                                     gfp_t gfp)
 943 {
 944         struct rnd_state state;
 945
 946         if (count < 2 || cachep->random_seq)
 947                 return 0;
 948
 949         cachep->random_seq = kcalloc(count, sizeof(unsigned int), gfp);
 950         if (!cachep->random_seq)
 951                 return -ENOMEM;
 952
 953         /* Get best entropy at this stage of boot */
 954         prandom_seed_state(&state, get_random_long());
 955
 956         freelist_randomize(&state, cachep->random_seq, count);
 957         return 0;
 958 }
 959
 960 /* Destroy the per-cache random freelist sequence */
 961 void cache_random_seq_destroy(struct kmem_cache *cachep)
 962 {
 963         kfree(cachep->random_seq);
 964         cachep->random_seq = NULL;
 965 }
 966 #endif /* CONFIG_SLAB_FREELIST_RANDOM */
 967
 968 #if defined(CONFIG_SLAB) || defined(CONFIG_SLUB_DEBUG)
 969 #ifdef CONFIG_SLAB
 970 #define SLABINFO_RIGHTS (0600)
 971 #else
 972 #define SLABINFO_RIGHTS (0400)
 973 #endif
 974
 975 static void print_slabinfo_header(struct seq_file *m)
 976 {
 977         /*
 978          * Output format version, so at least we can change it
 979          * without _too_ many complaints.
 980          */
 981 #ifdef CONFIG_DEBUG_SLAB
 982         seq_puts(m, "slabinfo - version: 2.1 (statistics)\n");
 983 #else
 984         seq_puts(m, "slabinfo - version: 2.1\n");
 985 #endif
 986         seq_puts(m, "# name            <active_objs> <num_objs> <objsize> <objperslab> <pagesperslab>");
 987         seq_puts(m, " : tunables <limit> <batchcount> <sharedfactor>");
 988         seq_puts(m, " : slabdata <active_slabs> <num_slabs> <sharedavail>");
 989 #ifdef CONFIG_DEBUG_SLAB
 990         seq_puts(m, " : globalstat <listallocs> <maxobjs> <grown> <reaped> <error> <maxfreeable> <nodeallocs> <remotefrees> <alienoverflow>");
 991         seq_puts(m, " : cpustat <allochit> <allocmiss> <freehit> <freemiss>");
 992 #endif
 993         seq_putc(m, '\n');
 994 }
 995
 996 void *slab_start(struct seq_file *m, loff_t *pos)
 997 {
 998         mutex_lock(&slab_mutex);
 999         return seq_list_start(&slab_caches, *pos);
1000 }
1001
1002 void *slab_next(struct seq_file *m, void *p, loff_t *pos)
1003 {
1004         return seq_list_next(p, &slab_caches, pos);
1005 }
1006
1007 void slab_stop(struct seq_file *m, void *p)
1008 {
1009         mutex_unlock(&slab_mutex);
1010 }
1011
1012 static void cache_show(struct kmem_cache *s, struct seq_file *m)
1013 {
1014         struct slabinfo sinfo;
1015
1016         memset(&sinfo, 0, sizeof(sinfo));
1017         get_slabinfo(s, &sinfo);
1018
1019         seq_printf(m, "%-17s %6lu %6lu %6u %4u %4d",
1020                    s->name, sinfo.active_objs, sinfo.num_objs, s->size,
1021                    sinfo.objects_per_slab, (1 << sinfo.cache_order));
1022
1023         seq_printf(m, " : tunables %4u %4u %4u",
1024                    sinfo.limit, sinfo.batchcount, sinfo.shared);
1025         seq_printf(m, " : slabdata %6lu %6lu %6lu",
1026                    sinfo.active_slabs, sinfo.num_slabs, sinfo.shared_avail);
1027         slabinfo_show_stats(m, s);
1028         seq_putc(m, '\n');
1029 }
1030
1031 static int slab_show(struct seq_file *m, void *p)
1032 {
1033         struct kmem_cache *s = list_entry(p, struct kmem_cache, list);
1034
1035         if (p == slab_caches.next)
1036                 print_slabinfo_header(m);
1037         cache_show(s, m);
1038         return 0;
1039 }
1040
1041 void dump_unreclaimable_slab(void)
1042 {
1043         struct kmem_cache *s;
1044         struct slabinfo sinfo;
1045
1046         /*
1047          * Here acquiring slab_mutex is risky since we don't prefer to get
1048          * sleep in oom path. But, without mutex hold, it may introduce a
1049          * risk of crash.
1050          * Use mutex_trylock to protect the list traverse, dump nothing
1051          * without acquiring the mutex.
1052          */
1053         if (!mutex_trylock(&slab_mutex)) {
1054                 pr_warn("excessive unreclaimable slab but cannot dump stats\n");
1055                 return;
1056         }
1057
1058         pr_info("Unreclaimable slab info:\n");
1059         pr_info("Name                      Used          Total\n");
1060
1061         list_for_each_entry(s, &slab_caches, list) {
1062                 if (s->flags & SLAB_RECLAIM_ACCOUNT)
1063                         continue;
1064
1065                 get_slabinfo(s, &sinfo);
1066
1067                 if (sinfo.num_objs > 0)
1068                         pr_info("%-17s %10luKB %10luKB\n", s->name,
1069                                 (sinfo.active_objs * s->size) / 1024,
1070                                 (sinfo.num_objs * s->size) / 1024);
1071         }
1072         mutex_unlock(&slab_mutex);
1073 }
1074
1075 #if defined(CONFIG_MEMCG_KMEM)
1076 int memcg_slab_show(struct seq_file *m, void *p)
1077 {
1078         /*
1079          * Deprecated.
1080          * Please, take a look at tools/cgroup/slabinfo.py .
1081          */
1082         return 0;
1083 }
1084 #endif
1085
1086 /*
1087  * slabinfo_op - iterator that generates /proc/slabinfo
1088  *
1089  * Output layout:
1090  * cache-name
1091  * num-active-objs
1092  * total-objs
1093  * object size
1094  * num-active-slabs
1095  * total-slabs
1096  * num-pages-per-slab
1097  * + further values on SMP and with statistics enabled
1098  */
1099 static const struct seq_operations slabinfo_op = {
1100         .start = slab_start,
1101         .next = slab_next,
1102         .stop = slab_stop,
1103         .show = slab_show,
1104 };
1105
1106 static int slabinfo_open(struct inode *inode, struct file *file)
1107 {
1108         return seq_open(file, &slabinfo_op);
1109 }
1110
1111 static const struct proc_ops slabinfo_proc_ops = {
1112         .proc_flags     = PROC_ENTRY_PERMANENT,
1113         .proc_open      = slabinfo_open,
1114         .proc_read      = seq_read,
1115         .proc_write     = slabinfo_write,
1116         .proc_lseek     = seq_lseek,
1117         .proc_release   = seq_release,
1118 };
1119
1120 static int __init slab_proc_init(void)
1121 {
1122         proc_create("slabinfo", SLABINFO_RIGHTS, NULL, &slabinfo_proc_ops);
1123         return 0;
1124 }
1125 module_init(slab_proc_init);
1126
1127 #endif /* CONFIG_SLAB || CONFIG_SLUB_DEBUG */
1128
1129 static __always_inline void *__do_krealloc(const void *p, size_t new_size,
1130                                            gfp_t flags)
1131 {
1132         void *ret;
1133         size_t ks;
1134
1135         ks = ksize(p);
1136
1137         if (ks >= new_size) {
1138                 p = kasan_krealloc((void *)p, new_size, flags);
1139                 return (void *)p;
1140         }
1141
1142         ret = kmalloc_track_caller(new_size, flags);
1143         if (ret && p)
1144                 memcpy(ret, p, ks);
1145
1146         return ret;
1147 }
1148
1149 /**
1150  * krealloc - reallocate memory. The contents will remain unchanged.
1151  * @p: object to reallocate memory for.
1152  * @new_size: how many bytes of memory are required.
1153  * @flags: the type of memory to allocate.
1154  *
1155  * The contents of the object pointed to are preserved up to the
1156  * lesser of the new and old sizes (__GFP_ZERO flag is effectively ignored).
1157  * If @p is %NULL, krealloc() behaves exactly like kmalloc().  If @new_size
1158  * is 0 and @p is not a %NULL pointer, the object pointed to is freed.
1159  *
1160  * Return: pointer to the allocated memory or %NULL in case of error
1161  */
1162 void *krealloc(const void *p, size_t new_size, gfp_t flags)
1163 {
1164         void *ret;
1165
1166         if (unlikely(!new_size)) {
1167                 kfree(p);
1168                 return ZERO_SIZE_PTR;
1169         }
1170
1171         ret = __do_krealloc(p, new_size, flags);
1172         if (ret && kasan_reset_tag(p) != kasan_reset_tag(ret))
1173                 kfree(p);
1174
1175         return ret;
1176 }
1177 EXPORT_SYMBOL(krealloc);
1178
1179 /**
1180  * kfree_sensitive - Clear sensitive information in memory before freeing
1181  * @p: object to free memory of
1182  *
1183  * The memory of the object @p points to is zeroed before freed.
1184  * If @p is %NULL, kfree_sensitive() does nothing.
1185  *
1186  * Note: this function zeroes the whole allocated buffer which can be a good
1187  * deal bigger than the requested buffer size passed to kmalloc(). So be
1188  * careful when using this function in performance sensitive code.
1189  */
1190 void kfree_sensitive(const void *p)
1191 {
1192         size_t ks;
1193         void *mem = (void *)p;
1194
1195         ks = ksize(mem);
1196         if (ks)
1197                 memzero_explicit(mem, ks);
1198         kfree(mem);
1199 }
1200 EXPORT_SYMBOL(kfree_sensitive);
1201
1202 /**
1203  * ksize - get the actual amount of memory allocated for a given object
1204  * @objp: Pointer to the object
1205  *
1206  * kmalloc may internally round up allocations and return more memory
1207  * than requested. ksize() can be used to determine the actual amount of
1208  * memory allocated. The caller may use this additional memory, even though
1209  * a smaller amount of memory was initially specified with the kmalloc call.
1210  * The caller must guarantee that objp points to a valid object previously
1211  * allocated with either kmalloc() or kmem_cache_alloc(). The object
1212  * must not be freed during the duration of the call.
1213  *
1214  * Return: size of the actual memory used by @objp in bytes
1215  */
1216 size_t ksize(const void *objp)
1217 {
1218         size_t size;
1219
1220         /*
1221          * We need to first check that the pointer to the object is valid, and
1222          * only then unpoison the memory. The report printed from ksize() is
1223          * more useful, then when it's printed later when the behaviour could
1224          * be undefined due to a potential use-after-free or double-free.
1225          *
1226          * We use kasan_check_byte(), which is supported for the hardware
1227          * tag-based KASAN mode, unlike kasan_check_read/write().
1228          *
1229          * If the pointed to memory is invalid, we return 0 to avoid users of
1230          * ksize() writing to and potentially corrupting the memory region.
1231          *
1232          * We want to perform the check before __ksize(), to avoid potentially
1233          * crashing in __ksize() due to accessing invalid metadata.
1234          */
1235         if (unlikely(ZERO_OR_NULL_PTR(objp)) || !kasan_check_byte(objp))
1236                 return 0;
1237
1238         size = __ksize(objp);
1239         /*
1240          * We assume that ksize callers could use whole allocated area,
1241          * so we need to unpoison this area.
1242          */
1243         kasan_unpoison_range(objp, size);
1244         return size;
1245 }
1246 EXPORT_SYMBOL(ksize);
1247
1248 /* Tracepoints definitions. */
1249 EXPORT_TRACEPOINT_SYMBOL(kmalloc);
1250 EXPORT_TRACEPOINT_SYMBOL(kmem_cache_alloc);
1251 EXPORT_TRACEPOINT_SYMBOL(kmalloc_node);
1252 EXPORT_TRACEPOINT_SYMBOL(kmem_cache_alloc_node);
1253 EXPORT_TRACEPOINT_SYMBOL(kfree);
1254 EXPORT_TRACEPOINT_SYMBOL(kmem_cache_free);
1255
1256 int should_failslab(struct kmem_cache *s, gfp_t gfpflags)
1257 {
1258         if (__should_failslab(s, gfpflags))
1259                 return -ENOMEM;
1260         return 0;
1261 }
1262 ALLOW_ERROR_INJECTION(should_failslab, ERRNO);