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