mm/cma.c

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