kvm/devices/vm.rst

1 .. SPDX-License-Identifier: GPL-2.0
9 struct kvm_device_attr as other devices, but targets VM-wide settings
21 -------------------------------------------
24 :Returns: -EBUSY if a vcpu is already defined, otherwise 0
29 ----------------------------------------
32 :Returns: -EINVAL if CMMA was not enabled;
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;
61 ---------------------------------------------
63 Allows user space to retrieve machine and kvm specific cpu related information::
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;
82 Allows user space to retrieve or request to change cpu related information for a vcpu::
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;
107 --------------------------------------------------
109 Allows user space to retrieve available cpu features. A feature is available if
116 	__u64 feat[16]; # Bitmap (1 = feature available), MSB 0 bit numbering
120 :Returns:  -EFAULT if the given address is not accessible from kernel space;
124 ----------------------------------------------------
126 Allows user space to retrieve or change enabled cpu features for all VCPUs of a
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;
141 -----------------------------------------------------
143 Allows user space to retrieve available cpu subfunctions without any filtering
152 contained in the returned struct in MSB 0 bit numbering.
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;
180 -------------------------------------------------------
182 Allows user space to retrieve or change cpu subfunctions to be indicated for
188 has not been disabled by user space (so the instruction to be queried is
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;
210 ------------------------------------
212 Allows user space to set/get the TOD clock extension (u8) (superseded by
215 :Parameters: address of a buffer in user space to store the data (u8) to
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)
221 -----------------------------------
223 Allows user space to set/get bits 0-63 of the TOD clock register as defined in
226 :Parameters: address of a buffer in user space to store the data (u64) to
227 :Returns:    -EFAULT if the given address is not accessible from kernel space
228 	     -EOPNOTSUPP for a PV guest (TOD managed by the ultravisor)
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
238 :Parameters: address of a buffer in user space to store the data
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)
250 ------------------------------------------------------
252 Allows user space to enable aes key wrapping, including generating a new
259 ------------------------------------------------------
261 Allows user space to enable dea key wrapping, including generating a new
268 -------------------------------------------------------
270 Allows user space to disable aes key wrapping, clearing the wrapping key.
276 -------------------------------------------------------
278 Allows user space to disable dea key wrapping, clearing the wrapping key.
289 ------------------------------------------------
299 -------------------------------------------------
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);
315 --------------------------------------------------
319 :Parameters: address of a buffer in user space to store the data (u64) to;
322 :Returns:   -EFAULT if the given address is not accessible from kernel space;
331 ---------------------------------------------
342         ENOMEM  Failed to allocate memory for the in-kernel
361 The filter is defined as a set of non-overlapping ranges. Each
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.