9e45491917895a23f5bcf49ef5d16596cbf93aeb
[muen/linux.git] / 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 <trace/events/cma.h>
39
40 #include "cma.h"
41
42 struct cma cma_areas[MAX_CMA_AREAS];
43 unsigned cma_area_count;
44 static DEFINE_MUTEX(cma_mutex);
45
46 phys_addr_t cma_get_base(const struct cma *cma)
47 {
48         return PFN_PHYS(cma->base_pfn);
49 }
50
51 unsigned long cma_get_size(const struct cma *cma)
52 {
53         return cma->count << PAGE_SHIFT;
54 }
55
56 const char *cma_get_name(const struct cma *cma)
57 {
58         return cma->name ? cma->name : "(undefined)";
59 }
60
61 static unsigned long cma_bitmap_aligned_mask(const struct cma *cma,
62                                              int align_order)
63 {
64         if (align_order <= cma->order_per_bit)
65                 return 0;
66         return (1UL << (align_order - cma->order_per_bit)) - 1;
67 }
68
69 /*
70  * Find a PFN aligned to the specified order and return an offset represented in
71  * order_per_bits.
72  */
73 static unsigned long cma_bitmap_aligned_offset(const struct cma *cma,
74                                                int align_order)
75 {
76         if (align_order <= cma->order_per_bit)
77                 return 0;
78
79         return (ALIGN(cma->base_pfn, (1UL << align_order))
80                 - cma->base_pfn) >> cma->order_per_bit;
81 }
82
83 static unsigned long cma_bitmap_pages_to_bits(const struct cma *cma,
84                                               unsigned long pages)
85 {
86         return ALIGN(pages, 1UL << cma->order_per_bit) >> cma->order_per_bit;
87 }
88
89 static void cma_clear_bitmap(struct cma *cma, unsigned long pfn,
90                              unsigned int count)
91 {
92         unsigned long bitmap_no, bitmap_count;
93
94         bitmap_no = (pfn - cma->base_pfn) >> cma->order_per_bit;
95         bitmap_count = cma_bitmap_pages_to_bits(cma, count);
96
97         mutex_lock(&cma->lock);
98         bitmap_clear(cma->bitmap, bitmap_no, bitmap_count);
99         mutex_unlock(&cma->lock);
100 }
101
102 static int __init cma_activate_area(struct cma *cma)
103 {
104         int bitmap_size = BITS_TO_LONGS(cma_bitmap_maxno(cma)) * sizeof(long);
105         unsigned long base_pfn = cma->base_pfn, pfn = base_pfn;
106         unsigned i = cma->count >> pageblock_order;
107         struct zone *zone;
108
109         cma->bitmap = kzalloc(bitmap_size, GFP_KERNEL);
110
111         if (!cma->bitmap)
112                 return -ENOMEM;
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  * @res_cma: Pointer to store the created cma region.
172  *
173  * This function creates custom contiguous area from already reserved memory.
174  */
175 int __init cma_init_reserved_mem(phys_addr_t base, phys_addr_t size,
176                                  unsigned int order_per_bit,
177                                  const char *name,
178                                  struct cma **res_cma)
179 {
180         struct cma *cma;
181         phys_addr_t alignment;
182
183         /* Sanity checks */
184         if (cma_area_count == ARRAY_SIZE(cma_areas)) {
185                 pr_err("Not enough slots for CMA reserved regions!\n");
186                 return -ENOSPC;
187         }
188
189         if (!size || !memblock_is_region_reserved(base, size))
190                 return -EINVAL;
191
192         /* ensure minimal alignment required by mm core */
193         alignment = PAGE_SIZE <<
194                         max_t(unsigned long, MAX_ORDER - 1, pageblock_order);
195
196         /* alignment should be aligned with order_per_bit */
197         if (!IS_ALIGNED(alignment >> PAGE_SHIFT, 1 << order_per_bit))
198                 return -EINVAL;
199
200         if (ALIGN(base, alignment) != base || ALIGN(size, alignment) != size)
201                 return -EINVAL;
202
203         /*
204          * Each reserved area must be initialised later, when more kernel
205          * subsystems (like slab allocator) are available.
206          */
207         cma = &cma_areas[cma_area_count];
208         if (name) {
209                 cma->name = name;
210         } else {
211                 cma->name = kasprintf(GFP_KERNEL, "cma%d\n", cma_area_count);
212                 if (!cma->name)
213                         return -ENOMEM;
214         }
215         cma->base_pfn = PFN_DOWN(base);
216         cma->count = size >> PAGE_SHIFT;
217         cma->order_per_bit = order_per_bit;
218         *res_cma = cma;
219         cma_area_count++;
220         totalcma_pages += (size / PAGE_SIZE);
221
222         return 0;
223 }
224
225 /**
226  * cma_declare_contiguous() - reserve custom contiguous area
227  * @base: Base address of the reserved area optional, use 0 for any
228  * @size: Size of the reserved area (in bytes),
229  * @limit: End address of the reserved memory (optional, 0 for any).
230  * @alignment: Alignment for the CMA area, should be power of 2 or zero
231  * @order_per_bit: Order of pages represented by one bit on bitmap.
232  * @fixed: hint about where to place the reserved area
233  * @res_cma: Pointer to store the created cma region.
234  *
235  * This function reserves memory from early allocator. It should be
236  * called by arch specific code once the early allocator (memblock or bootmem)
237  * has been activated and all other subsystems have already allocated/reserved
238  * memory. This function allows to create custom reserved areas.
239  *
240  * If @fixed is true, reserve contiguous area at exactly @base.  If false,
241  * reserve in range from @base to @limit.
242  */
243 int __init cma_declare_contiguous(phys_addr_t base,
244                         phys_addr_t size, phys_addr_t limit,
245                         phys_addr_t alignment, unsigned int order_per_bit,
246                         bool fixed, const char *name, struct cma **res_cma)
247 {
248         phys_addr_t memblock_end = memblock_end_of_DRAM();
249         phys_addr_t highmem_start;
250         int ret = 0;
251
252         /*
253          * We can't use __pa(high_memory) directly, since high_memory
254          * isn't a valid direct map VA, and DEBUG_VIRTUAL will (validly)
255          * complain. Find the boundary by adding one to the last valid
256          * address.
257          */
258         highmem_start = __pa(high_memory - 1) + 1;
259         pr_debug("%s(size %pa, base %pa, limit %pa alignment %pa)\n",
260                 __func__, &size, &base, &limit, &alignment);
261
262         if (cma_area_count == ARRAY_SIZE(cma_areas)) {
263                 pr_err("Not enough slots for CMA reserved regions!\n");
264                 return -ENOSPC;
265         }
266
267         if (!size)
268                 return -EINVAL;
269
270         if (alignment && !is_power_of_2(alignment))
271                 return -EINVAL;
272
273         /*
274          * Sanitise input arguments.
275          * Pages both ends in CMA area could be merged into adjacent unmovable
276          * migratetype page by page allocator's buddy algorithm. In the case,
277          * you couldn't get a contiguous memory, which is not what we want.
278          */
279         alignment = max(alignment,  (phys_addr_t)PAGE_SIZE <<
280                           max_t(unsigned long, MAX_ORDER - 1, pageblock_order));
281         base = ALIGN(base, alignment);
282         size = ALIGN(size, alignment);
283         limit &= ~(alignment - 1);
284
285         if (!base)
286                 fixed = false;
287
288         /* size should be aligned with order_per_bit */
289         if (!IS_ALIGNED(size >> PAGE_SHIFT, 1 << order_per_bit))
290                 return -EINVAL;
291
292         /*
293          * If allocating at a fixed base the request region must not cross the
294          * low/high memory boundary.
295          */
296         if (fixed && base < highmem_start && base + size > highmem_start) {
297                 ret = -EINVAL;
298                 pr_err("Region at %pa defined on low/high memory boundary (%pa)\n",
299                         &base, &highmem_start);
300                 goto err;
301         }
302
303         /*
304          * If the limit is unspecified or above the memblock end, its effective
305          * value will be the memblock end. Set it explicitly to simplify further
306          * checks.
307          */
308         if (limit == 0 || limit > memblock_end)
309                 limit = memblock_end;
310
311         /* Reserve memory */
312         if (fixed) {
313                 if (memblock_is_region_reserved(base, size) ||
314                     memblock_reserve(base, size) < 0) {
315                         ret = -EBUSY;
316                         goto err;
317                 }
318         } else {
319                 phys_addr_t addr = 0;
320
321                 /*
322                  * All pages in the reserved area must come from the same zone.
323                  * If the requested region crosses the low/high memory boundary,
324                  * try allocating from high memory first and fall back to low
325                  * memory in case of failure.
326                  */
327                 if (base < highmem_start && limit > highmem_start) {
328                         addr = memblock_alloc_range(size, alignment,
329                                                     highmem_start, limit,
330                                                     MEMBLOCK_NONE);
331                         limit = highmem_start;
332                 }
333
334                 if (!addr) {
335                         addr = memblock_alloc_range(size, alignment, base,
336                                                     limit,
337                                                     MEMBLOCK_NONE);
338                         if (!addr) {
339                                 ret = -ENOMEM;
340                                 goto err;
341                         }
342                 }
343
344                 /*
345                  * kmemleak scans/reads tracked objects for pointers to other
346                  * objects but this address isn't mapped and accessible
347                  */
348                 kmemleak_ignore_phys(addr);
349                 base = addr;
350         }
351
352         ret = cma_init_reserved_mem(base, size, order_per_bit, name, res_cma);
353         if (ret)
354                 goto err;
355
356         pr_info("Reserved %ld MiB at %pa\n", (unsigned long)size / SZ_1M,
357                 &base);
358         return 0;
359
360 err:
361         pr_err("Failed to reserve %ld MiB\n", (unsigned long)size / SZ_1M);
362         return ret;
363 }
364
365 #ifdef CONFIG_CMA_DEBUG
366 static void cma_debug_show_areas(struct cma *cma)
367 {
368         unsigned long next_zero_bit, next_set_bit;
369         unsigned long start = 0;
370         unsigned int nr_zero, nr_total = 0;
371
372         mutex_lock(&cma->lock);
373         pr_info("number of available pages: ");
374         for (;;) {
375                 next_zero_bit = find_next_zero_bit(cma->bitmap, cma->count, start);
376                 if (next_zero_bit >= cma->count)
377                         break;
378                 next_set_bit = find_next_bit(cma->bitmap, cma->count, next_zero_bit);
379                 nr_zero = next_set_bit - next_zero_bit;
380                 pr_cont("%s%u@%lu", nr_total ? "+" : "", nr_zero, next_zero_bit);
381                 nr_total += nr_zero;
382                 start = next_zero_bit + nr_zero;
383         }
384         pr_cont("=> %u free of %lu total pages\n", nr_total, cma->count);
385         mutex_unlock(&cma->lock);
386 }
387 #else
388 static inline void cma_debug_show_areas(struct cma *cma) { }
389 #endif
390
391 /**
392  * cma_alloc() - allocate pages from contiguous area
393  * @cma:   Contiguous memory region for which the allocation is performed.
394  * @count: Requested number of pages.
395  * @align: Requested alignment of pages (in PAGE_SIZE order).
396  *
397  * This function allocates part of contiguous memory on specific
398  * contiguous memory area.
399  */
400 struct page *cma_alloc(struct cma *cma, size_t count, unsigned int align,
401                        gfp_t gfp_mask)
402 {
403         unsigned long mask, offset;
404         unsigned long pfn = -1;
405         unsigned long start = 0;
406         unsigned long bitmap_maxno, bitmap_no, bitmap_count;
407         struct page *page = NULL;
408         int ret = -ENOMEM;
409
410         if (!cma || !cma->count)
411                 return NULL;
412
413         pr_debug("%s(cma %p, count %zu, align %d)\n", __func__, (void *)cma,
414                  count, align);
415
416         if (!count)
417                 return NULL;
418
419         mask = cma_bitmap_aligned_mask(cma, align);
420         offset = cma_bitmap_aligned_offset(cma, align);
421         bitmap_maxno = cma_bitmap_maxno(cma);
422         bitmap_count = cma_bitmap_pages_to_bits(cma, count);
423
424         if (bitmap_count > bitmap_maxno)
425                 return NULL;
426
427         for (;;) {
428                 mutex_lock(&cma->lock);
429                 bitmap_no = bitmap_find_next_zero_area_off(cma->bitmap,
430                                 bitmap_maxno, start, bitmap_count, mask,
431                                 offset);
432                 if (bitmap_no >= bitmap_maxno) {
433                         mutex_unlock(&cma->lock);
434                         break;
435                 }
436                 bitmap_set(cma->bitmap, bitmap_no, bitmap_count);
437                 /*
438                  * It's safe to drop the lock here. We've marked this region for
439                  * our exclusive use. If the migration fails we will take the
440                  * lock again and unmark it.
441                  */
442                 mutex_unlock(&cma->lock);
443
444                 pfn = cma->base_pfn + (bitmap_no << cma->order_per_bit);
445                 mutex_lock(&cma_mutex);
446                 ret = alloc_contig_range(pfn, pfn + count, MIGRATE_CMA,
447                                          gfp_mask);
448                 mutex_unlock(&cma_mutex);
449                 if (ret == 0) {
450                         page = pfn_to_page(pfn);
451                         break;
452                 }
453
454                 cma_clear_bitmap(cma, pfn, count);
455                 if (ret != -EBUSY)
456                         break;
457
458                 pr_debug("%s(): memory range at %p is busy, retrying\n",
459                          __func__, pfn_to_page(pfn));
460                 /* try again with a bit different memory target */
461                 start = bitmap_no + mask + 1;
462         }
463
464         trace_cma_alloc(pfn, page, count, align);
465
466         if (ret) {
467                 pr_info("%s: alloc failed, req-size: %zu pages, ret: %d\n",
468                         __func__, count, ret);
469                 cma_debug_show_areas(cma);
470         }
471
472         pr_debug("%s(): returned %p\n", __func__, page);
473         return page;
474 }
475
476 /**
477  * cma_release() - release allocated pages
478  * @cma:   Contiguous memory region for which the allocation is performed.
479  * @pages: Allocated pages.
480  * @count: Number of allocated pages.
481  *
482  * This function releases memory allocated by alloc_cma().
483  * It returns false when provided pages do not belong to contiguous area and
484  * true otherwise.
485  */
486 bool cma_release(struct cma *cma, const struct page *pages, unsigned int count)
487 {
488         unsigned long pfn;
489
490         if (!cma || !pages)
491                 return false;
492
493         pr_debug("%s(page %p)\n", __func__, (void *)pages);
494
495         pfn = page_to_pfn(pages);
496
497         if (pfn < cma->base_pfn || pfn >= cma->base_pfn + cma->count)
498                 return false;
499
500         VM_BUG_ON(pfn + count > cma->base_pfn + cma->count);
501
502         free_contig_range(pfn, count);
503         cma_clear_bitmap(cma, pfn, count);
504         trace_cma_release(pfn, pages, count);
505
506         return true;
507 }
508
509 int cma_for_each_area(int (*it)(struct cma *cma, void *data), void *data)
510 {
511         int i;
512
513         for (i = 0; i < cma_area_count; i++) {
514                 int ret = it(&cma_areas[i], data);
515
516                 if (ret)
517                         return ret;
518         }
519
520         return 0;
521 }