Commit | Line | Data |
---|---|---|
ad9a8612 JF |
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 | ||
f0774532 IC |
40 | #include <asm/page.h> |
41 | ||
42 | #include <xen/interface/xen.h> | |
ad9a8612 | 43 | #include <xen/interface/grant_table.h> |
f0774532 IC |
44 | |
45 | #include <asm/xen/hypervisor.h> | |
ad9a8612 | 46 | |
f0774532 IC |
47 | #include <xen/features.h> |
48 | ||
ad9a8612 JF |
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 | ||
183d03cc | 59 | int gnttab_init(void); |
0e91398f JF |
60 | int gnttab_suspend(void); |
61 | int gnttab_resume(void); | |
62 | ||
ad9a8612 JF |
63 | int gnttab_grant_foreign_access(domid_t domid, unsigned long frame, |
64 | int readonly); | |
6666754b AL |
65 | int gnttab_grant_foreign_access_subpage(domid_t domid, unsigned long frame, |
66 | int flags, unsigned page_off, | |
67 | unsigned length); | |
68 | ||
69 | /* | |
70 | * Are sub-page grants available on this version of Xen? Returns true if they | |
71 | * are, and false if they're not. | |
72 | */ | |
73 | bool gnttab_subpage_grants_available(void); | |
ad9a8612 JF |
74 | |
75 | /* | |
76 | * End access through the given grant reference, iff the grant entry is no | |
77 | * longer in use. Return 1 if the grant entry was freed, 0 if it is still in | |
78 | * use. | |
79 | */ | |
80 | int gnttab_end_foreign_access_ref(grant_ref_t ref, int readonly); | |
81 | ||
82 | /* | |
83 | * Eventually end access through the given grant reference, and once that | |
84 | * access has been ended, free the given page too. Access will be ended | |
85 | * immediately iff the grant entry is not in use, otherwise it will happen | |
86 | * some time later. page may be 0, in which case no freeing will occur. | |
87 | */ | |
88 | void gnttab_end_foreign_access(grant_ref_t ref, int readonly, | |
89 | unsigned long page); | |
90 | ||
91 | int gnttab_grant_foreign_transfer(domid_t domid, unsigned long pfn); | |
92 | ||
93 | unsigned long gnttab_end_foreign_transfer_ref(grant_ref_t ref); | |
94 | unsigned long gnttab_end_foreign_transfer(grant_ref_t ref); | |
95 | ||
96 | int gnttab_query_foreign_access(grant_ref_t ref); | |
97 | ||
98 | /* | |
99 | * operations on reserved batches of grant references | |
100 | */ | |
101 | int gnttab_alloc_grant_references(u16 count, grant_ref_t *pprivate_head); | |
102 | ||
103 | void gnttab_free_grant_reference(grant_ref_t ref); | |
104 | ||
105 | void gnttab_free_grant_references(grant_ref_t head); | |
106 | ||
107 | int gnttab_empty_grant_references(const grant_ref_t *pprivate_head); | |
108 | ||
109 | int gnttab_claim_grant_reference(grant_ref_t *pprivate_head); | |
110 | ||
111 | void gnttab_release_grant_reference(grant_ref_t *private_head, | |
112 | grant_ref_t release); | |
113 | ||
114 | void gnttab_request_free_callback(struct gnttab_free_callback *callback, | |
115 | void (*fn)(void *), void *arg, u16 count); | |
116 | void gnttab_cancel_free_callback(struct gnttab_free_callback *callback); | |
117 | ||
118 | void gnttab_grant_foreign_access_ref(grant_ref_t ref, domid_t domid, | |
119 | unsigned long frame, int readonly); | |
6666754b AL |
120 | int gnttab_grant_foreign_access_subpage_ref(grant_ref_t ref, domid_t domid, |
121 | unsigned long frame, int flags, | |
122 | unsigned page_off, | |
123 | unsigned length); | |
ad9a8612 JF |
124 | |
125 | void gnttab_grant_foreign_transfer_ref(grant_ref_t, domid_t domid, | |
126 | unsigned long pfn); | |
127 | ||
f0774532 IC |
128 | static inline void |
129 | gnttab_set_map_op(struct gnttab_map_grant_ref *map, phys_addr_t addr, | |
130 | uint32_t flags, grant_ref_t ref, domid_t domid) | |
131 | { | |
132 | if (flags & GNTMAP_contains_pte) | |
133 | map->host_addr = addr; | |
134 | else if (xen_feature(XENFEAT_auto_translated_physmap)) | |
135 | map->host_addr = __pa(addr); | |
136 | else | |
137 | map->host_addr = addr; | |
138 | ||
139 | map->flags = flags; | |
140 | map->ref = ref; | |
141 | map->dom = domid; | |
142 | } | |
143 | ||
144 | static inline void | |
145 | gnttab_set_unmap_op(struct gnttab_unmap_grant_ref *unmap, phys_addr_t addr, | |
146 | uint32_t flags, grant_handle_t handle) | |
147 | { | |
148 | if (flags & GNTMAP_contains_pte) | |
149 | unmap->host_addr = addr; | |
150 | else if (xen_feature(XENFEAT_auto_translated_physmap)) | |
151 | unmap->host_addr = __pa(addr); | |
152 | else | |
153 | unmap->host_addr = addr; | |
154 | ||
155 | unmap->handle = handle; | |
156 | unmap->dev_bus_addr = 0; | |
157 | } | |
158 | ||
8d3d2106 IY |
159 | int arch_gnttab_map_shared(unsigned long *frames, unsigned long nr_gframes, |
160 | unsigned long max_nr_gframes, | |
0f9f5a95 | 161 | void **__shared); |
85ff6acb AL |
162 | int arch_gnttab_map_status(uint64_t *frames, unsigned long nr_gframes, |
163 | unsigned long max_nr_gframes, | |
164 | grant_status_t **__shared); | |
165 | void arch_gnttab_unmap(void *shared, unsigned long nr_gframes); | |
8d3d2106 | 166 | |
183d03cc SS |
167 | extern unsigned long xen_hvm_resume_frames; |
168 | unsigned int gnttab_max_grant_frames(void); | |
169 | ||
ad9a8612 JF |
170 | #define gnttab_map_vaddr(map) ((void *)(map.host_virt_addr)) |
171 | ||
289b777e | 172 | int gnttab_map_refs(struct gnttab_map_grant_ref *map_ops, |
c123799a | 173 | struct gnttab_map_grant_ref *kmap_ops, |
289b777e SS |
174 | struct page **pages, unsigned int count); |
175 | int gnttab_unmap_refs(struct gnttab_unmap_grant_ref *unmap_ops, | |
176 | struct page **pages, unsigned int count); | |
177 | ||
ad9a8612 | 178 | #endif /* __ASM_GNTTAB_H__ */ |