mm/cma.c

   1 /*
   2  * Contiguous Memory Allocator
   3  *
   4  * Copyright (c) 2010-2011 by Samsung Electronics.
   5  * Copyright IBM Corporation, 2013
   6  * Copyright LG Electronics Inc., 2014
   7  * Written by:
   8  *      Marek Szyprowski <m.szyprowski@samsung.com>
   9  *      Michal Nazarewicz <mina86@mina86.com>
  10  *      Aneesh Kumar K.V <aneesh.kumar@linux.vnet.ibm.com>
  11  *      Joonsoo Kim <iamjoonsoo.kim@lge.com>
  12  *
  13  * This program is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU General Public License as
  15  * published by the Free Software Foundation; either version 2 of the
  16  * License or (at your optional) any later version of the license.
  17  */
  18
  19 #define pr_fmt(fmt) "cma: " fmt
  20
  21 #ifdef CONFIG_CMA_DEBUG
  22 #ifndef DEBUG
  23 #  define DEBUG
  24 #endif
  25 #endif
  26 #define CREATE_TRACE_POINTS
  27
  28 #include <linux/memblock.h>
  29 #include <linux/err.h>
  30 #include <linux/mm.h>
  31 #include <linux/mutex.h>
  32 #include <linux/sizes.h>
  33 #include <linux/slab.h>
  34 #include <linux/log2.h>
  35 #include <linux/cma.h>
  36 #include <linux/highmem.h>
  37 #include <linux/io.h>
  38 #include <linux/kmemleak.h>
  39 #include <trace/events/cma.h>
  40
  41 #include "cma.h"
  42
  43 struct cma cma_areas[MAX_CMA_AREAS];
  44 unsigned cma_area_count;
  45 static DEFINE_MUTEX(cma_mutex);
  46
  47 phys_addr_t cma_get_base(const struct cma *cma)
  48 {
  49         return PFN_PHYS(cma->base_pfn);
  50 }
  51
  52 unsigned long cma_get_size(const struct cma *cma)
  53 {
  54         return cma->count << PAGE_SHIFT;
  55 }
  56
  57 const char *cma_get_name(const struct cma *cma)
  58 {
  59         return cma->name ? cma->name : "(undefined)";
  60 }
  61
  62 static unsigned long cma_bitmap_aligned_mask(const struct cma *cma,
  63                                              unsigned int align_order)
  64 {
  65         if (align_order <= cma->order_per_bit)
  66                 return 0;
  67         return (1UL << (align_order - cma->order_per_bit)) - 1;
  68 }
  69
  70 /*
  71  * Find the offset of the base PFN from the specified align_order.
  72  * The value returned is represented in order_per_bits.
  73  */
  74 static unsigned long cma_bitmap_aligned_offset(const struct cma *cma,
  75                                                unsigned int align_order)
  76 {
  77         return (cma->base_pfn & ((1UL << align_order) - 1))
  78                 >> cma->order_per_bit;
  79 }
  80
  81 static unsigned long cma_bitmap_pages_to_bits(const struct cma *cma,
  82                                               unsigned long pages)
  83 {
  84         return ALIGN(pages, 1UL << cma->order_per_bit) >> cma->order_per_bit;
  85 }
  86
  87 static void cma_clear_bitmap(struct cma *cma, unsigned long pfn,
  88                              unsigned int count)
  89 {
  90         unsigned long bitmap_no, bitmap_count;
  91
  92         bitmap_no = (pfn - cma->base_pfn) >> cma->order_per_bit;
  93         bitmap_count = cma_bitmap_pages_to_bits(cma, count);
  94
  95         mutex_lock(&cma->lock);
  96         bitmap_clear(cma->bitmap, bitmap_no, bitmap_count);
  97         mutex_unlock(&cma->lock);
  98 }
  99
 100 static int __init cma_activate_area(struct cma *cma)
 101 {
 102         int bitmap_size = BITS_TO_LONGS(cma_bitmap_maxno(cma)) * sizeof(long);
 103         unsigned long base_pfn = cma->base_pfn, pfn = base_pfn;
 104         unsigned i = cma->count >> pageblock_order;
 105         struct zone *zone;
 106
 107         cma->bitmap = kzalloc(bitmap_size, GFP_KERNEL);
 108
 109         if (!cma->bitmap) {
 110                 cma->count = 0;
 111                 return -ENOMEM;
 112         }
 113
 114         WARN_ON_ONCE(!pfn_valid(pfn));
 115         zone = page_zone(pfn_to_page(pfn));
 116
 117         do {
 118                 unsigned j;
 119
 120                 base_pfn = pfn;
 121                 for (j = pageblock_nr_pages; j; --j, pfn++) {
 122                         WARN_ON_ONCE(!pfn_valid(pfn));
 123                         /*
 124                          * alloc_contig_range requires the pfn range
 125                          * specified to be in the same zone. Make this
 126                          * simple by forcing the entire CMA resv range
 127                          * to be in the same zone.
 128                          */
 129                         if (page_zone(pfn_to_page(pfn)) != zone)
 130                                 goto not_in_zone;
 131                 }
 132                 init_cma_reserved_pageblock(pfn_to_page(base_pfn));
 133         } while (--i);
 134
 135         mutex_init(&cma->lock);
 136
 137 #ifdef CONFIG_CMA_DEBUGFS
 138         INIT_HLIST_HEAD(&cma->mem_head);
 139         spin_lock_init(&cma->mem_head_lock);
 140 #endif
 141
 142         return 0;
 143
 144 not_in_zone:
 145         pr_err("CMA area %s could not be activated\n", cma->name);
 146         kfree(cma->bitmap);
 147         cma->count = 0;
 148         return -EINVAL;
 149 }
 150
 151 static int __init cma_init_reserved_areas(void)
 152 {
 153         int i;
 154
 155         for (i = 0; i < cma_area_count; i++) {
 156                 int ret = cma_activate_area(&cma_areas[i]);
 157
 158                 if (ret)
 159                         return ret;
 160         }
 161
 162         return 0;
 163 }
 164 core_initcall(cma_init_reserved_areas);
 165
 166 /**
 167  * cma_init_reserved_mem() - create custom contiguous area from reserved memory
 168  * @base: Base address of the reserved area
 169  * @size: Size of the reserved area (in bytes),
 170  * @order_per_bit: Order of pages represented by one bit on bitmap.
 171  * @name: The name of the area. If this parameter is NULL, the name of
 172  *        the area will be set to "cmaN", where N is a running counter of
 173  *        used areas.
 174  * @res_cma: Pointer to store the created cma region.
 175  *
 176  * This function creates custom contiguous area from already reserved memory.
 177  */
 178 int __init cma_init_reserved_mem(phys_addr_t base, phys_addr_t size,
 179                                  unsigned int order_per_bit,
 180                                  const char *name,
 181                                  struct cma **res_cma)
 182 {
 183         struct cma *cma;
 184         phys_addr_t alignment;
 185
 186         /* Sanity checks */
 187         if (cma_area_count == ARRAY_SIZE(cma_areas)) {
 188                 pr_err("Not enough slots for CMA reserved regions!\n");
 189                 return -ENOSPC;
 190         }
 191
 192         if (!size || !memblock_is_region_reserved(base, size))
 193                 return -EINVAL;
 194
 195         /* ensure minimal alignment required by mm core */
 196         alignment = PAGE_SIZE <<
 197                         max_t(unsigned long, MAX_ORDER - 1, pageblock_order);
 198
 199         /* alignment should be aligned with order_per_bit */
 200         if (!IS_ALIGNED(alignment >> PAGE_SHIFT, 1 << order_per_bit))
 201                 return -EINVAL;
 202
 203         if (ALIGN(base, alignment) != base || ALIGN(size, alignment) != size)
 204                 return -EINVAL;
 205
 206         /*
 207          * Each reserved area must be initialised later, when more kernel
 208          * subsystems (like slab allocator) are available.
 209          */
 210         cma = &cma_areas[cma_area_count];
 211         if (name) {
 212                 cma->name = name;
 213         } else {
 214                 cma->name = kasprintf(GFP_KERNEL, "cma%d\n", cma_area_count);
 215                 if (!cma->name)
 216                         return -ENOMEM;
 217         }
 218         cma->base_pfn = PFN_DOWN(base);
 219         cma->count = size >> PAGE_SHIFT;
 220         cma->order_per_bit = order_per_bit;
 221         *res_cma = cma;
 222         cma_area_count++;
 223         totalcma_pages += (size / PAGE_SIZE);
 224
 225         return 0;
 226 }
 227
 228 /**
 229  * cma_declare_contiguous() - reserve custom contiguous area
 230  * @base: Base address of the reserved area optional, use 0 for any
 231  * @size: Size of the reserved area (in bytes),
 232  * @limit: End address of the reserved memory (optional, 0 for any).
 233  * @alignment: Alignment for the CMA area, should be power of 2 or zero
 234  * @order_per_bit: Order of pages represented by one bit on bitmap.
 235  * @fixed: hint about where to place the reserved area
 236  * @name: The name of the area. See function cma_init_reserved_mem()
 237  * @res_cma: Pointer to store the created cma region.
 238  *
 239  * This function reserves memory from early allocator. It should be
 240  * called by arch specific code once the early allocator (memblock or bootmem)
 241  * has been activated and all other subsystems have already allocated/reserved
 242  * memory. This function allows to create custom reserved areas.
 243  *
 244  * If @fixed is true, reserve contiguous area at exactly @base.  If false,
 245  * reserve in range from @base to @limit.
 246  */
 247 int __init cma_declare_contiguous(phys_addr_t base,
 248                         phys_addr_t size, phys_addr_t limit,
 249                         phys_addr_t alignment, unsigned int order_per_bit,
 250                         bool fixed, const char *name, struct cma **res_cma)
 251 {
 252         phys_addr_t memblock_end = memblock_end_of_DRAM();
 253         phys_addr_t highmem_start;
 254         int ret = 0;
 255
 256         /*
 257          * We can't use __pa(high_memory) directly, since high_memory
 258          * isn't a valid direct map VA, and DEBUG_VIRTUAL will (validly)
 259          * complain. Find the boundary by adding one to the last valid
 260          * address.
 261          */
 262         highmem_start = __pa(high_memory - 1) + 1;
 263         pr_debug("%s(size %pa, base %pa, limit %pa alignment %pa)\n",
 264                 __func__, &size, &base, &limit, &alignment);
 265
 266         if (cma_area_count == ARRAY_SIZE(cma_areas)) {
 267                 pr_err("Not enough slots for CMA reserved regions!\n");
 268                 return -ENOSPC;
 269         }
 270
 271         if (!size)
 272                 return -EINVAL;
 273
 274         if (alignment && !is_power_of_2(alignment))
 275                 return -EINVAL;
 276
 277         /*
 278          * Sanitise input arguments.
 279          * Pages both ends in CMA area could be merged into adjacent unmovable
 280          * migratetype page by page allocator's buddy algorithm. In the case,
 281          * you couldn't get a contiguous memory, which is not what we want.
 282          */
 283         alignment = max(alignment,  (phys_addr_t)PAGE_SIZE <<
 284                           max_t(unsigned long, MAX_ORDER - 1, pageblock_order));
 285         if (fixed && base & (alignment - 1)) {
 286                 ret = -EINVAL;
 287                 pr_err("Region at %pa must be aligned to %pa bytes\n",
 288                         &base, &alignment);
 289                 goto err;
 290         }
 291         base = ALIGN(base, alignment);
 292         size = ALIGN(size, alignment);
 293         limit &= ~(alignment - 1);
 294
 295         if (!base)
 296                 fixed = false;
 297
 298         /* size should be aligned with order_per_bit */
 299         if (!IS_ALIGNED(size >> PAGE_SHIFT, 1 << order_per_bit))
 300                 return -EINVAL;
 301
 302         /*
 303          * If allocating at a fixed base the request region must not cross the
 304          * low/high memory boundary.
 305          */
 306         if (fixed && base < highmem_start && base + size > highmem_start) {
 307                 ret = -EINVAL;
 308                 pr_err("Region at %pa defined on low/high memory boundary (%pa)\n",
 309                         &base, &highmem_start);
 310                 goto err;
 311         }
 312
 313         /*
 314          * If the limit is unspecified or above the memblock end, its effective
 315          * value will be the memblock end. Set it explicitly to simplify further
 316          * checks.
 317          */
 318         if (limit == 0 || limit > memblock_end)
 319                 limit = memblock_end;
 320
 321         if (base + size > limit) {
 322                 ret = -EINVAL;
 323                 pr_err("Size (%pa) of region at %pa exceeds limit (%pa)\n",
 324                         &size, &base, &limit);
 325                 goto err;
 326         }
 327
 328         /* Reserve memory */
 329         if (fixed) {
 330                 if (memblock_is_region_reserved(base, size) ||
 331                     memblock_reserve(base, size) < 0) {
 332                         ret = -EBUSY;
 333                         goto err;
 334                 }
 335         } else {
 336                 phys_addr_t addr = 0;
 337
 338                 /*
 339                  * All pages in the reserved area must come from the same zone.
 340                  * If the requested region crosses the low/high memory boundary,
 341                  * try allocating from high memory first and fall back to low
 342                  * memory in case of failure.
 343                  */
 344                 if (base < highmem_start && limit > highmem_start) {
 345                         addr = memblock_alloc_range(size, alignment,
 346                                                     highmem_start, limit,
 347                                                     MEMBLOCK_NONE);
 348                         limit = highmem_start;
 349                 }
 350
 351                 if (!addr) {
 352                         addr = memblock_alloc_range(size, alignment, base,
 353                                                     limit,
 354                                                     MEMBLOCK_NONE);
 355                         if (!addr) {
 356                                 ret = -ENOMEM;
 357                                 goto err;
 358                         }
 359                 }
 360
 361                 /*
 362                  * kmemleak scans/reads tracked objects for pointers to other
 363                  * objects but this address isn't mapped and accessible
 364                  */
 365                 kmemleak_ignore_phys(addr);
 366                 base = addr;
 367         }
 368
 369         ret = cma_init_reserved_mem(base, size, order_per_bit, name, res_cma);
 370         if (ret)
 371                 goto free_mem;
 372
 373         pr_info("Reserved %ld MiB at %pa\n", (unsigned long)size / SZ_1M,
 374                 &base);
 375         return 0;
 376
 377 free_mem:
 378         memblock_free(base, size);
 379 err:
 380         pr_err("Failed to reserve %ld MiB\n", (unsigned long)size / SZ_1M);
 381         return ret;
 382 }
 383
 384 #ifdef CONFIG_CMA_DEBUG
 385 static void cma_debug_show_areas(struct cma *cma)
 386 {
 387         unsigned long next_zero_bit, next_set_bit, nr_zero;
 388         unsigned long start = 0;
 389         unsigned long nr_part, nr_total = 0;
 390         unsigned long nbits = cma_bitmap_maxno(cma);
 391
 392         mutex_lock(&cma->lock);
 393         pr_info("number of available pages: ");
 394         for (;;) {
 395                 next_zero_bit = find_next_zero_bit(cma->bitmap, nbits, start);
 396                 if (next_zero_bit >= nbits)
 397                         break;
 398                 next_set_bit = find_next_bit(cma->bitmap, nbits, next_zero_bit);
 399                 nr_zero = next_set_bit - next_zero_bit;
 400                 nr_part = nr_zero << cma->order_per_bit;
 401                 pr_cont("%s%lu@%lu", nr_total ? "+" : "", nr_part,
 402                         next_zero_bit);
 403                 nr_total += nr_part;
 404                 start = next_zero_bit + nr_zero;
 405         }
 406         pr_cont("=> %lu free of %lu total pages\n", nr_total, cma->count);
 407         mutex_unlock(&cma->lock);
 408 }
 409 #else
 410 static inline void cma_debug_show_areas(struct cma *cma) { }
 411 #endif
 412
 413 /**
 414  * cma_alloc() - allocate pages from contiguous area
 415  * @cma:   Contiguous memory region for which the allocation is performed.
 416  * @count: Requested number of pages.
 417  * @align: Requested alignment of pages (in PAGE_SIZE order).
 418  * @no_warn: Avoid printing message about failed allocation
 419  *
 420  * This function allocates part of contiguous memory on specific
 421  * contiguous memory area.
 422  */
 423 struct page *cma_alloc(struct cma *cma, size_t count, unsigned int align,
 424                        bool no_warn)
 425 {
 426         unsigned long mask, offset;
 427         unsigned long pfn = -1;
 428         unsigned long start = 0;
 429         unsigned long bitmap_maxno, bitmap_no, bitmap_count;
 430         struct page *page = NULL;
 431         int ret = -ENOMEM;
 432
 433         if (!cma || !cma->count)
 434                 return NULL;
 435
 436         pr_debug("%s(cma %p, count %zu, align %d)\n", __func__, (void *)cma,
 437                  count, align);
 438
 439         if (!count)
 440                 return NULL;
 441
 442         mask = cma_bitmap_aligned_mask(cma, align);
 443         offset = cma_bitmap_aligned_offset(cma, align);
 444         bitmap_maxno = cma_bitmap_maxno(cma);
 445         bitmap_count = cma_bitmap_pages_to_bits(cma, count);
 446
 447         if (bitmap_count > bitmap_maxno)
 448                 return NULL;
 449
 450         for (;;) {
 451                 mutex_lock(&cma->lock);
 452                 bitmap_no = bitmap_find_next_zero_area_off(cma->bitmap,
 453                                 bitmap_maxno, start, bitmap_count, mask,
 454                                 offset);
 455                 if (bitmap_no >= bitmap_maxno) {
 456                         mutex_unlock(&cma->lock);
 457                         break;
 458                 }
 459                 bitmap_set(cma->bitmap, bitmap_no, bitmap_count);
 460                 /*
 461                  * It's safe to drop the lock here. We've marked this region for
 462                  * our exclusive use. If the migration fails we will take the
 463                  * lock again and unmark it.
 464                  */
 465                 mutex_unlock(&cma->lock);
 466
 467                 pfn = cma->base_pfn + (bitmap_no << cma->order_per_bit);
 468                 mutex_lock(&cma_mutex);
 469                 ret = alloc_contig_range(pfn, pfn + count, MIGRATE_CMA,
 470                                      GFP_KERNEL | (no_warn ? __GFP_NOWARN : 0));
 471                 mutex_unlock(&cma_mutex);
 472                 if (ret == 0) {
 473                         page = pfn_to_page(pfn);
 474                         break;
 475                 }
 476
 477                 cma_clear_bitmap(cma, pfn, count);
 478                 if (ret != -EBUSY)
 479                         break;
 480
 481                 pr_debug("%s(): memory range at %p is busy, retrying\n",
 482                          __func__, pfn_to_page(pfn));
 483                 /* try again with a bit different memory target */
 484                 start = bitmap_no + mask + 1;
 485         }
 486
 487         trace_cma_alloc(pfn, page, count, align);
 488
 489         if (ret && !no_warn) {
 490                 pr_err("%s: alloc failed, req-size: %zu pages, ret: %d\n",
 491                         __func__, count, ret);
 492                 cma_debug_show_areas(cma);
 493         }
 494
 495         pr_debug("%s(): returned %p\n", __func__, page);
 496         return page;
 497 }
 498
 499 /**
 500  * cma_release() - release allocated pages
 501  * @cma:   Contiguous memory region for which the allocation is performed.
 502  * @pages: Allocated pages.
 503  * @count: Number of allocated pages.
 504  *
 505  * This function releases memory allocated by alloc_cma().
 506  * It returns false when provided pages do not belong to contiguous area and
 507  * true otherwise.
 508  */
 509 bool cma_release(struct cma *cma, const struct page *pages, unsigned int count)
 510 {
 511         unsigned long pfn;
 512
 513         if (!cma || !pages)
 514                 return false;
 515
 516         pr_debug("%s(page %p)\n", __func__, (void *)pages);
 517
 518         pfn = page_to_pfn(pages);
 519
 520         if (pfn < cma->base_pfn || pfn >= cma->base_pfn + cma->count)
 521                 return false;
 522
 523         VM_BUG_ON(pfn + count > cma->base_pfn + cma->count);
 524
 525         free_contig_range(pfn, count);
 526         cma_clear_bitmap(cma, pfn, count);
 527         trace_cma_release(pfn, pages, count);
 528
 529         return true;
 530 }
 531
 532 int cma_for_each_area(int (*it)(struct cma *cma, void *data), void *data)
 533 {
 534         int i;
 535
 536         for (i = 0; i < cma_area_count; i++) {
 537                 int ret = it(&cma_areas[i], data);
 538
 539                 if (ret)
 540                         return ret;
 541         }
 542
 543         return 0;
 544 }