opp: Attach genpds to devices from within OPP core
[linux-2.6-block.git] / kernel / memremap.c
CommitLineData
5981690d
DW
1/* SPDX-License-Identifier: GPL-2.0 */
2/* Copyright(c) 2015 Intel Corporation. All rights reserved. */
7d3dcf26 3#include <linux/device.h>
92281dee 4#include <linux/io.h>
0207df4f 5#include <linux/kasan.h>
41e94a85 6#include <linux/memory_hotplug.h>
bcfa4b72
MW
7#include <linux/mm.h>
8#include <linux/pfn_t.h>
5042db43
JG
9#include <linux/swap.h>
10#include <linux/swapops.h>
bcfa4b72 11#include <linux/types.h>
e7638488 12#include <linux/wait_bit.h>
bcfa4b72 13#include <linux/xarray.h>
063a7d1d 14#include <linux/hmm.h>
92281dee 15
bcfa4b72 16static DEFINE_XARRAY(pgmap_array);
9476df7d
DW
17#define SECTION_MASK ~((1UL << PA_SECTION_SHIFT) - 1)
18#define SECTION_SIZE (1UL << PA_SECTION_SHIFT)
19
5042db43 20#if IS_ENABLED(CONFIG_DEVICE_PRIVATE)
2b740303 21vm_fault_t device_private_entry_fault(struct vm_area_struct *vma,
5042db43
JG
22 unsigned long addr,
23 swp_entry_t entry,
24 unsigned int flags,
25 pmd_t *pmdp)
26{
27 struct page *page = device_private_entry_to_page(entry);
063a7d1d
DW
28 struct hmm_devmem *devmem;
29
30 devmem = container_of(page->pgmap, typeof(*devmem), pagemap);
5042db43
JG
31
32 /*
33 * The page_fault() callback must migrate page back to system memory
34 * so that CPU can access it. This might fail for various reasons
35 * (device issue, device was unsafely unplugged, ...). When such
36 * error conditions happen, the callback must return VM_FAULT_SIGBUS.
37 *
38 * Note that because memory cgroup charges are accounted to the device
39 * memory, this should never fail because of memory restrictions (but
40 * allocation of regular system page might still fail because we are
41 * out of memory).
42 *
43 * There is a more in-depth description of what that callback can and
44 * cannot do, in include/linux/memremap.h
45 */
063a7d1d 46 return devmem->page_fault(vma, addr, page, flags, pmdp);
5042db43 47}
5042db43
JG
48#endif /* CONFIG_DEVICE_PRIVATE */
49
bcfa4b72 50static void pgmap_array_delete(struct resource *res)
ab1b597e 51{
bcfa4b72
MW
52 xa_store_range(&pgmap_array, PHYS_PFN(res->start), PHYS_PFN(res->end),
53 NULL, GFP_KERNEL);
ab1b597e 54 synchronize_rcu();
9476df7d
DW
55}
56
e7744aa2 57static unsigned long pfn_first(struct dev_pagemap *pgmap)
5c2c2587 58{
e7744aa2
LG
59 const struct resource *res = &pgmap->res;
60 struct vmem_altmap *altmap = &pgmap->altmap;
5c2c2587
DW
61 unsigned long pfn;
62
63 pfn = res->start >> PAGE_SHIFT;
e7744aa2 64 if (pgmap->altmap_valid)
5c2c2587
DW
65 pfn += vmem_altmap_offset(altmap);
66 return pfn;
67}
68
e7744aa2 69static unsigned long pfn_end(struct dev_pagemap *pgmap)
5c2c2587 70{
e7744aa2 71 const struct resource *res = &pgmap->res;
5c2c2587
DW
72
73 return (res->start + resource_size(res)) >> PAGE_SHIFT;
74}
75
949b9325
DW
76static unsigned long pfn_next(unsigned long pfn)
77{
78 if (pfn % 1024 == 0)
79 cond_resched();
80 return pfn + 1;
81}
82
5c2c2587 83#define for_each_device_pfn(pfn, map) \
949b9325 84 for (pfn = pfn_first(map); pfn < pfn_end(map); pfn = pfn_next(pfn))
5c2c2587 85
e8d51348 86static void devm_memremap_pages_release(void *data)
41e94a85 87{
e7744aa2 88 struct dev_pagemap *pgmap = data;
e8d51348 89 struct device *dev = pgmap->dev;
e7744aa2 90 struct resource *res = &pgmap->res;
9476df7d 91 resource_size_t align_start, align_size;
71389703 92 unsigned long pfn;
2c2a5af6 93 int nid;
71389703 94
a95c90f1 95 pgmap->kill(pgmap->ref);
e7744aa2 96 for_each_device_pfn(pfn, pgmap)
71389703 97 put_page(pfn_to_page(pfn));
9476df7d 98
41e94a85 99 /* pages are dead and unused, undo the arch mapping */
9476df7d 100 align_start = res->start & ~(SECTION_SIZE - 1);
10a0cd6e
JS
101 align_size = ALIGN(res->start + resource_size(res), SECTION_SIZE)
102 - align_start;
b5d24fda 103
2c2a5af6
OS
104 nid = page_to_nid(pfn_to_page(align_start >> PAGE_SHIFT));
105
f931ab47 106 mem_hotplug_begin();
69324b8f
DW
107 if (pgmap->type == MEMORY_DEVICE_PRIVATE) {
108 pfn = align_start >> PAGE_SHIFT;
109 __remove_pages(page_zone(pfn_to_page(pfn)), pfn,
110 align_size >> PAGE_SHIFT, NULL);
111 } else {
2c2a5af6 112 arch_remove_memory(nid, align_start, align_size,
69324b8f
DW
113 pgmap->altmap_valid ? &pgmap->altmap : NULL);
114 kasan_remove_zero_shadow(__va(align_start), align_size);
115 }
f931ab47 116 mem_hotplug_done();
b5d24fda 117
9049771f 118 untrack_pfn(NULL, PHYS_PFN(align_start), align_size);
bcfa4b72 119 pgmap_array_delete(res);
e7744aa2
LG
120 dev_WARN_ONCE(dev, pgmap->altmap.alloc,
121 "%s: failed to free all reserved pages\n", __func__);
9476df7d
DW
122}
123
4b94ffdc
DW
124/**
125 * devm_memremap_pages - remap and provide memmap backing for the given resource
126 * @dev: hosting device for @res
a95c90f1 127 * @pgmap: pointer to a struct dev_pagemap
4b94ffdc 128 *
5c2c2587 129 * Notes:
e8d51348
CH
130 * 1/ At a minimum the res, ref and type members of @pgmap must be initialized
131 * by the caller before passing it to this function
132 *
133 * 2/ The altmap field may optionally be initialized, in which case altmap_valid
134 * must be set to true
135 *
a95c90f1
DW
136 * 3/ pgmap->ref must be 'live' on entry and will be killed at
137 * devm_memremap_pages_release() time, or if this routine fails.
5c2c2587 138 *
e8d51348 139 * 4/ res is expected to be a host memory range that could feasibly be
5c2c2587
DW
140 * treated as a "System RAM" range, i.e. not a device mmio range, but
141 * this is not enforced.
4b94ffdc 142 */
e8d51348 143void *devm_memremap_pages(struct device *dev, struct dev_pagemap *pgmap)
41e94a85 144{
ab1b597e 145 resource_size_t align_start, align_size, align_end;
e8d51348
CH
146 struct vmem_altmap *altmap = pgmap->altmap_valid ?
147 &pgmap->altmap : NULL;
949b9325 148 struct resource *res = &pgmap->res;
966cf44f 149 struct dev_pagemap *conflict_pgmap;
940519f0
MH
150 struct mhp_restrictions restrictions = {
151 /*
152 * We do not want any optional features only our own memmap
153 */
154 .altmap = altmap,
155 };
9049771f 156 pgprot_t pgprot = PAGE_KERNEL;
949b9325 157 int error, nid, is_ram;
5f29a77c 158
a95c90f1
DW
159 if (!pgmap->ref || !pgmap->kill)
160 return ERR_PTR(-EINVAL);
161
5f29a77c
DW
162 align_start = res->start & ~(SECTION_SIZE - 1);
163 align_size = ALIGN(res->start + resource_size(res), SECTION_SIZE)
164 - align_start;
15d36fec
DJ
165 align_end = align_start + align_size - 1;
166
167 conflict_pgmap = get_dev_pagemap(PHYS_PFN(align_start), NULL);
168 if (conflict_pgmap) {
169 dev_WARN(dev, "Conflicting mapping in same section\n");
170 put_dev_pagemap(conflict_pgmap);
171 return ERR_PTR(-ENOMEM);
172 }
173
174 conflict_pgmap = get_dev_pagemap(PHYS_PFN(align_end), NULL);
175 if (conflict_pgmap) {
176 dev_WARN(dev, "Conflicting mapping in same section\n");
177 put_dev_pagemap(conflict_pgmap);
178 return ERR_PTR(-ENOMEM);
179 }
180
d37a14bb
LT
181 is_ram = region_intersects(align_start, align_size,
182 IORESOURCE_SYSTEM_RAM, IORES_DESC_NONE);
41e94a85 183
06489cfb
DW
184 if (is_ram != REGION_DISJOINT) {
185 WARN_ONCE(1, "%s attempted on %s region %pr\n", __func__,
186 is_ram == REGION_MIXED ? "mixed" : "ram", res);
a95c90f1
DW
187 error = -ENXIO;
188 goto err_array;
41e94a85
CH
189 }
190
4b94ffdc 191 pgmap->dev = dev;
4b94ffdc 192
bcfa4b72
MW
193 error = xa_err(xa_store_range(&pgmap_array, PHYS_PFN(res->start),
194 PHYS_PFN(res->end), pgmap, GFP_KERNEL));
9476df7d 195 if (error)
bcfa4b72 196 goto err_array;
9476df7d 197
41e94a85
CH
198 nid = dev_to_node(dev);
199 if (nid < 0)
7eff93b7 200 nid = numa_mem_id();
41e94a85 201
9049771f
DW
202 error = track_pfn_remap(NULL, &pgprot, PHYS_PFN(align_start), 0,
203 align_size);
204 if (error)
205 goto err_pfn_remap;
206
f931ab47 207 mem_hotplug_begin();
69324b8f
DW
208
209 /*
210 * For device private memory we call add_pages() as we only need to
211 * allocate and initialize struct page for the device memory. More-
212 * over the device memory is un-accessible thus we do not want to
213 * create a linear mapping for the memory like arch_add_memory()
214 * would do.
215 *
216 * For all other device memory types, which are accessible by
217 * the CPU, we do want the linear mapping and thus use
218 * arch_add_memory().
219 */
220 if (pgmap->type == MEMORY_DEVICE_PRIVATE) {
221 error = add_pages(nid, align_start >> PAGE_SHIFT,
940519f0 222 align_size >> PAGE_SHIFT, &restrictions);
69324b8f
DW
223 } else {
224 error = kasan_add_zero_shadow(__va(align_start), align_size);
225 if (error) {
226 mem_hotplug_done();
227 goto err_kasan;
228 }
229
940519f0
MH
230 error = arch_add_memory(nid, align_start, align_size,
231 &restrictions);
69324b8f
DW
232 }
233
234 if (!error) {
235 struct zone *zone;
236
237 zone = &NODE_DATA(nid)->node_zones[ZONE_DEVICE];
238 move_pfn_range_to_zone(zone, align_start >> PAGE_SHIFT,
239 align_size >> PAGE_SHIFT, altmap);
0207df4f
AR
240 }
241
f931ab47 242 mem_hotplug_done();
9476df7d
DW
243 if (error)
244 goto err_add_memory;
41e94a85 245
966cf44f
AD
246 /*
247 * Initialization of the pages has been deferred until now in order
248 * to allow us to do the work while not holding the hotplug lock.
249 */
250 memmap_init_zone_device(&NODE_DATA(nid)->node_zones[ZONE_DEVICE],
251 align_start >> PAGE_SHIFT,
252 align_size >> PAGE_SHIFT, pgmap);
253 percpu_ref_get_many(pgmap->ref, pfn_end(pgmap) - pfn_first(pgmap));
e8d51348 254
a95c90f1
DW
255 error = devm_add_action_or_reset(dev, devm_memremap_pages_release,
256 pgmap);
257 if (error)
258 return ERR_PTR(error);
e8d51348 259
41e94a85 260 return __va(res->start);
9476df7d
DW
261
262 err_add_memory:
0207df4f
AR
263 kasan_remove_zero_shadow(__va(align_start), align_size);
264 err_kasan:
9049771f
DW
265 untrack_pfn(NULL, PHYS_PFN(align_start), align_size);
266 err_pfn_remap:
bcfa4b72
MW
267 pgmap_array_delete(res);
268 err_array:
a95c90f1 269 pgmap->kill(pgmap->ref);
9476df7d 270 return ERR_PTR(error);
41e94a85 271}
808153e1 272EXPORT_SYMBOL_GPL(devm_memremap_pages);
4b94ffdc
DW
273
274unsigned long vmem_altmap_offset(struct vmem_altmap *altmap)
275{
276 /* number of pfns from base where pfn_to_page() is valid */
277 return altmap->reserve + altmap->free;
278}
279
280void vmem_altmap_free(struct vmem_altmap *altmap, unsigned long nr_pfns)
281{
282 altmap->alloc -= nr_pfns;
283}
284
0822acb8
CH
285/**
286 * get_dev_pagemap() - take a new live reference on the dev_pagemap for @pfn
287 * @pfn: page frame number to lookup page_map
288 * @pgmap: optional known pgmap that already has a reference
289 *
832d7aa0
CH
290 * If @pgmap is non-NULL and covers @pfn it will be returned as-is. If @pgmap
291 * is non-NULL but does not cover @pfn the reference to it will be released.
0822acb8
CH
292 */
293struct dev_pagemap *get_dev_pagemap(unsigned long pfn,
294 struct dev_pagemap *pgmap)
295{
0822acb8
CH
296 resource_size_t phys = PFN_PHYS(pfn);
297
298 /*
832d7aa0 299 * In the cached case we're already holding a live reference.
0822acb8 300 */
832d7aa0 301 if (pgmap) {
e7744aa2 302 if (phys >= pgmap->res.start && phys <= pgmap->res.end)
832d7aa0
CH
303 return pgmap;
304 put_dev_pagemap(pgmap);
0822acb8
CH
305 }
306
307 /* fall back to slow path lookup */
308 rcu_read_lock();
bcfa4b72 309 pgmap = xa_load(&pgmap_array, PHYS_PFN(phys));
0822acb8
CH
310 if (pgmap && !percpu_ref_tryget_live(pgmap->ref))
311 pgmap = NULL;
312 rcu_read_unlock();
313
314 return pgmap;
315}
e7638488 316EXPORT_SYMBOL_GPL(get_dev_pagemap);
7b2d55d2 317
e7638488
DW
318#ifdef CONFIG_DEV_PAGEMAP_OPS
319DEFINE_STATIC_KEY_FALSE(devmap_managed_key);
31c5bda3 320EXPORT_SYMBOL(devmap_managed_key);
e7638488
DW
321static atomic_t devmap_enable;
322
323/*
324 * Toggle the static key for ->page_free() callbacks when dev_pagemap
325 * pages go idle.
326 */
327void dev_pagemap_get_ops(void)
328{
329 if (atomic_inc_return(&devmap_enable) == 1)
330 static_branch_enable(&devmap_managed_key);
331}
332EXPORT_SYMBOL_GPL(dev_pagemap_get_ops);
333
334void dev_pagemap_put_ops(void)
335{
336 if (atomic_dec_and_test(&devmap_enable))
337 static_branch_disable(&devmap_managed_key);
338}
339EXPORT_SYMBOL_GPL(dev_pagemap_put_ops);
340
341void __put_devmap_managed_page(struct page *page)
7b2d55d2
JG
342{
343 int count = page_ref_dec_return(page);
344
345 /*
346 * If refcount is 1 then page is freed and refcount is stable as nobody
347 * holds a reference on the page.
348 */
349 if (count == 1) {
350 /* Clear Active bit in case of parallel mark_page_accessed */
351 __ClearPageActive(page);
352 __ClearPageWaiters(page);
353
c733a828 354 mem_cgroup_uncharge(page);
7b2d55d2
JG
355
356 page->pgmap->page_free(page, page->pgmap->data);
357 } else if (!count)
358 __put_page(page);
359}
31c5bda3 360EXPORT_SYMBOL(__put_devmap_managed_page);
e7638488 361#endif /* CONFIG_DEV_PAGEMAP_OPS */