include/xen/gnttab.h

   1 /******************************************************************************
   2  * gnttab.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/hypervisor.h>
  41 #include <asm/maddr.h> /* maddr_t */
  42 #include <linux/mm.h>
  43 #include <xen/interface/grant_table.h>
  44 #include <xen/features.h>
  45
  46 struct gnttab_free_callback {
  47         struct gnttab_free_callback *next;
  48         void (*fn)(void *);
  49         void *arg;
  50         u16 count;
  51         u8 queued;
  52 };
  53
  54 int gnttab_grant_foreign_access(domid_t domid, unsigned long frame,
  55                                 int flags);
  56
  57 /*
  58  * End access through the given grant reference, iff the grant entry is no
  59  * longer in use.  Return 1 if the grant entry was freed, 0 if it is still in
  60  * use.
  61  */
  62 int gnttab_end_foreign_access_ref(grant_ref_t ref);
  63
  64 /*
  65  * Eventually end access through the given grant reference, and once that
  66  * access has been ended, free the given page too.  Access will be ended
  67  * immediately iff the grant entry is not in use, otherwise it will happen
  68  * some time later.  page may be 0, in which case no freeing will occur.
  69  */
  70 void gnttab_end_foreign_access(grant_ref_t ref, unsigned long page);
  71
  72 int gnttab_grant_foreign_transfer(domid_t domid, unsigned long pfn);
  73
  74 unsigned long gnttab_end_foreign_transfer_ref(grant_ref_t ref);
  75 unsigned long gnttab_end_foreign_transfer(grant_ref_t ref);
  76
  77 int gnttab_query_foreign_access(grant_ref_t ref);
  78
  79 /*
  80  * operations on reserved batches of grant references
  81  */
  82 int gnttab_alloc_grant_references(u16 count, grant_ref_t *pprivate_head);
  83
  84 void gnttab_free_grant_reference(grant_ref_t ref);
  85
  86 void gnttab_free_grant_references(grant_ref_t head);
  87
  88 int gnttab_empty_grant_references(const grant_ref_t *pprivate_head);
  89
  90 int gnttab_claim_grant_reference(grant_ref_t *pprivate_head);
  91
  92 void gnttab_release_grant_reference(grant_ref_t *private_head,
  93                                     grant_ref_t release);
  94
  95 void gnttab_request_free_callback(struct gnttab_free_callback *callback,
  96                                   void (*fn)(void *), void *arg, u16 count);
  97 void gnttab_cancel_free_callback(struct gnttab_free_callback *callback);
  98
  99 void gnttab_grant_foreign_access_ref(grant_ref_t ref, domid_t domid,
 100                                      unsigned long frame, int flags);
 101
 102 void gnttab_grant_foreign_transfer_ref(grant_ref_t, domid_t domid,
 103                                        unsigned long pfn);
 104
 105 int gnttab_copy_grant_page(grant_ref_t ref, struct page **pagep);
 106 #if defined(CONFIG_XEN_BACKEND) || defined(CONFIG_XEN_BACKEND_MODULE)
 107 void __gnttab_dma_map_page(struct page *page);
 108 #else
 109 #define __gnttab_dma_map_page __gnttab_dma_unmap_page
 110 #endif
 111 static inline void __gnttab_dma_unmap_page(struct page *page)
 112 {
 113 }
 114
 115 void gnttab_reset_grant_page(struct page *page);
 116
 117 #ifndef CONFIG_XEN
 118 int gnttab_resume(void);
 119 #endif
 120
 121 void *arch_gnttab_alloc_shared(unsigned long *frames);
 122
 123 static inline void
 124 gnttab_set_map_op(struct gnttab_map_grant_ref *map, maddr_t addr,
 125                   uint32_t flags, grant_ref_t ref, domid_t domid)
 126 {
 127         if (flags & GNTMAP_contains_pte)
 128                 map->host_addr = addr;
 129         else if (xen_feature(XENFEAT_auto_translated_physmap))
 130                 map->host_addr = __pa(addr);
 131         else
 132                 map->host_addr = addr;
 133
 134         map->flags = flags;
 135         map->ref = ref;
 136         map->dom = domid;
 137 }
 138
 139 static inline void
 140 gnttab_set_unmap_op(struct gnttab_unmap_grant_ref *unmap, maddr_t addr,
 141                     uint32_t flags, grant_handle_t handle)
 142 {
 143         if (flags & GNTMAP_contains_pte)
 144                 unmap->host_addr = addr;
 145         else if (xen_feature(XENFEAT_auto_translated_physmap))
 146                 unmap->host_addr = __pa(addr);
 147         else
 148                 unmap->host_addr = addr;
 149
 150         unmap->handle = handle;
 151         unmap->dev_bus_addr = 0;
 152 }
 153
 154 static inline void
 155 gnttab_set_replace_op(struct gnttab_unmap_and_replace *unmap, maddr_t addr,
 156                       maddr_t new_addr, grant_handle_t handle)
 157 {
 158         if (xen_feature(XENFEAT_auto_translated_physmap)) {
 159                 unmap->host_addr = __pa(addr);
 160                 unmap->new_addr = __pa(new_addr);
 161         } else {
 162                 unmap->host_addr = addr;
 163                 unmap->new_addr = new_addr;
 164         }
 165
 166         unmap->handle = handle;
 167 }
 168
 169 #endif /* __ASM_GNTTAB_H__ */