hv: remove UUID

With current arch design the UUID is used to identify ACRN VMs,
all VM configurations must be deployed with given UUIDs at build time.
For post-launched VMs, end user must use UUID as acrn-dm parameter
to launch specified user VM. This is not friendly for end users
that they have to look up the pre-configured UUID before launching VM,
and then can only launch the VM which its UUID in the pre-configured UUID
list,otherwise the launch will fail.Another side, VM name is much straight
forward for end user to identify VMs, whereas the VM name defined
in launch script has not been passed to hypervisor VM configuration
so it is not consistent with the VM name when user list VM
in hypervisor shell, this would confuse user a lot.

This patch will resolve these issues by removing UUID as VM identifier
and use VM name instead:
1. Hypervisor will check the VM name duplication during VM creation time
   to make sure the VM name is unique.
2. If the VM name passed from acrn-dm matches one of pre-configured
   VM configurations, the corresponding VM will be launched,
   we call it static configured VM.
   If there is no matching found, hypervisor will try to allocate one
   unused VM configuration slot for this VM with given VM name and get it
   run if VM number does not reach CONFIG_MAX_VM_NUM,
   we will call it dynamic configured VM.
3. For dynamic configured VMs, we need a guest flag to identify them
   because the VM configuration need to be destroyed
   when it is shutdown or creation failed.

v7->v8:
    -- rename is_static_vm_configured to is_static_configured_vm
    -- only set DM owned guest_flags in hcall_create_vm
    -- add check dynamic flag in get_unused_vmid

v6->v7:
    -- refine get_vmid_by_name, return the first matching vm_id
    -- the GUEST_FLAG_STATIC_VM is added to identify the static or
       dynamic VM, the offline tool will set this flag for
       all the pre-defined VMs.
    -- only clear name field for dynamic VM instead of clear entire
       vm_config

Tracked-On: #6685
Signed-off-by: Mingqiang Chi <mingqiang.chi@intel.com>
Reviewed-by: Zhao Yakui <yakui.zhao@intel.com>
Reviewed-by: Victor Sun<victor.sun@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>

Author: mingqiangchi

hypervisor/arch/x86/configs/vm_config.c

@@ -6,6 +6,7 @@
 
 #include <asm/vm_config.h>
 #include <util.h>
+#include <rtl.h>
 
 /*
  * @pre vm_id < CONFIG_MAX_VM_NUM
@@ -25,13 +26,13 @@ uint8_t get_vm_severity(uint16_t vm_id)
 }
 
 /**
- * return true if the input uuid is configured in VM
+ * return true if the input vm-name is configured in VM
  *
  * @pre vmid < CONFIG_MAX_VM_NUM
  */
-bool vm_has_matched_uuid(uint16_t vmid, const uint8_t *uuid)
+bool vm_has_matched_name(uint16_t vmid, const char *name)
 {
 	struct acrn_vm_config *vm_config = get_vm_config(vmid);
 
-	return (uuid_is_equal(vm_config->uuid, uuid));
+	return (strncmp(vm_config->name, name, MAX_VM_NAME_LEN) == 0);
 }

hypervisor/arch/x86/guest/trusty.c

