domctl.h revision ad09f8b827db90c9a0093f0b6382803fa64a5fd1
/******************************************************************************
* domctl.h
*
* Domain management operations. For use by node control stack.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
* Copyright (c) 2002-2003, B Dragovic
* Copyright (c) 2002-2006, K Fraser
*/
#ifndef __XEN_PUBLIC_DOMCTL_H__
#define __XEN_PUBLIC_DOMCTL_H__
#if !defined(__XEN__) && !defined(__XEN_TOOLS__)
#error "domctl operations are intended for use by node control tools only"
#endif
#include "xen.h"
#define XEN_DOMCTL_INTERFACE_VERSION 0x00000005
struct xenctl_cpumap {
};
/*
* If it is specified as zero, an id is auto-allocated and returned.
*/
#define XEN_DOMCTL_createdomain 1
struct xen_domctl_createdomain {
/* IN parameters */
/* Is this an HVM guest (as opposed to a PV guest)? */
#define _XEN_DOMCTL_CDF_hvm_guest 0
/* Use hardware-assisted paging if available? */
#define _XEN_DOMCTL_CDF_hap 1
/* Should domain memory integrity be verifed by tboot during Sx? */
#define _XEN_DOMCTL_CDF_s3_integrity 2
};
typedef struct xen_domctl_createdomain xen_domctl_createdomain_t;
#define XEN_DOMCTL_destroydomain 2
#define XEN_DOMCTL_pausedomain 3
#define XEN_DOMCTL_unpausedomain 4
#define XEN_DOMCTL_resumedomain 27
#define XEN_DOMCTL_getdomaininfo 5
struct xen_domctl_getdomaininfo {
/* OUT variables. */
/* Domain is scheduled to die. */
#define _XEN_DOMINF_dying 0
/* Domain is an HVM guest (as opposed to a PV guest). */
#define _XEN_DOMINF_hvm_guest 1
/* The guest OS has shut down. */
#define _XEN_DOMINF_shutdown 2
/* Currently paused by control software. */
#define _XEN_DOMINF_paused 3
/* Currently blocked pending an event. */
#define _XEN_DOMINF_blocked 4
/* Domain is currently running. */
#define _XEN_DOMINF_running 5
/* Being debugged. */
#define _XEN_DOMINF_debugged 6
/* XEN_DOMINF_shutdown guest-supplied code. */
#define XEN_DOMINF_shutdownmask 255
#define XEN_DOMINF_shutdownshift 16
};
typedef struct xen_domctl_getdomaininfo xen_domctl_getdomaininfo_t;
#define XEN_DOMCTL_getmemlist 6
struct xen_domctl_getmemlist {
/* IN variables. */
/* Max entries to write to output buffer. */
/* Start index in guest's page list. */
/* OUT variables. */
};
typedef struct xen_domctl_getmemlist xen_domctl_getmemlist_t;
#define XEN_DOMCTL_getpageframeinfo 7
#define XEN_DOMCTL_PFINFO_LTAB_SHIFT 28
struct xen_domctl_getpageframeinfo {
/* IN variables. */
/* OUT variables. */
/* Is the page PINNED to a type? */
};
typedef struct xen_domctl_getpageframeinfo xen_domctl_getpageframeinfo_t;
#define XEN_DOMCTL_getpageframeinfo2 8
struct xen_domctl_getpageframeinfo2 {
/* IN variables. */
};
typedef struct xen_domctl_getpageframeinfo2 xen_domctl_getpageframeinfo2_t;
/*
* Control shadow pagetables operation
*/
#define XEN_DOMCTL_shadow_op 10
/* Disable shadow mode. */
#define XEN_DOMCTL_SHADOW_OP_OFF 0
/* Enable shadow mode (mode contains ORed XEN_DOMCTL_SHADOW_ENABLE_* flags). */
#define XEN_DOMCTL_SHADOW_OP_ENABLE 32
/* Log-dirty bitmap operations. */
/* Return the bitmap and clean internal copy for next round. */
#define XEN_DOMCTL_SHADOW_OP_CLEAN 11
/* Return the bitmap but do not modify internal copy. */
#define XEN_DOMCTL_SHADOW_OP_PEEK 12
/* Memory allocation accessors. */
#define XEN_DOMCTL_SHADOW_OP_GET_ALLOCATION 30
#define XEN_DOMCTL_SHADOW_OP_SET_ALLOCATION 31
/* Legacy enable operations. */
/* Equiv. to ENABLE with no mode flags. */
#define XEN_DOMCTL_SHADOW_OP_ENABLE_TEST 1
/* Equiv. to ENABLE with mode flag ENABLE_LOG_DIRTY. */
#define XEN_DOMCTL_SHADOW_OP_ENABLE_LOGDIRTY 2
/* Equiv. to ENABLE with mode flags ENABLE_REFCOUNT and ENABLE_TRANSLATE. */
#define XEN_DOMCTL_SHADOW_OP_ENABLE_TRANSLATE 3
/* Mode flags for XEN_DOMCTL_SHADOW_OP_ENABLE. */
/*
* Shadow pagetables are refcounted: guest does not use explicit mmu
* operations nor write-protect its pagetables.
*/
/*
* Log pages in a bitmap as they are dirtied.
* Used for live relocation to determine which pages must be re-sent.
*/
/*
* Automatically translate GPFNs into MFNs.
*/
/*
* Xen does not steal virtual address space from the guest.
* Requires HVM support.
*/
struct xen_domctl_shadow_op_stats {
};
typedef struct xen_domctl_shadow_op_stats xen_domctl_shadow_op_stats_t;
struct xen_domctl_shadow_op {
/* IN variables. */
/* OP_ENABLE */
/* OP_GET_ALLOCATION / OP_SET_ALLOCATION */
/* OP_PEEK / OP_CLEAN */
struct xen_domctl_shadow_op_stats stats;
};
typedef struct xen_domctl_shadow_op xen_domctl_shadow_op_t;
#define XEN_DOMCTL_max_mem 11
struct xen_domctl_max_mem {
/* IN variables. */
};
typedef struct xen_domctl_max_mem xen_domctl_max_mem_t;
#define XEN_DOMCTL_setvcpucontext 12
#define XEN_DOMCTL_getvcpucontext 13
struct xen_domctl_vcpucontext {
};
typedef struct xen_domctl_vcpucontext xen_domctl_vcpucontext_t;
#define XEN_DOMCTL_getvcpuinfo 14
struct xen_domctl_getvcpuinfo {
/* IN variables. */
/* OUT variables. */
};
typedef struct xen_domctl_getvcpuinfo xen_domctl_getvcpuinfo_t;
#define XEN_DOMCTL_setvcpuaffinity 9
#define XEN_DOMCTL_getvcpuaffinity 25
struct xen_domctl_vcpuaffinity {
};
typedef struct xen_domctl_vcpuaffinity xen_domctl_vcpuaffinity_t;
#define XEN_DOMCTL_max_vcpus 15
struct xen_domctl_max_vcpus {
};
typedef struct xen_domctl_max_vcpus xen_domctl_max_vcpus_t;
#define XEN_DOMCTL_scheduler_op 16
/* Scheduler types. */
#define XEN_SCHEDULER_SEDF 4
#define XEN_SCHEDULER_CREDIT 5
/* Set or get info? */
#define XEN_DOMCTL_SCHEDOP_putinfo 0
#define XEN_DOMCTL_SCHEDOP_getinfo 1
struct xen_domctl_scheduler_op {
union {
struct xen_domctl_sched_sedf {
} sedf;
struct xen_domctl_sched_credit {
} credit;
} u;
};
typedef struct xen_domctl_scheduler_op xen_domctl_scheduler_op_t;
#define XEN_DOMCTL_setdomainhandle 17
struct xen_domctl_setdomainhandle {
};
typedef struct xen_domctl_setdomainhandle xen_domctl_setdomainhandle_t;
#define XEN_DOMCTL_setdebugging 18
struct xen_domctl_setdebugging {
};
typedef struct xen_domctl_setdebugging xen_domctl_setdebugging_t;
#define XEN_DOMCTL_irq_permission 19
struct xen_domctl_irq_permission {
};
typedef struct xen_domctl_irq_permission xen_domctl_irq_permission_t;
#define XEN_DOMCTL_iomem_permission 20
struct xen_domctl_iomem_permission {
};
typedef struct xen_domctl_iomem_permission xen_domctl_iomem_permission_t;
#define XEN_DOMCTL_ioport_permission 21
struct xen_domctl_ioport_permission {
};
typedef struct xen_domctl_ioport_permission xen_domctl_ioport_permission_t;
#define XEN_DOMCTL_hypercall_init 22
struct xen_domctl_hypercall_init {
};
typedef struct xen_domctl_hypercall_init xen_domctl_hypercall_init_t;
#define XEN_DOMCTL_arch_setup 23
#define _XEN_DOMAINSETUP_hvm_guest 0
#define _XEN_DOMAINSETUP_sioemu_guest 2
typedef struct xen_domctl_arch_setup {
#ifdef __ia64__
#endif
#define XEN_DOMCTL_settimeoffset 24
struct xen_domctl_settimeoffset {
};
typedef struct xen_domctl_settimeoffset xen_domctl_settimeoffset_t;
#define XEN_DOMCTL_gethvmcontext 33
#define XEN_DOMCTL_sethvmcontext 34
typedef struct xen_domctl_hvmcontext {
* gethvmcontext with NULL
* buffer to get size req'd */
#define XEN_DOMCTL_set_address_size 35
#define XEN_DOMCTL_get_address_size 36
typedef struct xen_domctl_address_size {
#define XEN_DOMCTL_real_mode_area 26
struct xen_domctl_real_mode_area {
};
typedef struct xen_domctl_real_mode_area xen_domctl_real_mode_area_t;
#define XEN_DOMCTL_sendtrigger 28
#define XEN_DOMCTL_SENDTRIGGER_NMI 0
#define XEN_DOMCTL_SENDTRIGGER_RESET 1
#define XEN_DOMCTL_SENDTRIGGER_INIT 2
#define XEN_DOMCTL_SENDTRIGGER_POWER 3
struct xen_domctl_sendtrigger {
};
typedef struct xen_domctl_sendtrigger xen_domctl_sendtrigger_t;
/* Assign PCI device to HVM guest. Sets up IOMMU structures. */
#define XEN_DOMCTL_assign_device 37
#define XEN_DOMCTL_test_assign_device 45
#define XEN_DOMCTL_deassign_device 47
struct xen_domctl_assign_device {
};
typedef struct xen_domctl_assign_device xen_domctl_assign_device_t;
/* Retrieve sibling devices infomation of machine_bdf */
#define XEN_DOMCTL_get_device_group 50
struct xen_domctl_get_device_group {
};
typedef struct xen_domctl_get_device_group xen_domctl_get_device_group_t;
/* Pass-through interrupts: bind real irq -> hvm devfn. */
#define XEN_DOMCTL_bind_pt_irq 38
#define XEN_DOMCTL_unbind_pt_irq 48
typedef enum pt_irq_type_e {
struct xen_domctl_bind_pt_irq {
union {
struct {
} isa;
struct {
} pci;
struct {
} msi;
} u;
};
typedef struct xen_domctl_bind_pt_irq xen_domctl_bind_pt_irq_t;
/* Bind machine I/O address range -> HVM address range. */
#define XEN_DOMCTL_memory_mapping 39
#define DPCI_ADD_MAPPING 1
#define DPCI_REMOVE_MAPPING 0
struct xen_domctl_memory_mapping {
};
typedef struct xen_domctl_memory_mapping xen_domctl_memory_mapping_t;
/* Bind machine I/O port range -> HVM I/O port range. */
#define XEN_DOMCTL_ioport_mapping 40
struct xen_domctl_ioport_mapping {
};
typedef struct xen_domctl_ioport_mapping xen_domctl_ioport_mapping_t;
/*
* Pin caching type of RAM space for x86 HVM domU.
*/
#define XEN_DOMCTL_pin_mem_cacheattr 41
#define XEN_DOMCTL_MEM_CACHEATTR_UC 0
#define XEN_DOMCTL_MEM_CACHEATTR_WC 1
#define XEN_DOMCTL_MEM_CACHEATTR_WT 4
#define XEN_DOMCTL_MEM_CACHEATTR_WP 5
#define XEN_DOMCTL_MEM_CACHEATTR_WB 6
#define XEN_DOMCTL_MEM_CACHEATTR_UCM 7
struct xen_domctl_pin_mem_cacheattr {
unsigned int type; /* XEN_DOMCTL_MEM_CACHEATTR_* */
};
typedef struct xen_domctl_pin_mem_cacheattr xen_domctl_pin_mem_cacheattr_t;
#define XEN_DOMCTL_set_ext_vcpucontext 42
#define XEN_DOMCTL_get_ext_vcpucontext 43
struct xen_domctl_ext_vcpucontext {
/* IN: VCPU that this call applies to. */
/*
* SET: Size of struct (IN)
* GET: Size of struct (OUT)
*/
#if defined(__i386__) || defined(__x86_64__)
/* SYSCALL from 32-bit mode and SYSENTER callback information. */
/* NB. SYSCALL from 64-bit mode is contained in vcpu_guest_context_t */
#endif
};
typedef struct xen_domctl_ext_vcpucontext xen_domctl_ext_vcpucontext_t;
/*
* Set optimizaton features for a domain
*/
#define XEN_DOMCTL_set_opt_feature 44
struct xen_domctl_set_opt_feature {
#if defined(__ia64__)
struct xen_ia64_opt_feature optf;
#else
/* Make struct non-empty: do not depend on this field name! */
#endif
};
typedef struct xen_domctl_set_opt_feature xen_domctl_set_opt_feature_t;
/*
* Set the target domain for a domain
*/
#define XEN_DOMCTL_set_target 46
struct xen_domctl_set_target {
};
typedef struct xen_domctl_set_target xen_domctl_set_target_t;
#if defined(__i386__) || defined(__x86_64__)
# define XEN_CPUID_INPUT_UNUSED 0xFFFFFFFF
# define XEN_DOMCTL_set_cpuid 49
struct xen_domctl_cpuid {
unsigned int input[2];
unsigned int eax;
unsigned int ebx;
unsigned int ecx;
unsigned int edx;
};
typedef struct xen_domctl_cpuid xen_domctl_cpuid_t;
#endif
#define XEN_DOMCTL_subscribe 29
struct xen_domctl_subscribe {
};
typedef struct xen_domctl_subscribe xen_domctl_subscribe_t;
/*
* Define the maximum machine address size which should be allocated
* to a guest.
*/
#define XEN_DOMCTL_set_machine_address_size 51
#define XEN_DOMCTL_get_machine_address_size 52
/*
* Do not inject spurious page faults into this domain.
*/
#define XEN_DOMCTL_suppress_spurious_page_faults 53
#define XEN_DOMCTL_debug_op 54
#define XEN_DOMCTL_DEBUG_OP_SINGLE_STEP_OFF 0
#define XEN_DOMCTL_DEBUG_OP_SINGLE_STEP_ON 1
struct xen_domctl_debug_op {
};
typedef struct xen_domctl_debug_op xen_domctl_debug_op_t;
/*
* Request a particular record from the HVM context
*/
#define XEN_DOMCTL_gethvmcontext_partial 55
typedef struct xen_domctl_hvmcontext_partial {
struct xen_domctl {
union {
struct xen_domctl_createdomain createdomain;
struct xen_domctl_getmemlist getmemlist;
struct xen_domctl_vcpuaffinity vcpuaffinity;
struct xen_domctl_shadow_op shadow_op;
struct xen_domctl_max_mem max_mem;
struct xen_domctl_vcpucontext vcpucontext;
struct xen_domctl_getvcpuinfo getvcpuinfo;
struct xen_domctl_max_vcpus max_vcpus;
struct xen_domctl_scheduler_op scheduler_op;
struct xen_domctl_setdebugging setdebugging;
struct xen_domctl_arch_setup arch_setup;
struct xen_domctl_hvmcontext hvmcontext;
struct xen_domctl_address_size address_size;
struct xen_domctl_sendtrigger sendtrigger;
struct xen_domctl_bind_pt_irq bind_pt_irq;
struct xen_domctl_set_target set_target;
struct xen_domctl_subscribe subscribe;
struct xen_domctl_debug_op debug_op;
#if defined(__i386__) || defined(__x86_64__)
struct xen_domctl_cpuid cpuid;
#endif
} u;
};
typedef struct xen_domctl xen_domctl_t;
#endif /* __XEN_PUBLIC_DOMCTL_H__ */
/*
* Local variables:
* mode: C
* c-set-style: "BSD"
* c-basic-offset: 4
* tab-width: 4
* indent-tabs-mode: nil
* End:
*/