include/xen/grant_table.h

   1 /******************************************************************************
   2  * grant_table.h
   3  *
   4  * Two sets of functionality:
   5  * 1. Granting foreign access to our memory reservation.
   6  * 2. Accessing others' memory reservations via grant references.
   7  * (i.e., mechanisms for both sender and recipient of grant references)
   8  *
   9  * Copyright (c) 2004-2005, K A Fraser
  10  * Copyright (c) 2005, Christopher Clark
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License version 2
  14  * as published by the Free Software Foundation; or, when distributed
  15  * separately from the Linux kernel or incorporated into other
  16  * software packages, subject to the following license:
  17  *
  18  * Permission is hereby granted, free of charge, to any person obtaining a copy
  19  * of this source file (the "Software"), to deal in the Software without
  20  * restriction, including without limitation the rights to use, copy, modify,
  21  * merge, publish, distribute, sublicense, and/or sell copies of the Software,
  22  * and to permit persons to whom the Software is furnished to do so, subject to
  23  * the following conditions:
  24  *
  25  * The above copyright notice and this permission notice shall be included in
  26  * all copies or substantial portions of the Software.
  27  *
  28  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  29  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  30  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  31  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  32  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  33  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  34  * IN THE SOFTWARE.
  35  */
  36
  37 #ifndef __ASM_GNTTAB_H__
  38 #define __ASM_GNTTAB_H__
  39
  40 #include <asm/page.h>
  41
  42 #include <xen/interface/xen.h>
  43 #include <xen/interface/grant_table.h>
  44
  45 #include <asm/xen/hypervisor.h>
  46
  47 #include <xen/features.h>
  48 #include <xen/page.h>
  49 #include <linux/mm_types.h>
  50 #include <linux/page-flags.h>
  51 #include <linux/kernel.h>
  52
  53 /*
  54  * Technically there's no reliably invalid grant reference or grant handle,
  55  * so pick the value that is the most unlikely one to be observed valid.
  56  */
  57 #define INVALID_GRANT_REF          ((grant_ref_t)-1)
  58 #define INVALID_GRANT_HANDLE       ((grant_handle_t)-1)
  59
  60 #define GNTTAB_RESERVED_XENSTORE 1
  61
  62 /* NR_GRANT_FRAMES must be less than or equal to that configured in Xen */
  63 #define NR_GRANT_FRAMES 4
  64
  65 struct gnttab_free_callback {
  66         struct gnttab_free_callback *next;
  67         void (*fn)(void *);
  68         void *arg;
  69         u16 count;
  70 };
  71
  72 struct gntab_unmap_queue_data;
  73
  74 typedef void (*gnttab_unmap_refs_done)(int result, struct gntab_unmap_queue_data *data);
  75
  76 struct gntab_unmap_queue_data
  77 {
  78         struct delayed_work     gnttab_work;
  79         void *data;
  80         gnttab_unmap_refs_done  done;
  81         struct gnttab_unmap_grant_ref *unmap_ops;
  82         struct gnttab_unmap_grant_ref *kunmap_ops;
  83         struct page **pages;
  84         unsigned int count;
  85         unsigned int age;
  86 };
  87
  88 int gnttab_init(void);
  89 int gnttab_suspend(void);
  90 int gnttab_resume(void);
  91
  92 int gnttab_grant_foreign_access(domid_t domid, unsigned long frame,
  93                                 int readonly);
  94
  95 /*
  96  * End access through the given grant reference, iff the grant entry is no
  97  * longer in use.  Return 1 if the grant entry was freed, 0 if it is still in
  98  * use.
  99  */
 100 int gnttab_end_foreign_access_ref(grant_ref_t ref, int readonly);
 101
 102 /*
 103  * Eventually end access through the given grant reference, and once that
 104  * access has been ended, free the given page too.  Access will be ended
 105  * immediately iff the grant entry is not in use, otherwise it will happen
 106  * some time later.  page may be 0, in which case no freeing will occur.
 107  * Note that the granted page might still be accessed (read or write) by the
 108  * other side after gnttab_end_foreign_access() returns, so even if page was
 109  * specified as 0 it is not allowed to just reuse the page for other
 110  * purposes immediately.
 111  */
 112 void gnttab_end_foreign_access(grant_ref_t ref, int readonly,
 113                                unsigned long page);
 114
 115 /*
 116  * End access through the given grant reference, iff the grant entry is
 117  * no longer in use.  In case of success ending foreign access, the
 118  * grant reference is deallocated.
 119  * Return 1 if the grant entry was freed, 0 if it is still in use.
 120  */
 121 int gnttab_try_end_foreign_access(grant_ref_t ref);
 122
 123 int gnttab_grant_foreign_transfer(domid_t domid, unsigned long pfn);
 124
 125 unsigned long gnttab_end_foreign_transfer_ref(grant_ref_t ref);
 126 unsigned long gnttab_end_foreign_transfer(grant_ref_t ref);
 127
 128 /*
 129  * operations on reserved batches of grant references
 130  */
 131 int gnttab_alloc_grant_references(u16 count, grant_ref_t *pprivate_head);
 132
 133 void gnttab_free_grant_reference(grant_ref_t ref);
 134
 135 void gnttab_free_grant_references(grant_ref_t head);
 136
 137 int gnttab_empty_grant_references(const grant_ref_t *pprivate_head);
 138
 139 int gnttab_claim_grant_reference(grant_ref_t *pprivate_head);
 140
 141 void gnttab_release_grant_reference(grant_ref_t *private_head,
 142                                     grant_ref_t release);
 143
 144 void gnttab_request_free_callback(struct gnttab_free_callback *callback,
 145                                   void (*fn)(void *), void *arg, u16 count);
 146 void gnttab_cancel_free_callback(struct gnttab_free_callback *callback);
 147
 148 void gnttab_grant_foreign_access_ref(grant_ref_t ref, domid_t domid,
 149                                      unsigned long frame, int readonly);
 150
 151 /* Give access to the first 4K of the page */
 152 static inline void gnttab_page_grant_foreign_access_ref_one(
 153         grant_ref_t ref, domid_t domid,
 154         struct page *page, int readonly)
 155 {
 156         gnttab_grant_foreign_access_ref(ref, domid, xen_page_to_gfn(page),
 157                                         readonly);
 158 }
 159
 160 void gnttab_grant_foreign_transfer_ref(grant_ref_t, domid_t domid,
 161                                        unsigned long pfn);
 162
 163 static inline void
 164 gnttab_set_map_op(struct gnttab_map_grant_ref *map, phys_addr_t addr,
 165                   uint32_t flags, grant_ref_t ref, domid_t domid)
 166 {
 167         if (flags & GNTMAP_contains_pte)
 168                 map->host_addr = addr;
 169         else if (xen_feature(XENFEAT_auto_translated_physmap))
 170                 map->host_addr = __pa(addr);
 171         else
 172                 map->host_addr = addr;
 173
 174         map->flags = flags;
 175         map->ref = ref;
 176         map->dom = domid;
 177         map->status = 1; /* arbitrary positive value */
 178 }
 179
 180 static inline void
 181 gnttab_set_unmap_op(struct gnttab_unmap_grant_ref *unmap, phys_addr_t addr,
 182                     uint32_t flags, grant_handle_t handle)
 183 {
 184         if (flags & GNTMAP_contains_pte)
 185                 unmap->host_addr = addr;
 186         else if (xen_feature(XENFEAT_auto_translated_physmap))
 187                 unmap->host_addr = __pa(addr);
 188         else
 189                 unmap->host_addr = addr;
 190
 191         unmap->handle = handle;
 192         unmap->dev_bus_addr = 0;
 193 }
 194
 195 int arch_gnttab_init(unsigned long nr_shared, unsigned long nr_status);
 196 int arch_gnttab_map_shared(xen_pfn_t *frames, unsigned long nr_gframes,
 197                            unsigned long max_nr_gframes,
 198                            void **__shared);
 199 int arch_gnttab_map_status(uint64_t *frames, unsigned long nr_gframes,
 200                            unsigned long max_nr_gframes,
 201                            grant_status_t **__shared);
 202 void arch_gnttab_unmap(void *shared, unsigned long nr_gframes);
 203
 204 struct grant_frames {
 205         xen_pfn_t *pfn;
 206         unsigned int count;
 207         void *vaddr;
 208 };
 209 extern struct grant_frames xen_auto_xlat_grant_frames;
 210 unsigned int gnttab_max_grant_frames(void);
 211 int gnttab_setup_auto_xlat_frames(phys_addr_t addr);
 212 void gnttab_free_auto_xlat_frames(void);
 213
 214 #define gnttab_map_vaddr(map) ((void *)(map.host_virt_addr))
 215
 216 int gnttab_alloc_pages(int nr_pages, struct page **pages);
 217 void gnttab_free_pages(int nr_pages, struct page **pages);
 218
 219 struct gnttab_page_cache {
 220         spinlock_t              lock;
 221 #ifdef CONFIG_XEN_UNPOPULATED_ALLOC
 222         struct page             *pages;
 223 #else
 224         struct list_head        pages;
 225 #endif
 226         unsigned int            num_pages;
 227 };
 228
 229 void gnttab_page_cache_init(struct gnttab_page_cache *cache);
 230 int gnttab_page_cache_get(struct gnttab_page_cache *cache, struct page **page);
 231 void gnttab_page_cache_put(struct gnttab_page_cache *cache, struct page **page,
 232                            unsigned int num);
 233 void gnttab_page_cache_shrink(struct gnttab_page_cache *cache,
 234                               unsigned int num);
 235
 236 #ifdef CONFIG_XEN_GRANT_DMA_ALLOC
 237 struct gnttab_dma_alloc_args {
 238         /* Device for which DMA memory will be/was allocated. */
 239         struct device *dev;
 240         /* If set then DMA buffer is coherent and write-combine otherwise. */
 241         bool coherent;
 242
 243         int nr_pages;
 244         struct page **pages;
 245         xen_pfn_t *frames;
 246         void *vaddr;
 247         dma_addr_t dev_bus_addr;
 248 };
 249
 250 int gnttab_dma_alloc_pages(struct gnttab_dma_alloc_args *args);
 251 int gnttab_dma_free_pages(struct gnttab_dma_alloc_args *args);
 252 #endif
 253
 254 int gnttab_pages_set_private(int nr_pages, struct page **pages);
 255 void gnttab_pages_clear_private(int nr_pages, struct page **pages);
 256
 257 int gnttab_map_refs(struct gnttab_map_grant_ref *map_ops,
 258                     struct gnttab_map_grant_ref *kmap_ops,
 259                     struct page **pages, unsigned int count);
 260 int gnttab_unmap_refs(struct gnttab_unmap_grant_ref *unmap_ops,
 261                       struct gnttab_unmap_grant_ref *kunmap_ops,
 262                       struct page **pages, unsigned int count);
 263 void gnttab_unmap_refs_async(struct gntab_unmap_queue_data* item);
 264 int gnttab_unmap_refs_sync(struct gntab_unmap_queue_data *item);
 265
 266
 267 /* Perform a batch of grant map/copy operations. Retry every batch slot
 268  * for which the hypervisor returns GNTST_eagain. This is typically due
 269  * to paged out target frames.
 270  *
 271  * Will retry for 1, 2, ... 255 ms, i.e. 256 times during 32 seconds.
 272  *
 273  * Return value in each iand every status field of the batch guaranteed
 274  * to not be GNTST_eagain.
 275  */
 276 void gnttab_batch_map(struct gnttab_map_grant_ref *batch, unsigned count);
 277 void gnttab_batch_copy(struct gnttab_copy *batch, unsigned count);
 278
 279
 280 struct xen_page_foreign {
 281         domid_t domid;
 282         grant_ref_t gref;
 283 };
 284
 285 static inline struct xen_page_foreign *xen_page_foreign(struct page *page)
 286 {
 287         if (!PageForeign(page))
 288                 return NULL;
 289 #if BITS_PER_LONG < 64
 290         return (struct xen_page_foreign *)page->private;
 291 #else
 292         BUILD_BUG_ON(sizeof(struct xen_page_foreign) > BITS_PER_LONG);
 293         return (struct xen_page_foreign *)&page->private;
 294 #endif
 295 }
 296
 297 /* Split Linux page in chunk of the size of the grant and call fn
 298  *
 299  * Parameters of fn:
 300  *      gfn: guest frame number
 301  *      offset: offset in the grant
 302  *      len: length of the data in the grant.
 303  *      data: internal information
 304  */
 305 typedef void (*xen_grant_fn_t)(unsigned long gfn, unsigned int offset,
 306                                unsigned int len, void *data);
 307
 308 void gnttab_foreach_grant_in_range(struct page *page,
 309                                    unsigned int offset,
 310                                    unsigned int len,
 311                                    xen_grant_fn_t fn,
 312                                    void *data);
 313
 314 /* Helper to get to call fn only on the first "grant chunk" */
 315 static inline void gnttab_for_one_grant(struct page *page, unsigned int offset,
 316                                         unsigned len, xen_grant_fn_t fn,
 317                                         void *data)
 318 {
 319         /* The first request is limited to the size of one grant */
 320         len = min_t(unsigned int, XEN_PAGE_SIZE - (offset & ~XEN_PAGE_MASK),
 321                     len);
 322
 323         gnttab_foreach_grant_in_range(page, offset, len, fn, data);
 324 }
 325
 326 /* Get @nr_grefs grants from an array of page and call fn for each grant */
 327 void gnttab_foreach_grant(struct page **pages,
 328                           unsigned int nr_grefs,
 329                           xen_grant_fn_t fn,
 330                           void *data);
 331
 332 /* Get the number of grant in a specified region
 333  *
 334  * start: Offset from the beginning of the first page
 335  * len: total length of data (can cross multiple page)
 336  */
 337 static inline unsigned int gnttab_count_grant(unsigned int start,
 338                                               unsigned int len)
 339 {
 340         return XEN_PFN_UP(xen_offset_in_page(start) + len);
 341 }
 342
 343 #endif /* __ASM_GNTTAB_H__ */