Documentation/virtual/kvm/devices/vm.txt

   1 Generic vm interface
   2 ====================================
   3
   4 The virtual machine "device" also accepts the ioctls KVM_SET_DEVICE_ATTR,
   5 KVM_GET_DEVICE_ATTR, and KVM_HAS_DEVICE_ATTR. The interface uses the same
   6 struct kvm_device_attr as other devices, but targets VM-wide settings
   7 and controls.
   8
   9 The groups and attributes per virtual machine, if any, are architecture
  10 specific.
  11
  12 1. GROUP: KVM_S390_VM_MEM_CTRL
  13 Architectures: s390
  14
  15 1.1. ATTRIBUTE: KVM_S390_VM_MEM_ENABLE_CMMA
  16 Parameters: none
  17 Returns: -EBUSY if a vcpu is already defined, otherwise 0
  18
  19 Enables Collaborative Memory Management Assist (CMMA) for the virtual machine.
  20
  21 1.2. ATTRIBUTE: KVM_S390_VM_MEM_CLR_CMMA
  22 Parameters: none
  23 Returns: -EINVAL if CMMA was not enabled
  24          0 otherwise
  25
  26 Clear the CMMA status for all guest pages, so any pages the guest marked
  27 as unused are again used any may not be reclaimed by the host.
  28
  29 1.3. ATTRIBUTE KVM_S390_VM_MEM_LIMIT_SIZE
  30 Parameters: in attr->addr the address for the new limit of guest memory
  31 Returns: -EFAULT if the given address is not accessible
  32          -EINVAL if the virtual machine is of type UCONTROL
  33          -E2BIG if the given guest memory is to big for that machine
  34          -EBUSY if a vcpu is already defined
  35          -ENOMEM if not enough memory is available for a new shadow guest mapping
  36           0 otherwise
  37
  38 Allows userspace to query the actual limit and set a new limit for
  39 the maximum guest memory size. The limit will be rounded up to
  40 2048 MB, 4096 GB, 8192 TB respectively, as this limit is governed by
  41 the number of page table levels. In the case that there is no limit we will set
  42 the limit to KVM_S390_NO_MEM_LIMIT (U64_MAX).
  43
  44 2. GROUP: KVM_S390_VM_CPU_MODEL
  45 Architectures: s390
  46
  47 2.1. ATTRIBUTE: KVM_S390_VM_CPU_MACHINE (r/o)
  48
  49 Allows user space to retrieve machine and kvm specific cpu related information:
  50
  51 struct kvm_s390_vm_cpu_machine {
  52        __u64 cpuid;           # CPUID of host
  53        __u32 ibc;             # IBC level range offered by host
  54        __u8  pad[4];
  55        __u64 fac_mask[256];   # set of cpu facilities enabled by KVM
  56        __u64 fac_list[256];   # set of cpu facilities offered by host
  57 }
  58
  59 Parameters: address of buffer to store the machine related cpu data
  60             of type struct kvm_s390_vm_cpu_machine*
  61 Returns:    -EFAULT if the given address is not accessible from kernel space
  62             -ENOMEM if not enough memory is available to process the ioctl
  63             0 in case of success
  64
  65 2.2. ATTRIBUTE: KVM_S390_VM_CPU_PROCESSOR (r/w)
  66
  67 Allows user space to retrieve or request to change cpu related information for a vcpu:
  68
  69 struct kvm_s390_vm_cpu_processor {
  70        __u64 cpuid;           # CPUID currently (to be) used by this vcpu
  71        __u16 ibc;             # IBC level currently (to be) used by this vcpu
  72        __u8  pad[6];
  73        __u64 fac_list[256];   # set of cpu facilities currently (to be) used
  74                               # by this vcpu
  75 }
  76
  77 KVM does not enforce or limit the cpu model data in any form. Take the information
  78 retrieved by means of KVM_S390_VM_CPU_MACHINE as hint for reasonable configuration
  79 setups. Instruction interceptions triggered by additionally set facility bits that
  80 are not handled by KVM need to by imlemented in the VM driver code.
  81
  82 Parameters: address of buffer to store/set the processor related cpu
  83             data of type struct kvm_s390_vm_cpu_processor*.
  84 Returns:    -EBUSY in case 1 or more vcpus are already activated (only in write case)
  85             -EFAULT if the given address is not accessible from kernel space
  86             -ENOMEM if not enough memory is available to process the ioctl
  87             0 in case of success
  88
  89 2.3. ATTRIBUTE: KVM_S390_VM_CPU_MACHINE_FEAT (r/o)
  90
  91 Allows user space to retrieve available cpu features. A feature is available if
  92 provided by the hardware and supported by kvm. In theory, cpu features could
  93 even be completely emulated by kvm.
  94
  95 struct kvm_s390_vm_cpu_feat {
  96         __u64 feat[16]; # Bitmap (1 = feature available), MSB 0 bit numbering
  97 };
  98
  99 Parameters: address of a buffer to load the feature list from.
 100 Returns:    -EFAULT if the given address is not accessible from kernel space.
 101             0 in case of success.
 102
 103 2.4. ATTRIBUTE: KVM_S390_VM_CPU_PROCESSOR_FEAT (r/w)
 104
 105 Allows user space to retrieve or change enabled cpu features for all VCPUs of a
 106 VM. Features that are not available cannot be enabled.
 107
 108 See 2.3. for a description of the parameter struct.
 109
 110 Parameters: address of a buffer to store/load the feature list from.
 111 Returns:    -EFAULT if the given address is not accessible from kernel space.
 112             -EINVAL if a cpu feature that is not available is to be enabled.
 113             -EBUSY if at least one VCPU has already been defined.
 114             0 in case of success.
 115
 116 2.5. ATTRIBUTE: KVM_S390_VM_CPU_MACHINE_SUBFUNC (r/o)
 117
 118 Allows user space to retrieve available cpu subfunctions without any filtering
 119 done by a set IBC. These subfunctions are indicated to the guest VCPU via
 120 query or "test bit" subfunctions and used e.g. by cpacf functions, plo and ptff.
 121
 122 A subfunction block is only valid if KVM_S390_VM_CPU_MACHINE contains the
 123 STFL(E) bit introducing the affected instruction. If the affected instruction
 124 indicates subfunctions via a "query subfunction", the response block is
 125 contained in the returned struct. If the affected instruction
 126 indicates subfunctions via a "test bit" mechanism, the subfunction codes are
 127 contained in the returned struct in MSB 0 bit numbering.
 128
 129 struct kvm_s390_vm_cpu_subfunc {
 130        u8 plo[32];           # always valid (ESA/390 feature)
 131        u8 ptff[16];          # valid with TOD-clock steering
 132        u8 kmac[16];          # valid with Message-Security-Assist
 133        u8 kmc[16];           # valid with Message-Security-Assist
 134        u8 km[16];            # valid with Message-Security-Assist
 135        u8 kimd[16];          # valid with Message-Security-Assist
 136        u8 klmd[16];          # valid with Message-Security-Assist
 137        u8 pckmo[16];         # valid with Message-Security-Assist-Extension 3
 138        u8 kmctr[16];         # valid with Message-Security-Assist-Extension 4
 139        u8 kmf[16];           # valid with Message-Security-Assist-Extension 4
 140        u8 kmo[16];           # valid with Message-Security-Assist-Extension 4
 141        u8 pcc[16];           # valid with Message-Security-Assist-Extension 4
 142        u8 ppno[16];          # valid with Message-Security-Assist-Extension 5
 143        u8 kma[16];           # valid with Message-Security-Assist-Extension 8
 144        u8 kdsa[16];          # valid with Message-Security-Assist-Extension 9
 145        u8 reserved[1792];    # reserved for future instructions
 146 };
 147
 148 Parameters: address of a buffer to load the subfunction blocks from.
 149 Returns:    -EFAULT if the given address is not accessible from kernel space.
 150             0 in case of success.
 151
 152 2.6. ATTRIBUTE: KVM_S390_VM_CPU_PROCESSOR_SUBFUNC (r/w)
 153
 154 Allows user space to retrieve or change cpu subfunctions to be indicated for
 155 all VCPUs of a VM. This attribute will only be available if kernel and
 156 hardware support are in place.
 157
 158 The kernel uses the configured subfunction blocks for indication to
 159 the guest. A subfunction block will only be used if the associated STFL(E) bit
 160 has not been disabled by user space (so the instruction to be queried is
 161 actually available for the guest).
 162
 163 As long as no data has been written, a read will fail. The IBC will be used
 164 to determine available subfunctions in this case, this will guarantee backward
 165 compatibility.
 166
 167 See 2.5. for a description of the parameter struct.
 168
 169 Parameters: address of a buffer to store/load the subfunction blocks from.
 170 Returns:    -EFAULT if the given address is not accessible from kernel space.
 171             -EINVAL when reading, if there was no write yet.
 172             -EBUSY if at least one VCPU has already been defined.
 173             0 in case of success.
 174
 175 3. GROUP: KVM_S390_VM_TOD
 176 Architectures: s390
 177
 178 3.1. ATTRIBUTE: KVM_S390_VM_TOD_HIGH
 179
 180 Allows user space to set/get the TOD clock extension (u8) (superseded by
 181 KVM_S390_VM_TOD_EXT).
 182
 183 Parameters: address of a buffer in user space to store the data (u8) to
 184 Returns:    -EFAULT if the given address is not accessible from kernel space
 185             -EINVAL if setting the TOD clock extension to != 0 is not supported
 186
 187 3.2. ATTRIBUTE: KVM_S390_VM_TOD_LOW
 188
 189 Allows user space to set/get bits 0-63 of the TOD clock register as defined in
 190 the POP (u64).
 191
 192 Parameters: address of a buffer in user space to store the data (u64) to
 193 Returns:    -EFAULT if the given address is not accessible from kernel space
 194
 195 3.3. ATTRIBUTE: KVM_S390_VM_TOD_EXT
 196 Allows user space to set/get bits 0-63 of the TOD clock register as defined in
 197 the POP (u64). If the guest CPU model supports the TOD clock extension (u8), it
 198 also allows user space to get/set it. If the guest CPU model does not support
 199 it, it is stored as 0 and not allowed to be set to a value != 0.
 200
 201 Parameters: address of a buffer in user space to store the data
 202             (kvm_s390_vm_tod_clock) to
 203 Returns:    -EFAULT if the given address is not accessible from kernel space
 204             -EINVAL if setting the TOD clock extension to != 0 is not supported
 205
 206 4. GROUP: KVM_S390_VM_CRYPTO
 207 Architectures: s390
 208
 209 4.1. ATTRIBUTE: KVM_S390_VM_CRYPTO_ENABLE_AES_KW (w/o)
 210
 211 Allows user space to enable aes key wrapping, including generating a new
 212 wrapping key.
 213
 214 Parameters: none
 215 Returns:    0
 216
 217 4.2. ATTRIBUTE: KVM_S390_VM_CRYPTO_ENABLE_DEA_KW (w/o)
 218
 219 Allows user space to enable dea key wrapping, including generating a new
 220 wrapping key.
 221
 222 Parameters: none
 223 Returns:    0
 224
 225 4.3. ATTRIBUTE: KVM_S390_VM_CRYPTO_DISABLE_AES_KW (w/o)
 226
 227 Allows user space to disable aes key wrapping, clearing the wrapping key.
 228
 229 Parameters: none
 230 Returns:    0
 231
 232 4.4. ATTRIBUTE: KVM_S390_VM_CRYPTO_DISABLE_DEA_KW (w/o)
 233
 234 Allows user space to disable dea key wrapping, clearing the wrapping key.
 235
 236 Parameters: none
 237 Returns:    0
 238
 239 5. GROUP: KVM_S390_VM_MIGRATION
 240 Architectures: s390
 241
 242 5.1. ATTRIBUTE: KVM_S390_VM_MIGRATION_STOP (w/o)
 243
 244 Allows userspace to stop migration mode, needed for PGSTE migration.
 245 Setting this attribute when migration mode is not active will have no
 246 effects.
 247
 248 Parameters: none
 249 Returns:    0
 250
 251 5.2. ATTRIBUTE: KVM_S390_VM_MIGRATION_START (w/o)
 252
 253 Allows userspace to start migration mode, needed for PGSTE migration.
 254 Setting this attribute when migration mode is already active will have
 255 no effects.
 256
 257 Parameters: none
 258 Returns:    -ENOMEM if there is not enough free memory to start migration mode
 259             -EINVAL if the state of the VM is invalid (e.g. no memory defined)
 260             0 in case of success.
 261
 262 5.3. ATTRIBUTE: KVM_S390_VM_MIGRATION_STATUS (r/o)
 263
 264 Allows userspace to query the status of migration mode.
 265
 266 Parameters: address of a buffer in user space to store the data (u64) to;
 267             the data itself is either 0 if migration mode is disabled or 1
 268             if it is enabled
 269 Returns:    -EFAULT if the given address is not accessible from kernel space
 270             0 in case of success.