sys/xen/interface/domctl.h

   1 /******************************************************************************
   2  * domctl.h
   3  *
   4  * Domain management operations. For use by node control stack.
   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) 2002-2003, B Dragovic
  25  * Copyright (c) 2002-2006, K Fraser
  26  */
  27
  28 #ifndef __XEN_PUBLIC_DOMCTL_H__
  29 #define __XEN_PUBLIC_DOMCTL_H__
  30
  31 #if !defined(__XEN__) && !defined(__XEN_TOOLS__)
  32 #error "domctl operations are intended for use by node control tools only"
  33 #endif
  34
  35 #include "xen.h"
  36 #include "grant_table.h"
  37 #include "hvm/save.h"
  38 #include "memory.h"
  39
  40 #define XEN_DOMCTL_INTERFACE_VERSION 0x0000000b
  41
  42 /*
  43  * NB. xen_domctl.domain is an IN/OUT parameter for this operation.
  44  * If it is specified as zero, an id is auto-allocated and returned.
  45  */
  46 /* XEN_DOMCTL_createdomain */
  47 struct xen_domctl_createdomain {
  48     /* IN parameters */
  49     uint32_t ssidref;
  50     xen_domain_handle_t handle;
  51  /* Is this an HVM guest (as opposed to a PVH or PV guest)? */
  52 #define _XEN_DOMCTL_CDF_hvm_guest     0
  53 #define XEN_DOMCTL_CDF_hvm_guest      (1U<<_XEN_DOMCTL_CDF_hvm_guest)
  54  /* Use hardware-assisted paging if available? */
  55 #define _XEN_DOMCTL_CDF_hap           1
  56 #define XEN_DOMCTL_CDF_hap            (1U<<_XEN_DOMCTL_CDF_hap)
  57  /* Should domain memory integrity be verifed by tboot during Sx? */
  58 #define _XEN_DOMCTL_CDF_s3_integrity  2
  59 #define XEN_DOMCTL_CDF_s3_integrity   (1U<<_XEN_DOMCTL_CDF_s3_integrity)
  60  /* Disable out-of-sync shadow page tables? */
  61 #define _XEN_DOMCTL_CDF_oos_off       3
  62 #define XEN_DOMCTL_CDF_oos_off        (1U<<_XEN_DOMCTL_CDF_oos_off)
  63  /* Is this a PVH guest (as opposed to an HVM or PV guest)? */
  64 #define _XEN_DOMCTL_CDF_pvh_guest     4
  65 #define XEN_DOMCTL_CDF_pvh_guest      (1U<<_XEN_DOMCTL_CDF_pvh_guest)
  66     uint32_t flags;
  67     struct xen_arch_domainconfig config;
  68 };
  69 typedef struct xen_domctl_createdomain xen_domctl_createdomain_t;
  70 DEFINE_XEN_GUEST_HANDLE(xen_domctl_createdomain_t);
  71
  72 /* XEN_DOMCTL_getdomaininfo */
  73 struct xen_domctl_getdomaininfo {
  74     /* OUT variables. */
  75     domid_t  domain;              /* Also echoed in domctl.domain */
  76  /* Domain is scheduled to die. */
  77 #define _XEN_DOMINF_dying     0
  78 #define XEN_DOMINF_dying      (1U<<_XEN_DOMINF_dying)
  79  /* Domain is an HVM guest (as opposed to a PV guest). */
  80 #define _XEN_DOMINF_hvm_guest 1
  81 #define XEN_DOMINF_hvm_guest  (1U<<_XEN_DOMINF_hvm_guest)
  82  /* The guest OS has shut down. */
  83 #define _XEN_DOMINF_shutdown  2
  84 #define XEN_DOMINF_shutdown   (1U<<_XEN_DOMINF_shutdown)
  85  /* Currently paused by control software. */
  86 #define _XEN_DOMINF_paused    3
  87 #define XEN_DOMINF_paused     (1U<<_XEN_DOMINF_paused)
  88  /* Currently blocked pending an event.     */
  89 #define _XEN_DOMINF_blocked   4
  90 #define XEN_DOMINF_blocked    (1U<<_XEN_DOMINF_blocked)
  91  /* Domain is currently running.            */
  92 #define _XEN_DOMINF_running   5
  93 #define XEN_DOMINF_running    (1U<<_XEN_DOMINF_running)
  94  /* Being debugged.  */
  95 #define _XEN_DOMINF_debugged  6
  96 #define XEN_DOMINF_debugged   (1U<<_XEN_DOMINF_debugged)
  97 /* domain is PVH */
  98 #define _XEN_DOMINF_pvh_guest 7
  99 #define XEN_DOMINF_pvh_guest  (1U<<_XEN_DOMINF_pvh_guest)
 100  /* XEN_DOMINF_shutdown guest-supplied code.  */
 101 #define XEN_DOMINF_shutdownmask 255
 102 #define XEN_DOMINF_shutdownshift 16
 103     uint32_t flags;              /* XEN_DOMINF_* */
 104     uint64_aligned_t tot_pages;
 105     uint64_aligned_t max_pages;
 106     uint64_aligned_t outstanding_pages;
 107     uint64_aligned_t shr_pages;
 108     uint64_aligned_t paged_pages;
 109     uint64_aligned_t shared_info_frame; /* GMFN of shared_info struct */
 110     uint64_aligned_t cpu_time;
 111     uint32_t nr_online_vcpus;    /* Number of VCPUs currently online. */
 112 #define XEN_INVALID_MAX_VCPU_ID (~0U) /* Domain has no vcpus? */
 113     uint32_t max_vcpu_id;        /* Maximum VCPUID in use by this domain. */
 114     uint32_t ssidref;
 115     xen_domain_handle_t handle;
 116     uint32_t cpupool;
 117 };
 118 typedef struct xen_domctl_getdomaininfo xen_domctl_getdomaininfo_t;
 119 DEFINE_XEN_GUEST_HANDLE(xen_domctl_getdomaininfo_t);
 120
 121 /* XEN_DOMCTL_getmemlist */
 122 struct xen_domctl_getmemlist {
 123     /* IN variables. */
 124     /* Max entries to write to output buffer. */
 125     uint64_aligned_t max_pfns;
 126     /* Start index in guest's page list. */
 127     uint64_aligned_t start_pfn;
 128     XEN_GUEST_HANDLE_64(uint64) buffer;
 129     /* OUT variables. */
 130     uint64_aligned_t num_pfns;
 131 };
 132 typedef struct xen_domctl_getmemlist xen_domctl_getmemlist_t;
 133 DEFINE_XEN_GUEST_HANDLE(xen_domctl_getmemlist_t);
 134
 135 /* XEN_DOMCTL_getpageframeinfo */
 136
 137 #define XEN_DOMCTL_PFINFO_LTAB_SHIFT 28
 138 #define XEN_DOMCTL_PFINFO_NOTAB   (0x0U<<28)
 139 #define XEN_DOMCTL_PFINFO_L1TAB   (0x1U<<28)
 140 #define XEN_DOMCTL_PFINFO_L2TAB   (0x2U<<28)
 141 #define XEN_DOMCTL_PFINFO_L3TAB   (0x3U<<28)
 142 #define XEN_DOMCTL_PFINFO_L4TAB   (0x4U<<28)
 143 #define XEN_DOMCTL_PFINFO_LTABTYPE_MASK (0x7U<<28)
 144 #define XEN_DOMCTL_PFINFO_LPINTAB (0x1U<<31)
 145 #define XEN_DOMCTL_PFINFO_XTAB    (0xfU<<28) /* invalid page */
 146 #define XEN_DOMCTL_PFINFO_XALLOC  (0xeU<<28) /* allocate-only page */
 147 #define XEN_DOMCTL_PFINFO_BROKEN  (0xdU<<28) /* broken page */
 148 #define XEN_DOMCTL_PFINFO_LTAB_MASK (0xfU<<28)
 149
 150 /* XEN_DOMCTL_getpageframeinfo3 */
 151 struct xen_domctl_getpageframeinfo3 {
 152     /* IN variables. */
 153     uint64_aligned_t num;
 154     /* IN/OUT variables. */
 155     XEN_GUEST_HANDLE_64(xen_pfn_t) array;
 156 };
 157
 158 /*
 159  * Control shadow pagetables operation
 160  */
 161 /* XEN_DOMCTL_shadow_op */
 162
 163 /* Disable shadow mode. */
 164 #define XEN_DOMCTL_SHADOW_OP_OFF         0
 165
 166 /* Enable shadow mode (mode contains ORed XEN_DOMCTL_SHADOW_ENABLE_* flags). */
 167 #define XEN_DOMCTL_SHADOW_OP_ENABLE      32
 168
 169 /* Log-dirty bitmap operations. */
 170  /* Return the bitmap and clean internal copy for next round. */
 171 #define XEN_DOMCTL_SHADOW_OP_CLEAN       11
 172  /* Return the bitmap but do not modify internal copy. */
 173 #define XEN_DOMCTL_SHADOW_OP_PEEK        12
 174
 175 /* Memory allocation accessors. */
 176 #define XEN_DOMCTL_SHADOW_OP_GET_ALLOCATION   30
 177 #define XEN_DOMCTL_SHADOW_OP_SET_ALLOCATION   31
 178
 179 /* Legacy enable operations. */
 180  /* Equiv. to ENABLE with no mode flags. */
 181 #define XEN_DOMCTL_SHADOW_OP_ENABLE_TEST       1
 182  /* Equiv. to ENABLE with mode flag ENABLE_LOG_DIRTY. */
 183 #define XEN_DOMCTL_SHADOW_OP_ENABLE_LOGDIRTY   2
 184  /* Equiv. to ENABLE with mode flags ENABLE_REFCOUNT and ENABLE_TRANSLATE. */
 185 #define XEN_DOMCTL_SHADOW_OP_ENABLE_TRANSLATE  3
 186
 187 /* Mode flags for XEN_DOMCTL_SHADOW_OP_ENABLE. */
 188  /*
 189   * Shadow pagetables are refcounted: guest does not use explicit mmu
 190   * operations nor write-protect its pagetables.
 191   */
 192 #define XEN_DOMCTL_SHADOW_ENABLE_REFCOUNT  (1 << 1)
 193  /*
 194   * Log pages in a bitmap as they are dirtied.
 195   * Used for live relocation to determine which pages must be re-sent.
 196   */
 197 #define XEN_DOMCTL_SHADOW_ENABLE_LOG_DIRTY (1 << 2)
 198  /*
 199   * Automatically translate GPFNs into MFNs.
 200   */
 201 #define XEN_DOMCTL_SHADOW_ENABLE_TRANSLATE (1 << 3)
 202  /*
 203   * Xen does not steal virtual address space from the guest.
 204   * Requires HVM support.
 205   */
 206 #define XEN_DOMCTL_SHADOW_ENABLE_EXTERNAL  (1 << 4)
 207
 208 struct xen_domctl_shadow_op_stats {
 209     uint32_t fault_count;
 210     uint32_t dirty_count;
 211 };
 212 typedef struct xen_domctl_shadow_op_stats xen_domctl_shadow_op_stats_t;
 213 DEFINE_XEN_GUEST_HANDLE(xen_domctl_shadow_op_stats_t);
 214
 215 struct xen_domctl_shadow_op {
 216     /* IN variables. */
 217     uint32_t       op;       /* XEN_DOMCTL_SHADOW_OP_* */
 218
 219     /* OP_ENABLE */
 220     uint32_t       mode;     /* XEN_DOMCTL_SHADOW_ENABLE_* */
 221
 222     /* OP_GET_ALLOCATION / OP_SET_ALLOCATION */
 223     uint32_t       mb;       /* Shadow memory allocation in MB */
 224
 225     /* OP_PEEK / OP_CLEAN */
 226     XEN_GUEST_HANDLE_64(uint8) dirty_bitmap;
 227     uint64_aligned_t pages; /* Size of buffer. Updated with actual size. */
 228     struct xen_domctl_shadow_op_stats stats;
 229 };
 230 typedef struct xen_domctl_shadow_op xen_domctl_shadow_op_t;
 231 DEFINE_XEN_GUEST_HANDLE(xen_domctl_shadow_op_t);
 232
 233 /* XEN_DOMCTL_max_mem */
 234 struct xen_domctl_max_mem {
 235     /* IN variables. */
 236     uint64_aligned_t max_memkb;
 237 };
 238 typedef struct xen_domctl_max_mem xen_domctl_max_mem_t;
 239 DEFINE_XEN_GUEST_HANDLE(xen_domctl_max_mem_t);
 240
 241 /* XEN_DOMCTL_setvcpucontext */
 242 /* XEN_DOMCTL_getvcpucontext */
 243 struct xen_domctl_vcpucontext {
 244     uint32_t              vcpu;                  /* IN */
 245     XEN_GUEST_HANDLE_64(vcpu_guest_context_t) ctxt; /* IN/OUT */
 246 };
 247 typedef struct xen_domctl_vcpucontext xen_domctl_vcpucontext_t;
 248 DEFINE_XEN_GUEST_HANDLE(xen_domctl_vcpucontext_t);
 249
 250 /* XEN_DOMCTL_getvcpuinfo */
 251 struct xen_domctl_getvcpuinfo {
 252     /* IN variables. */
 253     uint32_t vcpu;
 254     /* OUT variables. */
 255     uint8_t  online;                  /* currently online (not hotplugged)? */
 256     uint8_t  blocked;                 /* blocked waiting for an event? */
 257     uint8_t  running;                 /* currently scheduled on its CPU? */
 258     uint64_aligned_t cpu_time;        /* total cpu time consumed (ns) */
 259     uint32_t cpu;                     /* current mapping   */
 260 };
 261 typedef struct xen_domctl_getvcpuinfo xen_domctl_getvcpuinfo_t;
 262 DEFINE_XEN_GUEST_HANDLE(xen_domctl_getvcpuinfo_t);
 263
 264 /* Get/set the NUMA node(s) with which the guest has affinity with. */
 265 /* XEN_DOMCTL_setnodeaffinity */
 266 /* XEN_DOMCTL_getnodeaffinity */
 267 struct xen_domctl_nodeaffinity {
 268     struct xenctl_bitmap nodemap;/* IN */
 269 };
 270 typedef struct xen_domctl_nodeaffinity xen_domctl_nodeaffinity_t;
 271 DEFINE_XEN_GUEST_HANDLE(xen_domctl_nodeaffinity_t);
 272
 273 /* Get/set which physical cpus a vcpu can execute on. */
 274 /* XEN_DOMCTL_setvcpuaffinity */
 275 /* XEN_DOMCTL_getvcpuaffinity */
 276 struct xen_domctl_vcpuaffinity {
 277     /* IN variables. */
 278     uint32_t  vcpu;
 279  /* Set/get the hard affinity for vcpu */
 280 #define _XEN_VCPUAFFINITY_HARD  0
 281 #define XEN_VCPUAFFINITY_HARD   (1U<<_XEN_VCPUAFFINITY_HARD)
 282  /* Set/get the soft affinity for vcpu */
 283 #define _XEN_VCPUAFFINITY_SOFT  1
 284 #define XEN_VCPUAFFINITY_SOFT   (1U<<_XEN_VCPUAFFINITY_SOFT)
 285     uint32_t flags;
 286     /*
 287      * IN/OUT variables.
 288      *
 289      * Both are IN/OUT for XEN_DOMCTL_setvcpuaffinity, in which case they
 290      * contain effective hard or/and soft affinity. That is, upon successful
 291      * return, cpumap_soft, contains the intersection of the soft affinity,
 292      * hard affinity and the cpupool's online CPUs for the domain (if
 293      * XEN_VCPUAFFINITY_SOFT was set in flags). cpumap_hard contains the
 294      * intersection between hard affinity and the cpupool's online CPUs (if
 295      * XEN_VCPUAFFINITY_HARD was set in flags).
 296      *
 297      * Both are OUT-only for XEN_DOMCTL_getvcpuaffinity, in which case they
 298      * contain the plain hard and/or soft affinity masks that were set during
 299      * previous successful calls to XEN_DOMCTL_setvcpuaffinity (or the
 300      * default values), without intersecting or altering them in any way.
 301      */
 302     struct xenctl_bitmap cpumap_hard;
 303     struct xenctl_bitmap cpumap_soft;
 304 };
 305 typedef struct xen_domctl_vcpuaffinity xen_domctl_vcpuaffinity_t;
 306 DEFINE_XEN_GUEST_HANDLE(xen_domctl_vcpuaffinity_t);
 307
 308 /* XEN_DOMCTL_max_vcpus */
 309 struct xen_domctl_max_vcpus {
 310     uint32_t max;           /* maximum number of vcpus */
 311 };
 312 typedef struct xen_domctl_max_vcpus xen_domctl_max_vcpus_t;
 313 DEFINE_XEN_GUEST_HANDLE(xen_domctl_max_vcpus_t);
 314
 315 /* XEN_DOMCTL_scheduler_op */
 316 /* Scheduler types. */
 317 /* #define XEN_SCHEDULER_SEDF  4 (Removed) */
 318 #define XEN_SCHEDULER_CREDIT   5
 319 #define XEN_SCHEDULER_CREDIT2  6
 320 #define XEN_SCHEDULER_ARINC653 7
 321 #define XEN_SCHEDULER_RTDS     8
 322
 323 /* Set or get info? */
 324 #define XEN_DOMCTL_SCHEDOP_putinfo 0
 325 #define XEN_DOMCTL_SCHEDOP_getinfo 1
 326 struct xen_domctl_scheduler_op {
 327     uint32_t sched_id;  /* XEN_SCHEDULER_* */
 328     uint32_t cmd;       /* XEN_DOMCTL_SCHEDOP_* */
 329     union {
 330         struct xen_domctl_sched_credit {
 331             uint16_t weight;
 332             uint16_t cap;
 333         } credit;
 334         struct xen_domctl_sched_credit2 {
 335             uint16_t weight;
 336         } credit2;
 337         struct xen_domctl_sched_rtds {
 338             uint32_t period;
 339             uint32_t budget;
 340         } rtds;
 341     } u;
 342 };
 343 typedef struct xen_domctl_scheduler_op xen_domctl_scheduler_op_t;
 344 DEFINE_XEN_GUEST_HANDLE(xen_domctl_scheduler_op_t);
 345
 346 /* XEN_DOMCTL_setdomainhandle */
 347 struct xen_domctl_setdomainhandle {
 348     xen_domain_handle_t handle;
 349 };
 350 typedef struct xen_domctl_setdomainhandle xen_domctl_setdomainhandle_t;
 351 DEFINE_XEN_GUEST_HANDLE(xen_domctl_setdomainhandle_t);
 352
 353 /* XEN_DOMCTL_setdebugging */
 354 struct xen_domctl_setdebugging {
 355     uint8_t enable;
 356 };
 357 typedef struct xen_domctl_setdebugging xen_domctl_setdebugging_t;
 358 DEFINE_XEN_GUEST_HANDLE(xen_domctl_setdebugging_t);
 359
 360 /* XEN_DOMCTL_irq_permission */
 361 struct xen_domctl_irq_permission {
 362     uint8_t pirq;
 363     uint8_t allow_access;    /* flag to specify enable/disable of IRQ access */
 364 };
 365 typedef struct xen_domctl_irq_permission xen_domctl_irq_permission_t;
 366 DEFINE_XEN_GUEST_HANDLE(xen_domctl_irq_permission_t);
 367
 368 /* XEN_DOMCTL_iomem_permission */
 369 struct xen_domctl_iomem_permission {
 370     uint64_aligned_t first_mfn;/* first page (physical page number) in range */
 371     uint64_aligned_t nr_mfns;  /* number of pages in range (>0) */
 372     uint8_t  allow_access;     /* allow (!0) or deny (0) access to range? */
 373 };
 374 typedef struct xen_domctl_iomem_permission xen_domctl_iomem_permission_t;
 375 DEFINE_XEN_GUEST_HANDLE(xen_domctl_iomem_permission_t);
 376
 377 /* XEN_DOMCTL_ioport_permission */
 378 struct xen_domctl_ioport_permission {
 379     uint32_t first_port;              /* first port int range */
 380     uint32_t nr_ports;                /* size of port range */
 381     uint8_t  allow_access;            /* allow or deny access to range? */
 382 };
 383 typedef struct xen_domctl_ioport_permission xen_domctl_ioport_permission_t;
 384 DEFINE_XEN_GUEST_HANDLE(xen_domctl_ioport_permission_t);
 385
 386 /* XEN_DOMCTL_hypercall_init */
 387 struct xen_domctl_hypercall_init {
 388     uint64_aligned_t  gmfn;           /* GMFN to be initialised */
 389 };
 390 typedef struct xen_domctl_hypercall_init xen_domctl_hypercall_init_t;
 391 DEFINE_XEN_GUEST_HANDLE(xen_domctl_hypercall_init_t);
 392
 393 /* XEN_DOMCTL_settimeoffset */
 394 struct xen_domctl_settimeoffset {
 395     int64_aligned_t time_offset_seconds; /* applied to domain wallclock time */
 396 };
 397 typedef struct xen_domctl_settimeoffset xen_domctl_settimeoffset_t;
 398 DEFINE_XEN_GUEST_HANDLE(xen_domctl_settimeoffset_t);
 399
 400 /* XEN_DOMCTL_gethvmcontext */
 401 /* XEN_DOMCTL_sethvmcontext */
 402 typedef struct xen_domctl_hvmcontext {
 403     uint32_t size; /* IN/OUT: size of buffer / bytes filled */
 404     XEN_GUEST_HANDLE_64(uint8) buffer; /* IN/OUT: data, or call
 405                                         * gethvmcontext with NULL
 406                                         * buffer to get size req'd */
 407 } xen_domctl_hvmcontext_t;
 408 DEFINE_XEN_GUEST_HANDLE(xen_domctl_hvmcontext_t);
 409
 410 /* XEN_DOMCTL_set_address_size */
 411 /* XEN_DOMCTL_get_address_size */
 412 typedef struct xen_domctl_address_size {
 413     uint32_t size;
 414 } xen_domctl_address_size_t;
 415 DEFINE_XEN_GUEST_HANDLE(xen_domctl_address_size_t);
 416
 417 /* XEN_DOMCTL_sendtrigger */
 418 #define XEN_DOMCTL_SENDTRIGGER_NMI    0
 419 #define XEN_DOMCTL_SENDTRIGGER_RESET  1
 420 #define XEN_DOMCTL_SENDTRIGGER_INIT   2
 421 #define XEN_DOMCTL_SENDTRIGGER_POWER  3
 422 #define XEN_DOMCTL_SENDTRIGGER_SLEEP  4
 423 struct xen_domctl_sendtrigger {
 424     uint32_t  trigger;  /* IN */
 425     uint32_t  vcpu;     /* IN */
 426 };
 427 typedef struct xen_domctl_sendtrigger xen_domctl_sendtrigger_t;
 428 DEFINE_XEN_GUEST_HANDLE(xen_domctl_sendtrigger_t);
 429
 430 /* Assign a device to a guest. Sets up IOMMU structures. */
 431 /* XEN_DOMCTL_assign_device */
 432 /* XEN_DOMCTL_test_assign_device */
 433 /*
 434  * XEN_DOMCTL_deassign_device: The behavior of this DOMCTL differs
 435  * between the different type of device:
 436  *  - PCI device (XEN_DOMCTL_DEV_PCI) will be reassigned to DOM0
 437  *  - DT device (XEN_DOMCTL_DT_PCI) will left unassigned. DOM0
 438  *  will have to call XEN_DOMCTL_assign_device in order to use the
 439  *  device.
 440  */
 441 #define XEN_DOMCTL_DEV_PCI      0
 442 #define XEN_DOMCTL_DEV_DT       1
 443 struct xen_domctl_assign_device {
 444     uint32_t dev;   /* XEN_DOMCTL_DEV_* */
 445     union {
 446         struct {
 447             uint32_t machine_sbdf;   /* machine PCI ID of assigned device */
 448         } pci;
 449         struct {
 450             uint32_t size; /* Length of the path */
 451             XEN_GUEST_HANDLE_64(char) path; /* path to the device tree node */
 452         } dt;
 453     } u;
 454     /* IN */
 455 #define XEN_DOMCTL_DEV_RDM_RELAXED      1
 456     uint32_t  flag;   /* flag of assigned device */
 457 };
 458 typedef struct xen_domctl_assign_device xen_domctl_assign_device_t;
 459 DEFINE_XEN_GUEST_HANDLE(xen_domctl_assign_device_t);
 460
 461 /* Retrieve sibling devices infomation of machine_sbdf */
 462 /* XEN_DOMCTL_get_device_group */
 463 struct xen_domctl_get_device_group {
 464     uint32_t  machine_sbdf;     /* IN */
 465     uint32_t  max_sdevs;        /* IN */
 466     uint32_t  num_sdevs;        /* OUT */
 467     XEN_GUEST_HANDLE_64(uint32)  sdev_array;   /* OUT */
 468 };
 469 typedef struct xen_domctl_get_device_group xen_domctl_get_device_group_t;
 470 DEFINE_XEN_GUEST_HANDLE(xen_domctl_get_device_group_t);
 471
 472 /* Pass-through interrupts: bind real irq -> hvm devfn. */
 473 /* XEN_DOMCTL_bind_pt_irq */
 474 /* XEN_DOMCTL_unbind_pt_irq */
 475 typedef enum pt_irq_type_e {
 476     PT_IRQ_TYPE_PCI,
 477     PT_IRQ_TYPE_ISA,
 478     PT_IRQ_TYPE_MSI,
 479     PT_IRQ_TYPE_MSI_TRANSLATE,
 480     PT_IRQ_TYPE_SPI,    /* ARM: valid range 32-1019 */
 481 } pt_irq_type_t;
 482 struct xen_domctl_bind_pt_irq {
 483     uint32_t machine_irq;
 484     pt_irq_type_t irq_type;
 485     uint32_t hvm_domid;
 486
 487     union {
 488         struct {
 489             uint8_t isa_irq;
 490         } isa;
 491         struct {
 492             uint8_t bus;
 493             uint8_t device;
 494             uint8_t intx;
 495         } pci;
 496         struct {
 497             uint8_t gvec;
 498             uint32_t gflags;
 499             uint64_aligned_t gtable;
 500         } msi;
 501         struct {
 502             uint16_t spi;
 503         } spi;
 504     } u;
 505 };
 506 typedef struct xen_domctl_bind_pt_irq xen_domctl_bind_pt_irq_t;
 507 DEFINE_XEN_GUEST_HANDLE(xen_domctl_bind_pt_irq_t);
 508
 509 /* Bind machine I/O address range -> HVM address range. */
 510 /* If this returns -E2BIG lower nr_mfns value. */
 511 /* XEN_DOMCTL_memory_mapping */
 512 #define DPCI_ADD_MAPPING         1
 513 #define DPCI_REMOVE_MAPPING      0
 514 struct xen_domctl_memory_mapping {
 515     uint64_aligned_t first_gfn; /* first page (hvm guest phys page) in range */
 516     uint64_aligned_t first_mfn; /* first page (machine page) in range */
 517     uint64_aligned_t nr_mfns;   /* number of pages in range (>0) */
 518     uint32_t add_mapping;       /* add or remove mapping */
 519     uint32_t padding;           /* padding for 64-bit aligned structure */
 520 };
 521 typedef struct xen_domctl_memory_mapping xen_domctl_memory_mapping_t;
 522 DEFINE_XEN_GUEST_HANDLE(xen_domctl_memory_mapping_t);
 523
 524 /* Bind machine I/O port range -> HVM I/O port range. */
 525 /* XEN_DOMCTL_ioport_mapping */
 526 struct xen_domctl_ioport_mapping {
 527     uint32_t first_gport;     /* first guest IO port*/
 528     uint32_t first_mport;     /* first machine IO port */
 529     uint32_t nr_ports;        /* size of port range */
 530     uint32_t add_mapping;     /* add or remove mapping */
 531 };
 532 typedef struct xen_domctl_ioport_mapping xen_domctl_ioport_mapping_t;
 533 DEFINE_XEN_GUEST_HANDLE(xen_domctl_ioport_mapping_t);
 534
 535 /*
 536  * Pin caching type of RAM space for x86 HVM domU.
 537  */
 538 /* XEN_DOMCTL_pin_mem_cacheattr */
 539 /* Caching types: these happen to be the same as x86 MTRR/PAT type codes. */
 540 #define XEN_DOMCTL_MEM_CACHEATTR_UC  0
 541 #define XEN_DOMCTL_MEM_CACHEATTR_WC  1
 542 #define XEN_DOMCTL_MEM_CACHEATTR_WT  4
 543 #define XEN_DOMCTL_MEM_CACHEATTR_WP  5
 544 #define XEN_DOMCTL_MEM_CACHEATTR_WB  6
 545 #define XEN_DOMCTL_MEM_CACHEATTR_UCM 7
 546 #define XEN_DOMCTL_DELETE_MEM_CACHEATTR (~(uint32_t)0)
 547 struct xen_domctl_pin_mem_cacheattr {
 548     uint64_aligned_t start, end;
 549     uint32_t type; /* XEN_DOMCTL_MEM_CACHEATTR_* */
 550 };
 551 typedef struct xen_domctl_pin_mem_cacheattr xen_domctl_pin_mem_cacheattr_t;
 552 DEFINE_XEN_GUEST_HANDLE(xen_domctl_pin_mem_cacheattr_t);
 553
 554 /* XEN_DOMCTL_set_ext_vcpucontext */
 555 /* XEN_DOMCTL_get_ext_vcpucontext */
 556 struct xen_domctl_ext_vcpucontext {
 557     /* IN: VCPU that this call applies to. */
 558     uint32_t         vcpu;
 559     /*
 560      * SET: Size of struct (IN)
 561      * GET: Size of struct (OUT, up to 128 bytes)
 562      */
 563     uint32_t         size;
 564 #if defined(__i386__) || defined(__x86_64__)
 565     /* SYSCALL from 32-bit mode and SYSENTER callback information. */
 566     /* NB. SYSCALL from 64-bit mode is contained in vcpu_guest_context_t */
 567     uint64_aligned_t syscall32_callback_eip;
 568     uint64_aligned_t sysenter_callback_eip;
 569     uint16_t         syscall32_callback_cs;
 570     uint16_t         sysenter_callback_cs;
 571     uint8_t          syscall32_disables_events;
 572     uint8_t          sysenter_disables_events;
 573 #if defined(__GNUC__)
 574     union {
 575         uint64_aligned_t mcg_cap;
 576         struct hvm_vmce_vcpu vmce;
 577     };
 578 #else
 579     struct hvm_vmce_vcpu vmce;
 580 #endif
 581 #endif
 582 };
 583 typedef struct xen_domctl_ext_vcpucontext xen_domctl_ext_vcpucontext_t;
 584 DEFINE_XEN_GUEST_HANDLE(xen_domctl_ext_vcpucontext_t);
 585
 586 /*
 587  * Set the target domain for a domain
 588  */
 589 /* XEN_DOMCTL_set_target */
 590 struct xen_domctl_set_target {
 591     domid_t target;
 592 };
 593 typedef struct xen_domctl_set_target xen_domctl_set_target_t;
 594 DEFINE_XEN_GUEST_HANDLE(xen_domctl_set_target_t);
 595
 596 #if defined(__i386__) || defined(__x86_64__)
 597 # define XEN_CPUID_INPUT_UNUSED  0xFFFFFFFF
 598 /* XEN_DOMCTL_set_cpuid */
 599 struct xen_domctl_cpuid {
 600   uint32_t input[2];
 601   uint32_t eax;
 602   uint32_t ebx;
 603   uint32_t ecx;
 604   uint32_t edx;
 605 };
 606 typedef struct xen_domctl_cpuid xen_domctl_cpuid_t;
 607 DEFINE_XEN_GUEST_HANDLE(xen_domctl_cpuid_t);
 608 #endif
 609
 610 /*
 611  * Arranges that if the domain suspends (specifically, if it shuts
 612  * down with code SHUTDOWN_suspend), this event channel will be
 613  * notified.
 614  *
 615  * This is _instead of_ the usual notification to the global
 616  * VIRQ_DOM_EXC.  (In most systems that pirq is owned by xenstored.)
 617  *
 618  * Only one subscription per domain is possible.  Last subscriber
 619  * wins; others are silently displaced.
 620  *
 621  * NB that contrary to the rather general name, it only applies to
 622  * domain shutdown with code suspend.  Shutdown for other reasons
 623  * (including crash), and domain death, are notified to VIRQ_DOM_EXC
 624  * regardless.
 625  */
 626 /* XEN_DOMCTL_subscribe */
 627 struct xen_domctl_subscribe {
 628     uint32_t port; /* IN */
 629 };
 630 typedef struct xen_domctl_subscribe xen_domctl_subscribe_t;
 631 DEFINE_XEN_GUEST_HANDLE(xen_domctl_subscribe_t);
 632
 633 /*
 634  * Define the maximum machine address size which should be allocated
 635  * to a guest.
 636  */
 637 /* XEN_DOMCTL_set_machine_address_size */
 638 /* XEN_DOMCTL_get_machine_address_size */
 639
 640 /*
 641  * Do not inject spurious page faults into this domain.
 642  */
 643 /* XEN_DOMCTL_suppress_spurious_page_faults */
 644
 645 /* XEN_DOMCTL_debug_op */
 646 #define XEN_DOMCTL_DEBUG_OP_SINGLE_STEP_OFF         0
 647 #define XEN_DOMCTL_DEBUG_OP_SINGLE_STEP_ON          1
 648 struct xen_domctl_debug_op {
 649     uint32_t op;   /* IN */
 650     uint32_t vcpu; /* IN */
 651 };
 652 typedef struct xen_domctl_debug_op xen_domctl_debug_op_t;
 653 DEFINE_XEN_GUEST_HANDLE(xen_domctl_debug_op_t);
 654
 655 /*
 656  * Request a particular record from the HVM context
 657  */
 658 /* XEN_DOMCTL_gethvmcontext_partial */
 659 typedef struct xen_domctl_hvmcontext_partial {
 660     uint32_t type;                      /* IN: Type of record required */
 661     uint32_t instance;                  /* IN: Instance of that type */
 662     XEN_GUEST_HANDLE_64(uint8) buffer;  /* OUT: buffer to write record into */
 663 } xen_domctl_hvmcontext_partial_t;
 664 DEFINE_XEN_GUEST_HANDLE(xen_domctl_hvmcontext_partial_t);
 665
 666 /* XEN_DOMCTL_disable_migrate */
 667 typedef struct xen_domctl_disable_migrate {
 668     uint32_t disable; /* IN: 1: disable migration and restore */
 669 } xen_domctl_disable_migrate_t;
 670
 671 /* XEN_DOMCTL_gettscinfo */
 672 /* XEN_DOMCTL_settscinfo */
 673 typedef struct xen_domctl_tsc_info {
 674     /* IN/OUT */
 675     uint32_t tsc_mode;
 676     uint32_t gtsc_khz;
 677     uint32_t incarnation;
 678     uint32_t pad;
 679     uint64_aligned_t elapsed_nsec;
 680 } xen_domctl_tsc_info_t;
 681
 682 /* XEN_DOMCTL_gdbsx_guestmemio      guest mem io */
 683 struct xen_domctl_gdbsx_memio {
 684     /* IN */
 685     uint64_aligned_t pgd3val;/* optional: init_mm.pgd[3] value */
 686     uint64_aligned_t gva;    /* guest virtual address */
 687     uint64_aligned_t uva;    /* user buffer virtual address */
 688     uint32_t         len;    /* number of bytes to read/write */
 689     uint8_t          gwr;    /* 0 = read from guest. 1 = write to guest */
 690     /* OUT */
 691     uint32_t         remain; /* bytes remaining to be copied */
 692 };
 693
 694 /* XEN_DOMCTL_gdbsx_pausevcpu */
 695 /* XEN_DOMCTL_gdbsx_unpausevcpu */
 696 struct xen_domctl_gdbsx_pauseunp_vcpu { /* pause/unpause a vcpu */
 697     uint32_t         vcpu;         /* which vcpu */
 698 };
 699
 700 /* XEN_DOMCTL_gdbsx_domstatus */
 701 struct xen_domctl_gdbsx_domstatus {
 702     /* OUT */
 703     uint8_t          paused;     /* is the domain paused */
 704     uint32_t         vcpu_id;    /* any vcpu in an event? */
 705     uint32_t         vcpu_ev;    /* if yes, what event? */
 706 };
 707
 708 /*
 709  * VM event operations
 710  */
 711
 712 /* XEN_DOMCTL_vm_event_op */
 713
 714 /*
 715  * There are currently three rings available for VM events:
 716  * sharing, monitor and paging. This hypercall allows one to
 717  * control these rings (enable/disable), as well as to signal
 718  * to the hypervisor to pull responses (resume) from the given
 719  * ring.
 720  */
 721 #define XEN_VM_EVENT_ENABLE               0
 722 #define XEN_VM_EVENT_DISABLE              1
 723 #define XEN_VM_EVENT_RESUME               2
 724
 725 /*
 726  * Domain memory paging
 727  * Page memory in and out.
 728  * Domctl interface to set up and tear down the
 729  * pager<->hypervisor interface. Use XENMEM_paging_op*
 730  * to perform per-page operations.
 731  *
 732  * The XEN_VM_EVENT_PAGING_ENABLE domctl returns several
 733  * non-standard error codes to indicate why paging could not be enabled:
 734  * ENODEV - host lacks HAP support (EPT/NPT) or HAP is disabled in guest
 735  * EMLINK - guest has iommu passthrough enabled
 736  * EXDEV  - guest has PoD enabled
 737  * EBUSY  - guest has or had paging enabled, ring buffer still active
 738  */
 739 #define XEN_DOMCTL_VM_EVENT_OP_PAGING            1
 740
 741 /*
 742  * Monitor helper.
 743  *
 744  * As with paging, use the domctl for teardown/setup of the
 745  * helper<->hypervisor interface.
 746  *
 747  * The monitor interface can be used to register for various VM events. For
 748  * example, there are HVM hypercalls to set the per-page access permissions
 749  * of every page in a domain.  When one of these permissions--independent,
 750  * read, write, and execute--is violated, the VCPU is paused and a memory event
 751  * is sent with what happened. The memory event handler can then resume the
 752  * VCPU and redo the access with a XEN_VM_EVENT_RESUME option.
 753  *
 754  * See public/vm_event.h for the list of available events that can be
 755  * subscribed to via the monitor interface.
 756  *
 757  * The XEN_VM_EVENT_MONITOR_* domctls returns
 758  * non-standard error codes to indicate why access could not be enabled:
 759  * ENODEV - host lacks HAP support (EPT/NPT) or HAP is disabled in guest
 760  * EBUSY  - guest has or had access enabled, ring buffer still active
 761  *
 762  */
 763 #define XEN_DOMCTL_VM_EVENT_OP_MONITOR           2
 764
 765 /*
 766  * Sharing ENOMEM helper.
 767  *
 768  * As with paging, use the domctl for teardown/setup of the
 769  * helper<->hypervisor interface.
 770  *
 771  * If setup, this ring is used to communicate failed allocations
 772  * in the unshare path. XENMEM_sharing_op_resume is used to wake up
 773  * vcpus that could not unshare.
 774  *
 775  * Note that shring can be turned on (as per the domctl below)
 776  * *without* this ring being setup.
 777  */
 778 #define XEN_DOMCTL_VM_EVENT_OP_SHARING           3
 779
 780 /* Use for teardown/setup of helper<->hypervisor interface for paging,
 781  * access and sharing.*/
 782 struct xen_domctl_vm_event_op {
 783     uint32_t       op;           /* XEN_VM_EVENT_* */
 784     uint32_t       mode;         /* XEN_DOMCTL_VM_EVENT_OP_* */
 785
 786     uint32_t port;              /* OUT: event channel for ring */
 787 };
 788 typedef struct xen_domctl_vm_event_op xen_domctl_vm_event_op_t;
 789 DEFINE_XEN_GUEST_HANDLE(xen_domctl_vm_event_op_t);
 790
 791 /*
 792  * Memory sharing operations
 793  */
 794 /* XEN_DOMCTL_mem_sharing_op.
 795  * The CONTROL sub-domctl is used for bringup/teardown. */
 796 #define XEN_DOMCTL_MEM_SHARING_CONTROL          0
 797
 798 struct xen_domctl_mem_sharing_op {
 799     uint8_t op; /* XEN_DOMCTL_MEM_SHARING_* */
 800
 801     union {
 802         uint8_t enable;                   /* CONTROL */
 803     } u;
 804 };
 805 typedef struct xen_domctl_mem_sharing_op xen_domctl_mem_sharing_op_t;
 806 DEFINE_XEN_GUEST_HANDLE(xen_domctl_mem_sharing_op_t);
 807
 808 struct xen_domctl_audit_p2m {
 809     /* OUT error counts */
 810     uint64_t orphans;
 811     uint64_t m2p_bad;
 812     uint64_t p2m_bad;
 813 };
 814 typedef struct xen_domctl_audit_p2m xen_domctl_audit_p2m_t;
 815 DEFINE_XEN_GUEST_HANDLE(xen_domctl_audit_p2m_t);
 816
 817 struct xen_domctl_set_virq_handler {
 818     uint32_t virq; /* IN */
 819 };
 820 typedef struct xen_domctl_set_virq_handler xen_domctl_set_virq_handler_t;
 821 DEFINE_XEN_GUEST_HANDLE(xen_domctl_set_virq_handler_t);
 822
 823 #if defined(__i386__) || defined(__x86_64__)
 824 /* XEN_DOMCTL_setvcpuextstate */
 825 /* XEN_DOMCTL_getvcpuextstate */
 826 struct xen_domctl_vcpuextstate {
 827     /* IN: VCPU that this call applies to. */
 828     uint32_t         vcpu;
 829     /*
 830      * SET: Ignored.
 831      * GET: xfeature support mask of struct (IN/OUT)
 832      * xfeature mask is served as identifications of the saving format
 833      * so that compatible CPUs can have a check on format to decide
 834      * whether it can restore.
 835      */
 836     uint64_aligned_t         xfeature_mask;
 837     /*
 838      * SET: Size of struct (IN)
 839      * GET: Size of struct (IN/OUT)
 840      */
 841     uint64_aligned_t         size;
 842     XEN_GUEST_HANDLE_64(uint64) buffer;
 843 };
 844 typedef struct xen_domctl_vcpuextstate xen_domctl_vcpuextstate_t;
 845 DEFINE_XEN_GUEST_HANDLE(xen_domctl_vcpuextstate_t);
 846 #endif
 847
 848 /* XEN_DOMCTL_set_access_required: sets whether a memory event listener
 849  * must be present to handle page access events: if false, the page
 850  * access will revert to full permissions if no one is listening;
 851  *  */
 852 struct xen_domctl_set_access_required {
 853     uint8_t access_required;
 854 };
 855 typedef struct xen_domctl_set_access_required xen_domctl_set_access_required_t;
 856 DEFINE_XEN_GUEST_HANDLE(xen_domctl_set_access_required_t);
 857
 858 struct xen_domctl_set_broken_page_p2m {
 859     uint64_aligned_t pfn;
 860 };
 861 typedef struct xen_domctl_set_broken_page_p2m xen_domctl_set_broken_page_p2m_t;
 862 DEFINE_XEN_GUEST_HANDLE(xen_domctl_set_broken_page_p2m_t);
 863
 864 /*
 865  * XEN_DOMCTL_set_max_evtchn: sets the maximum event channel port
 866  * number the guest may use.  Use this limit the amount of resources
 867  * (global mapping space, xenheap) a guest may use for event channels.
 868  */
 869 struct xen_domctl_set_max_evtchn {
 870     uint32_t max_port;
 871 };
 872 typedef struct xen_domctl_set_max_evtchn xen_domctl_set_max_evtchn_t;
 873 DEFINE_XEN_GUEST_HANDLE(xen_domctl_set_max_evtchn_t);
 874
 875 /*
 876  * ARM: Clean and invalidate caches associated with given region of
 877  * guest memory.
 878  */
 879 struct xen_domctl_cacheflush {
 880     /* IN: page range to flush. */
 881     xen_pfn_t start_pfn, nr_pfns;
 882 };
 883 typedef struct xen_domctl_cacheflush xen_domctl_cacheflush_t;
 884 DEFINE_XEN_GUEST_HANDLE(xen_domctl_cacheflush_t);
 885
 886 #if defined(__i386__) || defined(__x86_64__)
 887 struct xen_domctl_vcpu_msr {
 888     uint32_t         index;
 889     uint32_t         reserved;
 890     uint64_aligned_t value;
 891 };
 892 typedef struct xen_domctl_vcpu_msr xen_domctl_vcpu_msr_t;
 893 DEFINE_XEN_GUEST_HANDLE(xen_domctl_vcpu_msr_t);
 894
 895 /*
 896  * XEN_DOMCTL_set_vcpu_msrs / XEN_DOMCTL_get_vcpu_msrs.
 897  *
 898  * Input:
 899  * - A NULL 'msrs' guest handle is a request for the maximum 'msr_count'.
 900  * - Otherwise, 'msr_count' is the number of entries in 'msrs'.
 901  *
 902  * Output for get:
 903  * - If 'msr_count' is less than the number Xen needs to write, -ENOBUFS shall
 904  *   be returned and 'msr_count' updated to reflect the intended number.
 905  * - On success, 'msr_count' shall indicate the number of MSRs written, which
 906  *   may be less than the maximum if some are not currently used by the vcpu.
 907  *
 908  * Output for set:
 909  * - If Xen encounters an error with a specific MSR, -EINVAL shall be returned
 910  *   and 'msr_count' shall be set to the offending index, to aid debugging.
 911  */
 912 struct xen_domctl_vcpu_msrs {
 913     uint32_t vcpu;                                   /* IN     */
 914     uint32_t msr_count;                              /* IN/OUT */
 915     XEN_GUEST_HANDLE_64(xen_domctl_vcpu_msr_t) msrs; /* IN/OUT */
 916 };
 917 typedef struct xen_domctl_vcpu_msrs xen_domctl_vcpu_msrs_t;
 918 DEFINE_XEN_GUEST_HANDLE(xen_domctl_vcpu_msrs_t);
 919 #endif
 920
 921 /* XEN_DOMCTL_setvnumainfo: specifies a virtual NUMA topology for the guest */
 922 struct xen_domctl_vnuma {
 923     /* IN: number of vNUMA nodes to setup. Shall be greater than 0 */
 924     uint32_t nr_vnodes;
 925     /* IN: number of memory ranges to setup */
 926     uint32_t nr_vmemranges;
 927     /*
 928      * IN: number of vCPUs of the domain (used as size of the vcpu_to_vnode
 929      * array declared below). Shall be equal to the domain's max_vcpus.
 930      */
 931     uint32_t nr_vcpus;
 932     uint32_t pad;                                  /* must be zero */
 933
 934     /*
 935      * IN: array for specifying the distances of the vNUMA nodes
 936      * between each others. Shall have nr_vnodes*nr_vnodes elements.
 937      */
 938     XEN_GUEST_HANDLE_64(uint) vdistance;
 939     /*
 940      * IN: array for specifying to what vNUMA node each vCPU belongs.
 941      * Shall have nr_vcpus elements.
 942      */
 943     XEN_GUEST_HANDLE_64(uint) vcpu_to_vnode;
 944     /*
 945      * IN: array for specifying on what physical NUMA node each vNUMA
 946      * node is placed. Shall have nr_vnodes elements.
 947      */
 948     XEN_GUEST_HANDLE_64(uint) vnode_to_pnode;
 949     /*
 950      * IN: array for specifying the memory ranges. Shall have
 951      * nr_vmemranges elements.
 952      */
 953     XEN_GUEST_HANDLE_64(xen_vmemrange_t) vmemrange;
 954 };
 955 typedef struct xen_domctl_vnuma xen_domctl_vnuma_t;
 956 DEFINE_XEN_GUEST_HANDLE(xen_domctl_vnuma_t);
 957
 958 struct xen_domctl_psr_cmt_op {
 959 #define XEN_DOMCTL_PSR_CMT_OP_DETACH         0
 960 #define XEN_DOMCTL_PSR_CMT_OP_ATTACH         1
 961 #define XEN_DOMCTL_PSR_CMT_OP_QUERY_RMID     2
 962     uint32_t cmd;
 963     uint32_t data;
 964 };
 965 typedef struct xen_domctl_psr_cmt_op xen_domctl_psr_cmt_op_t;
 966 DEFINE_XEN_GUEST_HANDLE(xen_domctl_psr_cmt_op_t);
 967
 968 /*  XEN_DOMCTL_MONITOR_*
 969  *
 970  * Enable/disable monitoring various VM events.
 971  * This domctl configures what events will be reported to helper apps
 972  * via the ring buffer "MONITOR". The ring has to be first enabled
 973  * with the domctl XEN_DOMCTL_VM_EVENT_OP_MONITOR.
 974  *
 975  * GET_CAPABILITIES can be used to determine which of these features is
 976  * available on a given platform.
 977  *
 978  * NOTICE: mem_access events are also delivered via the "MONITOR" ring buffer;
 979  * however, enabling/disabling those events is performed with the use of
 980  * memory_op hypercalls!
 981  */
 982 #define XEN_DOMCTL_MONITOR_OP_ENABLE            0
 983 #define XEN_DOMCTL_MONITOR_OP_DISABLE           1
 984 #define XEN_DOMCTL_MONITOR_OP_GET_CAPABILITIES  2
 985
 986 #define XEN_DOMCTL_MONITOR_EVENT_WRITE_CTRLREG         0
 987 #define XEN_DOMCTL_MONITOR_EVENT_MOV_TO_MSR            1
 988 #define XEN_DOMCTL_MONITOR_EVENT_SINGLESTEP            2
 989 #define XEN_DOMCTL_MONITOR_EVENT_SOFTWARE_BREAKPOINT   3
 990 #define XEN_DOMCTL_MONITOR_EVENT_GUEST_REQUEST         4
 991
 992 struct xen_domctl_monitor_op {
 993     uint32_t op; /* XEN_DOMCTL_MONITOR_OP_* */
 994
 995     /*
 996      * When used with ENABLE/DISABLE this has to be set to
 997      * the requested XEN_DOMCTL_MONITOR_EVENT_* value.
 998      * With GET_CAPABILITIES this field returns a bitmap of
 999      * events supported by the platform, in the format
1000      * (1 << XEN_DOMCTL_MONITOR_EVENT_*).
1001      */
1002     uint32_t event;
1003
1004     /*
1005      * Further options when issuing XEN_DOMCTL_MONITOR_OP_ENABLE.
1006      */
1007     union {
1008         struct {
1009             /* Which control register */
1010             uint8_t index;
1011             /* Pause vCPU until response */
1012             uint8_t sync;
1013             /* Send event only on a change of value */
1014             uint8_t onchangeonly;
1015         } mov_to_cr;
1016
1017         struct {
1018             /* Enable the capture of an extended set of MSRs */
1019             uint8_t extended_capture;
1020         } mov_to_msr;
1021
1022         struct {
1023             /* Pause vCPU until response */
1024             uint8_t sync;
1025         } guest_request;
1026     } u;
1027 };
1028 typedef struct xen_domctl_monitor_op xen_domctl_monitor_op_t;
1029 DEFINE_XEN_GUEST_HANDLE(xen_domctl_monitor_op_t);
1030
1031 struct xen_domctl_psr_cat_op {
1032 #define XEN_DOMCTL_PSR_CAT_OP_SET_L3_CBM     0
1033 #define XEN_DOMCTL_PSR_CAT_OP_GET_L3_CBM     1
1034     uint32_t cmd;       /* IN: XEN_DOMCTL_PSR_CAT_OP_* */
1035     uint32_t target;    /* IN */
1036     uint64_t data;      /* IN/OUT */
1037 };
1038 typedef struct xen_domctl_psr_cat_op xen_domctl_psr_cat_op_t;
1039 DEFINE_XEN_GUEST_HANDLE(xen_domctl_psr_cat_op_t);
1040
1041 struct xen_domctl {
1042     uint32_t cmd;
1043 #define XEN_DOMCTL_createdomain                   1
1044 #define XEN_DOMCTL_destroydomain                  2
1045 #define XEN_DOMCTL_pausedomain                    3
1046 #define XEN_DOMCTL_unpausedomain                  4
1047 #define XEN_DOMCTL_getdomaininfo                  5
1048 #define XEN_DOMCTL_getmemlist                     6
1049 /* #define XEN_DOMCTL_getpageframeinfo            7 Obsolete - use getpageframeinfo3 */
1050 /* #define XEN_DOMCTL_getpageframeinfo2           8 Obsolete - use getpageframeinfo3 */
1051 #define XEN_DOMCTL_setvcpuaffinity                9
1052 #define XEN_DOMCTL_shadow_op                     10
1053 #define XEN_DOMCTL_max_mem                       11
1054 #define XEN_DOMCTL_setvcpucontext                12
1055 #define XEN_DOMCTL_getvcpucontext                13
1056 #define XEN_DOMCTL_getvcpuinfo                   14
1057 #define XEN_DOMCTL_max_vcpus                     15
1058 #define XEN_DOMCTL_scheduler_op                  16
1059 #define XEN_DOMCTL_setdomainhandle               17
1060 #define XEN_DOMCTL_setdebugging                  18
1061 #define XEN_DOMCTL_irq_permission                19
1062 #define XEN_DOMCTL_iomem_permission              20
1063 #define XEN_DOMCTL_ioport_permission             21
1064 #define XEN_DOMCTL_hypercall_init                22
1065 #define XEN_DOMCTL_arch_setup                    23 /* Obsolete IA64 only */
1066 #define XEN_DOMCTL_settimeoffset                 24
1067 #define XEN_DOMCTL_getvcpuaffinity               25
1068 #define XEN_DOMCTL_real_mode_area                26 /* Obsolete PPC only */
1069 #define XEN_DOMCTL_resumedomain                  27
1070 #define XEN_DOMCTL_sendtrigger                   28
1071 #define XEN_DOMCTL_subscribe                     29
1072 #define XEN_DOMCTL_gethvmcontext                 33
1073 #define XEN_DOMCTL_sethvmcontext                 34
1074 #define XEN_DOMCTL_set_address_size              35
1075 #define XEN_DOMCTL_get_address_size              36
1076 #define XEN_DOMCTL_assign_device                 37
1077 #define XEN_DOMCTL_bind_pt_irq                   38
1078 #define XEN_DOMCTL_memory_mapping                39
1079 #define XEN_DOMCTL_ioport_mapping                40
1080 #define XEN_DOMCTL_pin_mem_cacheattr             41
1081 #define XEN_DOMCTL_set_ext_vcpucontext           42
1082 #define XEN_DOMCTL_get_ext_vcpucontext           43
1083 #define XEN_DOMCTL_set_opt_feature               44 /* Obsolete IA64 only */
1084 #define XEN_DOMCTL_test_assign_device            45
1085 #define XEN_DOMCTL_set_target                    46
1086 #define XEN_DOMCTL_deassign_device               47
1087 #define XEN_DOMCTL_unbind_pt_irq                 48
1088 #define XEN_DOMCTL_set_cpuid                     49
1089 #define XEN_DOMCTL_get_device_group              50
1090 #define XEN_DOMCTL_set_machine_address_size      51
1091 #define XEN_DOMCTL_get_machine_address_size      52
1092 #define XEN_DOMCTL_suppress_spurious_page_faults 53
1093 #define XEN_DOMCTL_debug_op                      54
1094 #define XEN_DOMCTL_gethvmcontext_partial         55
1095 #define XEN_DOMCTL_vm_event_op                   56
1096 #define XEN_DOMCTL_mem_sharing_op                57
1097 #define XEN_DOMCTL_disable_migrate               58
1098 #define XEN_DOMCTL_gettscinfo                    59
1099 #define XEN_DOMCTL_settscinfo                    60
1100 #define XEN_DOMCTL_getpageframeinfo3             61
1101 #define XEN_DOMCTL_setvcpuextstate               62
1102 #define XEN_DOMCTL_getvcpuextstate               63
1103 #define XEN_DOMCTL_set_access_required           64
1104 #define XEN_DOMCTL_audit_p2m                     65
1105 #define XEN_DOMCTL_set_virq_handler              66
1106 #define XEN_DOMCTL_set_broken_page_p2m           67
1107 #define XEN_DOMCTL_setnodeaffinity               68
1108 #define XEN_DOMCTL_getnodeaffinity               69
1109 #define XEN_DOMCTL_set_max_evtchn                70
1110 #define XEN_DOMCTL_cacheflush                    71
1111 #define XEN_DOMCTL_get_vcpu_msrs                 72
1112 #define XEN_DOMCTL_set_vcpu_msrs                 73
1113 #define XEN_DOMCTL_setvnumainfo                  74
1114 #define XEN_DOMCTL_psr_cmt_op                    75
1115 #define XEN_DOMCTL_monitor_op                    77
1116 #define XEN_DOMCTL_psr_cat_op                    78
1117 #define XEN_DOMCTL_gdbsx_guestmemio            1000
1118 #define XEN_DOMCTL_gdbsx_pausevcpu             1001
1119 #define XEN_DOMCTL_gdbsx_unpausevcpu           1002
1120 #define XEN_DOMCTL_gdbsx_domstatus             1003
1121     uint32_t interface_version; /* XEN_DOMCTL_INTERFACE_VERSION */
1122     domid_t  domain;
1123     union {
1124         struct xen_domctl_createdomain      createdomain;
1125         struct xen_domctl_getdomaininfo     getdomaininfo;
1126         struct xen_domctl_getmemlist        getmemlist;
1127         struct xen_domctl_getpageframeinfo3 getpageframeinfo3;
1128         struct xen_domctl_nodeaffinity      nodeaffinity;
1129         struct xen_domctl_vcpuaffinity      vcpuaffinity;
1130         struct xen_domctl_shadow_op         shadow_op;
1131         struct xen_domctl_max_mem           max_mem;
1132         struct xen_domctl_vcpucontext       vcpucontext;
1133         struct xen_domctl_getvcpuinfo       getvcpuinfo;
1134         struct xen_domctl_max_vcpus         max_vcpus;
1135         struct xen_domctl_scheduler_op      scheduler_op;
1136         struct xen_domctl_setdomainhandle   setdomainhandle;
1137         struct xen_domctl_setdebugging      setdebugging;
1138         struct xen_domctl_irq_permission    irq_permission;
1139         struct xen_domctl_iomem_permission  iomem_permission;
1140         struct xen_domctl_ioport_permission ioport_permission;
1141         struct xen_domctl_hypercall_init    hypercall_init;
1142         struct xen_domctl_settimeoffset     settimeoffset;
1143         struct xen_domctl_disable_migrate   disable_migrate;
1144         struct xen_domctl_tsc_info          tsc_info;
1145         struct xen_domctl_hvmcontext        hvmcontext;
1146         struct xen_domctl_hvmcontext_partial hvmcontext_partial;
1147         struct xen_domctl_address_size      address_size;
1148         struct xen_domctl_sendtrigger       sendtrigger;
1149         struct xen_domctl_get_device_group  get_device_group;
1150         struct xen_domctl_assign_device     assign_device;
1151         struct xen_domctl_bind_pt_irq       bind_pt_irq;
1152         struct xen_domctl_memory_mapping    memory_mapping;
1153         struct xen_domctl_ioport_mapping    ioport_mapping;
1154         struct xen_domctl_pin_mem_cacheattr pin_mem_cacheattr;
1155         struct xen_domctl_ext_vcpucontext   ext_vcpucontext;
1156         struct xen_domctl_set_target        set_target;
1157         struct xen_domctl_subscribe         subscribe;
1158         struct xen_domctl_debug_op          debug_op;
1159         struct xen_domctl_vm_event_op       vm_event_op;
1160         struct xen_domctl_mem_sharing_op    mem_sharing_op;
1161 #if defined(__i386__) || defined(__x86_64__)
1162         struct xen_domctl_cpuid             cpuid;
1163         struct xen_domctl_vcpuextstate      vcpuextstate;
1164         struct xen_domctl_vcpu_msrs         vcpu_msrs;
1165 #endif
1166         struct xen_domctl_set_access_required access_required;
1167         struct xen_domctl_audit_p2m         audit_p2m;
1168         struct xen_domctl_set_virq_handler  set_virq_handler;
1169         struct xen_domctl_set_max_evtchn    set_max_evtchn;
1170         struct xen_domctl_gdbsx_memio       gdbsx_guest_memio;
1171         struct xen_domctl_set_broken_page_p2m set_broken_page_p2m;
1172         struct xen_domctl_cacheflush        cacheflush;
1173         struct xen_domctl_gdbsx_pauseunp_vcpu gdbsx_pauseunp_vcpu;
1174         struct xen_domctl_gdbsx_domstatus   gdbsx_domstatus;
1175         struct xen_domctl_vnuma             vnuma;
1176         struct xen_domctl_psr_cmt_op        psr_cmt_op;
1177         struct xen_domctl_monitor_op        monitor_op;
1178         struct xen_domctl_psr_cat_op        psr_cat_op;
1179         uint8_t                             pad[128];
1180     } u;
1181 };
1182 typedef struct xen_domctl xen_domctl_t;
1183 DEFINE_XEN_GUEST_HANDLE(xen_domctl_t);
1184
1185 #endif /* __XEN_PUBLIC_DOMCTL_H__ */
1186
1187 /*
1188  * Local variables:
1189  * mode: C
1190  * c-file-style: "BSD"
1191  * c-basic-offset: 4
1192  * tab-width: 4
1193  * indent-tabs-mode: nil
1194  * End:
1195  */