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 49 /* NR_GRANT_FRAMES must be less than or equal to that configured in Xen */ 50 #define NR_GRANT_FRAMES 4 51 52 struct gnttab_free_callback { 53 struct gnttab_free_callback *next; 54 void (*fn)(void *); 55 void *arg; 56 u16 count; 57 }; 58 59 int gnttab_init(void); 60 int gnttab_suspend(void); 61 int gnttab_resume(void); 62 63 int gnttab_grant_foreign_access(domid_t domid, unsigned long frame, 64 int readonly); 65 66 /* 67 * End access through the given grant reference, iff the grant entry is no 68 * longer in use. Return 1 if the grant entry was freed, 0 if it is still in 69 * use. 70 */ 71 int gnttab_end_foreign_access_ref(grant_ref_t ref, int readonly); 72 73 /* 74 * Eventually end access through the given grant reference, and once that 75 * access has been ended, free the given page too. Access will be ended 76 * immediately iff the grant entry is not in use, otherwise it will happen 77 * some time later. page may be 0, in which case no freeing will occur. 78 */ 79 void gnttab_end_foreign_access(grant_ref_t ref, int readonly, 80 unsigned long page); 81 82 int gnttab_grant_foreign_transfer(domid_t domid, unsigned long pfn); 83 84 unsigned long gnttab_end_foreign_transfer_ref(grant_ref_t ref); 85 unsigned long gnttab_end_foreign_transfer(grant_ref_t ref); 86 87 int gnttab_query_foreign_access(grant_ref_t ref); 88 89 /* 90 * operations on reserved batches of grant references 91 */ 92 int gnttab_alloc_grant_references(u16 count, grant_ref_t *pprivate_head); 93 94 void gnttab_free_grant_reference(grant_ref_t ref); 95 96 void gnttab_free_grant_references(grant_ref_t head); 97 98 int gnttab_empty_grant_references(const grant_ref_t *pprivate_head); 99 100 int gnttab_claim_grant_reference(grant_ref_t *pprivate_head); 101 102 void gnttab_release_grant_reference(grant_ref_t *private_head, 103 grant_ref_t release); 104 105 void gnttab_request_free_callback(struct gnttab_free_callback *callback, 106 void (*fn)(void *), void *arg, u16 count); 107 void gnttab_cancel_free_callback(struct gnttab_free_callback *callback); 108 109 void gnttab_grant_foreign_access_ref(grant_ref_t ref, domid_t domid, 110 unsigned long frame, int readonly); 111 112 void gnttab_grant_foreign_transfer_ref(grant_ref_t, domid_t domid, 113 unsigned long pfn); 114 115 static inline void 116 gnttab_set_map_op(struct gnttab_map_grant_ref *map, phys_addr_t addr, 117 uint32_t flags, grant_ref_t ref, domid_t domid) 118 { 119 if (flags & GNTMAP_contains_pte) 120 map->host_addr = addr; 121 else if (xen_feature(XENFEAT_auto_translated_physmap)) 122 map->host_addr = __pa(addr); 123 else 124 map->host_addr = addr; 125 126 map->flags = flags; 127 map->ref = ref; 128 map->dom = domid; 129 } 130 131 static inline void 132 gnttab_set_unmap_op(struct gnttab_unmap_grant_ref *unmap, phys_addr_t addr, 133 uint32_t flags, grant_handle_t handle) 134 { 135 if (flags & GNTMAP_contains_pte) 136 unmap->host_addr = addr; 137 else if (xen_feature(XENFEAT_auto_translated_physmap)) 138 unmap->host_addr = __pa(addr); 139 else 140 unmap->host_addr = addr; 141 142 unmap->handle = handle; 143 unmap->dev_bus_addr = 0; 144 } 145 146 int arch_gnttab_map_shared(unsigned long *frames, unsigned long nr_gframes, 147 unsigned long max_nr_gframes, 148 struct grant_entry **__shared); 149 void arch_gnttab_unmap_shared(struct grant_entry *shared, 150 unsigned long nr_gframes); 151 152 extern unsigned long xen_hvm_resume_frames; 153 unsigned int gnttab_max_grant_frames(void); 154 155 #define gnttab_map_vaddr(map) ((void *)(map.host_virt_addr)) 156 157 int gnttab_map_refs(struct gnttab_map_grant_ref *map_ops, 158 struct gnttab_map_grant_ref *kmap_ops, 159 struct page **pages, unsigned int count); 160 int gnttab_unmap_refs(struct gnttab_unmap_grant_ref *unmap_ops, 161 struct page **pages, unsigned int count); 162 163 #endif /* __ASM_GNTTAB_H__ */ 164