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