arch/x86/include/asm/xen/page.h

   1 #ifndef _ASM_X86_XEN_PAGE_H
   2 #define _ASM_X86_XEN_PAGE_H
   3
   4 #include <linux/kernel.h>
   5 #include <linux/types.h>
   6 #include <linux/spinlock.h>
   7 #include <linux/pfn.h>
   8 #include <linux/mm.h>
   9
  10 #include <asm/uaccess.h>
  11 #include <asm/page.h>
  12 #include <asm/pgtable.h>
  13
  14 #include <xen/interface/xen.h>
  15 #include <xen/grant_table.h>
  16 #include <xen/features.h>
  17
  18 /* Xen machine address */
  19 typedef struct xmaddr {
  20         phys_addr_t maddr;
  21 } xmaddr_t;
  22
  23 /* Xen pseudo-physical address */
  24 typedef struct xpaddr {
  25         phys_addr_t paddr;
  26 } xpaddr_t;
  27
  28 #define XMADDR(x)       ((xmaddr_t) { .maddr = (x) })
  29 #define XPADDR(x)       ((xpaddr_t) { .paddr = (x) })
  30
  31 /**** MACHINE <-> PHYSICAL CONVERSION MACROS ****/
  32 #define INVALID_P2M_ENTRY       (~0UL)
  33 #define FOREIGN_FRAME_BIT       (1UL<<(BITS_PER_LONG-1))
  34 #define IDENTITY_FRAME_BIT      (1UL<<(BITS_PER_LONG-2))
  35 #define FOREIGN_FRAME(m)        ((m) | FOREIGN_FRAME_BIT)
  36 #define IDENTITY_FRAME(m)       ((m) | IDENTITY_FRAME_BIT)
  37
  38 #define P2M_PER_PAGE            (PAGE_SIZE / sizeof(unsigned long))
  39
  40 extern unsigned long *machine_to_phys_mapping;
  41 extern unsigned long  machine_to_phys_nr;
  42 extern unsigned long *xen_p2m_addr;
  43 extern unsigned long  xen_p2m_size;
  44 extern unsigned long  xen_max_p2m_pfn;
  45
  46 extern unsigned long get_phys_to_machine(unsigned long pfn);
  47 extern bool set_phys_to_machine(unsigned long pfn, unsigned long mfn);
  48 extern bool __set_phys_to_machine(unsigned long pfn, unsigned long mfn);
  49 extern unsigned long __init set_phys_range_identity(unsigned long pfn_s,
  50                                                     unsigned long pfn_e);
  51
  52 extern int set_foreign_p2m_mapping(struct gnttab_map_grant_ref *map_ops,
  53                                    struct gnttab_map_grant_ref *kmap_ops,
  54                                    struct page **pages, unsigned int count);
  55 extern int clear_foreign_p2m_mapping(struct gnttab_unmap_grant_ref *unmap_ops,
  56                                      struct gnttab_unmap_grant_ref *kunmap_ops,
  57                                      struct page **pages, unsigned int count);
  58
  59 /*
  60  * Helper functions to write or read unsigned long values to/from
  61  * memory, when the access may fault.
  62  */
  63 static inline int xen_safe_write_ulong(unsigned long *addr, unsigned long val)
  64 {
  65         return __put_user(val, (unsigned long __user *)addr);
  66 }
  67
  68 static inline int xen_safe_read_ulong(unsigned long *addr, unsigned long *val)
  69 {
  70         return __get_user(*val, (unsigned long __user *)addr);
  71 }
  72
  73 /*
  74  * When to use pfn_to_mfn(), __pfn_to_mfn() or get_phys_to_machine():
  75  * - pfn_to_mfn() returns either INVALID_P2M_ENTRY or the mfn. No indicator
  76  *   bits (identity or foreign) are set.
  77  * - __pfn_to_mfn() returns the found entry of the p2m table. A possibly set
  78  *   identity or foreign indicator will be still set. __pfn_to_mfn() is
  79  *   encapsulating get_phys_to_machine() which is called in special cases only.
  80  * - get_phys_to_machine() is to be called by __pfn_to_mfn() only in special
  81  *   cases needing an extended handling.
  82  */
  83 static inline unsigned long __pfn_to_mfn(unsigned long pfn)
  84 {
  85         unsigned long mfn;
  86
  87         if (pfn < xen_p2m_size)
  88                 mfn = xen_p2m_addr[pfn];
  89         else if (unlikely(pfn < xen_max_p2m_pfn))
  90                 return get_phys_to_machine(pfn);
  91         else
  92                 return IDENTITY_FRAME(pfn);
  93
  94         if (unlikely(mfn == INVALID_P2M_ENTRY))
  95                 return get_phys_to_machine(pfn);
  96
  97         return mfn;
  98 }
  99
 100 static inline unsigned long pfn_to_mfn(unsigned long pfn)
 101 {
 102         unsigned long mfn;
 103
 104         if (xen_feature(XENFEAT_auto_translated_physmap))
 105                 return pfn;
 106
 107         mfn = __pfn_to_mfn(pfn);
 108
 109         if (mfn != INVALID_P2M_ENTRY)
 110                 mfn &= ~(FOREIGN_FRAME_BIT | IDENTITY_FRAME_BIT);
 111
 112         return mfn;
 113 }
 114
 115 static inline int phys_to_machine_mapping_valid(unsigned long pfn)
 116 {
 117         if (xen_feature(XENFEAT_auto_translated_physmap))
 118                 return 1;
 119
 120         return __pfn_to_mfn(pfn) != INVALID_P2M_ENTRY;
 121 }
 122
 123 static inline unsigned long mfn_to_pfn_no_overrides(unsigned long mfn)
 124 {
 125         unsigned long pfn;
 126         int ret;
 127
 128         if (xen_feature(XENFEAT_auto_translated_physmap))
 129                 return mfn;
 130
 131         if (unlikely(mfn >= machine_to_phys_nr))
 132                 return ~0;
 133
 134         /*
 135          * The array access can fail (e.g., device space beyond end of RAM).
 136          * In such cases it doesn't matter what we return (we return garbage),
 137          * but we must handle the fault without crashing!
 138          */
 139         ret = xen_safe_read_ulong(&machine_to_phys_mapping[mfn], &pfn);
 140         if (ret < 0)
 141                 return ~0;
 142
 143         return pfn;
 144 }
 145
 146 static inline unsigned long mfn_to_pfn(unsigned long mfn)
 147 {
 148         unsigned long pfn;
 149
 150         if (xen_feature(XENFEAT_auto_translated_physmap))
 151                 return mfn;
 152
 153         pfn = mfn_to_pfn_no_overrides(mfn);
 154         if (__pfn_to_mfn(pfn) != mfn)
 155                 pfn = ~0;
 156
 157         /*
 158          * pfn is ~0 if there are no entries in the m2p for mfn or the
 159          * entry doesn't map back to the mfn.
 160          */
 161         if (pfn == ~0 && __pfn_to_mfn(mfn) == IDENTITY_FRAME(mfn))
 162                 pfn = mfn;
 163
 164         return pfn;
 165 }
 166
 167 static inline xmaddr_t phys_to_machine(xpaddr_t phys)
 168 {
 169         unsigned offset = phys.paddr & ~PAGE_MASK;
 170         return XMADDR(PFN_PHYS(pfn_to_mfn(PFN_DOWN(phys.paddr))) | offset);
 171 }
 172
 173 static inline xpaddr_t machine_to_phys(xmaddr_t machine)
 174 {
 175         unsigned offset = machine.maddr & ~PAGE_MASK;
 176         return XPADDR(PFN_PHYS(mfn_to_pfn(PFN_DOWN(machine.maddr))) | offset);
 177 }
 178
 179 /* Pseudo-physical <-> Bus conversion */
 180 #define pfn_to_bfn(pfn)         pfn_to_mfn(pfn)
 181 #define bfn_to_pfn(bfn)         mfn_to_pfn(bfn)
 182
 183 /*
 184  * We detect special mappings in one of two ways:
 185  *  1. If the MFN is an I/O page then Xen will set the m2p entry
 186  *     to be outside our maximum possible pseudophys range.
 187  *  2. If the MFN belongs to a different domain then we will certainly
 188  *     not have MFN in our p2m table. Conversely, if the page is ours,
 189  *     then we'll have p2m(m2p(MFN))==MFN.
 190  * If we detect a special mapping then it doesn't have a 'struct page'.
 191  * We force !pfn_valid() by returning an out-of-range pointer.
 192  *
 193  * NB. These checks require that, for any MFN that is not in our reservation,
 194  * there is no PFN such that p2m(PFN) == MFN. Otherwise we can get confused if
 195  * we are foreign-mapping the MFN, and the other domain as m2p(MFN) == PFN.
 196  * Yikes! Various places must poke in INVALID_P2M_ENTRY for safety.
 197  *
 198  * NB2. When deliberately mapping foreign pages into the p2m table, you *must*
 199  *      use FOREIGN_FRAME(). This will cause pte_pfn() to choke on it, as we
 200  *      require. In all the cases we care about, the FOREIGN_FRAME bit is
 201  *      masked (e.g., pfn_to_mfn()) so behaviour there is correct.
 202  */
 203 static inline unsigned long bfn_to_local_pfn(unsigned long mfn)
 204 {
 205         unsigned long pfn;
 206
 207         if (xen_feature(XENFEAT_auto_translated_physmap))
 208                 return mfn;
 209
 210         pfn = mfn_to_pfn(mfn);
 211         if (__pfn_to_mfn(pfn) != mfn)
 212                 return -1; /* force !pfn_valid() */
 213         return pfn;
 214 }
 215
 216 /* VIRT <-> MACHINE conversion */
 217 #define virt_to_machine(v)      (phys_to_machine(XPADDR(__pa(v))))
 218 #define virt_to_pfn(v)          (PFN_DOWN(__pa(v)))
 219 #define virt_to_mfn(v)          (pfn_to_mfn(virt_to_pfn(v)))
 220 #define mfn_to_virt(m)          (__va(mfn_to_pfn(m) << PAGE_SHIFT))
 221
 222 static inline unsigned long pte_mfn(pte_t pte)
 223 {
 224         return (pte.pte & PTE_PFN_MASK) >> PAGE_SHIFT;
 225 }
 226
 227 static inline pte_t mfn_pte(unsigned long page_nr, pgprot_t pgprot)
 228 {
 229         pte_t pte;
 230
 231         pte.pte = ((phys_addr_t)page_nr << PAGE_SHIFT) |
 232                         massage_pgprot(pgprot);
 233
 234         return pte;
 235 }
 236
 237 static inline pteval_t pte_val_ma(pte_t pte)
 238 {
 239         return pte.pte;
 240 }
 241
 242 static inline pte_t __pte_ma(pteval_t x)
 243 {
 244         return (pte_t) { .pte = x };
 245 }
 246
 247 #define pmd_val_ma(v) ((v).pmd)
 248 #ifdef __PAGETABLE_PUD_FOLDED
 249 #define pud_val_ma(v) ((v).pgd.pgd)
 250 #else
 251 #define pud_val_ma(v) ((v).pud)
 252 #endif
 253 #define __pmd_ma(x)     ((pmd_t) { (x) } )
 254
 255 #define pgd_val_ma(x)   ((x).pgd)
 256
 257 void xen_set_domain_pte(pte_t *ptep, pte_t pteval, unsigned domid);
 258
 259 xmaddr_t arbitrary_virt_to_machine(void *address);
 260 unsigned long arbitrary_virt_to_mfn(void *vaddr);
 261 void make_lowmem_page_readonly(void *vaddr);
 262 void make_lowmem_page_readwrite(void *vaddr);
 263
 264 #define xen_remap(cookie, size) ioremap((cookie), (size));
 265 #define xen_unmap(cookie) iounmap((cookie))
 266
 267 static inline bool xen_arch_need_swiotlb(struct device *dev,
 268                                          unsigned long pfn,
 269                                          unsigned long bfn)
 270 {
 271         return false;
 272 }
 273
 274 static inline unsigned long xen_get_swiotlb_free_pages(unsigned int order)
 275 {
 276         return __get_free_pages(__GFP_NOWARN, order);
 277 }
 278
 279 #endif /* _ASM_X86_XEN_PAGE_H */