/****************************************************************************** * dom0_ops.h * * Process command requests from domain-0 guest OS. * * Copyright (c) 2002-2003, B Dragovic * Copyright (c) 2002-2004, K Fraser */ #ifndef __XEN_PUBLIC_DOM0_OPS_H__ #define __XEN_PUBLIC_DOM0_OPS_H__ #include "xen.h" #include "sched_ctl.h" /* * Make sure you increment the interface version whenever you modify this file! * This makes sure that old versions of dom0 tools will stop working in a * well-defined way (rather than crashing the machine, for instance). */ #define DOM0_INTERFACE_VERSION 0x03000001 /************************************************************************/ #define DOM0_GETMEMLIST 2 struct dom0_getmemlist { /* IN variables. */ domid_t domain; uint64_t max_pfns; XEN_GUEST_HANDLE(xen_pfn_t) buffer; /* OUT variables. */ uint64_t num_pfns; }; typedef struct dom0_getmemlist dom0_getmemlist_t; DEFINE_XEN_GUEST_HANDLE(dom0_getmemlist_t); #define DOM0_SCHEDCTL 6 /* struct sched_ctl_cmd is from sched-ctl.h */ typedef struct sched_ctl_cmd dom0_schedctl_t; DEFINE_XEN_GUEST_HANDLE(dom0_schedctl_t); #define DOM0_ADJUSTDOM 7 /* struct sched_adjdom_cmd is from sched-ctl.h */ typedef struct sched_adjdom_cmd dom0_adjustdom_t; DEFINE_XEN_GUEST_HANDLE(dom0_adjustdom_t); #define DOM0_CREATEDOMAIN 8 struct dom0_createdomain { /* IN parameters */ uint32_t ssidref; xen_domain_handle_t handle; /* IN/OUT parameters. */ /* Identifier for new domain (auto-allocate if zero is specified). */ domid_t domain; }; typedef struct dom0_createdomain dom0_createdomain_t; DEFINE_XEN_GUEST_HANDLE(dom0_createdomain_t); #define DOM0_DESTROYDOMAIN 9 struct dom0_destroydomain { /* IN variables. */ domid_t domain; }; typedef struct dom0_destroydomain dom0_destroydomain_t; DEFINE_XEN_GUEST_HANDLE(dom0_destroydomain_t); #define DOM0_PAUSEDOMAIN 10 struct dom0_pausedomain { /* IN parameters. */ domid_t domain; }; typedef struct dom0_pausedomain dom0_pausedomain_t; DEFINE_XEN_GUEST_HANDLE(dom0_pausedomain_t); #define DOM0_UNPAUSEDOMAIN 11 struct dom0_unpausedomain { /* IN parameters. */ domid_t domain; }; typedef struct dom0_unpausedomain dom0_unpausedomain_t; DEFINE_XEN_GUEST_HANDLE(dom0_unpausedomain_t); #define DOM0_GETDOMAININFO 12 struct dom0_getdomaininfo { /* IN variables. */ domid_t domain; /* NB. IN/OUT variable. */ /* OUT variables. */ #define DOMFLAGS_DYING (1<<0) /* Domain is scheduled to die. */ #define DOMFLAGS_SHUTDOWN (1<<2) /* The guest OS has shut down. */ #define DOMFLAGS_PAUSED (1<<3) /* Currently paused by control software. */ #define DOMFLAGS_BLOCKED (1<<4) /* Currently blocked pending an event. */ #define DOMFLAGS_RUNNING (1<<5) /* Domain is currently running. */ #define DOMFLAGS_CPUMASK 255 /* CPU to which this domain is bound. */ #define DOMFLAGS_CPUSHIFT 8 #define DOMFLAGS_SHUTDOWNMASK 255 /* DOMFLAGS_SHUTDOWN guest-supplied code. */ #define DOMFLAGS_SHUTDOWNSHIFT 16 uint32_t flags; uint64_t tot_pages; uint64_t max_pages; xen_pfn_t shared_info_frame; /* MFN of shared_info struct */ uint64_t cpu_time; uint32_t nr_online_vcpus; /* Number of VCPUs currently online. */ uint32_t max_vcpu_id; /* Maximum VCPUID in use by this domain. */ uint32_t ssidref; xen_domain_handle_t handle; }; typedef struct dom0_getdomaininfo dom0_getdomaininfo_t; DEFINE_XEN_GUEST_HANDLE(dom0_getdomaininfo_t); #define DOM0_SETVCPUCONTEXT 13 struct dom0_setvcpucontext { /* IN variables. */ domid_t domain; uint32_t vcpu; /* IN/OUT parameters */ XEN_GUEST_HANDLE(vcpu_guest_context_t) ctxt; }; typedef struct dom0_setvcpucontext dom0_setvcpucontext_t; DEFINE_XEN_GUEST_HANDLE(dom0_setvcpucontext_t); #define DOM0_MSR 15 struct dom0_msr { /* IN variables. */ uint32_t write; cpumap_t cpu_mask; uint32_t msr; uint32_t in1; uint32_t in2; /* OUT variables. */ uint32_t out1; uint32_t out2; }; typedef struct dom0_msr dom0_msr_t; DEFINE_XEN_GUEST_HANDLE(dom0_msr_t); /* * Set clock such that it would read after 00:00:00 UTC, * 1 January, 1970 if the current system time was . */ #define DOM0_SETTIME 17 struct dom0_settime { /* IN variables. */ uint32_t secs; uint32_t nsecs; uint64_t system_time; }; typedef struct dom0_settime dom0_settime_t; DEFINE_XEN_GUEST_HANDLE(dom0_settime_t); #define DOM0_GETPAGEFRAMEINFO 18 #define LTAB_SHIFT 28 #define NOTAB 0 /* normal page */ #define L1TAB (1< clear after reading. */ XEN_GUEST_HANDLE(char) buffer; /* Buffer start */ /* IN/OUT variables. */ uint32_t count; /* In: Buffer size; Out: Used buffer size */ }; typedef struct dom0_readconsole dom0_readconsole_t; DEFINE_XEN_GUEST_HANDLE(dom0_readconsole_t); /* * Set which physical cpus a vcpu can execute on. */ #define DOM0_SETVCPUAFFINITY 20 struct dom0_setvcpuaffinity { /* IN variables. */ domid_t domain; uint32_t vcpu; cpumap_t cpumap; }; typedef struct dom0_setvcpuaffinity dom0_setvcpuaffinity_t; DEFINE_XEN_GUEST_HANDLE(dom0_setvcpuaffinity_t); /* Get trace buffers machine base address */ #define DOM0_TBUFCONTROL 21 struct dom0_tbufcontrol { /* IN variables */ #define DOM0_TBUF_GET_INFO 0 #define DOM0_TBUF_SET_CPU_MASK 1 #define DOM0_TBUF_SET_EVT_MASK 2 #define DOM0_TBUF_SET_SIZE 3 #define DOM0_TBUF_ENABLE 4 #define DOM0_TBUF_DISABLE 5 uint32_t op; /* IN/OUT variables */ cpumap_t cpu_mask; uint32_t evt_mask; /* OUT variables */ xen_pfn_t buffer_mfn; uint32_t size; }; typedef struct dom0_tbufcontrol dom0_tbufcontrol_t; DEFINE_XEN_GUEST_HANDLE(dom0_tbufcontrol_t); /* * Get physical information about the host machine */ #define DOM0_PHYSINFO 22 struct dom0_physinfo { uint32_t threads_per_core; uint32_t cores_per_socket; uint32_t sockets_per_node; uint32_t nr_nodes; uint32_t cpu_khz; uint64_t total_pages; uint64_t free_pages; uint64_t scrub_pages; uint32_t hw_cap[8]; }; typedef struct dom0_physinfo dom0_physinfo_t; DEFINE_XEN_GUEST_HANDLE(dom0_physinfo_t); /* * Get the ID of the current scheduler. */ #define DOM0_SCHED_ID 24 struct dom0_sched_id { /* OUT variable */ uint32_t sched_id; }; typedef struct dom0_physinfo dom0_sched_id_t; DEFINE_XEN_GUEST_HANDLE(dom0_sched_id_t); /* * Control shadow pagetables operation */ #define DOM0_SHADOW_CONTROL 25 #define DOM0_SHADOW_CONTROL_OP_OFF 0 #define DOM0_SHADOW_CONTROL_OP_ENABLE_TEST 1 #define DOM0_SHADOW_CONTROL_OP_ENABLE_LOGDIRTY 2 #define DOM0_SHADOW_CONTROL_OP_ENABLE_TRANSLATE 3 #define DOM0_SHADOW_CONTROL_OP_FLUSH 10 /* table ops */ #define DOM0_SHADOW_CONTROL_OP_CLEAN 11 #define DOM0_SHADOW_CONTROL_OP_PEEK 12 struct dom0_shadow_control_stats { uint32_t fault_count; uint32_t dirty_count; uint32_t dirty_net_count; uint32_t dirty_block_count; }; typedef struct dom0_shadow_control_stats dom0_shadow_control_stats_t; DEFINE_XEN_GUEST_HANDLE(dom0_shadow_control_stats_t); struct dom0_shadow_control { /* IN variables. */ domid_t domain; uint32_t op; XEN_GUEST_HANDLE(ulong) dirty_bitmap; /* IN/OUT variables. */ uint64_t pages; /* size of buffer, updated with actual size */ /* OUT variables. */ struct dom0_shadow_control_stats stats; }; typedef struct dom0_shadow_control dom0_shadow_control_t; DEFINE_XEN_GUEST_HANDLE(dom0_shadow_control_t); #define DOM0_SETDOMAINMAXMEM 28 struct dom0_setdomainmaxmem { /* IN variables. */ domid_t domain; uint64_t max_memkb; }; typedef struct dom0_setdomainmaxmem dom0_setdomainmaxmem_t; DEFINE_XEN_GUEST_HANDLE(dom0_setdomainmaxmem_t); #define DOM0_GETPAGEFRAMEINFO2 29 /* batched interface */ struct dom0_getpageframeinfo2 { /* IN variables. */ domid_t domain; uint64_t num; /* IN/OUT variables. */ XEN_GUEST_HANDLE(ulong) array; }; typedef struct dom0_getpageframeinfo2 dom0_getpageframeinfo2_t; DEFINE_XEN_GUEST_HANDLE(dom0_getpageframeinfo2_t); /* * Request memory range (@mfn, @mfn+@nr_mfns-1) to have type @type. * On x86, @type is an architecture-defined MTRR memory type. * On success, returns the MTRR that was used (@reg) and a handle that can * be passed to DOM0_DEL_MEMTYPE to accurately tear down the new setting. * (x86-specific). */ #define DOM0_ADD_MEMTYPE 31 struct dom0_add_memtype { /* IN variables. */ xen_pfn_t mfn; uint64_t nr_mfns; uint32_t type; /* OUT variables. */ uint32_t handle; uint32_t reg; }; typedef struct dom0_add_memtype dom0_add_memtype_t; DEFINE_XEN_GUEST_HANDLE(dom0_add_memtype_t); /* * Tear down an existing memory-range type. If @handle is remembered then it * should be passed in to accurately tear down the correct setting (in case * of overlapping memory regions with differing types). If it is not known * then @handle should be set to zero. In all cases @reg must be set. * (x86-specific). */ #define DOM0_DEL_MEMTYPE 32 struct dom0_del_memtype { /* IN variables. */ uint32_t handle; uint32_t reg; }; typedef struct dom0_del_memtype dom0_del_memtype_t; DEFINE_XEN_GUEST_HANDLE(dom0_del_memtype_t); /* Read current type of an MTRR (x86-specific). */ #define DOM0_READ_MEMTYPE 33 struct dom0_read_memtype { /* IN variables. */ uint32_t reg; /* OUT variables. */ xen_pfn_t mfn; uint64_t nr_mfns; uint32_t type; }; typedef struct dom0_read_memtype dom0_read_memtype_t; DEFINE_XEN_GUEST_HANDLE(dom0_read_memtype_t); /* Interface for controlling Xen software performance counters. */ #define DOM0_PERFCCONTROL 34 /* Sub-operations: */ #define DOM0_PERFCCONTROL_OP_RESET 1 /* Reset all counters to zero. */ #define DOM0_PERFCCONTROL_OP_QUERY 2 /* Get perfctr information. */ struct dom0_perfc_desc { char name[80]; /* name of perf counter */ uint32_t nr_vals; /* number of values for this counter */ }; typedef struct dom0_perfc_desc dom0_perfc_desc_t; DEFINE_XEN_GUEST_HANDLE(dom0_perfc_desc_t); typedef uint32_t dom0_perfc_val_t; DEFINE_XEN_GUEST_HANDLE(dom0_perfc_val_t); struct dom0_perfccontrol { /* IN variables. */ uint32_t op; /* DOM0_PERFCCONTROL_OP_??? */ /* OUT variables. */ uint32_t nr_counters; /* number of counters description */ uint32_t nr_vals; /* number of values */ XEN_GUEST_HANDLE(dom0_perfc_desc_t) desc; /* counter information (or NULL) */ XEN_GUEST_HANDLE(dom0_perfc_val_t) val; /* counter values (or NULL) */ }; typedef struct dom0_perfccontrol dom0_perfccontrol_t; DEFINE_XEN_GUEST_HANDLE(dom0_perfccontrol_t); #define DOM0_MICROCODE 35 struct dom0_microcode { /* IN variables. */ XEN_GUEST_HANDLE(void) data; /* Pointer to microcode data */ uint32_t length; /* Length of microcode data. */ }; typedef struct dom0_microcode dom0_microcode_t; DEFINE_XEN_GUEST_HANDLE(dom0_microcode_t); #define DOM0_IOPORT_PERMISSION 36 struct dom0_ioport_permission { domid_t domain; /* domain to be affected */ uint32_t first_port; /* first port int range */ uint32_t nr_ports; /* size of port range */ uint8_t allow_access; /* allow or deny access to range? */ }; typedef struct dom0_ioport_permission dom0_ioport_permission_t; DEFINE_XEN_GUEST_HANDLE(dom0_ioport_permission_t); #define DOM0_GETVCPUCONTEXT 37 struct dom0_getvcpucontext { /* IN variables. */ domid_t domain; /* domain to be affected */ uint32_t vcpu; /* vcpu # */ /* OUT variables. */ XEN_GUEST_HANDLE(vcpu_guest_context_t) ctxt; }; typedef struct dom0_getvcpucontext dom0_getvcpucontext_t; DEFINE_XEN_GUEST_HANDLE(dom0_getvcpucontext_t); #define DOM0_GETVCPUINFO 43 struct dom0_getvcpuinfo { /* IN variables. */ domid_t domain; /* domain to be affected */ uint32_t vcpu; /* vcpu # */ /* OUT variables. */ uint8_t online; /* currently online (not hotplugged)? */ uint8_t blocked; /* blocked waiting for an event? */ uint8_t running; /* currently scheduled on its CPU? */ uint64_t cpu_time; /* total cpu time consumed (ns) */ uint32_t cpu; /* current mapping */ cpumap_t cpumap; /* allowable mapping */ }; typedef struct dom0_getvcpuinfo dom0_getvcpuinfo_t; DEFINE_XEN_GUEST_HANDLE(dom0_getvcpuinfo_t); #define DOM0_GETDOMAININFOLIST 38 struct dom0_getdomaininfolist { /* IN variables. */ domid_t first_domain; uint32_t max_domains; XEN_GUEST_HANDLE(dom0_getdomaininfo_t) buffer; /* OUT variables. */ uint32_t num_domains; }; typedef struct dom0_getdomaininfolist dom0_getdomaininfolist_t; DEFINE_XEN_GUEST_HANDLE(dom0_getdomaininfolist_t); #define DOM0_PLATFORM_QUIRK 39 #define QUIRK_NOIRQBALANCING 1 /* Do not restrict IO-APIC RTE targets */ #define QUIRK_IOAPIC_BAD_REGSEL 2 /* IO-APIC REGSEL forgets its value */ #define QUIRK_IOAPIC_GOOD_REGSEL 3 /* IO-APIC REGSEL behaves properly */ struct dom0_platform_quirk { /* IN variables. */ uint32_t quirk_id; }; typedef struct dom0_platform_quirk dom0_platform_quirk_t; DEFINE_XEN_GUEST_HANDLE(dom0_platform_quirk_t); #define DOM0_PHYSICAL_MEMORY_MAP 40 /* Unimplemented from 3.0.3 onwards */ struct dom0_memory_map_entry { uint64_t start, end; uint32_t flags; /* reserved */ uint8_t is_ram; }; typedef struct dom0_memory_map_entry dom0_memory_map_entry_t; DEFINE_XEN_GUEST_HANDLE(dom0_memory_map_entry_t); struct dom0_physical_memory_map { /* IN variables. */ uint32_t max_map_entries; /* OUT variables. */ uint32_t nr_map_entries; XEN_GUEST_HANDLE(dom0_memory_map_entry_t) memory_map; }; typedef struct dom0_physical_memory_map dom0_physical_memory_map_t; DEFINE_XEN_GUEST_HANDLE(dom0_physical_memory_map_t); #define DOM0_MAX_VCPUS 41 struct dom0_max_vcpus { domid_t domain; /* domain to be affected */ uint32_t max; /* maximum number of vcpus */ }; typedef struct dom0_max_vcpus dom0_max_vcpus_t; DEFINE_XEN_GUEST_HANDLE(dom0_max_vcpus_t); #define DOM0_SETDOMAINHANDLE 44 struct dom0_setdomainhandle { domid_t domain; xen_domain_handle_t handle; }; typedef struct dom0_setdomainhandle dom0_setdomainhandle_t; DEFINE_XEN_GUEST_HANDLE(dom0_setdomainhandle_t); #define DOM0_SETDEBUGGING 45 struct dom0_setdebugging { domid_t domain; uint8_t enable; }; typedef struct dom0_setdebugging dom0_setdebugging_t; DEFINE_XEN_GUEST_HANDLE(dom0_setdebugging_t); #define DOM0_IRQ_PERMISSION 46 struct dom0_irq_permission { domid_t domain; /* domain to be affected */ uint8_t pirq; uint8_t allow_access; /* flag to specify enable/disable of IRQ access */ }; typedef struct dom0_irq_permission dom0_irq_permission_t; DEFINE_XEN_GUEST_HANDLE(dom0_irq_permission_t); #define DOM0_IOMEM_PERMISSION 47 struct dom0_iomem_permission { domid_t domain; /* domain to be affected */ xen_pfn_t first_mfn; /* first page (physical page number) in range */ uint64_t nr_mfns; /* number of pages in range (>0) */ uint8_t allow_access; /* allow (!0) or deny (0) access to range? */ }; typedef struct dom0_iomem_permission dom0_iomem_permission_t; DEFINE_XEN_GUEST_HANDLE(dom0_iomem_permission_t); #define DOM0_HYPERCALL_INIT 48 struct dom0_hypercall_init { domid_t domain; /* domain to be affected */ xen_pfn_t gmfn; /* GMFN to be initialised */ }; typedef struct dom0_hypercall_init dom0_hypercall_init_t; DEFINE_XEN_GUEST_HANDLE(dom0_hypercall_init_t); #define DOM0_DOMAIN_SETUP 49 #define _XEN_DOMAINSETUP_hvm_guest 0 #define XEN_DOMAINSETUP_hvm_guest (1UL<<_XEN_DOMAINSETUP_hvm_guest) #define _XEN_DOMAINSETUP_query 1 /* Get parameters (for save) */ #define XEN_DOMAINSETUP_query (1UL<<_XEN_DOMAINSETUP_query) typedef struct dom0_domain_setup { domid_t domain; /* domain to be affected */ unsigned long flags; /* XEN_DOMAINSETUP_* */ #ifdef __ia64__ unsigned long bp; /* mpaddr of boot param area */ unsigned long maxmem; /* Highest memory address for MDT. */ unsigned long xsi_va; /* Xen shared_info area virtual address. */ unsigned int hypercall_imm; /* Break imm for Xen hypercalls. */ #endif } dom0_domain_setup_t; DEFINE_XEN_GUEST_HANDLE(dom0_domain_setup_t); #define DOM0_SETTIMEOFFSET 50 struct dom0_settimeoffset { domid_t domain; int32_t time_offset_seconds; /* applied to domain wallclock time */ }; typedef struct dom0_settimeoffset dom0_settimeoffset_t; DEFINE_XEN_GUEST_HANDLE(dom0_settimeoffset_t); struct dom0_op { uint32_t cmd; uint32_t interface_version; /* DOM0_INTERFACE_VERSION */ union { struct dom0_createdomain createdomain; struct dom0_pausedomain pausedomain; struct dom0_unpausedomain unpausedomain; struct dom0_destroydomain destroydomain; struct dom0_getmemlist getmemlist; struct sched_ctl_cmd schedctl; struct sched_adjdom_cmd adjustdom; struct dom0_setvcpucontext setvcpucontext; struct dom0_getdomaininfo getdomaininfo; struct dom0_getpageframeinfo getpageframeinfo; struct dom0_msr msr; struct dom0_settime settime; struct dom0_readconsole readconsole; struct dom0_setvcpuaffinity setvcpuaffinity; struct dom0_tbufcontrol tbufcontrol; struct dom0_physinfo physinfo; struct dom0_sched_id sched_id; struct dom0_shadow_control shadow_control; struct dom0_setdomainmaxmem setdomainmaxmem; struct dom0_getpageframeinfo2 getpageframeinfo2; struct dom0_add_memtype add_memtype; struct dom0_del_memtype del_memtype; struct dom0_read_memtype read_memtype; struct dom0_perfccontrol perfccontrol; struct dom0_microcode microcode; struct dom0_ioport_permission ioport_permission; struct dom0_getvcpucontext getvcpucontext; struct dom0_getvcpuinfo getvcpuinfo; struct dom0_getdomaininfolist getdomaininfolist; struct dom0_platform_quirk platform_quirk; struct dom0_physical_memory_map physical_memory_map; struct dom0_max_vcpus max_vcpus; struct dom0_setdomainhandle setdomainhandle; struct dom0_setdebugging setdebugging; struct dom0_irq_permission irq_permission; struct dom0_iomem_permission iomem_permission; struct dom0_hypercall_init hypercall_init; struct dom0_domain_setup domain_setup; struct dom0_settimeoffset settimeoffset; uint8_t pad[128]; } u; }; typedef struct dom0_op dom0_op_t; DEFINE_XEN_GUEST_HANDLE(dom0_op_t); #endif /* __XEN_PUBLIC_DOM0_OPS_H__ */ /* * Local variables: * mode: C * c-set-style: "BSD" * c-basic-offset: 4 * tab-width: 4 * indent-tabs-mode: nil * End: */