mm/slab_common.c

   1 /*
   2  * Slab allocator functions that are independent of the allocator strategy
   3  *
   4  * (C) 2012 Christoph Lameter <cl@linux.com>
   5  */
   6 #include <linux/slab.h>
   7
   8 #include <linux/mm.h>
   9 #include <linux/poison.h>
  10 #include <linux/interrupt.h>
  11 #include <linux/memory.h>
  12 #include <linux/compiler.h>
  13 #include <linux/module.h>
  14 #include <linux/cpu.h>
  15 #include <linux/uaccess.h>
  16 #include <linux/seq_file.h>
  17 #include <linux/proc_fs.h>
  18 #include <asm/cacheflush.h>
  19 #include <asm/tlbflush.h>
  20 #include <asm/page.h>
  21 #include <linux/memcontrol.h>
  22 #include <trace/events/kmem.h>
  23
  24 #include "slab.h"
  25
  26 enum slab_state slab_state;
  27 LIST_HEAD(slab_caches);
  28 DEFINE_MUTEX(slab_mutex);
  29 struct kmem_cache *kmem_cache;
  30
  31 #ifdef CONFIG_DEBUG_VM
  32 static int kmem_cache_sanity_check(struct mem_cgroup *memcg, const char *name,
  33                                    size_t size)
  34 {
  35         struct kmem_cache *s = NULL;
  36
  37         if (!name || in_interrupt() || size < sizeof(void *) ||
  38                 size > KMALLOC_MAX_SIZE) {
  39                 pr_err("kmem_cache_create(%s) integrity check failed\n", name);
  40                 return -EINVAL;
  41         }
  42
  43         list_for_each_entry(s, &slab_caches, list) {
  44                 char tmp;
  45                 int res;
  46
  47                 /*
  48                  * This happens when the module gets unloaded and doesn't
  49                  * destroy its slab cache and no-one else reuses the vmalloc
  50                  * area of the module.  Print a warning.
  51                  */
  52                 res = probe_kernel_address(s->name, tmp);
  53                 if (res) {
  54                         pr_err("Slab cache with size %d has lost its name\n",
  55                                s->object_size);
  56                         continue;
  57                 }
  58
  59 #if !defined(CONFIG_SLUB) || !defined(CONFIG_SLUB_DEBUG_ON)
  60                 /*
  61                  * For simplicity, we won't check this in the list of memcg
  62                  * caches. We have control over memcg naming, and if there
  63                  * aren't duplicates in the global list, there won't be any
  64                  * duplicates in the memcg lists as well.
  65                  */
  66                 if (!memcg && !strcmp(s->name, name)) {
  67                         pr_err("%s (%s): Cache name already exists.\n",
  68                                __func__, name);
  69                         dump_stack();
  70                         s = NULL;
  71                         return -EINVAL;
  72                 }
  73 #endif
  74         }
  75
  76         WARN_ON(strchr(name, ' '));     /* It confuses parsers */
  77         return 0;
  78 }
  79 #else
  80 static inline int kmem_cache_sanity_check(struct mem_cgroup *memcg,
  81                                           const char *name, size_t size)
  82 {
  83         return 0;
  84 }
  85 #endif
  86
  87 #ifdef CONFIG_MEMCG_KMEM
  88 int memcg_update_all_caches(int num_memcgs)
  89 {
  90         struct kmem_cache *s;
  91         int ret = 0;
  92         mutex_lock(&slab_mutex);
  93
  94         list_for_each_entry(s, &slab_caches, list) {
  95                 if (!is_root_cache(s))
  96                         continue;
  97
  98                 ret = memcg_update_cache_size(s, num_memcgs);
  99                 /*
 100                  * See comment in memcontrol.c, memcg_update_cache_size:
 101                  * Instead of freeing the memory, we'll just leave the caches
 102                  * up to this point in an updated state.
 103                  */
 104                 if (ret)
 105                         goto out;
 106         }
 107
 108         memcg_update_array_size(num_memcgs);
 109 out:
 110         mutex_unlock(&slab_mutex);
 111         return ret;
 112 }
 113 #endif
 114
 115 /*
 116  * Figure out what the alignment of the objects will be given a set of
 117  * flags, a user specified alignment and the size of the objects.
 118  */
 119 unsigned long calculate_alignment(unsigned long flags,
 120                 unsigned long align, unsigned long size)
 121 {
 122         /*
 123          * If the user wants hardware cache aligned objects then follow that
 124          * suggestion if the object is sufficiently large.
 125          *
 126          * The hardware cache alignment cannot override the specified
 127          * alignment though. If that is greater then use it.
 128          */
 129         if (flags & SLAB_HWCACHE_ALIGN) {
 130                 unsigned long ralign = cache_line_size();
 131                 while (size <= ralign / 2)
 132                         ralign /= 2;
 133                 align = max(align, ralign);
 134         }
 135
 136         if (align < ARCH_SLAB_MINALIGN)
 137                 align = ARCH_SLAB_MINALIGN;
 138
 139         return ALIGN(align, sizeof(void *));
 140 }
 141
 142
 143 /*
 144  * kmem_cache_create - Create a cache.
 145  * @name: A string which is used in /proc/slabinfo to identify this cache.
 146  * @size: The size of objects to be created in this cache.
 147  * @align: The required alignment for the objects.
 148  * @flags: SLAB flags
 149  * @ctor: A constructor for the objects.
 150  *
 151  * Returns a ptr to the cache on success, NULL on failure.
 152  * Cannot be called within a interrupt, but can be interrupted.
 153  * The @ctor is run when new pages are allocated by the cache.
 154  *
 155  * The flags are
 156  *
 157  * %SLAB_POISON - Poison the slab with a known test pattern (a5a5a5a5)
 158  * to catch references to uninitialised memory.
 159  *
 160  * %SLAB_RED_ZONE - Insert `Red' zones around the allocated memory to check
 161  * for buffer overruns.
 162  *
 163  * %SLAB_HWCACHE_ALIGN - Align the objects in this cache to a hardware
 164  * cacheline.  This can be beneficial if you're counting cycles as closely
 165  * as davem.
 166  */
 167
 168 struct kmem_cache *
 169 kmem_cache_create_memcg(struct mem_cgroup *memcg, const char *name, size_t size,
 170                         size_t align, unsigned long flags, void (*ctor)(void *),
 171                         struct kmem_cache *parent_cache)
 172 {
 173         struct kmem_cache *s = NULL;
 174         int err;
 175
 176         get_online_cpus();
 177         mutex_lock(&slab_mutex);
 178
 179         err = kmem_cache_sanity_check(memcg, name, size);
 180         if (err)
 181                 goto out_unlock;
 182
 183         if (memcg) {
 184                 /*
 185                  * Since per-memcg caches are created asynchronously on first
 186                  * allocation (see memcg_kmem_get_cache()), several threads can
 187                  * try to create the same cache, but only one of them may
 188                  * succeed. Therefore if we get here and see the cache has
 189                  * already been created, we silently return NULL.
 190                  */
 191                 if (cache_from_memcg_idx(parent_cache, memcg_cache_id(memcg)))
 192                         goto out_unlock;
 193         }
 194
 195         /*
 196          * Some allocators will constraint the set of valid flags to a subset
 197          * of all flags. We expect them to define CACHE_CREATE_MASK in this
 198          * case, and we'll just provide them with a sanitized version of the
 199          * passed flags.
 200          */
 201         flags &= CACHE_CREATE_MASK;
 202
 203         if (!memcg) {
 204                 s = __kmem_cache_alias(name, size, align, flags, ctor);
 205                 if (s)
 206                         goto out_unlock;
 207         }
 208
 209         err = -ENOMEM;
 210         s = kmem_cache_zalloc(kmem_cache, GFP_KERNEL);
 211         if (!s)
 212                 goto out_unlock;
 213
 214         s->object_size = s->size = size;
 215         s->align = calculate_alignment(flags, align, size);
 216         s->ctor = ctor;
 217
 218         s->name = kstrdup(name, GFP_KERNEL);
 219         if (!s->name)
 220                 goto out_free_cache;
 221
 222         err = memcg_alloc_cache_params(memcg, s, parent_cache);
 223         if (err)
 224                 goto out_free_cache;
 225
 226         err = __kmem_cache_create(s, flags);
 227         if (err)
 228                 goto out_free_cache;
 229
 230         s->refcount = 1;
 231         list_add(&s->list, &slab_caches);
 232         memcg_register_cache(s);
 233
 234 out_unlock:
 235         mutex_unlock(&slab_mutex);
 236         put_online_cpus();
 237
 238         if (err) {
 239                 /*
 240                  * There is no point in flooding logs with warnings or
 241                  * especially crashing the system if we fail to create a cache
 242                  * for a memcg. In this case we will be accounting the memcg
 243                  * allocation to the root cgroup until we succeed to create its
 244                  * own cache, but it isn't that critical.
 245                  */
 246                 if (!memcg)
 247                         return NULL;
 248
 249                 if (flags & SLAB_PANIC)
 250                         panic("kmem_cache_create: Failed to create slab '%s'. Error %d\n",
 251                                 name, err);
 252                 else {
 253                         printk(KERN_WARNING "kmem_cache_create(%s) failed with error %d",
 254                                 name, err);
 255                         dump_stack();
 256                 }
 257                 return NULL;
 258         }
 259         return s;
 260
 261 out_free_cache:
 262         memcg_free_cache_params(s);
 263         kfree(s->name);
 264         kmem_cache_free(kmem_cache, s);
 265         goto out_unlock;
 266 }
 267
 268 struct kmem_cache *
 269 kmem_cache_create(const char *name, size_t size, size_t align,
 270                   unsigned long flags, void (*ctor)(void *))
 271 {
 272         return kmem_cache_create_memcg(NULL, name, size, align, flags, ctor, NULL);
 273 }
 274 EXPORT_SYMBOL(kmem_cache_create);
 275
 276 void kmem_cache_destroy(struct kmem_cache *s)
 277 {
 278         /* Destroy all the children caches if we aren't a memcg cache */
 279         kmem_cache_destroy_memcg_children(s);
 280
 281         get_online_cpus();
 282         mutex_lock(&slab_mutex);
 283         s->refcount--;
 284         if (!s->refcount) {
 285                 list_del(&s->list);
 286
 287                 if (!__kmem_cache_shutdown(s)) {
 288                         memcg_unregister_cache(s);
 289                         mutex_unlock(&slab_mutex);
 290                         if (s->flags & SLAB_DESTROY_BY_RCU)
 291                                 rcu_barrier();
 292
 293                         memcg_free_cache_params(s);
 294                         kfree(s->name);
 295                         kmem_cache_free(kmem_cache, s);
 296                 } else {
 297                         list_add(&s->list, &slab_caches);
 298                         mutex_unlock(&slab_mutex);
 299                         printk(KERN_ERR "kmem_cache_destroy %s: Slab cache still has objects\n",
 300                                 s->name);
 301                         dump_stack();
 302                 }
 303         } else {
 304                 mutex_unlock(&slab_mutex);
 305         }
 306         put_online_cpus();
 307 }
 308 EXPORT_SYMBOL(kmem_cache_destroy);
 309
 310 int slab_is_available(void)
 311 {
 312         return slab_state >= UP;
 313 }
 314
 315 #ifndef CONFIG_SLOB
 316 /* Create a cache during boot when no slab services are available yet */
 317 void __init create_boot_cache(struct kmem_cache *s, const char *name, size_t size,
 318                 unsigned long flags)
 319 {
 320         int err;
 321
 322         s->name = name;
 323         s->size = s->object_size = size;
 324         s->align = calculate_alignment(flags, ARCH_KMALLOC_MINALIGN, size);
 325         err = __kmem_cache_create(s, flags);
 326
 327         if (err)
 328                 panic("Creation of kmalloc slab %s size=%zu failed. Reason %d\n",
 329                                         name, size, err);
 330
 331         s->refcount = -1;       /* Exempt from merging for now */
 332 }
 333
 334 struct kmem_cache *__init create_kmalloc_cache(const char *name, size_t size,
 335                                 unsigned long flags)
 336 {
 337         struct kmem_cache *s = kmem_cache_zalloc(kmem_cache, GFP_NOWAIT);
 338
 339         if (!s)
 340                 panic("Out of memory when creating slab %s\n", name);
 341
 342         create_boot_cache(s, name, size, flags);
 343         list_add(&s->list, &slab_caches);
 344         s->refcount = 1;
 345         return s;
 346 }
 347
 348 struct kmem_cache *kmalloc_caches[KMALLOC_SHIFT_HIGH + 1];
 349 EXPORT_SYMBOL(kmalloc_caches);
 350
 351 #ifdef CONFIG_ZONE_DMA
 352 struct kmem_cache *kmalloc_dma_caches[KMALLOC_SHIFT_HIGH + 1];
 353 EXPORT_SYMBOL(kmalloc_dma_caches);
 354 #endif
 355
 356 /*
 357  * Conversion table for small slabs sizes / 8 to the index in the
 358  * kmalloc array. This is necessary for slabs < 192 since we have non power
 359  * of two cache sizes there. The size of larger slabs can be determined using
 360  * fls.
 361  */
 362 static s8 size_index[24] = {
 363         3,      /* 8 */
 364         4,      /* 16 */
 365         5,      /* 24 */
 366         5,      /* 32 */
 367         6,      /* 40 */
 368         6,      /* 48 */
 369         6,      /* 56 */
 370         6,      /* 64 */
 371         1,      /* 72 */
 372         1,      /* 80 */
 373         1,      /* 88 */
 374         1,      /* 96 */
 375         7,      /* 104 */
 376         7,      /* 112 */
 377         7,      /* 120 */
 378         7,      /* 128 */
 379         2,      /* 136 */
 380         2,      /* 144 */
 381         2,      /* 152 */
 382         2,      /* 160 */
 383         2,      /* 168 */
 384         2,      /* 176 */
 385         2,      /* 184 */
 386         2       /* 192 */
 387 };
 388
 389 static inline int size_index_elem(size_t bytes)
 390 {
 391         return (bytes - 1) / 8;
 392 }
 393
 394 /*
 395  * Find the kmem_cache structure that serves a given size of
 396  * allocation
 397  */
 398 struct kmem_cache *kmalloc_slab(size_t size, gfp_t flags)
 399 {
 400         int index;
 401
 402         if (unlikely(size > KMALLOC_MAX_SIZE)) {
 403                 WARN_ON_ONCE(!(flags & __GFP_NOWARN));
 404                 return NULL;
 405         }
 406
 407         if (size <= 192) {
 408                 if (!size)
 409                         return ZERO_SIZE_PTR;
 410
 411                 index = size_index[size_index_elem(size)];
 412         } else
 413                 index = fls(size - 1);
 414
 415 #ifdef CONFIG_ZONE_DMA
 416         if (unlikely((flags & GFP_DMA)))
 417                 return kmalloc_dma_caches[index];
 418
 419 #endif
 420         return kmalloc_caches[index];
 421 }
 422
 423 /*
 424  * Create the kmalloc array. Some of the regular kmalloc arrays
 425  * may already have been created because they were needed to
 426  * enable allocations for slab creation.
 427  */
 428 void __init create_kmalloc_caches(unsigned long flags)
 429 {
 430         int i;
 431
 432         /*
 433          * Patch up the size_index table if we have strange large alignment
 434          * requirements for the kmalloc array. This is only the case for
 435          * MIPS it seems. The standard arches will not generate any code here.
 436          *
 437          * Largest permitted alignment is 256 bytes due to the way we
 438          * handle the index determination for the smaller caches.
 439          *
 440          * Make sure that nothing crazy happens if someone starts tinkering
 441          * around with ARCH_KMALLOC_MINALIGN
 442          */
 443         BUILD_BUG_ON(KMALLOC_MIN_SIZE > 256 ||
 444                 (KMALLOC_MIN_SIZE & (KMALLOC_MIN_SIZE - 1)));
 445
 446         for (i = 8; i < KMALLOC_MIN_SIZE; i += 8) {
 447                 int elem = size_index_elem(i);
 448
 449                 if (elem >= ARRAY_SIZE(size_index))
 450                         break;
 451                 size_index[elem] = KMALLOC_SHIFT_LOW;
 452         }
 453
 454         if (KMALLOC_MIN_SIZE >= 64) {
 455                 /*
 456                  * The 96 byte size cache is not used if the alignment
 457                  * is 64 byte.
 458                  */
 459                 for (i = 64 + 8; i <= 96; i += 8)
 460                         size_index[size_index_elem(i)] = 7;
 461
 462         }
 463
 464         if (KMALLOC_MIN_SIZE >= 128) {
 465                 /*
 466                  * The 192 byte sized cache is not used if the alignment
 467                  * is 128 byte. Redirect kmalloc to use the 256 byte cache
 468                  * instead.
 469                  */
 470                 for (i = 128 + 8; i <= 192; i += 8)
 471                         size_index[size_index_elem(i)] = 8;
 472         }
 473         for (i = KMALLOC_SHIFT_LOW; i <= KMALLOC_SHIFT_HIGH; i++) {
 474                 if (!kmalloc_caches[i]) {
 475                         kmalloc_caches[i] = create_kmalloc_cache(NULL,
 476                                                         1 << i, flags);
 477                 }
 478
 479                 /*
 480                  * Caches that are not of the two-to-the-power-of size.
 481                  * These have to be created immediately after the
 482                  * earlier power of two caches
 483                  */
 484                 if (KMALLOC_MIN_SIZE <= 32 && !kmalloc_caches[1] && i == 6)
 485                         kmalloc_caches[1] = create_kmalloc_cache(NULL, 96, flags);
 486
 487                 if (KMALLOC_MIN_SIZE <= 64 && !kmalloc_caches[2] && i == 7)
 488                         kmalloc_caches[2] = create_kmalloc_cache(NULL, 192, flags);
 489         }
 490
 491         /* Kmalloc array is now usable */
 492         slab_state = UP;
 493
 494         for (i = 0; i <= KMALLOC_SHIFT_HIGH; i++) {
 495                 struct kmem_cache *s = kmalloc_caches[i];
 496                 char *n;
 497
 498                 if (s) {
 499                         n = kasprintf(GFP_NOWAIT, "kmalloc-%d", kmalloc_size(i));
 500
 501                         BUG_ON(!n);
 502                         s->name = n;
 503                 }
 504         }
 505
 506 #ifdef CONFIG_ZONE_DMA
 507         for (i = 0; i <= KMALLOC_SHIFT_HIGH; i++) {
 508                 struct kmem_cache *s = kmalloc_caches[i];
 509
 510                 if (s) {
 511                         int size = kmalloc_size(i);
 512                         char *n = kasprintf(GFP_NOWAIT,
 513                                  "dma-kmalloc-%d", size);
 514
 515                         BUG_ON(!n);
 516                         kmalloc_dma_caches[i] = create_kmalloc_cache(n,
 517                                 size, SLAB_CACHE_DMA | flags);
 518                 }
 519         }
 520 #endif
 521 }
 522 #endif /* !CONFIG_SLOB */
 523
 524 #ifdef CONFIG_TRACING
 525 void *kmalloc_order_trace(size_t size, gfp_t flags, unsigned int order)
 526 {
 527         void *ret = kmalloc_order(size, flags, order);
 528         trace_kmalloc(_RET_IP_, ret, size, PAGE_SIZE << order, flags);
 529         return ret;
 530 }
 531 EXPORT_SYMBOL(kmalloc_order_trace);
 532 #endif
 533
 534 #ifdef CONFIG_SLABINFO
 535
 536 #ifdef CONFIG_SLAB
 537 #define SLABINFO_RIGHTS (S_IWUSR | S_IRUSR)
 538 #else
 539 #define SLABINFO_RIGHTS S_IRUSR
 540 #endif
 541
 542 void print_slabinfo_header(struct seq_file *m)
 543 {
 544         /*
 545          * Output format version, so at least we can change it
 546          * without _too_ many complaints.
 547          */
 548 #ifdef CONFIG_DEBUG_SLAB
 549         seq_puts(m, "slabinfo - version: 2.1 (statistics)\n");
 550 #else
 551         seq_puts(m, "slabinfo - version: 2.1\n");
 552 #endif
 553         seq_puts(m, "# name            <active_objs> <num_objs> <objsize> "
 554                  "<objperslab> <pagesperslab>");
 555         seq_puts(m, " : tunables <limit> <batchcount> <sharedfactor>");
 556         seq_puts(m, " : slabdata <active_slabs> <num_slabs> <sharedavail>");
 557 #ifdef CONFIG_DEBUG_SLAB
 558         seq_puts(m, " : globalstat <listallocs> <maxobjs> <grown> <reaped> "
 559                  "<error> <maxfreeable> <nodeallocs> <remotefrees> <alienoverflow>");
 560         seq_puts(m, " : cpustat <allochit> <allocmiss> <freehit> <freemiss>");
 561 #endif
 562         seq_putc(m, '\n');
 563 }
 564
 565 static void *s_start(struct seq_file *m, loff_t *pos)
 566 {
 567         loff_t n = *pos;
 568
 569         mutex_lock(&slab_mutex);
 570         if (!n)
 571                 print_slabinfo_header(m);
 572
 573         return seq_list_start(&slab_caches, *pos);
 574 }
 575
 576 void *slab_next(struct seq_file *m, void *p, loff_t *pos)
 577 {
 578         return seq_list_next(p, &slab_caches, pos);
 579 }
 580
 581 void slab_stop(struct seq_file *m, void *p)
 582 {
 583         mutex_unlock(&slab_mutex);
 584 }
 585
 586 static void
 587 memcg_accumulate_slabinfo(struct kmem_cache *s, struct slabinfo *info)
 588 {
 589         struct kmem_cache *c;
 590         struct slabinfo sinfo;
 591         int i;
 592
 593         if (!is_root_cache(s))
 594                 return;
 595
 596         for_each_memcg_cache_index(i) {
 597                 c = cache_from_memcg_idx(s, i);
 598                 if (!c)
 599                         continue;
 600
 601                 memset(&sinfo, 0, sizeof(sinfo));
 602                 get_slabinfo(c, &sinfo);
 603
 604                 info->active_slabs += sinfo.active_slabs;
 605                 info->num_slabs += sinfo.num_slabs;
 606                 info->shared_avail += sinfo.shared_avail;
 607                 info->active_objs += sinfo.active_objs;
 608                 info->num_objs += sinfo.num_objs;
 609         }
 610 }
 611
 612 int cache_show(struct kmem_cache *s, struct seq_file *m)
 613 {
 614         struct slabinfo sinfo;
 615
 616         memset(&sinfo, 0, sizeof(sinfo));
 617         get_slabinfo(s, &sinfo);
 618
 619         memcg_accumulate_slabinfo(s, &sinfo);
 620
 621         seq_printf(m, "%-17s %6lu %6lu %6u %4u %4d",
 622                    cache_name(s), sinfo.active_objs, sinfo.num_objs, s->size,
 623                    sinfo.objects_per_slab, (1 << sinfo.cache_order));
 624
 625         seq_printf(m, " : tunables %4u %4u %4u",
 626                    sinfo.limit, sinfo.batchcount, sinfo.shared);
 627         seq_printf(m, " : slabdata %6lu %6lu %6lu",
 628                    sinfo.active_slabs, sinfo.num_slabs, sinfo.shared_avail);
 629         slabinfo_show_stats(m, s);
 630         seq_putc(m, '\n');
 631         return 0;
 632 }
 633
 634 static int s_show(struct seq_file *m, void *p)
 635 {
 636         struct kmem_cache *s = list_entry(p, struct kmem_cache, list);
 637
 638         if (!is_root_cache(s))
 639                 return 0;
 640         return cache_show(s, m);
 641 }
 642
 643 /*
 644  * slabinfo_op - iterator that generates /proc/slabinfo
 645  *
 646  * Output layout:
 647  * cache-name
 648  * num-active-objs
 649  * total-objs
 650  * object size
 651  * num-active-slabs
 652  * total-slabs
 653  * num-pages-per-slab
 654  * + further values on SMP and with statistics enabled
 655  */
 656 static const struct seq_operations slabinfo_op = {
 657         .start = s_start,
 658         .next = slab_next,
 659         .stop = slab_stop,
 660         .show = s_show,
 661 };
 662
 663 static int slabinfo_open(struct inode *inode, struct file *file)
 664 {
 665         return seq_open(file, &slabinfo_op);
 666 }
 667
 668 static const struct file_operations proc_slabinfo_operations = {
 669         .open           = slabinfo_open,
 670         .read           = seq_read,
 671         .write          = slabinfo_write,
 672         .llseek         = seq_lseek,
 673         .release        = seq_release,
 674 };
 675
 676 static int __init slab_proc_init(void)
 677 {
 678         proc_create("slabinfo", SLABINFO_RIGHTS, NULL,
 679                                                 &proc_slabinfo_operations);
 680         return 0;
 681 }
 682 module_init(slab_proc_init);
 683 #endif /* CONFIG_SLABINFO */