ia64/linux-2.6.18-xen.hg

view include/xen/interface/xen.h @ 540:db71fb3204b5

Sync public Xen hedaers with xen-unstable.hg
Signed-off-by: Keir Fraser <keir.fraser@citrix.com>
author Keir Fraser <keir.fraser@citrix.com>
date Mon May 12 10:03:08 2008 +0100 (2008-05-12)
parents 06ffa3eb5e3f
children 2f1355579c9c
line source
1 /******************************************************************************
2 * xen.h
3 *
4 * Guest OS interface to Xen.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to
8 * deal in the Software without restriction, including without limitation the
9 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10 * sell copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *
24 * Copyright (c) 2004, K A Fraser
25 */
27 #ifndef __XEN_PUBLIC_XEN_H__
28 #define __XEN_PUBLIC_XEN_H__
30 #include "xen-compat.h"
32 #if defined(__i386__) || defined(__x86_64__)
33 #include "arch-x86/xen.h"
34 #elif defined(__ia64__)
35 #include "arch-ia64.h"
36 #else
37 #error "Unsupported architecture"
38 #endif
40 #ifndef __ASSEMBLY__
41 /* Guest handles for primitive C types. */
42 DEFINE_XEN_GUEST_HANDLE(char);
43 __DEFINE_XEN_GUEST_HANDLE(uchar, unsigned char);
44 DEFINE_XEN_GUEST_HANDLE(int);
45 __DEFINE_XEN_GUEST_HANDLE(uint, unsigned int);
46 DEFINE_XEN_GUEST_HANDLE(long);
47 __DEFINE_XEN_GUEST_HANDLE(ulong, unsigned long);
48 DEFINE_XEN_GUEST_HANDLE(void);
50 DEFINE_XEN_GUEST_HANDLE(xen_pfn_t);
51 #endif
53 /*
54 * HYPERCALLS
55 */
57 #define __HYPERVISOR_set_trap_table 0
58 #define __HYPERVISOR_mmu_update 1
59 #define __HYPERVISOR_set_gdt 2
60 #define __HYPERVISOR_stack_switch 3
61 #define __HYPERVISOR_set_callbacks 4
62 #define __HYPERVISOR_fpu_taskswitch 5
63 #define __HYPERVISOR_sched_op_compat 6 /* compat since 0x00030101 */
64 #define __HYPERVISOR_platform_op 7
65 #define __HYPERVISOR_set_debugreg 8
66 #define __HYPERVISOR_get_debugreg 9
67 #define __HYPERVISOR_update_descriptor 10
68 #define __HYPERVISOR_memory_op 12
69 #define __HYPERVISOR_multicall 13
70 #define __HYPERVISOR_update_va_mapping 14
71 #define __HYPERVISOR_set_timer_op 15
72 #define __HYPERVISOR_event_channel_op_compat 16 /* compat since 0x00030202 */
73 #define __HYPERVISOR_xen_version 17
74 #define __HYPERVISOR_console_io 18
75 #define __HYPERVISOR_physdev_op_compat 19 /* compat since 0x00030202 */
76 #define __HYPERVISOR_grant_table_op 20
77 #define __HYPERVISOR_vm_assist 21
78 #define __HYPERVISOR_update_va_mapping_otherdomain 22
79 #define __HYPERVISOR_iret 23 /* x86 only */
80 #define __HYPERVISOR_vcpu_op 24
81 #define __HYPERVISOR_set_segment_base 25 /* x86/64 only */
82 #define __HYPERVISOR_mmuext_op 26
83 #define __HYPERVISOR_xsm_op 27
84 #define __HYPERVISOR_nmi_op 28
85 #define __HYPERVISOR_sched_op 29
86 #define __HYPERVISOR_callback_op 30
87 #define __HYPERVISOR_xenoprof_op 31
88 #define __HYPERVISOR_event_channel_op 32
89 #define __HYPERVISOR_physdev_op 33
90 #define __HYPERVISOR_hvm_op 34
91 #define __HYPERVISOR_sysctl 35
92 #define __HYPERVISOR_domctl 36
93 #define __HYPERVISOR_kexec_op 37
95 /* Architecture-specific hypercall definitions. */
96 #define __HYPERVISOR_arch_0 48
97 #define __HYPERVISOR_arch_1 49
98 #define __HYPERVISOR_arch_2 50
99 #define __HYPERVISOR_arch_3 51
100 #define __HYPERVISOR_arch_4 52
101 #define __HYPERVISOR_arch_5 53
102 #define __HYPERVISOR_arch_6 54
103 #define __HYPERVISOR_arch_7 55
105 /*
106 * HYPERCALL COMPATIBILITY.
107 */
109 /* New sched_op hypercall introduced in 0x00030101. */
110 #if __XEN_INTERFACE_VERSION__ < 0x00030101
111 #undef __HYPERVISOR_sched_op
112 #define __HYPERVISOR_sched_op __HYPERVISOR_sched_op_compat
113 #endif
115 /* New event-channel and physdev hypercalls introduced in 0x00030202. */
116 #if __XEN_INTERFACE_VERSION__ < 0x00030202
117 #undef __HYPERVISOR_event_channel_op
118 #define __HYPERVISOR_event_channel_op __HYPERVISOR_event_channel_op_compat
119 #undef __HYPERVISOR_physdev_op
120 #define __HYPERVISOR_physdev_op __HYPERVISOR_physdev_op_compat
121 #endif
123 /* New platform_op hypercall introduced in 0x00030204. */
124 #if __XEN_INTERFACE_VERSION__ < 0x00030204
125 #define __HYPERVISOR_dom0_op __HYPERVISOR_platform_op
126 #endif
128 /*
129 * VIRTUAL INTERRUPTS
130 *
131 * Virtual interrupts that a guest OS may receive from Xen.
132 *
133 * In the side comments, 'V.' denotes a per-VCPU VIRQ while 'G.' denotes a
134 * global VIRQ. The former can be bound once per VCPU and cannot be re-bound.
135 * The latter can be allocated only once per guest: they must initially be
136 * allocated to VCPU0 but can subsequently be re-bound.
137 */
138 #define VIRQ_TIMER 0 /* V. Timebase update, and/or requested timeout. */
139 #define VIRQ_DEBUG 1 /* V. Request guest to dump debug info. */
140 #define VIRQ_CONSOLE 2 /* G. (DOM0) Bytes received on emergency console. */
141 #define VIRQ_DOM_EXC 3 /* G. (DOM0) Exceptional event for some domain. */
142 #define VIRQ_TBUF 4 /* G. (DOM0) Trace buffer has records available. */
143 #define VIRQ_DEBUGGER 6 /* G. (DOM0) A domain has paused for debugging. */
144 #define VIRQ_XENOPROF 7 /* V. XenOprofile interrupt: new sample available */
145 #define VIRQ_CON_RING 8 /* G. (DOM0) Bytes received on console */
147 /* Architecture-specific VIRQ definitions. */
148 #define VIRQ_ARCH_0 16
149 #define VIRQ_ARCH_1 17
150 #define VIRQ_ARCH_2 18
151 #define VIRQ_ARCH_3 19
152 #define VIRQ_ARCH_4 20
153 #define VIRQ_ARCH_5 21
154 #define VIRQ_ARCH_6 22
155 #define VIRQ_ARCH_7 23
157 #define NR_VIRQS 24
159 /*
160 * MMU-UPDATE REQUESTS
161 *
162 * HYPERVISOR_mmu_update() accepts a list of (ptr, val) pairs.
163 * A foreigndom (FD) can be specified (or DOMID_SELF for none).
164 * Where the FD has some effect, it is described below.
165 * ptr[1:0] specifies the appropriate MMU_* command.
166 *
167 * ptr[1:0] == MMU_NORMAL_PT_UPDATE:
168 * Updates an entry in a page table. If updating an L1 table, and the new
169 * table entry is valid/present, the mapped frame must belong to the FD, if
170 * an FD has been specified. If attempting to map an I/O page then the
171 * caller assumes the privilege of the FD.
172 * FD == DOMID_IO: Permit /only/ I/O mappings, at the priv level of the caller.
173 * FD == DOMID_XEN: Map restricted areas of Xen's heap space.
174 * ptr[:2] -- Machine address of the page-table entry to modify.
175 * val -- Value to write.
176 *
177 * ptr[1:0] == MMU_MACHPHYS_UPDATE:
178 * Updates an entry in the machine->pseudo-physical mapping table.
179 * ptr[:2] -- Machine address within the frame whose mapping to modify.
180 * The frame must belong to the FD, if one is specified.
181 * val -- Value to write into the mapping entry.
182 *
183 * ptr[1:0] == MMU_PT_UPDATE_PRESERVE_AD:
184 * As MMU_NORMAL_PT_UPDATE above, but A/D bits currently in the PTE are ORed
185 * with those in @val.
186 */
187 #define MMU_NORMAL_PT_UPDATE 0 /* checked '*ptr = val'. ptr is MA. */
188 #define MMU_MACHPHYS_UPDATE 1 /* ptr = MA of frame to modify entry for */
189 #define MMU_PT_UPDATE_PRESERVE_AD 2 /* atomically: *ptr = val | (*ptr&(A|D)) */
191 /*
192 * MMU EXTENDED OPERATIONS
193 *
194 * HYPERVISOR_mmuext_op() accepts a list of mmuext_op structures.
195 * A foreigndom (FD) can be specified (or DOMID_SELF for none).
196 * Where the FD has some effect, it is described below.
197 *
198 * cmd: MMUEXT_(UN)PIN_*_TABLE
199 * mfn: Machine frame number to be (un)pinned as a p.t. page.
200 * The frame must belong to the FD, if one is specified.
201 *
202 * cmd: MMUEXT_NEW_BASEPTR
203 * mfn: Machine frame number of new page-table base to install in MMU.
204 *
205 * cmd: MMUEXT_NEW_USER_BASEPTR [x86/64 only]
206 * mfn: Machine frame number of new page-table base to install in MMU
207 * when in user space.
208 *
209 * cmd: MMUEXT_TLB_FLUSH_LOCAL
210 * No additional arguments. Flushes local TLB.
211 *
212 * cmd: MMUEXT_INVLPG_LOCAL
213 * linear_addr: Linear address to be flushed from the local TLB.
214 *
215 * cmd: MMUEXT_TLB_FLUSH_MULTI
216 * vcpumask: Pointer to bitmap of VCPUs to be flushed.
217 *
218 * cmd: MMUEXT_INVLPG_MULTI
219 * linear_addr: Linear address to be flushed.
220 * vcpumask: Pointer to bitmap of VCPUs to be flushed.
221 *
222 * cmd: MMUEXT_TLB_FLUSH_ALL
223 * No additional arguments. Flushes all VCPUs' TLBs.
224 *
225 * cmd: MMUEXT_INVLPG_ALL
226 * linear_addr: Linear address to be flushed from all VCPUs' TLBs.
227 *
228 * cmd: MMUEXT_FLUSH_CACHE
229 * No additional arguments. Writes back and flushes cache contents.
230 *
231 * cmd: MMUEXT_SET_LDT
232 * linear_addr: Linear address of LDT base (NB. must be page-aligned).
233 * nr_ents: Number of entries in LDT.
234 */
235 #define MMUEXT_PIN_L1_TABLE 0
236 #define MMUEXT_PIN_L2_TABLE 1
237 #define MMUEXT_PIN_L3_TABLE 2
238 #define MMUEXT_PIN_L4_TABLE 3
239 #define MMUEXT_UNPIN_TABLE 4
240 #define MMUEXT_NEW_BASEPTR 5
241 #define MMUEXT_TLB_FLUSH_LOCAL 6
242 #define MMUEXT_INVLPG_LOCAL 7
243 #define MMUEXT_TLB_FLUSH_MULTI 8
244 #define MMUEXT_INVLPG_MULTI 9
245 #define MMUEXT_TLB_FLUSH_ALL 10
246 #define MMUEXT_INVLPG_ALL 11
247 #define MMUEXT_FLUSH_CACHE 12
248 #define MMUEXT_SET_LDT 13
249 #define MMUEXT_NEW_USER_BASEPTR 15
251 #ifndef __ASSEMBLY__
252 struct mmuext_op {
253 unsigned int cmd;
254 union {
255 /* [UN]PIN_TABLE, NEW_BASEPTR, NEW_USER_BASEPTR */
256 xen_pfn_t mfn;
257 /* INVLPG_LOCAL, INVLPG_ALL, SET_LDT */
258 unsigned long linear_addr;
259 } arg1;
260 union {
261 /* SET_LDT */
262 unsigned int nr_ents;
263 /* TLB_FLUSH_MULTI, INVLPG_MULTI */
264 #if __XEN_INTERFACE_VERSION__ >= 0x00030205
265 XEN_GUEST_HANDLE(void) vcpumask;
266 #else
267 void *vcpumask;
268 #endif
269 } arg2;
270 };
271 typedef struct mmuext_op mmuext_op_t;
272 DEFINE_XEN_GUEST_HANDLE(mmuext_op_t);
273 #endif
275 /* These are passed as 'flags' to update_va_mapping. They can be ORed. */
276 /* When specifying UVMF_MULTI, also OR in a pointer to a CPU bitmap. */
277 /* UVMF_LOCAL is merely UVMF_MULTI with a NULL bitmap pointer. */
278 #define UVMF_NONE (0UL<<0) /* No flushing at all. */
279 #define UVMF_TLB_FLUSH (1UL<<0) /* Flush entire TLB(s). */
280 #define UVMF_INVLPG (2UL<<0) /* Flush only one entry. */
281 #define UVMF_FLUSHTYPE_MASK (3UL<<0)
282 #define UVMF_MULTI (0UL<<2) /* Flush subset of TLBs. */
283 #define UVMF_LOCAL (0UL<<2) /* Flush local TLB. */
284 #define UVMF_ALL (1UL<<2) /* Flush all TLBs. */
286 /*
287 * Commands to HYPERVISOR_console_io().
288 */
289 #define CONSOLEIO_write 0
290 #define CONSOLEIO_read 1
292 /*
293 * Commands to HYPERVISOR_vm_assist().
294 */
295 #define VMASST_CMD_enable 0
296 #define VMASST_CMD_disable 1
298 /* x86/32 guests: simulate full 4GB segment limits. */
299 #define VMASST_TYPE_4gb_segments 0
301 /* x86/32 guests: trap (vector 15) whenever above vmassist is used. */
302 #define VMASST_TYPE_4gb_segments_notify 1
304 /*
305 * x86 guests: support writes to bottom-level PTEs.
306 * NB1. Page-directory entries cannot be written.
307 * NB2. Guest must continue to remove all writable mappings of PTEs.
308 */
309 #define VMASST_TYPE_writable_pagetables 2
311 /* x86/PAE guests: support PDPTs above 4GB. */
312 #define VMASST_TYPE_pae_extended_cr3 3
314 #define MAX_VMASST_TYPE 3
316 #ifndef __ASSEMBLY__
318 typedef uint16_t domid_t;
320 /* Domain ids >= DOMID_FIRST_RESERVED cannot be used for ordinary domains. */
321 #define DOMID_FIRST_RESERVED (0x7FF0U)
323 /* DOMID_SELF is used in certain contexts to refer to oneself. */
324 #define DOMID_SELF (0x7FF0U)
326 /*
327 * DOMID_IO is used to restrict page-table updates to mapping I/O memory.
328 * Although no Foreign Domain need be specified to map I/O pages, DOMID_IO
329 * is useful to ensure that no mappings to the OS's own heap are accidentally
330 * installed. (e.g., in Linux this could cause havoc as reference counts
331 * aren't adjusted on the I/O-mapping code path).
332 * This only makes sense in MMUEXT_SET_FOREIGNDOM, but in that context can
333 * be specified by any calling domain.
334 */
335 #define DOMID_IO (0x7FF1U)
337 /*
338 * DOMID_XEN is used to allow privileged domains to map restricted parts of
339 * Xen's heap space (e.g., the machine_to_phys table).
340 * This only makes sense in MMUEXT_SET_FOREIGNDOM, and is only permitted if
341 * the caller is privileged.
342 */
343 #define DOMID_XEN (0x7FF2U)
345 /*
346 * Send an array of these to HYPERVISOR_mmu_update().
347 * NB. The fields are natural pointer/address size for this architecture.
348 */
349 struct mmu_update {
350 uint64_t ptr; /* Machine address of PTE. */
351 uint64_t val; /* New contents of PTE. */
352 };
353 typedef struct mmu_update mmu_update_t;
354 DEFINE_XEN_GUEST_HANDLE(mmu_update_t);
356 /*
357 * Send an array of these to HYPERVISOR_multicall().
358 * NB. The fields are natural register size for this architecture.
359 */
360 struct multicall_entry {
361 unsigned long op, result;
362 unsigned long args[6];
363 };
364 typedef struct multicall_entry multicall_entry_t;
365 DEFINE_XEN_GUEST_HANDLE(multicall_entry_t);
367 /*
368 * Event channel endpoints per domain:
369 * 1024 if a long is 32 bits; 4096 if a long is 64 bits.
370 */
371 #define NR_EVENT_CHANNELS (sizeof(unsigned long) * sizeof(unsigned long) * 64)
373 struct vcpu_time_info {
374 /*
375 * Updates to the following values are preceded and followed by an
376 * increment of 'version'. The guest can therefore detect updates by
377 * looking for changes to 'version'. If the least-significant bit of
378 * the version number is set then an update is in progress and the guest
379 * must wait to read a consistent set of values.
380 * The correct way to interact with the version number is similar to
381 * Linux's seqlock: see the implementations of read_seqbegin/read_seqretry.
382 */
383 uint32_t version;
384 uint32_t pad0;
385 uint64_t tsc_timestamp; /* TSC at last update of time vals. */
386 uint64_t system_time; /* Time, in nanosecs, since boot. */
387 /*
388 * Current system time:
389 * system_time +
390 * ((((tsc - tsc_timestamp) << tsc_shift) * tsc_to_system_mul) >> 32)
391 * CPU frequency (Hz):
392 * ((10^9 << 32) / tsc_to_system_mul) >> tsc_shift
393 */
394 uint32_t tsc_to_system_mul;
395 int8_t tsc_shift;
396 int8_t pad1[3];
397 }; /* 32 bytes */
398 typedef struct vcpu_time_info vcpu_time_info_t;
400 struct vcpu_info {
401 /*
402 * 'evtchn_upcall_pending' is written non-zero by Xen to indicate
403 * a pending notification for a particular VCPU. It is then cleared
404 * by the guest OS /before/ checking for pending work, thus avoiding
405 * a set-and-check race. Note that the mask is only accessed by Xen
406 * on the CPU that is currently hosting the VCPU. This means that the
407 * pending and mask flags can be updated by the guest without special
408 * synchronisation (i.e., no need for the x86 LOCK prefix).
409 * This may seem suboptimal because if the pending flag is set by
410 * a different CPU then an IPI may be scheduled even when the mask
411 * is set. However, note:
412 * 1. The task of 'interrupt holdoff' is covered by the per-event-
413 * channel mask bits. A 'noisy' event that is continually being
414 * triggered can be masked at source at this very precise
415 * granularity.
416 * 2. The main purpose of the per-VCPU mask is therefore to restrict
417 * reentrant execution: whether for concurrency control, or to
418 * prevent unbounded stack usage. Whatever the purpose, we expect
419 * that the mask will be asserted only for short periods at a time,
420 * and so the likelihood of a 'spurious' IPI is suitably small.
421 * The mask is read before making an event upcall to the guest: a
422 * non-zero mask therefore guarantees that the VCPU will not receive
423 * an upcall activation. The mask is cleared when the VCPU requests
424 * to block: this avoids wakeup-waiting races.
425 */
426 uint8_t evtchn_upcall_pending;
427 uint8_t evtchn_upcall_mask;
428 unsigned long evtchn_pending_sel;
429 struct arch_vcpu_info arch;
430 struct vcpu_time_info time;
431 }; /* 64 bytes (x86) */
432 #ifndef __XEN__
433 typedef struct vcpu_info vcpu_info_t;
434 #endif
436 /*
437 * Xen/kernel shared data -- pointer provided in start_info.
438 *
439 * This structure is defined to be both smaller than a page, and the
440 * only data on the shared page, but may vary in actual size even within
441 * compatible Xen versions; guests should not rely on the size
442 * of this structure remaining constant.
443 */
444 struct shared_info {
445 struct vcpu_info vcpu_info[MAX_VIRT_CPUS];
447 /*
448 * A domain can create "event channels" on which it can send and receive
449 * asynchronous event notifications. There are three classes of event that
450 * are delivered by this mechanism:
451 * 1. Bi-directional inter- and intra-domain connections. Domains must
452 * arrange out-of-band to set up a connection (usually by allocating
453 * an unbound 'listener' port and avertising that via a storage service
454 * such as xenstore).
455 * 2. Physical interrupts. A domain with suitable hardware-access
456 * privileges can bind an event-channel port to a physical interrupt
457 * source.
458 * 3. Virtual interrupts ('events'). A domain can bind an event-channel
459 * port to a virtual interrupt source, such as the virtual-timer
460 * device or the emergency console.
461 *
462 * Event channels are addressed by a "port index". Each channel is
463 * associated with two bits of information:
464 * 1. PENDING -- notifies the domain that there is a pending notification
465 * to be processed. This bit is cleared by the guest.
466 * 2. MASK -- if this bit is clear then a 0->1 transition of PENDING
467 * will cause an asynchronous upcall to be scheduled. This bit is only
468 * updated by the guest. It is read-only within Xen. If a channel
469 * becomes pending while the channel is masked then the 'edge' is lost
470 * (i.e., when the channel is unmasked, the guest must manually handle
471 * pending notifications as no upcall will be scheduled by Xen).
472 *
473 * To expedite scanning of pending notifications, any 0->1 pending
474 * transition on an unmasked channel causes a corresponding bit in a
475 * per-vcpu selector word to be set. Each bit in the selector covers a
476 * 'C long' in the PENDING bitfield array.
477 */
478 unsigned long evtchn_pending[sizeof(unsigned long) * 8];
479 unsigned long evtchn_mask[sizeof(unsigned long) * 8];
481 /*
482 * Wallclock time: updated only by control software. Guests should base
483 * their gettimeofday() syscall on this wallclock-base value.
484 */
485 uint32_t wc_version; /* Version counter: see vcpu_time_info_t. */
486 uint32_t wc_sec; /* Secs 00:00:00 UTC, Jan 1, 1970. */
487 uint32_t wc_nsec; /* Nsecs 00:00:00 UTC, Jan 1, 1970. */
489 struct arch_shared_info arch;
491 };
492 #ifndef __XEN__
493 typedef struct shared_info shared_info_t;
494 #endif
496 /*
497 * Start-of-day memory layout:
498 * 1. The domain is started within contiguous virtual-memory region.
499 * 2. The contiguous region ends on an aligned 4MB boundary.
500 * 3. This the order of bootstrap elements in the initial virtual region:
501 * a. relocated kernel image
502 * b. initial ram disk [mod_start, mod_len]
503 * c. list of allocated page frames [mfn_list, nr_pages]
504 * d. start_info_t structure [register ESI (x86)]
505 * e. bootstrap page tables [pt_base, CR3 (x86)]
506 * f. bootstrap stack [register ESP (x86)]
507 * 4. Bootstrap elements are packed together, but each is 4kB-aligned.
508 * 5. The initial ram disk may be omitted.
509 * 6. The list of page frames forms a contiguous 'pseudo-physical' memory
510 * layout for the domain. In particular, the bootstrap virtual-memory
511 * region is a 1:1 mapping to the first section of the pseudo-physical map.
512 * 7. All bootstrap elements are mapped read-writable for the guest OS. The
513 * only exception is the bootstrap page table, which is mapped read-only.
514 * 8. There is guaranteed to be at least 512kB padding after the final
515 * bootstrap element. If necessary, the bootstrap virtual region is
516 * extended by an extra 4MB to ensure this.
517 */
519 #define MAX_GUEST_CMDLINE 1024
520 struct start_info {
521 /* THE FOLLOWING ARE FILLED IN BOTH ON INITIAL BOOT AND ON RESUME. */
522 char magic[32]; /* "xen-<version>-<platform>". */
523 unsigned long nr_pages; /* Total pages allocated to this domain. */
524 unsigned long shared_info; /* MACHINE address of shared info struct. */
525 uint32_t flags; /* SIF_xxx flags. */
526 xen_pfn_t store_mfn; /* MACHINE page number of shared page. */
527 uint32_t store_evtchn; /* Event channel for store communication. */
528 union {
529 struct {
530 xen_pfn_t mfn; /* MACHINE page number of console page. */
531 uint32_t evtchn; /* Event channel for console page. */
532 } domU;
533 struct {
534 uint32_t info_off; /* Offset of console_info struct. */
535 uint32_t info_size; /* Size of console_info struct from start.*/
536 } dom0;
537 } console;
538 /* THE FOLLOWING ARE ONLY FILLED IN ON INITIAL BOOT (NOT RESUME). */
539 unsigned long pt_base; /* VIRTUAL address of page directory. */
540 unsigned long nr_pt_frames; /* Number of bootstrap p.t. frames. */
541 unsigned long mfn_list; /* VIRTUAL address of page-frame list. */
542 unsigned long mod_start; /* VIRTUAL address of pre-loaded module. */
543 unsigned long mod_len; /* Size (bytes) of pre-loaded module. */
544 int8_t cmd_line[MAX_GUEST_CMDLINE];
545 };
546 typedef struct start_info start_info_t;
548 /* New console union for dom0 introduced in 0x00030203. */
549 #if __XEN_INTERFACE_VERSION__ < 0x00030203
550 #define console_mfn console.domU.mfn
551 #define console_evtchn console.domU.evtchn
552 #endif
554 /* These flags are passed in the 'flags' field of start_info_t. */
555 #define SIF_PRIVILEGED (1<<0) /* Is the domain privileged? */
556 #define SIF_INITDOMAIN (1<<1) /* Is this the initial control domain? */
558 typedef struct dom0_vga_console_info {
559 uint8_t video_type; /* DOM0_VGA_CONSOLE_??? */
560 #define XEN_VGATYPE_TEXT_MODE_3 0x03
561 #define XEN_VGATYPE_VESA_LFB 0x23
563 union {
564 struct {
565 /* Font height, in pixels. */
566 uint16_t font_height;
567 /* Cursor location (column, row). */
568 uint16_t cursor_x, cursor_y;
569 /* Number of rows and columns (dimensions in characters). */
570 uint16_t rows, columns;
571 } text_mode_3;
573 struct {
574 /* Width and height, in pixels. */
575 uint16_t width, height;
576 /* Bytes per scan line. */
577 uint16_t bytes_per_line;
578 /* Bits per pixel. */
579 uint16_t bits_per_pixel;
580 /* LFB physical address, and size (in units of 64kB). */
581 uint32_t lfb_base;
582 uint32_t lfb_size;
583 /* RGB mask offsets and sizes, as defined by VBE 1.2+ */
584 uint8_t red_pos, red_size;
585 uint8_t green_pos, green_size;
586 uint8_t blue_pos, blue_size;
587 uint8_t rsvd_pos, rsvd_size;
588 #if __XEN_INTERFACE_VERSION__ >= 0x00030206
589 /* VESA capabilities (offset 0xa, VESA command 0x4f00). */
590 uint32_t gbl_caps;
591 /* Mode attributes (offset 0x0, VESA command 0x4f01). */
592 uint16_t mode_attrs;
593 #endif
594 } vesa_lfb;
595 } u;
596 } dom0_vga_console_info_t;
597 #define xen_vga_console_info dom0_vga_console_info
598 #define xen_vga_console_info_t dom0_vga_console_info_t
600 typedef uint8_t xen_domain_handle_t[16];
602 /* Turn a plain number into a C unsigned long constant. */
603 #define __mk_unsigned_long(x) x ## UL
604 #define mk_unsigned_long(x) __mk_unsigned_long(x)
606 __DEFINE_XEN_GUEST_HANDLE(uint8, uint8_t);
607 __DEFINE_XEN_GUEST_HANDLE(uint16, uint16_t);
608 __DEFINE_XEN_GUEST_HANDLE(uint32, uint32_t);
609 __DEFINE_XEN_GUEST_HANDLE(uint64, uint64_t);
611 #else /* __ASSEMBLY__ */
613 /* In assembly code we cannot use C numeric constant suffixes. */
614 #define mk_unsigned_long(x) x
616 #endif /* !__ASSEMBLY__ */
618 /* Default definitions for macros used by domctl/sysctl. */
619 #if defined(__XEN__) || defined(__XEN_TOOLS__)
620 #ifndef uint64_aligned_t
621 #define uint64_aligned_t uint64_t
622 #endif
623 #ifndef XEN_GUEST_HANDLE_64
624 #define XEN_GUEST_HANDLE_64(name) XEN_GUEST_HANDLE(name)
625 #endif
626 #endif
628 #endif /* __XEN_PUBLIC_XEN_H__ */
630 /*
631 * Local variables:
632 * mode: C
633 * c-set-style: "BSD"
634 * c-basic-offset: 4
635 * tab-width: 4
636 * indent-tabs-mode: nil
637 * End:
638 */