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
  23 #include "slab.h"
  24
  25 enum slab_state slab_state;
  26 LIST_HEAD(slab_caches);
  27 DEFINE_MUTEX(slab_mutex);
  28 struct kmem_cache *kmem_cache;
  29
  30 #ifdef CONFIG_DEBUG_VM
  31 static int kmem_cache_sanity_check(struct mem_cgroup *memcg, const char *name,
  32                                    size_t size)
  33 {
  34         struct kmem_cache *s = NULL;
  35
  36         if (!name || in_interrupt() || size < sizeof(void *) ||
  37                 size > KMALLOC_MAX_SIZE) {
  38                 pr_err("kmem_cache_create(%s) integrity check failed\n", name);
  39                 return -EINVAL;
  40         }
  41
  42         list_for_each_entry(s, &slab_caches, list) {
  43                 char tmp;
  44                 int res;
  45
  46                 /*
  47                  * This happens when the module gets unloaded and doesn't
  48                  * destroy its slab cache and no-one else reuses the vmalloc
  49                  * area of the module.  Print a warning.
  50                  */
  51                 res = probe_kernel_address(s->name, tmp);
  52                 if (res) {
  53                         pr_err("Slab cache with size %d has lost its name\n",
  54                                s->object_size);
  55                         continue;
  56                 }
  57
  58                 /*
  59                  * For simplicity, we won't check this in the list of memcg
  60                  * caches. We have control over memcg naming, and if there
  61                  * aren't duplicates in the global list, there won't be any
  62                  * duplicates in the memcg lists as well.
  63                  */
  64                 if (!memcg && !strcmp(s->name, name)) {
  65                         pr_err("%s (%s): Cache name already exists.\n",
  66                                __func__, name);
  67                         dump_stack();
  68                         s = NULL;
  69                         return -EINVAL;
  70                 }
  71         }
  72
  73         WARN_ON(strchr(name, ' '));     /* It confuses parsers */
  74         return 0;
  75 }
  76 #else
  77 static inline int kmem_cache_sanity_check(struct mem_cgroup *memcg,
  78                                           const char *name, size_t size)
  79 {
  80         return 0;
  81 }
  82 #endif
  83
  84 #ifdef CONFIG_MEMCG_KMEM
  85 int memcg_update_all_caches(int num_memcgs)
  86 {
  87         struct kmem_cache *s;
  88         int ret = 0;
  89         mutex_lock(&slab_mutex);
  90
  91         list_for_each_entry(s, &slab_caches, list) {
  92                 if (!is_root_cache(s))
  93                         continue;
  94
  95                 ret = memcg_update_cache_size(s, num_memcgs);
  96                 /*
  97                  * See comment in memcontrol.c, memcg_update_cache_size:
  98                  * Instead of freeing the memory, we'll just leave the caches
  99                  * up to this point in an updated state.
 100                  */
 101                 if (ret)
 102                         goto out;
 103         }
 104
 105         memcg_update_array_size(num_memcgs);
 106 out:
 107         mutex_unlock(&slab_mutex);
 108         return ret;
 109 }
 110 #endif
 111
 112 /*
 113  * kmem_cache_create - Create a cache.
 114  * @name: A string which is used in /proc/slabinfo to identify this cache.
 115  * @size: The size of objects to be created in this cache.
 116  * @align: The required alignment for the objects.
 117  * @flags: SLAB flags
 118  * @ctor: A constructor for the objects.
 119  *
 120  * Returns a ptr to the cache on success, NULL on failure.
 121  * Cannot be called within a interrupt, but can be interrupted.
 122  * The @ctor is run when new pages are allocated by the cache.
 123  *
 124  * The flags are
 125  *
 126  * %SLAB_POISON - Poison the slab with a known test pattern (a5a5a5a5)
 127  * to catch references to uninitialised memory.
 128  *
 129  * %SLAB_RED_ZONE - Insert `Red' zones around the allocated memory to check
 130  * for buffer overruns.
 131  *
 132  * %SLAB_HWCACHE_ALIGN - Align the objects in this cache to a hardware
 133  * cacheline.  This can be beneficial if you're counting cycles as closely
 134  * as davem.
 135  */
 136
 137 struct kmem_cache *
 138 kmem_cache_create_memcg(struct mem_cgroup *memcg, const char *name, size_t size,
 139                         size_t align, unsigned long flags, void (*ctor)(void *))
 140 {
 141         struct kmem_cache *s = NULL;
 142         int err = 0;
 143
 144         get_online_cpus();
 145         mutex_lock(&slab_mutex);
 146
 147         if (!kmem_cache_sanity_check(memcg, name, size) == 0)
 148                 goto out_locked;
 149
 150         /*
 151          * Some allocators will constraint the set of valid flags to a subset
 152          * of all flags. We expect them to define CACHE_CREATE_MASK in this
 153          * case, and we'll just provide them with a sanitized version of the
 154          * passed flags.
 155          */
 156         flags &= CACHE_CREATE_MASK;
 157
 158         s = __kmem_cache_alias(memcg, name, size, align, flags, ctor);
 159         if (s)
 160                 goto out_locked;
 161
 162         s = kmem_cache_zalloc(kmem_cache, GFP_KERNEL);
 163         if (s) {
 164                 s->object_size = s->size = size;
 165                 s->align = align;
 166                 s->ctor = ctor;
 167
 168                 if (memcg_register_cache(memcg, s)) {
 169                         kmem_cache_free(kmem_cache, s);
 170                         err = -ENOMEM;
 171                         goto out_locked;
 172                 }
 173
 174                 s->name = kstrdup(name, GFP_KERNEL);
 175                 if (!s->name) {
 176                         kmem_cache_free(kmem_cache, s);
 177                         err = -ENOMEM;
 178                         goto out_locked;
 179                 }
 180
 181                 err = __kmem_cache_create(s, flags);
 182                 if (!err) {
 183                         s->refcount = 1;
 184                         list_add(&s->list, &slab_caches);
 185                         memcg_cache_list_add(memcg, s);
 186                 } else {
 187                         kfree(s->name);
 188                         kmem_cache_free(kmem_cache, s);
 189                 }
 190         } else
 191                 err = -ENOMEM;
 192
 193 out_locked:
 194         mutex_unlock(&slab_mutex);
 195         put_online_cpus();
 196
 197         if (err) {
 198
 199                 if (flags & SLAB_PANIC)
 200                         panic("kmem_cache_create: Failed to create slab '%s'. Error %d\n",
 201                                 name, err);
 202                 else {
 203                         printk(KERN_WARNING "kmem_cache_create(%s) failed with error %d",
 204                                 name, err);
 205                         dump_stack();
 206                 }
 207
 208                 return NULL;
 209         }
 210
 211         return s;
 212 }
 213
 214 struct kmem_cache *
 215 kmem_cache_create(const char *name, size_t size, size_t align,
 216                   unsigned long flags, void (*ctor)(void *))
 217 {
 218         return kmem_cache_create_memcg(NULL, name, size, align, flags, ctor);
 219 }
 220 EXPORT_SYMBOL(kmem_cache_create);
 221
 222 void kmem_cache_destroy(struct kmem_cache *s)
 223 {
 224         /* Destroy all the children caches if we aren't a memcg cache */
 225         kmem_cache_destroy_memcg_children(s);
 226
 227         get_online_cpus();
 228         mutex_lock(&slab_mutex);
 229         s->refcount--;
 230         if (!s->refcount) {
 231                 list_del(&s->list);
 232
 233                 if (!__kmem_cache_shutdown(s)) {
 234                         mutex_unlock(&slab_mutex);
 235                         if (s->flags & SLAB_DESTROY_BY_RCU)
 236                                 rcu_barrier();
 237
 238                         memcg_release_cache(s);
 239                         kfree(s->name);
 240                         kmem_cache_free(kmem_cache, s);
 241                 } else {
 242                         list_add(&s->list, &slab_caches);
 243                         mutex_unlock(&slab_mutex);
 244                         printk(KERN_ERR "kmem_cache_destroy %s: Slab cache still has objects\n",
 245                                 s->name);
 246                         dump_stack();
 247                 }
 248         } else {
 249                 mutex_unlock(&slab_mutex);
 250         }
 251         put_online_cpus();
 252 }
 253 EXPORT_SYMBOL(kmem_cache_destroy);
 254
 255 int slab_is_available(void)
 256 {
 257         return slab_state >= UP;
 258 }
 259
 260 #ifdef CONFIG_SLABINFO
 261 void print_slabinfo_header(struct seq_file *m)
 262 {
 263         /*
 264          * Output format version, so at least we can change it
 265          * without _too_ many complaints.
 266          */
 267 #ifdef CONFIG_DEBUG_SLAB
 268         seq_puts(m, "slabinfo - version: 2.1 (statistics)\n");
 269 #else
 270         seq_puts(m, "slabinfo - version: 2.1\n");
 271 #endif
 272         seq_puts(m, "# name            <active_objs> <num_objs> <objsize> "
 273                  "<objperslab> <pagesperslab>");
 274         seq_puts(m, " : tunables <limit> <batchcount> <sharedfactor>");
 275         seq_puts(m, " : slabdata <active_slabs> <num_slabs> <sharedavail>");
 276 #ifdef CONFIG_DEBUG_SLAB
 277         seq_puts(m, " : globalstat <listallocs> <maxobjs> <grown> <reaped> "
 278                  "<error> <maxfreeable> <nodeallocs> <remotefrees> <alienoverflow>");
 279         seq_puts(m, " : cpustat <allochit> <allocmiss> <freehit> <freemiss>");
 280 #endif
 281         seq_putc(m, '\n');
 282 }
 283
 284 static void *s_start(struct seq_file *m, loff_t *pos)
 285 {
 286         loff_t n = *pos;
 287
 288         mutex_lock(&slab_mutex);
 289         if (!n)
 290                 print_slabinfo_header(m);
 291
 292         return seq_list_start(&slab_caches, *pos);
 293 }
 294
 295 static void *s_next(struct seq_file *m, void *p, loff_t *pos)
 296 {
 297         return seq_list_next(p, &slab_caches, pos);
 298 }
 299
 300 static void s_stop(struct seq_file *m, void *p)
 301 {
 302         mutex_unlock(&slab_mutex);
 303 }
 304
 305 static void
 306 memcg_accumulate_slabinfo(struct kmem_cache *s, struct slabinfo *info)
 307 {
 308         struct kmem_cache *c;
 309         struct slabinfo sinfo;
 310         int i;
 311
 312         if (!is_root_cache(s))
 313                 return;
 314
 315         for_each_memcg_cache_index(i) {
 316                 c = cache_from_memcg(s, i);
 317                 if (!c)
 318                         continue;
 319
 320                 memset(&sinfo, 0, sizeof(sinfo));
 321                 get_slabinfo(c, &sinfo);
 322
 323                 info->active_slabs += sinfo.active_slabs;
 324                 info->num_slabs += sinfo.num_slabs;
 325                 info->shared_avail += sinfo.shared_avail;
 326                 info->active_objs += sinfo.active_objs;
 327                 info->num_objs += sinfo.num_objs;
 328         }
 329 }
 330
 331 int cache_show(struct kmem_cache *s, struct seq_file *m)
 332 {
 333         struct slabinfo sinfo;
 334
 335         memset(&sinfo, 0, sizeof(sinfo));
 336         get_slabinfo(s, &sinfo);
 337
 338         memcg_accumulate_slabinfo(s, &sinfo);
 339
 340         seq_printf(m, "%-17s %6lu %6lu %6u %4u %4d",
 341                    cache_name(s), sinfo.active_objs, sinfo.num_objs, s->size,
 342                    sinfo.objects_per_slab, (1 << sinfo.cache_order));
 343
 344         seq_printf(m, " : tunables %4u %4u %4u",
 345                    sinfo.limit, sinfo.batchcount, sinfo.shared);
 346         seq_printf(m, " : slabdata %6lu %6lu %6lu",
 347                    sinfo.active_slabs, sinfo.num_slabs, sinfo.shared_avail);
 348         slabinfo_show_stats(m, s);
 349         seq_putc(m, '\n');
 350         return 0;
 351 }
 352
 353 static int s_show(struct seq_file *m, void *p)
 354 {
 355         struct kmem_cache *s = list_entry(p, struct kmem_cache, list);
 356
 357         if (!is_root_cache(s))
 358                 return 0;
 359         return cache_show(s, m);
 360 }
 361
 362 /*
 363  * slabinfo_op - iterator that generates /proc/slabinfo
 364  *
 365  * Output layout:
 366  * cache-name
 367  * num-active-objs
 368  * total-objs
 369  * object size
 370  * num-active-slabs
 371  * total-slabs
 372  * num-pages-per-slab
 373  * + further values on SMP and with statistics enabled
 374  */
 375 static const struct seq_operations slabinfo_op = {
 376         .start = s_start,
 377         .next = s_next,
 378         .stop = s_stop,
 379         .show = s_show,
 380 };
 381
 382 static int slabinfo_open(struct inode *inode, struct file *file)
 383 {
 384         return seq_open(file, &slabinfo_op);
 385 }
 386
 387 static const struct file_operations proc_slabinfo_operations = {
 388         .open           = slabinfo_open,
 389         .read           = seq_read,
 390         .write          = slabinfo_write,
 391         .llseek         = seq_lseek,
 392         .release        = seq_release,
 393 };
 394
 395 static int __init slab_proc_init(void)
 396 {
 397         proc_create("slabinfo", S_IRUSR, NULL, &proc_slabinfo_operations);
 398         return 0;
 399 }
 400 module_init(slab_proc_init);
 401 #endif /* CONFIG_SLABINFO */