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