@@ -279,7 +279,7 @@ static bool setup_trusty_info(struct acrn_vcpu *vcpu, uint32_t mem_size, uint64_
 	/* Derive dvseed from dseed for Trusty */
 	if (derive_virtual_seed(&key_info.dseed_list[0U], &key_info.num_seeds,
 				  NULL, 0U,
-				  vcpu->vm->uuid, sizeof(vcpu->vm->uuid))) {
+				  (uint8_t *)vcpu->vm->name, strnlen_s(vcpu->vm->name, MAX_VM_NAME_LEN))) {
 		/* Derive encryption key of attestation keybox from dseed */
 		if (derive_attkb_enc_key(key_info.attkb_enc_key)) {
 			/* Prepare trusty startup param */

hypervisor/arch/x86/guest/vm.c

@@ -58,17 +58,30 @@ void *get_sworld_memory_base(void)
 	return post_user_vm_sworld_memory;
 }
 
-uint16_t get_vmid_by_uuid(const uint8_t *uuid)
+uint16_t get_unused_vmid(void)
 {
-	uint16_t vm_id = 0U;
+	uint16_t vm_id;
+	struct acrn_vm_config *vm_config;
+
+	for (vm_id = 0; vm_id < CONFIG_MAX_VM_NUM; vm_id++) {
+		vm_config = get_vm_config(vm_id);
+		if ((vm_config->name[0] == '\0') && ((vm_config->guest_flags & GUEST_FLAG_STATIC_VM) == 0U)) {
+			break;
+		}
+	}
+	return (vm_id < CONFIG_MAX_VM_NUM) ? (vm_id) : (ACRN_INVALID_VMID);
+}
+
+uint16_t get_vmid_by_name(const char *name)
+{
+	uint16_t vm_id;
 
-	while (!vm_has_matched_uuid(vm_id, uuid)) {
-		vm_id++;
-		if (vm_id == CONFIG_MAX_VM_NUM) {
+	for (vm_id = 0U; vm_id < CONFIG_MAX_VM_NUM; vm_id++) {
+		if ((*name != '\0') && vm_has_matched_name(vm_id, name)) {
 			break;
 		}
 	}
-	return vm_id;
+	return (vm_id < CONFIG_MAX_VM_NUM) ? (vm_id) : (ACRN_INVALID_VMID);
 }
 
 /**
@@ -162,6 +175,16 @@ bool is_vcat_configured(const struct acrn_vm *vm)
 	return ((vm_config->guest_flags & GUEST_FLAG_VCAT_ENABLED) != 0U);
 }
 
+/**
+ * @pre vm != NULL && vm_config != NULL && vm->vmid < CONFIG_MAX_VM_NUM
+ */
+bool is_static_configured_vm(const struct acrn_vm *vm)
+{
+	struct acrn_vm_config *vm_config = get_vm_config(vm->vm_id);
+
+	return ((vm_config->guest_flags & GUEST_FLAG_STATIC_VM) != 0U);
+}
+
 /**
  * @brief VT-d PI posted mode can possibly be used for PTDEVs assigned
  * to this VM if platform supports VT-d PI AND lapic passthru is not configured
@@ -546,8 +569,7 @@ int32_t create_vm(uint16_t vm_id, uint64_t pcpu_bitmap, struct acrn_vm_config *v
 	init_ept_pgtable(&vm->arch_vm.ept_pgtable, vm->vm_id);
 	vm->arch_vm.nworld_eptp = pgtable_create_root(&vm->arch_vm.ept_pgtable);
 
-	(void)memcpy_s(&vm->uuid[0], sizeof(vm->uuid),
-		&vm_config->uuid[0], sizeof(vm_config->uuid));
+	(void)memcpy_s(&vm->name[0], MAX_VM_NAME_LEN, &vm_config->name[0], MAX_VM_NAME_LEN);
 
 	if (is_service_vm(vm)) {
 		/* Only for Service VM */
@@ -792,6 +814,9 @@ int32_t shutdown_vm(struct acrn_vm *vm)
 	/* after guest_flags not used, then clear it */
 	vm_config = get_vm_config(vm->vm_id);
 	vm_config->guest_flags &= ~DM_OWNED_GUEST_FLAG_MASK;
+	if (!is_static_configured_vm(vm)) {
+		memset(vm_config->name, 0U, MAX_VM_NAME_LEN);
+	}
 
 	if (is_ready_for_system_shutdown()) {
 		/* If no any guest running, shutdown system */
@@ -932,8 +957,13 @@ void prepare_vm(uint16_t vm_id, struct acrn_vm_config *vm_config)
 #ifdef CONFIG_SECURITY_VM_FIXUP
 	security_vm_fixup(vm_id);
 #endif
-	/* Service VM and pre-launched VMs launch on all pCPUs defined in vm_config->cpu_affinity */
-	err = create_vm(vm_id, vm_config->cpu_affinity, vm_config, &vm);
+	if (get_vmid_by_name(vm_config->name) != vm_id) {
+		pr_err("Invalid VM name: %s", vm_config->name);
+		err = -1;
+	} else {
+		/* Service VM and pre-launched VMs launch on all pCPUs defined in vm_config->cpu_affinity */
+		err = create_vm(vm_id, vm_config->cpu_affinity, vm_config, &vm);
+	}
 
 	if (err == 0) {
 		if (is_prelaunched_vm(vm)) {

hypervisor/arch/x86/guest/vmcall.c

@@ -15,6 +15,7 @@
 #include <trace.h>
 #include <logmsg.h>
 
+static spinlock_t vm_id_lock = { .head = 0U, .tail = 0U };
 struct hc_dispatch {
 	int32_t (*handler)(struct acrn_vcpu *vcpu, struct acrn_vm *target_vm, uint64_t param1, uint64_t param2);
 
@@ -105,6 +106,22 @@ static const struct hc_dispatch hc_dispatch_table[] = {
 		.permission_flags = GUEST_FLAG_SECURE_WORLD_ENABLED},
 };
 
+uint16_t allocate_dynamical_vmid(struct acrn_vm_creation *cv)
+{
+	uint16_t vm_id;
+	struct acrn_vm_config *vm_config;
+
+	spinlock_obtain(&vm_id_lock);
+	vm_id = get_unused_vmid();
+	if (vm_id != ACRN_INVALID_VMID) {
+		vm_config = get_vm_config(vm_id);
+		memcpy_s(vm_config->name, MAX_VM_NAME_LEN, cv->name, MAX_VM_NAME_LEN);
+		vm_config->cpu_affinity = cv->cpu_affinity;
+	}
+	spinlock_release(&vm_id_lock);
+	return vm_id;
+}
+
 #define GUEST_FLAGS_ALLOWING_HYPERCALLS GUEST_FLAG_SECURE_WORLD_ENABLED
 
 struct acrn_vm *parse_target_vm(struct acrn_vm *service_vm, uint64_t hcall_id, uint64_t param1, __unused uint64_t param2)
@@ -118,7 +135,19 @@ struct acrn_vm *parse_target_vm(struct acrn_vm *service_vm, uint64_t hcall_id, u
 	switch (hcall_id) {
 	case HC_CREATE_VM:
 		if (copy_from_gpa(service_vm, &cv, param1, sizeof(cv)) == 0) {
-			vm_id = get_vmid_by_uuid(&cv.uuid[0]);
+			vm_id = get_vmid_by_name((char *)cv.name);
+			/* if the vm-name is not found, it indicates that it is not in pre-defined vm_list.
+			 * So try to allocate one free slot to start one vm based on user-requirement
+			 */
+			if (vm_id == ACRN_INVALID_VMID) {
+				vm_id = allocate_dynamical_vmid(&cv);
+				/* it doesn't find the available vm_slot for the given vm_name.
+				 * Maybe the CONFIG_MAX_VM_NUM is too small to start the VM.
+				 */
+				if (vm_id == ACRN_INVALID_VMID) {
+					pr_err("The VM name provided (%s) is invalid, cannot create VM", cv.name);
+				}
+			}
 		}
 		break;
 

hypervisor/common/hypercall.c

@@ -254,14 +254,13 @@ int32_t hcall_create_vm(struct acrn_vcpu *vcpu, struct acrn_vm *target_vm, uint6
 	int32_t ret = -1;
 	struct acrn_vm *tgt_vm = NULL;
 	struct acrn_vm_creation cv;
-	struct acrn_vm_config* vm_config = NULL;
+	struct acrn_vm_config *vm_config = get_vm_config(vmid);
 
 	if (copy_from_gpa(vm, &cv, param1, sizeof(cv)) == 0) {
 		if (is_poweroff_vm(get_vm_from_vmid(vmid))) {
 
-			vm_config = get_vm_config(vmid);
-
 			/* Filter out the bits should not set by DM and then assign it to guest_flags */
+			vm_config->guest_flags &= ~DM_OWNED_GUEST_FLAG_MASK;
 			vm_config->guest_flags |= (cv.vm_flag & DM_OWNED_GUEST_FLAG_MASK);
 
 			/* post-launched VM is allowed to choose pCPUs from vm_config->cpu_affinity only */
@@ -301,6 +300,10 @@ int32_t hcall_create_vm(struct acrn_vcpu *vcpu, struct acrn_vm *target_vm, uint6
 
 	}
 
+	if (((ret != 0) || (cv.vmid == ACRN_INVALID_VMID)) && (!is_static_configured_vm(target_vm))) {
+		memset(vm_config->name, 0U, MAX_VM_NAME_LEN);
+	}
+
 	return ret;
 }
 

hypervisor/debug/profiling.c

@@ -875,8 +875,6 @@ int32_t profiling_vm_list_info(struct acrn_vm *vm, uint64_t addr)
 		vm_idx++;
 
 		vm_info_list.vm_list[vm_idx].vm_id_num = tmp_vm->vm_id;
-		(void)memcpy_s((void *)vm_info_list.vm_list[vm_idx].uuid,
-			16U, tmp_vm->uuid, 16U);
 		snprintf(vm_info_list.vm_list[vm_idx].vm_name, 16U, "vm_%d",
 				tmp_vm->vm_id, 16U);
 		vm_info_list.vm_list[vm_idx].num_vcpus = 0;

hypervisor/debug/shell.c

@@ -590,8 +590,8 @@ static int32_t shell_list_vm(__unused int32_t argc, __unused char **argv)
 	uint16_t vm_id;
 	char state[32];
 
-	shell_puts("\r\nVM_UUID                          VM_ID VM_NAME                          VM_STATE"
-		   "\r\n================================ ===== ================================ ========\r\n");
+	shell_puts("\r\nVM_ID VM_NAME                          VM_STATE"
+		   "\r\n===== ================================ ========\r\n");
 
 	for (vm_id = 0U; vm_id < CONFIG_MAX_VM_NUM; vm_id++) {
 		vm = get_vm_from_vmid(vm_id);
@@ -614,12 +614,7 @@ static int32_t shell_list_vm(__unused int32_t argc, __unused char **argv)
 		}
 		vm_config = get_vm_config(vm_id);
 		if (!is_poweroff_vm(vm)) {
-			int8_t i;
-
-			for (i = 0; i < 16; i++) {
-				snprintf(temp_str + 2 * i, 3U, "%02x", vm->uuid[i]);
-			}
-			snprintf(temp_str + 32, MAX_STR_SIZE - 32U, "   %-3d %-32s %-8s\r\n",
+			snprintf(temp_str, MAX_STR_SIZE, "  %-3d %-32s %-8s\r\n",
 				vm_id, vm_config->name, state);
 
 			/* Output information for this task */

hypervisor/include/arch/x86/asm/guest/vm.h

@@ -156,7 +156,7 @@ struct acrn_vm {
 
 	struct vm_io_handler_desc emul_pio[EMUL_PIO_IDX_MAX];
 
-	uint8_t uuid[16];
+	char name[MAX_VM_NAME_LEN];
 	struct secure_world_control sworld_control;
 
 	/* Secure World's snapshot
@@ -241,7 +241,7 @@ bool is_paused_vm(const struct acrn_vm *vm);
 bool is_service_vm(const struct acrn_vm *vm);
 bool is_postlaunched_vm(const struct acrn_vm *vm);
 bool is_prelaunched_vm(const struct acrn_vm *vm);
-uint16_t get_vmid_by_uuid(const uint8_t *uuid);
+uint16_t get_vmid_by_name(const char *name);
 struct acrn_vm *get_vm_from_vmid(uint16_t vm_id);
 struct acrn_vm *get_service_vm(void);
 
@@ -257,6 +257,8 @@ bool is_lapic_pt_configured(const struct acrn_vm *vm);
 bool is_rt_vm(const struct acrn_vm *vm);
 bool is_nvmx_configured(const struct acrn_vm *vm);
 bool is_vcat_configured(const struct acrn_vm *vm);
+bool is_static_configured_vm(const struct acrn_vm *vm);
+uint16_t get_unused_vmid(void);
 bool is_pi_capable(const struct acrn_vm *vm);
 bool has_rt_vm(void);
 struct acrn_vm *get_highest_severity_vm(bool runtime);

hypervisor/include/arch/x86/asm/vm_config.h

@@ -12,13 +12,10 @@
 #include <board_info.h>
 #include <boot.h>
 #include <acrn_common.h>
-#include <vm_uuids.h>
 #include <vm_configurations.h>
 #include <asm/sgx.h>
 #include <acrn_hv_defs.h>
 
-#define CONFIG_MAX_VM_NUM	(PRE_VM_NUM + SERVICE_VM_NUM + MAX_POST_VM_NUM)
-
 #define AFFINITY_CPU(n)		(1UL << (n))
 #define MAX_VCPUS_PER_VM	MAX_PCPU_NUM
 #define MAX_VUART_NUM_PER_VM	8U
@@ -38,31 +35,24 @@
 #define MAX_MMIO_DEV_NUM	2U
 
 #define CONFIG_SERVICE_VM	.load_order = SERVICE_VM,	\
-				.uuid = SERVICE_VM_UUID,	\
 				.severity = SEVERITY_SERVICE_VM
 
-#define CONFIG_SAFETY_VM(idx)	.load_order = PRE_LAUNCHED_VM,	\
-				.uuid = SAFETY_VM_UUID##idx,	\
+#define CONFIG_SAFETY_VM	.load_order = PRE_LAUNCHED_VM,	\
 				.severity = SEVERITY_SAFETY_VM
 
-#define CONFIG_PRE_STD_VM(idx)	.load_order = PRE_LAUNCHED_VM,	\
-				.uuid = PRE_STANDARD_VM_UUID##idx,	\
+#define CONFIG_PRE_STD_VM	.load_order = PRE_LAUNCHED_VM,	\
 				.severity = SEVERITY_STANDARD_VM
 
-#define CONFIG_PRE_RT_VM(idx)	.load_order = PRE_LAUNCHED_VM,	\
-				.uuid = PRE_RTVM_UUID##idx,	\
+#define CONFIG_PRE_RT_VM	.load_order = PRE_LAUNCHED_VM,	\
 				.severity = SEVERITY_RTVM
 
-#define CONFIG_POST_STD_VM(idx)	.load_order = POST_LAUNCHED_VM,	\
-				.uuid = POST_STANDARD_VM_UUID##idx,	\
+#define CONFIG_POST_STD_VM	.load_order = POST_LAUNCHED_VM,	\
 				.severity = SEVERITY_STANDARD_VM
 
-#define CONFIG_POST_RT_VM(idx)	.load_order = POST_LAUNCHED_VM,	\
-				.uuid = POST_RTVM_UUID##idx,	\
+#define CONFIG_POST_RT_VM	.load_order = POST_LAUNCHED_VM,	\
 				.severity = SEVERITY_RTVM
 
-#define CONFIG_KATA_VM(idx)	.load_order = POST_LAUNCHED_VM,	\
-				.uuid = KATA_VM_UUID##idx,	\
+#define CONFIG_KATA_VM	.load_order = POST_LAUNCHED_VM,	\
 				.severity = SEVERITY_STANDARD_VM
 
 /* ACRN guest severity */
@@ -154,8 +144,7 @@ struct pt_intx_config {
 
 struct acrn_vm_config {
 	enum acrn_vm_load_order load_order;		/* specify the load order of VM */
-	char name[MAX_VM_OS_NAME_LEN];			/* VM name identifier, useful for debug. */
-	const uint8_t uuid[16];				/* UUID of the VM */
+	char name[MAX_VM_NAME_LEN];				/* VM name identifier */
 	uint8_t reserved[2];				/* Temporarily reserve it so that don't need to update
 							 * the users of get_platform_info frequently.
 							 */
@@ -214,7 +203,7 @@ struct acrn_vm_config {
 
 struct acrn_vm_config *get_vm_config(uint16_t vm_id);
 uint8_t get_vm_severity(uint16_t vm_id);
-bool vm_has_matched_uuid(uint16_t vmid, const uint8_t *uuid);
+bool vm_has_matched_name(uint16_t vmid, const char *name);
 
 extern struct acrn_vm_config vm_configs[CONFIG_MAX_VM_NUM];