drm/amdgpu/vm: fix up documentation in amdgpu_vm.c
[linux-2.6-block.git] / mm / 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>
92281dee 14
bcfa4b72 15static DEFINE_XARRAY(pgmap_array);
9476df7d
DW
16#define SECTION_MASK ~((1UL << PA_SECTION_SHIFT) - 1)
17#define SECTION_SIZE (1UL << PA_SECTION_SHIFT)
18
f6a55e1a
CH
19#ifdef CONFIG_DEV_PAGEMAP_OPS
20DEFINE_STATIC_KEY_FALSE(devmap_managed_key);
21EXPORT_SYMBOL(devmap_managed_key);
22static atomic_t devmap_managed_enable;
23
24static void devmap_managed_enable_put(void *data)
25{
26 if (atomic_dec_and_test(&devmap_managed_enable))
27 static_branch_disable(&devmap_managed_key);
28}
29
30static int devmap_managed_enable_get(struct device *dev, struct dev_pagemap *pgmap)
31{
24917f6b 32 if (!pgmap->ops || !pgmap->ops->page_free) {
f6a55e1a
CH
33 WARN(1, "Missing page_free method\n");
34 return -EINVAL;
35 }
36
37 if (atomic_inc_return(&devmap_managed_enable) == 1)
38 static_branch_enable(&devmap_managed_key);
39 return devm_add_action_or_reset(dev, devmap_managed_enable_put, NULL);
40}
41#else
42static int devmap_managed_enable_get(struct device *dev, struct dev_pagemap *pgmap)
43{
44 return -EINVAL;
45}
46#endif /* CONFIG_DEV_PAGEMAP_OPS */
47
bcfa4b72 48static void pgmap_array_delete(struct resource *res)
ab1b597e 49{
bcfa4b72
MW
50 xa_store_range(&pgmap_array, PHYS_PFN(res->start), PHYS_PFN(res->end),
51 NULL, GFP_KERNEL);
ab1b597e 52 synchronize_rcu();
9476df7d
DW
53}
54
e7744aa2 55static unsigned long pfn_first(struct dev_pagemap *pgmap)
5c2c2587 56{
7cc7867f 57 return PHYS_PFN(pgmap->res.start) +
514caf23 58 vmem_altmap_offset(pgmap_altmap(pgmap));
5c2c2587
DW
59}
60
e7744aa2 61static unsigned long pfn_end(struct dev_pagemap *pgmap)
5c2c2587 62{
e7744aa2 63 const struct resource *res = &pgmap->res;
5c2c2587
DW
64
65 return (res->start + resource_size(res)) >> PAGE_SHIFT;
66}
67
949b9325
DW
68static unsigned long pfn_next(unsigned long pfn)
69{
70 if (pfn % 1024 == 0)
71 cond_resched();
72 return pfn + 1;
73}
74
5c2c2587 75#define for_each_device_pfn(pfn, map) \
949b9325 76 for (pfn = pfn_first(map); pfn < pfn_end(map); pfn = pfn_next(pfn))
5c2c2587 77
24917f6b
CH
78static void dev_pagemap_kill(struct dev_pagemap *pgmap)
79{
80 if (pgmap->ops && pgmap->ops->kill)
81 pgmap->ops->kill(pgmap);
82 else
83 percpu_ref_kill(pgmap->ref);
84}
85
86static void dev_pagemap_cleanup(struct dev_pagemap *pgmap)
87{
88 if (pgmap->ops && pgmap->ops->cleanup) {
89 pgmap->ops->cleanup(pgmap);
90 } else {
91 wait_for_completion(&pgmap->done);
92 percpu_ref_exit(pgmap->ref);
93 }
94}
95
e8d51348 96static void devm_memremap_pages_release(void *data)
41e94a85 97{
e7744aa2 98 struct dev_pagemap *pgmap = data;
e8d51348 99 struct device *dev = pgmap->dev;
e7744aa2 100 struct resource *res = &pgmap->res;
71389703 101 unsigned long pfn;
2c2a5af6 102 int nid;
71389703 103
24917f6b 104 dev_pagemap_kill(pgmap);
e7744aa2 105 for_each_device_pfn(pfn, pgmap)
71389703 106 put_page(pfn_to_page(pfn));
24917f6b 107 dev_pagemap_cleanup(pgmap);
9476df7d 108
41e94a85 109 /* pages are dead and unused, undo the arch mapping */
7cc7867f 110 nid = page_to_nid(pfn_to_page(PHYS_PFN(res->start)));
2c2a5af6 111
f931ab47 112 mem_hotplug_begin();
69324b8f 113 if (pgmap->type == MEMORY_DEVICE_PRIVATE) {
7cc7867f 114 pfn = PHYS_PFN(res->start);
69324b8f 115 __remove_pages(page_zone(pfn_to_page(pfn)), pfn,
7cc7867f 116 PHYS_PFN(resource_size(res)), NULL);
69324b8f 117 } else {
7cc7867f 118 arch_remove_memory(nid, res->start, resource_size(res),
514caf23 119 pgmap_altmap(pgmap));
7cc7867f 120 kasan_remove_zero_shadow(__va(res->start), resource_size(res));
69324b8f 121 }
f931ab47 122 mem_hotplug_done();
b5d24fda 123
7cc7867f 124 untrack_pfn(NULL, PHYS_PFN(res->start), resource_size(res));
bcfa4b72 125 pgmap_array_delete(res);
e7744aa2
LG
126 dev_WARN_ONCE(dev, pgmap->altmap.alloc,
127 "%s: failed to free all reserved pages\n", __func__);
9476df7d
DW
128}
129
24917f6b
CH
130static void dev_pagemap_percpu_release(struct percpu_ref *ref)
131{
132 struct dev_pagemap *pgmap =
133 container_of(ref, struct dev_pagemap, internal_ref);
134
135 complete(&pgmap->done);
136}
137
4b94ffdc
DW
138/**
139 * devm_memremap_pages - remap and provide memmap backing for the given resource
140 * @dev: hosting device for @res
a95c90f1 141 * @pgmap: pointer to a struct dev_pagemap
4b94ffdc 142 *
5c2c2587 143 * Notes:
24917f6b
CH
144 * 1/ At a minimum the res and type members of @pgmap must be initialized
145 * by the caller before passing it to this function
e8d51348 146 *
514caf23
CH
147 * 2/ The altmap field may optionally be initialized, in which case
148 * PGMAP_ALTMAP_VALID must be set in pgmap->flags.
e8d51348 149 *
24917f6b
CH
150 * 3/ The ref field may optionally be provided, in which pgmap->ref must be
151 * 'live' on entry and will be killed and reaped at
152 * devm_memremap_pages_release() time, or if this routine fails.
5c2c2587 153 *
e8d51348 154 * 4/ res is expected to be a host memory range that could feasibly be
5c2c2587
DW
155 * treated as a "System RAM" range, i.e. not a device mmio range, but
156 * this is not enforced.
4b94ffdc 157 */
e8d51348 158void *devm_memremap_pages(struct device *dev, struct dev_pagemap *pgmap)
41e94a85 159{
949b9325 160 struct resource *res = &pgmap->res;
966cf44f 161 struct dev_pagemap *conflict_pgmap;
940519f0
MH
162 struct mhp_restrictions restrictions = {
163 /*
164 * We do not want any optional features only our own memmap
7cc7867f 165 */
514caf23 166 .altmap = pgmap_altmap(pgmap),
940519f0 167 };
9049771f 168 pgprot_t pgprot = PAGE_KERNEL;
949b9325 169 int error, nid, is_ram;
f6a55e1a 170 bool need_devmap_managed = true;
5f29a77c 171
3ed2dcdf
CH
172 switch (pgmap->type) {
173 case MEMORY_DEVICE_PRIVATE:
174 if (!IS_ENABLED(CONFIG_DEVICE_PRIVATE)) {
175 WARN(1, "Device private memory not supported\n");
176 return ERR_PTR(-EINVAL);
177 }
897e6365
CH
178 if (!pgmap->ops || !pgmap->ops->migrate_to_ram) {
179 WARN(1, "Missing migrate_to_ram method\n");
180 return ERR_PTR(-EINVAL);
181 }
3ed2dcdf
CH
182 break;
183 case MEMORY_DEVICE_FS_DAX:
184 if (!IS_ENABLED(CONFIG_ZONE_DEVICE) ||
185 IS_ENABLED(CONFIG_FS_DAX_LIMITED)) {
186 WARN(1, "File system DAX not supported\n");
187 return ERR_PTR(-EINVAL);
188 }
189 break;
190 case MEMORY_DEVICE_DEVDAX:
191 case MEMORY_DEVICE_PCI_P2PDMA:
f6a55e1a 192 need_devmap_managed = false;
3ed2dcdf
CH
193 break;
194 default:
195 WARN(1, "Invalid pgmap type %d\n", pgmap->type);
196 break;
197 }
198
24917f6b
CH
199 if (!pgmap->ref) {
200 if (pgmap->ops && (pgmap->ops->kill || pgmap->ops->cleanup))
201 return ERR_PTR(-EINVAL);
202
203 init_completion(&pgmap->done);
204 error = percpu_ref_init(&pgmap->internal_ref,
205 dev_pagemap_percpu_release, 0, GFP_KERNEL);
206 if (error)
207 return ERR_PTR(error);
208 pgmap->ref = &pgmap->internal_ref;
209 } else {
210 if (!pgmap->ops || !pgmap->ops->kill || !pgmap->ops->cleanup) {
211 WARN(1, "Missing reference count teardown definition\n");
212 return ERR_PTR(-EINVAL);
213 }
50f44ee7 214 }
a95c90f1 215
f6a55e1a
CH
216 if (need_devmap_managed) {
217 error = devmap_managed_enable_get(dev, pgmap);
218 if (error)
219 return ERR_PTR(error);
220 }
221
7cc7867f 222 conflict_pgmap = get_dev_pagemap(PHYS_PFN(res->start), NULL);
15d36fec
DJ
223 if (conflict_pgmap) {
224 dev_WARN(dev, "Conflicting mapping in same section\n");
225 put_dev_pagemap(conflict_pgmap);
50f44ee7
DW
226 error = -ENOMEM;
227 goto err_array;
15d36fec
DJ
228 }
229
7cc7867f 230 conflict_pgmap = get_dev_pagemap(PHYS_PFN(res->end), NULL);
15d36fec
DJ
231 if (conflict_pgmap) {
232 dev_WARN(dev, "Conflicting mapping in same section\n");
233 put_dev_pagemap(conflict_pgmap);
50f44ee7
DW
234 error = -ENOMEM;
235 goto err_array;
15d36fec
DJ
236 }
237
7cc7867f 238 is_ram = region_intersects(res->start, resource_size(res),
d37a14bb 239 IORESOURCE_SYSTEM_RAM, IORES_DESC_NONE);
41e94a85 240
06489cfb
DW
241 if (is_ram != REGION_DISJOINT) {
242 WARN_ONCE(1, "%s attempted on %s region %pr\n", __func__,
243 is_ram == REGION_MIXED ? "mixed" : "ram", res);
a95c90f1
DW
244 error = -ENXIO;
245 goto err_array;
41e94a85
CH
246 }
247
4b94ffdc 248 pgmap->dev = dev;
4b94ffdc 249
bcfa4b72
MW
250 error = xa_err(xa_store_range(&pgmap_array, PHYS_PFN(res->start),
251 PHYS_PFN(res->end), pgmap, GFP_KERNEL));
9476df7d 252 if (error)
bcfa4b72 253 goto err_array;
9476df7d 254
41e94a85
CH
255 nid = dev_to_node(dev);
256 if (nid < 0)
7eff93b7 257 nid = numa_mem_id();
41e94a85 258
7cc7867f
DW
259 error = track_pfn_remap(NULL, &pgprot, PHYS_PFN(res->start), 0,
260 resource_size(res));
9049771f
DW
261 if (error)
262 goto err_pfn_remap;
263
f931ab47 264 mem_hotplug_begin();
69324b8f
DW
265
266 /*
267 * For device private memory we call add_pages() as we only need to
268 * allocate and initialize struct page for the device memory. More-
269 * over the device memory is un-accessible thus we do not want to
270 * create a linear mapping for the memory like arch_add_memory()
271 * would do.
272 *
273 * For all other device memory types, which are accessible by
274 * the CPU, we do want the linear mapping and thus use
275 * arch_add_memory().
276 */
277 if (pgmap->type == MEMORY_DEVICE_PRIVATE) {
7cc7867f
DW
278 error = add_pages(nid, PHYS_PFN(res->start),
279 PHYS_PFN(resource_size(res)), &restrictions);
69324b8f 280 } else {
7cc7867f 281 error = kasan_add_zero_shadow(__va(res->start), resource_size(res));
69324b8f
DW
282 if (error) {
283 mem_hotplug_done();
284 goto err_kasan;
285 }
286
7cc7867f 287 error = arch_add_memory(nid, res->start, resource_size(res),
940519f0 288 &restrictions);
69324b8f
DW
289 }
290
291 if (!error) {
292 struct zone *zone;
293
294 zone = &NODE_DATA(nid)->node_zones[ZONE_DEVICE];
7cc7867f
DW
295 move_pfn_range_to_zone(zone, PHYS_PFN(res->start),
296 PHYS_PFN(resource_size(res)), restrictions.altmap);
0207df4f
AR
297 }
298
f931ab47 299 mem_hotplug_done();
9476df7d
DW
300 if (error)
301 goto err_add_memory;
41e94a85 302
966cf44f
AD
303 /*
304 * Initialization of the pages has been deferred until now in order
305 * to allow us to do the work while not holding the hotplug lock.
306 */
307 memmap_init_zone_device(&NODE_DATA(nid)->node_zones[ZONE_DEVICE],
7cc7867f
DW
308 PHYS_PFN(res->start),
309 PHYS_PFN(resource_size(res)), pgmap);
966cf44f 310 percpu_ref_get_many(pgmap->ref, pfn_end(pgmap) - pfn_first(pgmap));
e8d51348 311
a95c90f1
DW
312 error = devm_add_action_or_reset(dev, devm_memremap_pages_release,
313 pgmap);
314 if (error)
315 return ERR_PTR(error);
e8d51348 316
41e94a85 317 return __va(res->start);
9476df7d
DW
318
319 err_add_memory:
7cc7867f 320 kasan_remove_zero_shadow(__va(res->start), resource_size(res));
0207df4f 321 err_kasan:
7cc7867f 322 untrack_pfn(NULL, PHYS_PFN(res->start), resource_size(res));
9049771f 323 err_pfn_remap:
bcfa4b72
MW
324 pgmap_array_delete(res);
325 err_array:
24917f6b
CH
326 dev_pagemap_kill(pgmap);
327 dev_pagemap_cleanup(pgmap);
9476df7d 328 return ERR_PTR(error);
41e94a85 329}
808153e1 330EXPORT_SYMBOL_GPL(devm_memremap_pages);
4b94ffdc 331
2e3f139e
DW
332void devm_memunmap_pages(struct device *dev, struct dev_pagemap *pgmap)
333{
334 devm_release_action(dev, devm_memremap_pages_release, pgmap);
335}
336EXPORT_SYMBOL_GPL(devm_memunmap_pages);
337
4b94ffdc
DW
338unsigned long vmem_altmap_offset(struct vmem_altmap *altmap)
339{
340 /* number of pfns from base where pfn_to_page() is valid */
514caf23
CH
341 if (altmap)
342 return altmap->reserve + altmap->free;
343 return 0;
4b94ffdc
DW
344}
345
346void vmem_altmap_free(struct vmem_altmap *altmap, unsigned long nr_pfns)
347{
348 altmap->alloc -= nr_pfns;
349}
350
0822acb8
CH
351/**
352 * get_dev_pagemap() - take a new live reference on the dev_pagemap for @pfn
353 * @pfn: page frame number to lookup page_map
354 * @pgmap: optional known pgmap that already has a reference
355 *
832d7aa0
CH
356 * If @pgmap is non-NULL and covers @pfn it will be returned as-is. If @pgmap
357 * is non-NULL but does not cover @pfn the reference to it will be released.
0822acb8
CH
358 */
359struct dev_pagemap *get_dev_pagemap(unsigned long pfn,
360 struct dev_pagemap *pgmap)
361{
0822acb8
CH
362 resource_size_t phys = PFN_PHYS(pfn);
363
364 /*
832d7aa0 365 * In the cached case we're already holding a live reference.
0822acb8 366 */
832d7aa0 367 if (pgmap) {
e7744aa2 368 if (phys >= pgmap->res.start && phys <= pgmap->res.end)
832d7aa0
CH
369 return pgmap;
370 put_dev_pagemap(pgmap);
0822acb8
CH
371 }
372
373 /* fall back to slow path lookup */
374 rcu_read_lock();
bcfa4b72 375 pgmap = xa_load(&pgmap_array, PHYS_PFN(phys));
0822acb8
CH
376 if (pgmap && !percpu_ref_tryget_live(pgmap->ref))
377 pgmap = NULL;
378 rcu_read_unlock();
379
380 return pgmap;
381}
e7638488 382EXPORT_SYMBOL_GPL(get_dev_pagemap);
7b2d55d2 383
e7638488 384#ifdef CONFIG_DEV_PAGEMAP_OPS
e7638488 385void __put_devmap_managed_page(struct page *page)
7b2d55d2
JG
386{
387 int count = page_ref_dec_return(page);
388
389 /*
390 * If refcount is 1 then page is freed and refcount is stable as nobody
391 * holds a reference on the page.
392 */
393 if (count == 1) {
394 /* Clear Active bit in case of parallel mark_page_accessed */
395 __ClearPageActive(page);
396 __ClearPageWaiters(page);
397
c733a828 398 mem_cgroup_uncharge(page);
7b2d55d2 399
80a72d0a 400 page->pgmap->ops->page_free(page);
7b2d55d2
JG
401 } else if (!count)
402 __put_page(page);
403}
31c5bda3 404EXPORT_SYMBOL(__put_devmap_managed_page);
e7638488 405#endif /* CONFIG_DEV_PAGEMAP_OPS */