#include <Hypervisor/hv_vm_config.h> also included by
<Hypervisor/Hypervisor.h>hv_vm_config.h
functionhv_vm_config_create
API_AVAILABLE(macos(13.0)) OS_EXPORT OS_OBJECT_RETURNS_RETAINED OS_WARN_RESULT hv_vm_config_t hv_vm_config_create( void )
@abstract Creates a virtual machine configuration object.
@result A new virtual machine configuration object. This should be released with os_release
when no longer used.
functionhv_vm_config_get_max_ipa_size
OS_EXPORT API_AVAILABLE(macos(13.0)) hv_return_t hv_vm_config_get_max_ipa_size( uint32_t *ipa_bit_length )
@abstract Return the maximum intermediate physical address bit length.
@param ipa_bit_length Pointer to bit length (written on success)
@result HV_SUCCESS on success, an error code otherwise.
@discussion The bit length is the number of valid bits from an intermediate physical address (IPA).
For example, max IPA bit length of 36 means only the least significant 36 bits
of an IPA are valid, and covers a 64GB range.
functionhv_vm_config_get_default_ipa_size
OS_EXPORT API_AVAILABLE(macos(13.0)) hv_return_t hv_vm_config_get_default_ipa_size( uint32_t *ipa_bit_length )
@abstract Return the default intermediate physical address bit length.
@param ipa_bit_length Pointer to bit length (written on success)
@result HV_SUCCESS on success, an error code otherwise.
@discussion This default IPA size is used if the IPA size is not set explicitly.
functionhv_vm_config_set_ipa_size
OS_EXPORT API_AVAILABLE(macos(13.0)) hv_return_t hv_vm_config_set_ipa_size( hv_vm_config_t config, uint32_t ipa_bit_length )
@abstract Set intermediate physical address bit length in virtual machine configuration.
@param config Configuration.
@param ipa_bit_length intermediate physical address bit length.
@result HV_SUCCESS on success, an error code otherwise.
@discussion VM IPA size should be no greater than the max IPA size from hv_vm_config_get_max_ipa_size().
@see hv_vm_config_get_max_ipa_size
functionhv_vm_config_get_ipa_size
OS_EXPORT API_AVAILABLE(macos(13.0)) hv_return_t hv_vm_config_get_ipa_size( hv_vm_config_t config, uint32_t *ipa_bit_length )
@abstract Return intermediate physical address bit length in configuration.
@param config Configuration.
@param ipa_bit_length Pointer to bit length (written on success)
@result HV_SUCCESS on success, an error code otherwise.
functionhv_vm_config_get_el2_supported
OS_EXPORT API_AVAILABLE(macos(15.0)) hv_return_t hv_vm_config_get_el2_supported( bool *el2_supported )
@abstract Return whether or not EL2 is supported on the current platform.
@param el2_supported Pointer to whether or not EL2 is supported (written on success).
@result HV_SUCCESS on success, an error code otherwise.
functionhv_vm_config_get_el2_enabled
OS_EXPORT API_AVAILABLE(macos(15.0)) hv_return_t hv_vm_config_get_el2_enabled( hv_vm_config_t config, bool *el2_enabled )
@abstract Return whether or not EL2 is enabled for a VM configuration.
@param config Configuration.
@param el2_enabled Pointer to whether or not EL2 is enabled (written on success).
@result HV_SUCCESS on success, an error code otherwise.
functionhv_vm_config_set_el2_enabled
OS_EXPORT API_AVAILABLE(macos(15.0)) hv_return_t hv_vm_config_set_el2_enabled( hv_vm_config_t config, bool el2_enabled )
@abstract Set whether or not EL2 is enabled for a VM configuration.
@param config Configuration.
@param el2_enabled Whether or not to enable EL2.
@result HV_SUCCESS on success, an error code otherwise.
@discussion The EL2 enabled status determines how guest accesses to PMU (Performance Monitor Unit)
registers are handled.
When EL2 is disabled, PMU register accesses trigger "Trapped MSR, MRS, or System Instruction"
exceptions. When this happens, `hv_vcpu_run()` returns, and the `hv_vcpu_exit_t` object
contains the information about this exception.
When EL2 is enabled, the handling of PMU register accesses is determined by the `PMUVer`
field of `ID_AA64DFR0_EL1` register.
If the `PMUVer` field value is zero or is invalid, PMU register accesses generate "Undefined"
exceptions, which are sent to the guest.
If the `PMUVer` field value is non-zero and valid, PMU register accesses are emulated by the
framework.
The `ID_AA64DFR0_EL1` register can be modified via `hv_vcpu_set_sys_reg` API.
@see hv_vcpu_set_sys_reg
enumhv_ipa_granule_t
| HV_IPA_GRANULE_4KB | 0 | |
| HV_IPA_GRANULE_16KB | 1 |
typedefhv_ipa_granule_t
typedef enum hv_ipa_granule_t hv_ipa_granule_t;
functionhv_vm_config_get_default_ipa_granule
OS_EXPORT API_AVAILABLE(macos(26.0)) hv_return_t hv_vm_config_get_default_ipa_granule( hv_ipa_granule_t *granule )
@abstract Return the default intermediate physical address granule.
@param granule Pointer to the default intermediate physical address granule size (written on success).
@result HV_SUCCESS on success, an error code otherwise.
functionhv_vm_config_get_ipa_granule
OS_EXPORT API_AVAILABLE(macos(26.0)) hv_return_t hv_vm_config_get_ipa_granule( hv_vm_config_t config, hv_ipa_granule_t *granule )
@abstract Return the intermediate physical address granule size in virtual machine configuration.
@param config Configuration.
@param granule Pointer to the currently configured granule size (written on success).
@result HV_SUCCESS on success, an error code otherwise.
functionhv_vm_config_set_ipa_granule
OS_EXPORT API_AVAILABLE(macos(26.0)) hv_return_t hv_vm_config_set_ipa_granule( hv_vm_config_t config, hv_ipa_granule_t granule )
@abstract Set the intermediate physical address granule size in virtual machine configuration.
@param config Configuration.
@param granule Granule size.
@result HV_SUCCESS on success, an error code otherwise.