ia64/xen-unstable

view xen/include/public/grant_table.h @ 6788:e939d5c5e646

Pass the root directory to Doxyfilter and thence pythfilter.py so that the latter can get the namespace/packages correct.
author ewan@linford.intra
date Tue Sep 13 14:42:21 2005 +0100 (2005-09-13)
parents dd668f7527cb
children b2f4823b6ff0 b35215021b32 9af349b055e5 3233e7ecfa9f
line source
1 /******************************************************************************
2 * grant_table.h
3 *
4 * Interface for granting foreign access to page frames, and receiving
5 * page-ownership transfers.
6 *
7 * Copyright (c) 2004, K A Fraser
8 */
10 #ifndef __XEN_PUBLIC_GRANT_TABLE_H__
11 #define __XEN_PUBLIC_GRANT_TABLE_H__
14 /***********************************
15 * GRANT TABLE REPRESENTATION
16 */
18 /* Some rough guidelines on accessing and updating grant-table entries
19 * in a concurrency-safe manner. For more information, Linux contains a
20 * reference implementation for guest OSes (arch/xen/kernel/grant_table.c).
21 *
22 * NB. WMB is a no-op on current-generation x86 processors. However, a
23 * compiler barrier will still be required.
24 *
25 * Introducing a valid entry into the grant table:
26 * 1. Write ent->domid.
27 * 2. Write ent->frame:
28 * GTF_permit_access: Frame to which access is permitted.
29 * GTF_accept_transfer: Pseudo-phys frame slot being filled by new
30 * frame, or zero if none.
31 * 3. Write memory barrier (WMB).
32 * 4. Write ent->flags, inc. valid type.
33 *
34 * Invalidating an unused GTF_permit_access entry:
35 * 1. flags = ent->flags.
36 * 2. Observe that !(flags & (GTF_reading|GTF_writing)).
37 * 3. Check result of SMP-safe CMPXCHG(&ent->flags, flags, 0).
38 * NB. No need for WMB as reuse of entry is control-dependent on success of
39 * step 3, and all architectures guarantee ordering of ctrl-dep writes.
40 *
41 * Invalidating an in-use GTF_permit_access entry:
42 * This cannot be done directly. Request assistance from the domain controller
43 * which can set a timeout on the use of a grant entry and take necessary
44 * action. (NB. This is not yet implemented!).
45 *
46 * Invalidating an unused GTF_accept_transfer entry:
47 * 1. flags = ent->flags.
48 * 2. Observe that !(flags & GTF_transfer_committed). [*]
49 * 3. Check result of SMP-safe CMPXCHG(&ent->flags, flags, 0).
50 * NB. No need for WMB as reuse of entry is control-dependent on success of
51 * step 3, and all architectures guarantee ordering of ctrl-dep writes.
52 * [*] If GTF_transfer_committed is set then the grant entry is 'committed'.
53 * The guest must /not/ modify the grant entry until the address of the
54 * transferred frame is written. It is safe for the guest to spin waiting
55 * for this to occur (detect by observing GTF_transfer_completed in
56 * ent->flags).
57 *
58 * Invalidating a committed GTF_accept_transfer entry:
59 * 1. Wait for (ent->flags & GTF_transfer_completed).
60 *
61 * Changing a GTF_permit_access from writable to read-only:
62 * Use SMP-safe CMPXCHG to set GTF_readonly, while checking !GTF_writing.
63 *
64 * Changing a GTF_permit_access from read-only to writable:
65 * Use SMP-safe bit-setting instruction.
66 */
68 /*
69 * A grant table comprises a packed array of grant entries in one or more
70 * page frames shared between Xen and a guest.
71 * [XEN]: This field is written by Xen and read by the sharing guest.
72 * [GST]: This field is written by the guest and read by Xen.
73 */
74 typedef struct grant_entry {
75 /* GTF_xxx: various type and flag information. [XEN,GST] */
76 u16 flags;
77 /* The domain being granted foreign privileges. [GST] */
78 domid_t domid;
79 /*
80 * GTF_permit_access: Frame that @domid is allowed to map and access. [GST]
81 * GTF_accept_transfer: Frame whose ownership transferred by @domid. [XEN]
82 */
83 u32 frame;
84 } grant_entry_t;
86 /*
87 * Type of grant entry.
88 * GTF_invalid: This grant entry grants no privileges.
89 * GTF_permit_access: Allow @domid to map/access @frame.
90 * GTF_accept_transfer: Allow @domid to transfer ownership of one page frame
91 * to this guest. Xen writes the page number to @frame.
92 */
93 #define GTF_invalid (0U<<0)
94 #define GTF_permit_access (1U<<0)
95 #define GTF_accept_transfer (2U<<0)
96 #define GTF_type_mask (3U<<0)
98 /*
99 * Subflags for GTF_permit_access.
100 * GTF_readonly: Restrict @domid to read-only mappings and accesses. [GST]
101 * GTF_reading: Grant entry is currently mapped for reading by @domid. [XEN]
102 * GTF_writing: Grant entry is currently mapped for writing by @domid. [XEN]
103 */
104 #define _GTF_readonly (2)
105 #define GTF_readonly (1U<<_GTF_readonly)
106 #define _GTF_reading (3)
107 #define GTF_reading (1U<<_GTF_reading)
108 #define _GTF_writing (4)
109 #define GTF_writing (1U<<_GTF_writing)
111 /*
112 * Subflags for GTF_accept_transfer:
113 * GTF_transfer_committed: Xen sets this flag to indicate that it is committed
114 * to transferring ownership of a page frame. When a guest sees this flag
115 * it must /not/ modify the grant entry until GTF_transfer_completed is
116 * set by Xen.
117 * GTF_transfer_completed: It is safe for the guest to spin-wait on this flag
118 * after reading GTF_transfer_committed. Xen will always write the frame
119 * address, followed by ORing this flag, in a timely manner.
120 */
121 #define _GTF_transfer_committed (2)
122 #define GTF_transfer_committed (1U<<_GTF_transfer_committed)
123 #define _GTF_transfer_completed (3)
124 #define GTF_transfer_completed (1U<<_GTF_transfer_completed)
127 /***********************************
128 * GRANT TABLE QUERIES AND USES
129 */
131 /*
132 * Reference to a grant entry in a specified domain's grant table.
133 */
134 typedef u16 grant_ref_t;
136 /*
137 * GNTTABOP_map_grant_ref: Map the grant entry (<dom>,<ref>) for access
138 * by devices and/or host CPUs. If successful, <handle> is a tracking number
139 * that must be presented later to destroy the mapping(s). On error, <handle>
140 * is a negative status code.
141 * NOTES:
142 * 1. If GNTPIN_map_for_dev is specified then <dev_bus_addr> is the address
143 * via which I/O devices may access the granted frame.
144 * 2. If GNTPIN_map_for_host is specified then a mapping will be added at
145 * either a host virtual address in the current address space, or at
146 * a PTE at the specified machine address. The type of mapping to
147 * perform is selected through the GNTMAP_contains_pte flag, and the
148 * address is specified in <host_addr>.
149 * 3. Mappings should only be destroyed via GNTTABOP_unmap_grant_ref. If a
150 * host mapping is destroyed by other means then it is *NOT* guaranteed
151 * to be accounted to the correct grant reference!
152 */
153 #define GNTTABOP_map_grant_ref 0
154 typedef struct gnttab_map_grant_ref {
155 /* IN parameters. */
156 u64 host_addr;
157 domid_t dom;
158 grant_ref_t ref;
159 u16 flags; /* GNTMAP_* */
160 /* OUT parameters. */
161 s16 handle; /* +ve: handle; -ve: GNTST_* */
162 u64 dev_bus_addr;
163 } gnttab_map_grant_ref_t;
165 /*
166 * GNTTABOP_unmap_grant_ref: Destroy one or more grant-reference mappings
167 * tracked by <handle>. If <host_addr> or <dev_bus_addr> is zero, that
168 * field is ignored. If non-zero, they must refer to a device/host mapping
169 * that is tracked by <handle>
170 * NOTES:
171 * 1. The call may fail in an undefined manner if either mapping is not
172 * tracked by <handle>.
173 * 3. After executing a batch of unmaps, it is guaranteed that no stale
174 * mappings will remain in the device or host TLBs.
175 */
176 #define GNTTABOP_unmap_grant_ref 1
177 typedef struct gnttab_unmap_grant_ref {
178 /* IN parameters. */
179 u64 host_addr;
180 u64 dev_bus_addr;
181 u16 handle;
182 /* OUT parameters. */
183 s16 status; /* GNTST_* */
184 } gnttab_unmap_grant_ref_t;
186 /*
187 * GNTTABOP_setup_table: Set up a grant table for <dom> comprising at least
188 * <nr_frames> pages. The frame addresses are written to the <frame_list>.
189 * Only <nr_frames> addresses are written, even if the table is larger.
190 * NOTES:
191 * 1. <dom> may be specified as DOMID_SELF.
192 * 2. Only a sufficiently-privileged domain may specify <dom> != DOMID_SELF.
193 * 3. Xen may not support more than a single grant-table page per domain.
194 */
195 #define GNTTABOP_setup_table 2
196 typedef struct gnttab_setup_table {
197 /* IN parameters. */
198 domid_t dom;
199 u16 nr_frames;
200 /* OUT parameters. */
201 s16 status; /* GNTST_* */
202 unsigned long *frame_list;
203 } gnttab_setup_table_t;
205 /*
206 * GNTTABOP_dump_table: Dump the contents of the grant table to the
207 * xen console. Debugging use only.
208 */
209 #define GNTTABOP_dump_table 3
210 typedef struct gnttab_dump_table {
211 /* IN parameters. */
212 domid_t dom;
213 /* OUT parameters. */
214 s16 status; /* GNTST_* */
215 } gnttab_dump_table_t;
217 /*
218 * GNTTABOP_donate_grant_ref: Donate <frame> to a foreign domain. The
219 * foreign domain has previously registered the details of the transfer.
220 * These can be identified from <handle>, a grant reference.
221 */
222 #define GNTTABOP_donate 4
223 typedef struct {
224 unsigned long mfn; /* 0 */
225 domid_t domid; /* 4 */
226 u16 handle; /* 8 */
227 s16 status; /* 10: GNTST_* */
228 u32 __pad;
229 } gnttab_donate_t; /* 14 bytes */
231 /*
232 * Bitfield values for update_pin_status.flags.
233 */
234 /* Map the grant entry for access by I/O devices. */
235 #define _GNTMAP_device_map (0)
236 #define GNTMAP_device_map (1<<_GNTMAP_device_map)
237 /* Map the grant entry for access by host CPUs. */
238 #define _GNTMAP_host_map (1)
239 #define GNTMAP_host_map (1<<_GNTMAP_host_map)
240 /* Accesses to the granted frame will be restricted to read-only access. */
241 #define _GNTMAP_readonly (2)
242 #define GNTMAP_readonly (1<<_GNTMAP_readonly)
243 /*
244 * GNTMAP_host_map subflag:
245 * 0 => The host mapping is usable only by the guest OS.
246 * 1 => The host mapping is usable by guest OS + current application.
247 */
248 #define _GNTMAP_application_map (3)
249 #define GNTMAP_application_map (1<<_GNTMAP_application_map)
251 /*
252 * GNTMAP_contains_pte subflag:
253 * 0 => This map request contains a host virtual address.
254 * 1 => This map request contains the machine addess of the PTE to update.
255 */
256 #define _GNTMAP_contains_pte (4)
257 #define GNTMAP_contains_pte (1<<_GNTMAP_contains_pte)
259 /*
260 * Values for error status returns. All errors are -ve.
261 */
262 #define GNTST_okay (0) /* Normal return. */
263 #define GNTST_general_error (-1) /* General undefined error. */
264 #define GNTST_bad_domain (-2) /* Unrecognsed domain id. */
265 #define GNTST_bad_gntref (-3) /* Unrecognised or inappropriate gntref. */
266 #define GNTST_bad_handle (-4) /* Unrecognised or inappropriate handle. */
267 #define GNTST_bad_virt_addr (-5) /* Inappropriate virtual address to map. */
268 #define GNTST_bad_dev_addr (-6) /* Inappropriate device address to unmap.*/
269 #define GNTST_no_device_space (-7) /* Out of space in I/O MMU. */
270 #define GNTST_permission_denied (-8) /* Not enough privilege for operation. */
272 #define GNTTABOP_error_msgs { \
273 "okay", \
274 "undefined error", \
275 "unrecognised domain id", \
276 "invalid grant reference", \
277 "invalid mapping handle", \
278 "invalid virtual address", \
279 "invalid device address", \
280 "no spare translation slot in the I/O MMU", \
281 "permission denied" \
282 }
284 #endif /* __XEN_PUBLIC_GRANT_TABLE_H__ */