Merge tag 'pci-v6.16-fixes-3' of git://git.kernel.org/pub/scm/linux/kernel/git/pci/pci
[linux-2.6-block.git] / arch / x86 / include / asm / xen / page.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
05e4d316
PA
2#ifndef _ASM_X86_XEN_PAGE_H
3#define _ASM_X86_XEN_PAGE_H
20e71f2e 4
ecbf29cd
JF
5#include <linux/kernel.h>
6#include <linux/types.h>
7#include <linux/spinlock.h>
20e71f2e 8#include <linux/pfn.h>
7e77506a 9#include <linux/mm.h>
7fd5cf0b 10#include <linux/device.h>
20e71f2e 11
1457d8cf 12#include <asm/extable.h>
ecbf29cd 13#include <asm/page.h>
20e71f2e 14
ecbf29cd 15#include <xen/interface/xen.h>
008c320a 16#include <xen/interface/grant_table.h>
20e71f2e
IY
17#include <xen/features.h>
18
19/* Xen machine address */
20typedef struct xmaddr {
21 phys_addr_t maddr;
22} xmaddr_t;
23
24/* Xen pseudo-physical address */
25typedef struct xpaddr {
26 phys_addr_t paddr;
27} xpaddr_t;
28
6f0e8bf1
JG
29#ifdef CONFIG_X86_64
30#define XEN_PHYSICAL_MASK __sme_clr((1UL << 52) - 1)
31#else
32#define XEN_PHYSICAL_MASK __PHYSICAL_MASK
33#endif
34
35#define XEN_PTE_MFN_MASK ((pteval_t)(((signed long)PAGE_MASK) & \
36 XEN_PHYSICAL_MASK))
37
20e71f2e
IY
38#define XMADDR(x) ((xmaddr_t) { .maddr = (x) })
39#define XPADDR(x) ((xpaddr_t) { .paddr = (x) })
40
41/**** MACHINE <-> PHYSICAL CONVERSION MACROS ****/
42#define INVALID_P2M_ENTRY (~0UL)
f4cec35b
KRW
43#define FOREIGN_FRAME_BIT (1UL<<(BITS_PER_LONG-1))
44#define IDENTITY_FRAME_BIT (1UL<<(BITS_PER_LONG-2))
20e71f2e 45#define FOREIGN_FRAME(m) ((m) | FOREIGN_FRAME_BIT)
f4cec35b 46#define IDENTITY_FRAME(m) ((m) | IDENTITY_FRAME_BIT)
20e71f2e 47
cb3eb850
JG
48#define P2M_PER_PAGE (PAGE_SIZE / sizeof(unsigned long))
49
7e77506a 50extern unsigned long *machine_to_phys_mapping;
ccbcdf7c 51extern unsigned long machine_to_phys_nr;
5b8e7d80
JG
52extern unsigned long *xen_p2m_addr;
53extern unsigned long xen_p2m_size;
54extern unsigned long xen_max_p2m_pfn;
8006ec3e 55
8edfcf88
DV
56extern int xen_alloc_p2m_entry(unsigned long pfn);
57
d451bb7a 58extern unsigned long get_phys_to_machine(unsigned long pfn);
c3798062 59extern bool set_phys_to_machine(unsigned long pfn, unsigned long mfn);
6eaa412f 60extern bool __set_phys_to_machine(unsigned long pfn, unsigned long mfn);
cb3eb850
JG
61extern unsigned long __init set_phys_range_identity(unsigned long pfn_s,
62 unsigned long pfn_e);
20e71f2e 63
3d4ebdb2 64#ifdef CONFIG_XEN_PV
1429d46d
ZK
65extern int set_foreign_p2m_mapping(struct gnttab_map_grant_ref *map_ops,
66 struct gnttab_map_grant_ref *kmap_ops,
67 struct page **pages, unsigned int count);
1429d46d 68extern int clear_foreign_p2m_mapping(struct gnttab_unmap_grant_ref *unmap_ops,
853d0289 69 struct gnttab_unmap_grant_ref *kunmap_ops,
1429d46d 70 struct page **pages, unsigned int count);
3d4ebdb2
VK
71#else
72static inline int
73set_foreign_p2m_mapping(struct gnttab_map_grant_ref *map_ops,
74 struct gnttab_map_grant_ref *kmap_ops,
75 struct page **pages, unsigned int count)
76{
77 return 0;
78}
79
80static inline int
81clear_foreign_p2m_mapping(struct gnttab_unmap_grant_ref *unmap_ops,
82 struct gnttab_unmap_grant_ref *kunmap_ops,
83 struct page **pages, unsigned int count)
84{
85 return 0;
86}
87#endif
448f2831 88
90fff3ea
JG
89/*
90 * Helper functions to write or read unsigned long values to/from
91 * memory, when the access may fault.
92 */
93static inline int xen_safe_write_ulong(unsigned long *addr, unsigned long val)
94{
1457d8cf
JG
95 int ret = 0;
96
97 asm volatile("1: mov %[val], %[ptr]\n"
98 "2:\n"
e2b48e43 99 _ASM_EXTABLE_TYPE_REG(1b, 2b, EX_TYPE_EFAULT_REG, %[ret])
1457d8cf
JG
100 : [ret] "+r" (ret), [ptr] "=m" (*addr)
101 : [val] "r" (val));
102
103 return ret;
90fff3ea
JG
104}
105
1457d8cf
JG
106static inline int xen_safe_read_ulong(const unsigned long *addr,
107 unsigned long *val)
90fff3ea 108{
1457d8cf 109 unsigned long rval = ~0ul;
e2b48e43 110 int ret = 0;
1457d8cf
JG
111
112 asm volatile("1: mov %[ptr], %[rval]\n"
113 "2:\n"
e2b48e43 114 _ASM_EXTABLE_TYPE_REG(1b, 2b, EX_TYPE_EFAULT_REG, %[ret])
1457d8cf
JG
115 : [ret] "+r" (ret), [rval] "+r" (rval)
116 : [ptr] "m" (*addr));
117 *val = rval;
118
119 return ret;
90fff3ea
JG
120}
121
3d4ebdb2 122#ifdef CONFIG_XEN_PV
0aad5689
JG
123/*
124 * When to use pfn_to_mfn(), __pfn_to_mfn() or get_phys_to_machine():
125 * - pfn_to_mfn() returns either INVALID_P2M_ENTRY or the mfn. No indicator
126 * bits (identity or foreign) are set.
127 * - __pfn_to_mfn() returns the found entry of the p2m table. A possibly set
128 * identity or foreign indicator will be still set. __pfn_to_mfn() is
054954eb
JG
129 * encapsulating get_phys_to_machine() which is called in special cases only.
130 * - get_phys_to_machine() is to be called by __pfn_to_mfn() only in special
131 * cases needing an extended handling.
0aad5689
JG
132 */
133static inline unsigned long __pfn_to_mfn(unsigned long pfn)
134{
054954eb
JG
135 unsigned long mfn;
136
137 if (pfn < xen_p2m_size)
138 mfn = xen_p2m_addr[pfn];
139 else if (unlikely(pfn < xen_max_p2m_pfn))
140 return get_phys_to_machine(pfn);
141 else
142 return IDENTITY_FRAME(pfn);
143
144 if (unlikely(mfn == INVALID_P2M_ENTRY))
145 return get_phys_to_machine(pfn);
146
147 return mfn;
0aad5689 148}
3d4ebdb2
VK
149#else
150static inline unsigned long __pfn_to_mfn(unsigned long pfn)
151{
152 return pfn;
153}
154#endif
0aad5689 155
20e71f2e
IY
156static inline unsigned long pfn_to_mfn(unsigned long pfn)
157{
cfd8951e
JF
158 unsigned long mfn;
159
0df4f266
JG
160 /*
161 * Some x86 code are still using pfn_to_mfn instead of
162 * pfn_to_mfn. This will have to be removed when we figured
163 * out which call.
164 */
20e71f2e
IY
165 if (xen_feature(XENFEAT_auto_translated_physmap))
166 return pfn;
167
0aad5689 168 mfn = __pfn_to_mfn(pfn);
cfd8951e
JF
169
170 if (mfn != INVALID_P2M_ENTRY)
f4cec35b 171 mfn &= ~(FOREIGN_FRAME_BIT | IDENTITY_FRAME_BIT);
cfd8951e
JF
172
173 return mfn;
20e71f2e
IY
174}
175
176static inline int phys_to_machine_mapping_valid(unsigned long pfn)
177{
178 if (xen_feature(XENFEAT_auto_translated_physmap))
179 return 1;
180
0aad5689 181 return __pfn_to_mfn(pfn) != INVALID_P2M_ENTRY;
20e71f2e
IY
182}
183
0160676b 184static inline unsigned long mfn_to_pfn_no_overrides(unsigned long mfn)
20e71f2e
IY
185{
186 unsigned long pfn;
0160676b 187 int ret;
20e71f2e 188
0160676b
DV
189 if (unlikely(mfn >= machine_to_phys_nr))
190 return ~0;
191
20e71f2e
IY
192 /*
193 * The array access can fail (e.g., device space beyond end of RAM).
194 * In such cases it doesn't matter what we return (we return garbage),
195 * but we must handle the fault without crashing!
196 */
90fff3ea 197 ret = xen_safe_read_ulong(&machine_to_phys_mapping[mfn], &pfn);
706cc9d2 198 if (ret < 0)
0160676b
DV
199 return ~0;
200
201 return pfn;
202}
203
204static inline unsigned long mfn_to_pfn(unsigned long mfn)
205{
206 unsigned long pfn;
207
0df4f266
JG
208 /*
209 * Some x86 code are still using mfn_to_pfn instead of
210 * gfn_to_pfn. This will have to be removed when we figure
211 * out which call.
212 */
0160676b
DV
213 if (xen_feature(XENFEAT_auto_translated_physmap))
214 return mfn;
215
216 pfn = mfn_to_pfn_no_overrides(mfn);
0bb599fd
DV
217 if (__pfn_to_mfn(pfn) != mfn)
218 pfn = ~0;
706cc9d2 219
1429d46d 220 /*
0bb599fd
DV
221 * pfn is ~0 if there are no entries in the m2p for mfn or the
222 * entry doesn't map back to the mfn.
448f2831 223 */
0aad5689 224 if (pfn == ~0 && __pfn_to_mfn(mfn) == IDENTITY_FRAME(mfn))
706cc9d2 225 pfn = mfn;
448f2831 226
20e71f2e
IY
227 return pfn;
228}
229
230static inline xmaddr_t phys_to_machine(xpaddr_t phys)
231{
232 unsigned offset = phys.paddr & ~PAGE_MASK;
947d0496 233 return XMADDR(PFN_PHYS(pfn_to_mfn(PFN_DOWN(phys.paddr))) | offset);
20e71f2e
IY
234}
235
236static inline xpaddr_t machine_to_phys(xmaddr_t machine)
237{
238 unsigned offset = machine.maddr & ~PAGE_MASK;
947d0496 239 return XPADDR(PFN_PHYS(mfn_to_pfn(PFN_DOWN(machine.maddr))) | offset);
20e71f2e
IY
240}
241
0df4f266
JG
242/* Pseudo-physical <-> Guest conversion */
243static inline unsigned long pfn_to_gfn(unsigned long pfn)
244{
245 if (xen_feature(XENFEAT_auto_translated_physmap))
246 return pfn;
247 else
248 return pfn_to_mfn(pfn);
249}
250
251static inline unsigned long gfn_to_pfn(unsigned long gfn)
252{
253 if (xen_feature(XENFEAT_auto_translated_physmap))
254 return gfn;
255 else
256 return mfn_to_pfn(gfn);
257}
258
32e09870 259/* Pseudo-physical <-> Bus conversion */
0df4f266
JG
260#define pfn_to_bfn(pfn) pfn_to_gfn(pfn)
261#define bfn_to_pfn(bfn) gfn_to_pfn(bfn)
32e09870 262
20e71f2e
IY
263/*
264 * We detect special mappings in one of two ways:
265 * 1. If the MFN is an I/O page then Xen will set the m2p entry
266 * to be outside our maximum possible pseudophys range.
267 * 2. If the MFN belongs to a different domain then we will certainly
268 * not have MFN in our p2m table. Conversely, if the page is ours,
269 * then we'll have p2m(m2p(MFN))==MFN.
270 * If we detect a special mapping then it doesn't have a 'struct page'.
271 * We force !pfn_valid() by returning an out-of-range pointer.
272 *
273 * NB. These checks require that, for any MFN that is not in our reservation,
274 * there is no PFN such that p2m(PFN) == MFN. Otherwise we can get confused if
275 * we are foreign-mapping the MFN, and the other domain as m2p(MFN) == PFN.
276 * Yikes! Various places must poke in INVALID_P2M_ENTRY for safety.
277 *
278 * NB2. When deliberately mapping foreign pages into the p2m table, you *must*
279 * use FOREIGN_FRAME(). This will cause pte_pfn() to choke on it, as we
280 * require. In all the cases we care about, the FOREIGN_FRAME bit is
281 * masked (e.g., pfn_to_mfn()) so behaviour there is correct.
282 */
32e09870 283static inline unsigned long bfn_to_local_pfn(unsigned long mfn)
20e71f2e 284{
fc590efe
MR
285 unsigned long pfn;
286
287 if (xen_feature(XENFEAT_auto_translated_physmap))
288 return mfn;
289
290 pfn = mfn_to_pfn(mfn);
0aad5689 291 if (__pfn_to_mfn(pfn) != mfn)
c0011dbf 292 return -1; /* force !pfn_valid() */
20e71f2e
IY
293 return pfn;
294}
295
20e71f2e
IY
296/* VIRT <-> MACHINE conversion */
297#define virt_to_machine(v) (phys_to_machine(XPADDR(__pa(v))))
067e4f17
LW
298static inline unsigned long virt_to_pfn(const void *v)
299{
300 return PFN_DOWN(__pa(v));
301}
b40bf53e 302#define virt_to_mfn(v) (pfn_to_mfn(virt_to_pfn(v)))
20e71f2e
IY
303#define mfn_to_virt(m) (__va(mfn_to_pfn(m) << PAGE_SHIFT))
304
0df4f266
JG
305/* VIRT <-> GUEST conversion */
306#define virt_to_gfn(v) (pfn_to_gfn(virt_to_pfn(v)))
307#define gfn_to_virt(g) (__va(gfn_to_pfn(g) << PAGE_SHIFT))
308
20e71f2e
IY
309static inline unsigned long pte_mfn(pte_t pte)
310{
6f0e8bf1 311 return (pte.pte & XEN_PTE_MFN_MASK) >> PAGE_SHIFT;
20e71f2e
IY
312}
313
314static inline pte_t mfn_pte(unsigned long page_nr, pgprot_t pgprot)
315{
316 pte_t pte;
317
318 pte.pte = ((phys_addr_t)page_nr << PAGE_SHIFT) |
b534816b 319 massage_pgprot(pgprot);
20e71f2e
IY
320
321 return pte;
322}
323
324static inline pteval_t pte_val_ma(pte_t pte)
325{
326 return pte.pte;
327}
328
329static inline pte_t __pte_ma(pteval_t x)
330{
331 return (pte_t) { .pte = x };
332}
333
20e71f2e 334#define pmd_val_ma(v) ((v).pmd)
f6e58732 335#ifdef __PAGETABLE_PUD_FOLDED
f2a6a705 336#define pud_val_ma(v) ((v).p4d.pgd.pgd)
f6e58732
JF
337#else
338#define pud_val_ma(v) ((v).pud)
339#endif
20e71f2e 340#define __pmd_ma(x) ((pmd_t) { (x) } )
20e71f2e 341
f2a6a705
KS
342#ifdef __PAGETABLE_P4D_FOLDED
343#define p4d_val_ma(x) ((x).pgd.pgd)
344#else
345#define p4d_val_ma(x) ((x).p4d)
346#endif
20e71f2e 347
ce803e70 348xmaddr_t arbitrary_virt_to_machine(void *address);
9976b39b 349unsigned long arbitrary_virt_to_mfn(void *vaddr);
20e71f2e
IY
350void make_lowmem_page_readonly(void *vaddr);
351void make_lowmem_page_readwrite(void *vaddr);
352
a4dba130 353static inline bool xen_arch_need_swiotlb(struct device *dev,
291be10f
JG
354 phys_addr_t phys,
355 dma_addr_t dev_addr)
a4dba130
SS
356{
357 return false;
358}
359
05e4d316 360#endif /* _ASM_X86_XEN_PAGE_H */