mm: cma: Ensure that reservations never cross the low/high mem boundary
[linux-2.6-block.git] / mm / cma.c
CommitLineData
a254129e
JK
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
27#include <linux/memblock.h>
28#include <linux/err.h>
29#include <linux/mm.h>
30#include <linux/mutex.h>
31#include <linux/sizes.h>
32#include <linux/slab.h>
33#include <linux/log2.h>
34#include <linux/cma.h>
f7426b98 35#include <linux/highmem.h>
a254129e
JK
36
37struct cma {
38 unsigned long base_pfn;
39 unsigned long count;
40 unsigned long *bitmap;
41 unsigned int order_per_bit; /* Order of pages represented by one bit */
42 struct mutex lock;
43};
44
45static struct cma cma_areas[MAX_CMA_AREAS];
46static unsigned cma_area_count;
47static DEFINE_MUTEX(cma_mutex);
48
49phys_addr_t cma_get_base(struct cma *cma)
50{
51 return PFN_PHYS(cma->base_pfn);
52}
53
54unsigned long cma_get_size(struct cma *cma)
55{
56 return cma->count << PAGE_SHIFT;
57}
58
59static unsigned long cma_bitmap_aligned_mask(struct cma *cma, int align_order)
60{
68faed63
WY
61 if (align_order <= cma->order_per_bit)
62 return 0;
63 return (1UL << (align_order - cma->order_per_bit)) - 1;
a254129e
JK
64}
65
66static unsigned long cma_bitmap_maxno(struct cma *cma)
67{
68 return cma->count >> cma->order_per_bit;
69}
70
71static unsigned long cma_bitmap_pages_to_bits(struct cma *cma,
72 unsigned long pages)
73{
74 return ALIGN(pages, 1UL << cma->order_per_bit) >> cma->order_per_bit;
75}
76
77static void cma_clear_bitmap(struct cma *cma, unsigned long pfn, int count)
78{
79 unsigned long bitmap_no, bitmap_count;
80
81 bitmap_no = (pfn - cma->base_pfn) >> cma->order_per_bit;
82 bitmap_count = cma_bitmap_pages_to_bits(cma, count);
83
84 mutex_lock(&cma->lock);
85 bitmap_clear(cma->bitmap, bitmap_no, bitmap_count);
86 mutex_unlock(&cma->lock);
87}
88
89static int __init cma_activate_area(struct cma *cma)
90{
91 int bitmap_size = BITS_TO_LONGS(cma_bitmap_maxno(cma)) * sizeof(long);
92 unsigned long base_pfn = cma->base_pfn, pfn = base_pfn;
93 unsigned i = cma->count >> pageblock_order;
94 struct zone *zone;
95
96 cma->bitmap = kzalloc(bitmap_size, GFP_KERNEL);
97
98 if (!cma->bitmap)
99 return -ENOMEM;
100
101 WARN_ON_ONCE(!pfn_valid(pfn));
102 zone = page_zone(pfn_to_page(pfn));
103
104 do {
105 unsigned j;
106
107 base_pfn = pfn;
108 for (j = pageblock_nr_pages; j; --j, pfn++) {
109 WARN_ON_ONCE(!pfn_valid(pfn));
110 /*
111 * alloc_contig_range requires the pfn range
112 * specified to be in the same zone. Make this
113 * simple by forcing the entire CMA resv range
114 * to be in the same zone.
115 */
116 if (page_zone(pfn_to_page(pfn)) != zone)
117 goto err;
118 }
119 init_cma_reserved_pageblock(pfn_to_page(base_pfn));
120 } while (--i);
121
122 mutex_init(&cma->lock);
123 return 0;
124
125err:
126 kfree(cma->bitmap);
f022d8cb 127 cma->count = 0;
a254129e
JK
128 return -EINVAL;
129}
130
131static int __init cma_init_reserved_areas(void)
132{
133 int i;
134
135 for (i = 0; i < cma_area_count; i++) {
136 int ret = cma_activate_area(&cma_areas[i]);
137
138 if (ret)
139 return ret;
140 }
141
142 return 0;
143}
144core_initcall(cma_init_reserved_areas);
145
de9e14ee
MS
146/**
147 * cma_init_reserved_mem() - create custom contiguous area from reserved memory
148 * @base: Base address of the reserved area
149 * @size: Size of the reserved area (in bytes),
150 * @order_per_bit: Order of pages represented by one bit on bitmap.
151 * @res_cma: Pointer to store the created cma region.
152 *
153 * This function creates custom contiguous area from already reserved memory.
154 */
155int __init cma_init_reserved_mem(phys_addr_t base, phys_addr_t size,
156 int order_per_bit, struct cma **res_cma)
157{
158 struct cma *cma;
159 phys_addr_t alignment;
160
161 /* Sanity checks */
162 if (cma_area_count == ARRAY_SIZE(cma_areas)) {
163 pr_err("Not enough slots for CMA reserved regions!\n");
164 return -ENOSPC;
165 }
166
167 if (!size || !memblock_is_region_reserved(base, size))
168 return -EINVAL;
169
170 /* ensure minimal alignment requied by mm core */
171 alignment = PAGE_SIZE << max(MAX_ORDER - 1, pageblock_order);
172
173 /* alignment should be aligned with order_per_bit */
174 if (!IS_ALIGNED(alignment >> PAGE_SHIFT, 1 << order_per_bit))
175 return -EINVAL;
176
177 if (ALIGN(base, alignment) != base || ALIGN(size, alignment) != size)
178 return -EINVAL;
179
180 /*
181 * Each reserved area must be initialised later, when more kernel
182 * subsystems (like slab allocator) are available.
183 */
184 cma = &cma_areas[cma_area_count];
185 cma->base_pfn = PFN_DOWN(base);
186 cma->count = size >> PAGE_SHIFT;
187 cma->order_per_bit = order_per_bit;
188 *res_cma = cma;
189 cma_area_count++;
190
191 return 0;
192}
193
a254129e
JK
194/**
195 * cma_declare_contiguous() - reserve custom contiguous area
a254129e 196 * @base: Base address of the reserved area optional, use 0 for any
c1f733aa 197 * @size: Size of the reserved area (in bytes),
a254129e
JK
198 * @limit: End address of the reserved memory (optional, 0 for any).
199 * @alignment: Alignment for the CMA area, should be power of 2 or zero
200 * @order_per_bit: Order of pages represented by one bit on bitmap.
a254129e 201 * @fixed: hint about where to place the reserved area
c1f733aa 202 * @res_cma: Pointer to store the created cma region.
a254129e
JK
203 *
204 * This function reserves memory from early allocator. It should be
205 * called by arch specific code once the early allocator (memblock or bootmem)
206 * has been activated and all other subsystems have already allocated/reserved
207 * memory. This function allows to create custom reserved areas.
208 *
209 * If @fixed is true, reserve contiguous area at exactly @base. If false,
210 * reserve in range from @base to @limit.
211 */
c1f733aa
JK
212int __init cma_declare_contiguous(phys_addr_t base,
213 phys_addr_t size, phys_addr_t limit,
a254129e 214 phys_addr_t alignment, unsigned int order_per_bit,
c1f733aa 215 bool fixed, struct cma **res_cma)
a254129e 216{
f7426b98
MS
217 phys_addr_t memblock_end = memblock_end_of_DRAM();
218 phys_addr_t highmem_start = __pa(high_memory);
a254129e
JK
219 int ret = 0;
220
221 pr_debug("%s(size %lx, base %08lx, limit %08lx alignment %08lx)\n",
222 __func__, (unsigned long)size, (unsigned long)base,
223 (unsigned long)limit, (unsigned long)alignment);
224
225 if (cma_area_count == ARRAY_SIZE(cma_areas)) {
226 pr_err("Not enough slots for CMA reserved regions!\n");
227 return -ENOSPC;
228 }
229
230 if (!size)
231 return -EINVAL;
232
233 if (alignment && !is_power_of_2(alignment))
234 return -EINVAL;
235
236 /*
237 * Sanitise input arguments.
238 * Pages both ends in CMA area could be merged into adjacent unmovable
239 * migratetype page by page allocator's buddy algorithm. In the case,
240 * you couldn't get a contiguous memory, which is not what we want.
241 */
242 alignment = max(alignment,
243 (phys_addr_t)PAGE_SIZE << max(MAX_ORDER - 1, pageblock_order));
244 base = ALIGN(base, alignment);
245 size = ALIGN(size, alignment);
246 limit &= ~(alignment - 1);
247
800a85d3
LP
248 if (!base)
249 fixed = false;
250
a254129e
JK
251 /* size should be aligned with order_per_bit */
252 if (!IS_ALIGNED(size >> PAGE_SHIFT, 1 << order_per_bit))
253 return -EINVAL;
254
f7426b98 255 /*
16195ddd
LP
256 * If allocating at a fixed base the request region must not cross the
257 * low/high memory boundary.
f7426b98 258 */
16195ddd 259 if (fixed && base < highmem_start && base + size > highmem_start) {
f7426b98
MS
260 ret = -EINVAL;
261 pr_err("Region at %08lx defined on low/high memory boundary (%08lx)\n",
262 (unsigned long)base, (unsigned long)highmem_start);
263 goto err;
264 }
265
16195ddd
LP
266 /*
267 * If the limit is unspecified or above the memblock end, its effective
268 * value will be the memblock end. Set it explicitly to simplify further
269 * checks.
270 */
271 if (limit == 0 || limit > memblock_end)
272 limit = memblock_end;
273
a254129e 274 /* Reserve memory */
800a85d3 275 if (fixed) {
a254129e
JK
276 if (memblock_is_region_reserved(base, size) ||
277 memblock_reserve(base, size) < 0) {
278 ret = -EBUSY;
279 goto err;
280 }
281 } else {
16195ddd
LP
282 phys_addr_t addr = 0;
283
284 /*
285 * All pages in the reserved area must come from the same zone.
286 * If the requested region crosses the low/high memory boundary,
287 * try allocating from high memory first and fall back to low
288 * memory in case of failure.
289 */
290 if (base < highmem_start && limit > highmem_start) {
291 addr = memblock_alloc_range(size, alignment,
292 highmem_start, limit);
293 limit = highmem_start;
294 }
295
a254129e 296 if (!addr) {
16195ddd
LP
297 addr = memblock_alloc_range(size, alignment, base,
298 limit);
299 if (!addr) {
300 ret = -ENOMEM;
301 goto err;
302 }
a254129e 303 }
16195ddd
LP
304
305 base = addr;
a254129e
JK
306 }
307
de9e14ee
MS
308 ret = cma_init_reserved_mem(base, size, order_per_bit, res_cma);
309 if (ret)
310 goto err;
a254129e 311
0de9d2eb 312 pr_info("Reserved %ld MiB at %08lx\n", (unsigned long)size / SZ_1M,
a254129e
JK
313 (unsigned long)base);
314 return 0;
315
316err:
0de9d2eb 317 pr_err("Failed to reserve %ld MiB\n", (unsigned long)size / SZ_1M);
a254129e
JK
318 return ret;
319}
320
321/**
322 * cma_alloc() - allocate pages from contiguous area
323 * @cma: Contiguous memory region for which the allocation is performed.
324 * @count: Requested number of pages.
325 * @align: Requested alignment of pages (in PAGE_SIZE order).
326 *
327 * This function allocates part of contiguous memory on specific
328 * contiguous memory area.
329 */
330struct page *cma_alloc(struct cma *cma, int count, unsigned int align)
331{
332 unsigned long mask, pfn, start = 0;
333 unsigned long bitmap_maxno, bitmap_no, bitmap_count;
334 struct page *page = NULL;
335 int ret;
336
337 if (!cma || !cma->count)
338 return NULL;
339
340 pr_debug("%s(cma %p, count %d, align %d)\n", __func__, (void *)cma,
341 count, align);
342
343 if (!count)
344 return NULL;
345
346 mask = cma_bitmap_aligned_mask(cma, align);
347 bitmap_maxno = cma_bitmap_maxno(cma);
348 bitmap_count = cma_bitmap_pages_to_bits(cma, count);
349
350 for (;;) {
351 mutex_lock(&cma->lock);
352 bitmap_no = bitmap_find_next_zero_area(cma->bitmap,
353 bitmap_maxno, start, bitmap_count, mask);
354 if (bitmap_no >= bitmap_maxno) {
355 mutex_unlock(&cma->lock);
356 break;
357 }
358 bitmap_set(cma->bitmap, bitmap_no, bitmap_count);
359 /*
360 * It's safe to drop the lock here. We've marked this region for
361 * our exclusive use. If the migration fails we will take the
362 * lock again and unmark it.
363 */
364 mutex_unlock(&cma->lock);
365
366 pfn = cma->base_pfn + (bitmap_no << cma->order_per_bit);
367 mutex_lock(&cma_mutex);
368 ret = alloc_contig_range(pfn, pfn + count, MIGRATE_CMA);
369 mutex_unlock(&cma_mutex);
370 if (ret == 0) {
371 page = pfn_to_page(pfn);
372 break;
a254129e 373 }
b7155e76 374
a254129e 375 cma_clear_bitmap(cma, pfn, count);
b7155e76
JK
376 if (ret != -EBUSY)
377 break;
378
a254129e
JK
379 pr_debug("%s(): memory range at %p is busy, retrying\n",
380 __func__, pfn_to_page(pfn));
381 /* try again with a bit different memory target */
382 start = bitmap_no + mask + 1;
383 }
384
385 pr_debug("%s(): returned %p\n", __func__, page);
386 return page;
387}
388
389/**
390 * cma_release() - release allocated pages
391 * @cma: Contiguous memory region for which the allocation is performed.
392 * @pages: Allocated pages.
393 * @count: Number of allocated pages.
394 *
395 * This function releases memory allocated by alloc_cma().
396 * It returns false when provided pages do not belong to contiguous area and
397 * true otherwise.
398 */
399bool cma_release(struct cma *cma, struct page *pages, int count)
400{
401 unsigned long pfn;
402
403 if (!cma || !pages)
404 return false;
405
406 pr_debug("%s(page %p)\n", __func__, (void *)pages);
407
408 pfn = page_to_pfn(pages);
409
410 if (pfn < cma->base_pfn || pfn >= cma->base_pfn + cma->count)
411 return false;
412
413 VM_BUG_ON(pfn + count > cma->base_pfn + cma->count);
414
415 free_contig_range(pfn, count);
416 cma_clear_bitmap(cma, pfn, count);
417
418 return true;
419}