]> git.ipfire.org Git - people/arne_f/kernel.git/blame - kernel/memremap.c
scsi: pm8001: Fix memleak in pm8001_exec_internal_task_abort
[people/arne_f/kernel.git] / kernel / memremap.c
CommitLineData
92281dee
DW
1/*
2 * Copyright(c) 2015 Intel Corporation. All rights reserved.
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of version 2 of the GNU General Public License as
6 * published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
12 */
9476df7d 13#include <linux/radix-tree.h>
7d3dcf26 14#include <linux/device.h>
92281dee 15#include <linux/types.h>
34c0fd54 16#include <linux/pfn_t.h>
92281dee
DW
17#include <linux/io.h>
18#include <linux/mm.h>
41e94a85 19#include <linux/memory_hotplug.h>
5042db43
JG
20#include <linux/swap.h>
21#include <linux/swapops.h>
92281dee
DW
22
23#ifndef ioremap_cache
24/* temporary while we convert existing ioremap_cache users to memremap */
25__weak void __iomem *ioremap_cache(resource_size_t offset, unsigned long size)
26{
27 return ioremap(offset, size);
28}
29#endif
30
c269cba3
AB
31#ifndef arch_memremap_wb
32static void *arch_memremap_wb(resource_size_t offset, unsigned long size)
33{
34 return (__force void *)ioremap_cache(offset, size);
35}
36#endif
37
8f716c9b
TL
38#ifndef arch_memremap_can_ram_remap
39static bool arch_memremap_can_ram_remap(resource_size_t offset, size_t size,
40 unsigned long flags)
41{
42 return true;
43}
44#endif
45
46static void *try_ram_remap(resource_size_t offset, size_t size,
47 unsigned long flags)
182475b7 48{
ac343e88 49 unsigned long pfn = PHYS_PFN(offset);
182475b7
DW
50
51 /* In the simple case just return the existing linear address */
8f716c9b
TL
52 if (pfn_valid(pfn) && !PageHighMem(pfn_to_page(pfn)) &&
53 arch_memremap_can_ram_remap(offset, size, flags))
182475b7 54 return __va(offset);
8f716c9b 55
c269cba3 56 return NULL; /* fallback to arch_memremap_wb */
182475b7
DW
57}
58
92281dee
DW
59/**
60 * memremap() - remap an iomem_resource as cacheable memory
61 * @offset: iomem resource start address
62 * @size: size of remap
8f716c9b
TL
63 * @flags: any of MEMREMAP_WB, MEMREMAP_WT, MEMREMAP_WC,
64 * MEMREMAP_ENC, MEMREMAP_DEC
92281dee
DW
65 *
66 * memremap() is "ioremap" for cases where it is known that the resource
67 * being mapped does not have i/o side effects and the __iomem
c907e0eb
BS
68 * annotation is not applicable. In the case of multiple flags, the different
69 * mapping types will be attempted in the order listed below until one of
70 * them succeeds.
92281dee 71 *
1c29f25b 72 * MEMREMAP_WB - matches the default mapping for System RAM on
92281dee
DW
73 * the architecture. This is usually a read-allocate write-back cache.
74 * Morever, if MEMREMAP_WB is specified and the requested remap region is RAM
75 * memremap() will bypass establishing a new mapping and instead return
76 * a pointer into the direct map.
77 *
78 * MEMREMAP_WT - establish a mapping whereby writes either bypass the
79 * cache or are written through to memory and never exist in a
80 * cache-dirty state with respect to program visibility. Attempts to
1c29f25b 81 * map System RAM with this mapping type will fail.
c907e0eb
BS
82 *
83 * MEMREMAP_WC - establish a writecombine mapping, whereby writes may
84 * be coalesced together (e.g. in the CPU's write buffers), but is otherwise
85 * uncached. Attempts to map System RAM with this mapping type will fail.
92281dee
DW
86 */
87void *memremap(resource_size_t offset, size_t size, unsigned long flags)
88{
1c29f25b
TK
89 int is_ram = region_intersects(offset, size,
90 IORESOURCE_SYSTEM_RAM, IORES_DESC_NONE);
92281dee
DW
91 void *addr = NULL;
92
cf61e2a1
BS
93 if (!flags)
94 return NULL;
95
92281dee
DW
96 if (is_ram == REGION_MIXED) {
97 WARN_ONCE(1, "memremap attempted on mixed range %pa size: %#lx\n",
98 &offset, (unsigned long) size);
99 return NULL;
100 }
101
102 /* Try all mapping types requested until one returns non-NULL */
103 if (flags & MEMREMAP_WB) {
92281dee
DW
104 /*
105 * MEMREMAP_WB is special in that it can be satisifed
106 * from the direct map. Some archs depend on the
107 * capability of memremap() to autodetect cases where
1c29f25b 108 * the requested range is potentially in System RAM.
92281dee
DW
109 */
110 if (is_ram == REGION_INTERSECTS)
8f716c9b 111 addr = try_ram_remap(offset, size, flags);
182475b7 112 if (!addr)
c269cba3 113 addr = arch_memremap_wb(offset, size);
92281dee
DW
114 }
115
116 /*
cf61e2a1
BS
117 * If we don't have a mapping yet and other request flags are
118 * present then we will be attempting to establish a new virtual
92281dee 119 * address mapping. Enforce that this mapping is not aliasing
1c29f25b 120 * System RAM.
92281dee 121 */
cf61e2a1 122 if (!addr && is_ram == REGION_INTERSECTS && flags != MEMREMAP_WB) {
92281dee
DW
123 WARN_ONCE(1, "memremap attempted on ram %pa size: %#lx\n",
124 &offset, (unsigned long) size);
125 return NULL;
126 }
127
cf61e2a1 128 if (!addr && (flags & MEMREMAP_WT))
92281dee 129 addr = ioremap_wt(offset, size);
c907e0eb
BS
130
131 if (!addr && (flags & MEMREMAP_WC))
132 addr = ioremap_wc(offset, size);
92281dee
DW
133
134 return addr;
135}
136EXPORT_SYMBOL(memremap);
137
138void memunmap(void *addr)
139{
140 if (is_vmalloc_addr(addr))
141 iounmap((void __iomem *) addr);
142}
143EXPORT_SYMBOL(memunmap);
7d3dcf26
CH
144
145static void devm_memremap_release(struct device *dev, void *res)
146{
9273a8bb 147 memunmap(*(void **)res);
7d3dcf26
CH
148}
149
150static int devm_memremap_match(struct device *dev, void *res, void *match_data)
151{
152 return *(void **)res == match_data;
153}
154
155void *devm_memremap(struct device *dev, resource_size_t offset,
156 size_t size, unsigned long flags)
157{
158 void **ptr, *addr;
159
538ea4aa
DW
160 ptr = devres_alloc_node(devm_memremap_release, sizeof(*ptr), GFP_KERNEL,
161 dev_to_node(dev));
7d3dcf26 162 if (!ptr)
b36f4761 163 return ERR_PTR(-ENOMEM);
7d3dcf26
CH
164
165 addr = memremap(offset, size, flags);
166 if (addr) {
167 *ptr = addr;
168 devres_add(dev, ptr);
93f834df 169 } else {
7d3dcf26 170 devres_free(ptr);
93f834df
TK
171 return ERR_PTR(-ENXIO);
172 }
7d3dcf26
CH
173
174 return addr;
175}
176EXPORT_SYMBOL(devm_memremap);
177
178void devm_memunmap(struct device *dev, void *addr)
179{
d741314f
DW
180 WARN_ON(devres_release(dev, devm_memremap_release,
181 devm_memremap_match, addr));
7d3dcf26
CH
182}
183EXPORT_SYMBOL(devm_memunmap);
41e94a85
CH
184
185#ifdef CONFIG_ZONE_DEVICE
9476df7d
DW
186static DEFINE_MUTEX(pgmap_lock);
187static RADIX_TREE(pgmap_radix, GFP_KERNEL);
188#define SECTION_MASK ~((1UL << PA_SECTION_SHIFT) - 1)
189#define SECTION_SIZE (1UL << PA_SECTION_SHIFT)
190
41e94a85
CH
191struct page_map {
192 struct resource res;
9476df7d
DW
193 struct percpu_ref *ref;
194 struct dev_pagemap pgmap;
4b94ffdc 195 struct vmem_altmap altmap;
41e94a85
CH
196};
197
ab1b597e 198static unsigned long order_at(struct resource *res, unsigned long pgoff)
9476df7d 199{
ab1b597e
DW
200 unsigned long phys_pgoff = PHYS_PFN(res->start) + pgoff;
201 unsigned long nr_pages, mask;
eb7d78c9 202
ab1b597e
DW
203 nr_pages = PHYS_PFN(resource_size(res));
204 if (nr_pages == pgoff)
205 return ULONG_MAX;
206
207 /*
208 * What is the largest aligned power-of-2 range available from
209 * this resource pgoff to the end of the resource range,
210 * considering the alignment of the current pgoff?
211 */
212 mask = phys_pgoff | rounddown_pow_of_two(nr_pages - pgoff);
213 if (!mask)
214 return ULONG_MAX;
215
216 return find_first_bit(&mask, BITS_PER_LONG);
217}
218
219#define foreach_order_pgoff(res, order, pgoff) \
220 for (pgoff = 0, order = order_at((res), pgoff); order < ULONG_MAX; \
221 pgoff += 1UL << order, order = order_at((res), pgoff))
222
5042db43
JG
223#if IS_ENABLED(CONFIG_DEVICE_PRIVATE)
224int device_private_entry_fault(struct vm_area_struct *vma,
225 unsigned long addr,
226 swp_entry_t entry,
227 unsigned int flags,
228 pmd_t *pmdp)
229{
230 struct page *page = device_private_entry_to_page(entry);
231
232 /*
233 * The page_fault() callback must migrate page back to system memory
234 * so that CPU can access it. This might fail for various reasons
235 * (device issue, device was unsafely unplugged, ...). When such
236 * error conditions happen, the callback must return VM_FAULT_SIGBUS.
237 *
238 * Note that because memory cgroup charges are accounted to the device
239 * memory, this should never fail because of memory restrictions (but
240 * allocation of regular system page might still fail because we are
241 * out of memory).
242 *
243 * There is a more in-depth description of what that callback can and
244 * cannot do, in include/linux/memremap.h
245 */
246 return page->pgmap->page_fault(vma, addr, page, flags, pmdp);
247}
248EXPORT_SYMBOL(device_private_entry_fault);
249#endif /* CONFIG_DEVICE_PRIVATE */
250
801fc191 251static void pgmap_radix_release(struct resource *res, unsigned long end_pgoff)
ab1b597e
DW
252{
253 unsigned long pgoff, order;
9476df7d
DW
254
255 mutex_lock(&pgmap_lock);
801fc191
JS
256 foreach_order_pgoff(res, order, pgoff) {
257 if (pgoff >= end_pgoff)
258 break;
ab1b597e 259 radix_tree_delete(&pgmap_radix, PHYS_PFN(res->start) + pgoff);
801fc191 260 }
9476df7d 261 mutex_unlock(&pgmap_lock);
ab1b597e
DW
262
263 synchronize_rcu();
9476df7d
DW
264}
265
5c2c2587
DW
266static unsigned long pfn_first(struct page_map *page_map)
267{
268 struct dev_pagemap *pgmap = &page_map->pgmap;
269 const struct resource *res = &page_map->res;
270 struct vmem_altmap *altmap = pgmap->altmap;
271 unsigned long pfn;
272
273 pfn = res->start >> PAGE_SHIFT;
274 if (altmap)
275 pfn += vmem_altmap_offset(altmap);
276 return pfn;
277}
278
279static unsigned long pfn_end(struct page_map *page_map)
280{
281 const struct resource *res = &page_map->res;
282
283 return (res->start + resource_size(res)) >> PAGE_SHIFT;
284}
285
286#define for_each_device_pfn(pfn, map) \
287 for (pfn = pfn_first(map); pfn < pfn_end(map); pfn++)
288
9476df7d 289static void devm_memremap_pages_release(struct device *dev, void *data)
41e94a85 290{
9476df7d
DW
291 struct page_map *page_map = data;
292 struct resource *res = &page_map->res;
293 resource_size_t align_start, align_size;
4b94ffdc 294 struct dev_pagemap *pgmap = &page_map->pgmap;
71389703
DW
295 unsigned long pfn;
296
297 for_each_device_pfn(pfn, page_map)
298 put_page(pfn_to_page(pfn));
9476df7d 299
5c2c2587
DW
300 if (percpu_ref_tryget_live(pgmap->ref)) {
301 dev_WARN(dev, "%s: page mapping is still live!\n", __func__);
302 percpu_ref_put(pgmap->ref);
303 }
304
41e94a85 305 /* pages are dead and unused, undo the arch mapping */
9476df7d 306 align_start = res->start & ~(SECTION_SIZE - 1);
1f21cd46
JS
307 align_size = ALIGN(res->start + resource_size(res), SECTION_SIZE)
308 - align_start;
b5d24fda 309
f931ab47 310 mem_hotplug_begin();
9476df7d 311 arch_remove_memory(align_start, align_size);
f931ab47 312 mem_hotplug_done();
b5d24fda 313
9049771f 314 untrack_pfn(NULL, PHYS_PFN(align_start), align_size);
801fc191 315 pgmap_radix_release(res, -1);
4b94ffdc
DW
316 dev_WARN_ONCE(dev, pgmap->altmap && pgmap->altmap->alloc,
317 "%s: failed to free all reserved pages\n", __func__);
9476df7d
DW
318}
319
320/* assumes rcu_read_lock() held at entry */
321struct dev_pagemap *find_dev_pagemap(resource_size_t phys)
322{
323 struct page_map *page_map;
324
325 WARN_ON_ONCE(!rcu_read_lock_held());
326
ab1b597e 327 page_map = radix_tree_lookup(&pgmap_radix, PHYS_PFN(phys));
9476df7d 328 return page_map ? &page_map->pgmap : NULL;
41e94a85
CH
329}
330
4b94ffdc
DW
331/**
332 * devm_memremap_pages - remap and provide memmap backing for the given resource
333 * @dev: hosting device for @res
334 * @res: "host memory" address range
5c2c2587 335 * @ref: a live per-cpu reference count
4b94ffdc
DW
336 * @altmap: optional descriptor for allocating the memmap from @res
337 *
5c2c2587
DW
338 * Notes:
339 * 1/ @ref must be 'live' on entry and 'dead' before devm_memunmap_pages() time
71389703
DW
340 * (or devm release event). The expected order of events is that @ref has
341 * been through percpu_ref_kill() before devm_memremap_pages_release(). The
342 * wait for the completion of all references being dropped and
343 * percpu_ref_exit() must occur after devm_memremap_pages_release().
5c2c2587
DW
344 *
345 * 2/ @res is expected to be a host memory range that could feasibly be
346 * treated as a "System RAM" range, i.e. not a device mmio range, but
347 * this is not enforced.
4b94ffdc
DW
348 */
349void *devm_memremap_pages(struct device *dev, struct resource *res,
5c2c2587 350 struct percpu_ref *ref, struct vmem_altmap *altmap)
41e94a85 351{
ab1b597e
DW
352 resource_size_t align_start, align_size, align_end;
353 unsigned long pfn, pgoff, order;
9049771f 354 pgprot_t pgprot = PAGE_KERNEL;
4b94ffdc 355 struct dev_pagemap *pgmap;
41e94a85 356 struct page_map *page_map;
1fdcce6e 357 int error, nid, is_ram, i = 0;
2a797fd8 358 struct dev_pagemap *conflict_pgmap;
5f29a77c
DW
359
360 align_start = res->start & ~(SECTION_SIZE - 1);
361 align_size = ALIGN(res->start + resource_size(res), SECTION_SIZE)
362 - align_start;
2a797fd8
DJ
363 align_end = align_start + align_size - 1;
364
365 conflict_pgmap = get_dev_pagemap(PHYS_PFN(align_start), NULL);
366 if (conflict_pgmap) {
367 dev_WARN(dev, "Conflicting mapping in same section\n");
368 put_dev_pagemap(conflict_pgmap);
369 return ERR_PTR(-ENOMEM);
370 }
371
372 conflict_pgmap = get_dev_pagemap(PHYS_PFN(align_end), NULL);
373 if (conflict_pgmap) {
374 dev_WARN(dev, "Conflicting mapping in same section\n");
375 put_dev_pagemap(conflict_pgmap);
376 return ERR_PTR(-ENOMEM);
377 }
378
d37a14bb
LT
379 is_ram = region_intersects(align_start, align_size,
380 IORESOURCE_SYSTEM_RAM, IORES_DESC_NONE);
41e94a85 381
14327542
DW
382 if (is_ram != REGION_DISJOINT) {
383 WARN_ONCE(1, "%s attempted on %s region %pr\n", __func__,
384 is_ram == REGION_MIXED ? "mixed" : "ram", res);
41e94a85
CH
385 return ERR_PTR(-ENXIO);
386 }
387
5c2c2587
DW
388 if (!ref)
389 return ERR_PTR(-EINVAL);
390
538ea4aa
DW
391 page_map = devres_alloc_node(devm_memremap_pages_release,
392 sizeof(*page_map), GFP_KERNEL, dev_to_node(dev));
41e94a85
CH
393 if (!page_map)
394 return ERR_PTR(-ENOMEM);
4b94ffdc 395 pgmap = &page_map->pgmap;
41e94a85
CH
396
397 memcpy(&page_map->res, res, sizeof(*res));
398
4b94ffdc
DW
399 pgmap->dev = dev;
400 if (altmap) {
401 memcpy(&page_map->altmap, altmap, sizeof(*altmap));
402 pgmap->altmap = &page_map->altmap;
403 }
5c2c2587 404 pgmap->ref = ref;
4b94ffdc 405 pgmap->res = &page_map->res;
5042db43
JG
406 pgmap->type = MEMORY_DEVICE_HOST;
407 pgmap->page_fault = NULL;
408 pgmap->page_free = NULL;
409 pgmap->data = NULL;
4b94ffdc 410
9476df7d
DW
411 mutex_lock(&pgmap_lock);
412 error = 0;
ab1b597e
DW
413
414 foreach_order_pgoff(res, order, pgoff) {
9476df7d
DW
415 struct dev_pagemap *dup;
416
417 rcu_read_lock();
ab1b597e 418 dup = find_dev_pagemap(res->start + PFN_PHYS(pgoff));
9476df7d
DW
419 rcu_read_unlock();
420 if (dup) {
421 dev_err(dev, "%s: %pr collides with mapping for %s\n",
422 __func__, res, dev_name(dup->dev));
423 error = -EBUSY;
424 break;
425 }
ab1b597e
DW
426 error = __radix_tree_insert(&pgmap_radix,
427 PHYS_PFN(res->start) + pgoff, order, page_map);
9476df7d
DW
428 if (error) {
429 dev_err(dev, "%s: failed: %d\n", __func__, error);
430 break;
431 }
432 }
433 mutex_unlock(&pgmap_lock);
434 if (error)
435 goto err_radix;
436
41e94a85
CH
437 nid = dev_to_node(dev);
438 if (nid < 0)
7eff93b7 439 nid = numa_mem_id();
41e94a85 440
9049771f
DW
441 error = track_pfn_remap(NULL, &pgprot, PHYS_PFN(align_start), 0,
442 align_size);
443 if (error)
444 goto err_pfn_remap;
445
f931ab47 446 mem_hotplug_begin();
3d79a728 447 error = arch_add_memory(nid, align_start, align_size, false);
f1dd2cd1
MH
448 if (!error)
449 move_pfn_range_to_zone(&NODE_DATA(nid)->node_zones[ZONE_DEVICE],
450 align_start >> PAGE_SHIFT,
451 align_size >> PAGE_SHIFT);
f931ab47 452 mem_hotplug_done();
9476df7d
DW
453 if (error)
454 goto err_add_memory;
41e94a85 455
5c2c2587
DW
456 for_each_device_pfn(pfn, page_map) {
457 struct page *page = pfn_to_page(pfn);
458
d77a117e
DW
459 /*
460 * ZONE_DEVICE pages union ->lru with a ->pgmap back
461 * pointer. It is a bug if a ZONE_DEVICE page is ever
462 * freed or placed on a driver-private list. Seed the
463 * storage with LIST_POISON* values.
464 */
465 list_del(&page->lru);
5c2c2587 466 page->pgmap = pgmap;
71389703 467 percpu_ref_get(ref);
1fdcce6e
MH
468 if (!(++i % 1024))
469 cond_resched();
5c2c2587 470 }
41e94a85
CH
471 devres_add(dev, page_map);
472 return __va(res->start);
9476df7d
DW
473
474 err_add_memory:
9049771f
DW
475 untrack_pfn(NULL, PHYS_PFN(align_start), align_size);
476 err_pfn_remap:
9476df7d 477 err_radix:
801fc191 478 pgmap_radix_release(res, pgoff);
9476df7d
DW
479 devres_free(page_map);
480 return ERR_PTR(error);
41e94a85 481}
47d24f8c 482EXPORT_SYMBOL_GPL(devm_memremap_pages);
4b94ffdc
DW
483
484unsigned long vmem_altmap_offset(struct vmem_altmap *altmap)
485{
486 /* number of pfns from base where pfn_to_page() is valid */
487 return altmap->reserve + altmap->free;
488}
489
490void vmem_altmap_free(struct vmem_altmap *altmap, unsigned long nr_pfns)
491{
492 altmap->alloc -= nr_pfns;
493}
494
4b94ffdc
DW
495struct vmem_altmap *to_vmem_altmap(unsigned long memmap_start)
496{
497 /*
498 * 'memmap_start' is the virtual address for the first "struct
499 * page" in this range of the vmemmap array. In the case of
07061aab 500 * CONFIG_SPARSEMEM_VMEMMAP a page_to_pfn conversion is simple
4b94ffdc
DW
501 * pointer arithmetic, so we can perform this to_vmem_altmap()
502 * conversion without concern for the initialization state of
503 * the struct page fields.
504 */
505 struct page *page = (struct page *) memmap_start;
506 struct dev_pagemap *pgmap;
507
508 /*
07061aab 509 * Unconditionally retrieve a dev_pagemap associated with the
4b94ffdc
DW
510 * given physical address, this is only for use in the
511 * arch_{add|remove}_memory() for setting up and tearing down
512 * the memmap.
513 */
514 rcu_read_lock();
515 pgmap = find_dev_pagemap(__pfn_to_phys(page_to_pfn(page)));
516 rcu_read_unlock();
517
518 return pgmap ? pgmap->altmap : NULL;
519}
41e94a85 520#endif /* CONFIG_ZONE_DEVICE */
7b2d55d2
JG
521
522
df6ad698
JG
523#if IS_ENABLED(CONFIG_DEVICE_PRIVATE) || IS_ENABLED(CONFIG_DEVICE_PUBLIC)
524void put_zone_device_private_or_public_page(struct page *page)
7b2d55d2
JG
525{
526 int count = page_ref_dec_return(page);
527
528 /*
529 * If refcount is 1 then page is freed and refcount is stable as nobody
530 * holds a reference on the page.
531 */
532 if (count == 1) {
533 /* Clear Active bit in case of parallel mark_page_accessed */
534 __ClearPageActive(page);
535 __ClearPageWaiters(page);
536
537 page->mapping = NULL;
c733a828 538 mem_cgroup_uncharge(page);
7b2d55d2
JG
539
540 page->pgmap->page_free(page, page->pgmap->data);
541 } else if (!count)
542 __put_page(page);
543}
df6ad698
JG
544EXPORT_SYMBOL(put_zone_device_private_or_public_page);
545#endif /* CONFIG_DEVICE_PRIVATE || CONFIG_DEVICE_PUBLIC */