kvm/devices/vm.rst

1 .. SPDX-License-Identifier: GPL-2.0
9 struct kvm_device_attr as other devices, but targets VM-wide settings
20 1.1. ATTRIBUTE: KVM_S390_VM_MEM_ENABLE_CMMA
21 -------------------------------------------
24 :Returns: -EBUSY if a vcpu is already defined, otherwise 0
28 1.2. ATTRIBUTE: KVM_S390_VM_MEM_CLR_CMMA
29 ----------------------------------------
32 :Returns: -EINVAL if CMMA was not enabled;
38 1.3. ATTRIBUTE KVM_S390_VM_MEM_LIMIT_SIZE
39 -----------------------------------------
41 :Parameters: in attr->addr the address for the new limit of guest memory
42 :Returns: -EFAULT if the given address is not accessible;
43 	  -EINVAL if the virtual machine is of type UCONTROL;
44 	  -E2BIG if the given guest memory is to big for that machine;
45 	  -EBUSY if a vcpu is already defined;
46 	  -ENOMEM if not enough memory is available for a new shadow guest mapping;
49 Allows userspace to query the actual limit and set a new limit for
52 the number of page table levels. In the case that there is no limit we will set
60 2.1. ATTRIBUTE: KVM_S390_VM_CPU_MACHINE (r/o)
61 ---------------------------------------------
69        __u64 fac_mask[256];   # set of cpu facilities enabled by KVM
70        __u64 fac_list[256];   # set of cpu facilities offered by host
75 :Returns:   -EFAULT if the given address is not accessible from kernel space;
76 	    -ENOMEM if not enough memory is available to process the ioctl;
79 2.2. ATTRIBUTE: KVM_S390_VM_CPU_PROCESSOR (r/w)
88        __u64 fac_list[256];   # set of cpu facilities currently (to be) used
94 setups. Instruction interceptions triggered by additionally set facility bits that
97 :Parameters: address of buffer to store/set the processor related cpu
99 :Returns:  -EBUSY in case 1 or more vcpus are already activated (only in write case);
100 	   -EFAULT if the given address is not accessible from kernel space;
101 	   -ENOMEM if not enough memory is available to process the ioctl;
106 2.3. ATTRIBUTE: KVM_S390_VM_CPU_MACHINE_FEAT (r/o)
107 --------------------------------------------------
120 :Returns:  -EFAULT if the given address is not accessible from kernel space;
123 2.4. ATTRIBUTE: KVM_S390_VM_CPU_PROCESSOR_FEAT (r/w)
124 ----------------------------------------------------
133 :Returns:   -EFAULT if the given address is not accessible from kernel space;
134 	    -EINVAL if a cpu feature that is not available is to be enabled;
135 	    -EBUSY if at least one VCPU has already been defined;
140 2.5. ATTRIBUTE: KVM_S390_VM_CPU_MACHINE_SUBFUNC (r/o)
141 -----------------------------------------------------
144 done by a set IBC. These subfunctions are indicated to the guest VCPU via
158        u8 ptff[16];          # valid with TOD-clock steering
159        u8 kmac[16];          # valid with Message-Security-Assist
160        u8 kmc[16];           # valid with Message-Security-Assist
161        u8 km[16];            # valid with Message-Security-Assist
162        u8 kimd[16];          # valid with Message-Security-Assist
163        u8 klmd[16];          # valid with Message-Security-Assist
164        u8 pckmo[16];         # valid with Message-Security-Assist-Extension 3
165        u8 kmctr[16];         # valid with Message-Security-Assist-Extension 4
166        u8 kmf[16];           # valid with Message-Security-Assist-Extension 4
167        u8 kmo[16];           # valid with Message-Security-Assist-Extension 4
168        u8 pcc[16];           # valid with Message-Security-Assist-Extension 4
169        u8 ppno[16];          # valid with Message-Security-Assist-Extension 5
170        u8 kma[16];           # valid with Message-Security-Assist-Extension 8
171        u8 kdsa[16];          # valid with Message-Security-Assist-Extension 9
176 :Returns:   -EFAULT if the given address is not accessible from kernel space;
179 2.6. ATTRIBUTE: KVM_S390_VM_CPU_PROCESSOR_SUBFUNC (r/w)
180 -------------------------------------------------------
183 all VCPUs of a VM. This attribute will only be available if kernel and
199 :Returns:   -EFAULT if the given address is not accessible from kernel space;
200 	    -EINVAL when reading, if there was no write yet;
201 	    -EBUSY if at least one VCPU has already been defined;
209 3.1. ATTRIBUTE: KVM_S390_VM_TOD_HIGH
210 ------------------------------------
212 Allows user space to set/get the TOD clock extension (u8) (superseded by
216 :Returns:   -EFAULT if the given address is not accessible from kernel space;
217 	    -EINVAL if setting the TOD clock extension to != 0 is not supported
218 	    -EOPNOTSUPP for a PV guest (TOD managed by the ultravisor)
220 3.2. ATTRIBUTE: KVM_S390_VM_TOD_LOW
221 -----------------------------------
223 Allows user space to set/get bits 0-63 of the TOD clock register as defined in
227 :Returns:    -EFAULT if the given address is not accessible from kernel space
228 	     -EOPNOTSUPP for a PV guest (TOD managed by the ultravisor)
230 3.3. ATTRIBUTE: KVM_S390_VM_TOD_EXT
231 -----------------------------------
233 Allows user space to set/get bits 0-63 of the TOD clock register as defined in
235 also allows user space to get/set it. If the guest CPU model does not support
236 it, it is stored as 0 and not allowed to be set to a value != 0.
240 :Returns:   -EFAULT if the given address is not accessible from kernel space;
241 	    -EINVAL if setting the TOD clock extension to != 0 is not supported
242 	    -EOPNOTSUPP for a PV guest (TOD managed by the ultravisor)
249 4.1. ATTRIBUTE: KVM_S390_VM_CRYPTO_ENABLE_AES_KW (w/o)
250 ------------------------------------------------------
258 4.2. ATTRIBUTE: KVM_S390_VM_CRYPTO_ENABLE_DEA_KW (w/o)
259 ------------------------------------------------------
267 4.3. ATTRIBUTE: KVM_S390_VM_CRYPTO_DISABLE_AES_KW (w/o)
268 -------------------------------------------------------
275 4.4. ATTRIBUTE: KVM_S390_VM_CRYPTO_DISABLE_DEA_KW (w/o)
276 -------------------------------------------------------
288 5.1. ATTRIBUTE: KVM_S390_VM_MIGRATION_STOP (w/o)
289 ------------------------------------------------
292 Setting this attribute when migration mode is not active will have no
298 5.2. ATTRIBUTE: KVM_S390_VM_MIGRATION_START (w/o)
299 -------------------------------------------------
302 Setting this attribute when migration mode is already active will have
305 Dirty tracking must be enabled on all memslots, else -EINVAL is returned. When
310 :Returns:   -ENOMEM if there is not enough free memory to start migration mode;
311 	    -EINVAL if the state of the VM is invalid (e.g. no memory defined);
314 5.3. ATTRIBUTE: KVM_S390_VM_MIGRATION_STATUS (r/o)
315 --------------------------------------------------
322 :Returns:   -EFAULT if the given address is not accessible from kernel space;
330 6.1. ATTRIBUTE: KVM_ARM_VM_SMCCC_FILTER (w/o)
331 ---------------------------------------------
342         ENOMEM  Failed to allocate memory for the in-kernel
361 The filter is defined as a set of non-overlapping ranges. Each
364 successive calls to this attribute.
375 guest. The SMCCC filter gates the in-kernel emulation of SMCCC calls
381  - ``KVM_SMCCC_FILTER_HANDLE``: Allows the guest SMCCC call to be
382    handled in-kernel. It is strongly recommended that userspace *not*
385  - ``KVM_SMCCC_FILTER_DENY``: Rejects the guest SMCCC call in-kernel
388  - ``KVM_SMCCC_FILTER_FWD_TO_USER``: The guest SMCCC call is forwarded
392 return ``-EINVAL`` if the field is nonzero.