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
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
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
220 -----------------------------------
222 Allows user space to set/get bits 0-63 of the TOD clock register as defined in
225 :Parameters: address of a buffer in user space to store the data (u64) to
226 :Returns:    -EFAULT if the given address is not accessible from kernel space
229 -----------------------------------
231 Allows user space to set/get bits 0-63 of the TOD clock register as defined in
233 also allows user space to get/set it. If the guest CPU model does not support
236 :Parameters: address of a buffer in user space to store the data
238 :Returns:   -EFAULT if the given address is not accessible from kernel space;
239 	    -EINVAL if setting the TOD clock extension to != 0 is not supported
247 ------------------------------------------------------
249 Allows user space to enable aes key wrapping, including generating a new
256 ------------------------------------------------------
258 Allows user space to enable dea key wrapping, including generating a new
265 -------------------------------------------------------
267 Allows user space to disable aes key wrapping, clearing the wrapping key.
273 -------------------------------------------------------
275 Allows user space to disable dea key wrapping, clearing the wrapping key.
286 ------------------------------------------------
296 -------------------------------------------------
303 :Returns:   -ENOMEM if there is not enough free memory to start migration mode;
304 	    -EINVAL if the state of the VM is invalid (e.g. no memory defined);
308 --------------------------------------------------
312 :Parameters: address of a buffer in user space to store the data (u64) to;
315 :Returns:   -EFAULT if the given address is not accessible from kernel space;