HV: rename the term of vm0 to sos vm

Under sharing mode, VM0 is identical with SOS VM. But the coupling of
SOS VM and VM 0 is not friendly for partition mode.

This patch is a pure term change of vm0 to sos VM, it does not change
any code logic or senmantic.

Tracked-On: #2291

Signed-off-by: Victor Sun <victor.sun@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>

Author: jsun26intel

devicemodel/include/public/vhm_ioctl_defs.h

@@ -123,7 +123,7 @@
 struct vm_memmap {
 	/** memory mapping type */
 	uint32_t type;
-	/** using vma_base to get vm0_gpa,
+	/** using vma_base to get sos_vm_gpa,
 	 * only for type == VM_MEMMAP_SYSMEM
 	 */
 	uint32_t using_vma;

doc/developer-guides/hld/hv-memmgt.rst

@@ -439,7 +439,7 @@ Address Space Translation
 .. doxygenfunction:: gpa2hpa
    :project: Project ACRN
 
-.. doxygenfunction:: vm0_hpa2gpa
+.. doxygenfunction:: sos_vm_hpa2gpa
    :project: Project ACRN
 
 EPT

doc/developer-guides/hld/hv-vt-d.rst

@@ -306,7 +306,7 @@ deinitialization:
 .. doxygenfunction:: init_iommu
    :project: Project ACRN
 
-.. doxygenfunction:: init_iommu_vm0_domain
+.. doxygenfunction:: init_iommu_sos_vm_domain
    :project: Project ACRN
 
 runtime

hypervisor/arch/x86/Kconfig

@@ -279,11 +279,11 @@ config PLATFORM_RAM_SIZE
 	  (MMIO not included).
 
 config SOS_RAM_SIZE
-	hex "Size of the vm0 (SOS) RAM"
+	hex "Size of the Service OS (SOS) RAM"
 	default 0x200000000 if PLATFORM_SBL
 	default 0x400000000 if PLATFORM_UEFI
 	help
-	  A 64-bit integer indicating the size of the vm0 (SOS) RAM (MMIO not
+	  A 64-bit integer indicating the size of the Service OS RAM (MMIO not
 	  included).
 
  config UOS_RAM_SIZE

hypervisor/arch/x86/assign.c

@@ -182,7 +182,7 @@ ptirq_build_physical_rte(struct acrn_vm *vm, struct ptirq_remapping_info *entry)
 
 /* add msix entry for a vm, based on msi id (phys_bdf+msix_index)
  * - if the entry not be added by any vm, allocate it
- * - if the entry already be added by vm0, then change the owner to current vm
+ * - if the entry already be added by sos_vm, then change the owner to current vm
  * - if the entry already be added by other vm, return NULL
  */
 static struct ptirq_remapping_info *add_msix_remapping(struct acrn_vm *vm,
@@ -209,7 +209,7 @@ static struct ptirq_remapping_info *add_msix_remapping(struct acrn_vm *vm,
 			}
 		}
 	} else if (entry->vm != vm) {
-		if (is_vm0(entry->vm)) {
+		if (is_sos_vm(entry->vm)) {
 			entry->vm = vm;
 			entry->virt_sid.msi_id.bdf = virt_bdf;
 		} else {
@@ -257,7 +257,7 @@ remove_msix_remapping(const struct acrn_vm *vm, uint16_t virt_bdf, uint32_t entr
 
 /* add intx entry for a vm, based on intx id (phys_pin)
  * - if the entry not be added by any vm, allocate it
- * - if the entry already be added by vm0, then change the owner to current vm
+ * - if the entry already be added by sos_vm, then change the owner to current vm
  * - if the entry already be added by other vm, return NULL
  */
 static struct ptirq_remapping_info *add_intx_remapping(struct acrn_vm *vm, uint32_t virt_pin,
@@ -292,7 +292,7 @@ static struct ptirq_remapping_info *add_intx_remapping(struct acrn_vm *vm, uint3
 				pr_err("INTX re-add vpin %d", virt_pin);
 			}
 		} else if (entry->vm != vm) {
-			if (is_vm0(entry->vm)) {
+			if (is_sos_vm(entry->vm)) {
 				entry->vm = vm;
 				entry->virt_sid.value = virt_sid.value;
 			} else {
@@ -511,14 +511,14 @@ int32_t ptirq_msix_remap(struct acrn_vm *vm, uint16_t virt_bdf,
 	 * Device Model should pre-hold the mapping entries by calling
 	 * ptirq_add_msix_remapping for UOS.
 	 *
-	 * For SOS(vm0), it adds the mapping entries at runtime, if the
+	 * For SOS(sos_vm), it adds the mapping entries at runtime, if the
 	 * entry already be held by others, return error.
 	 */
 	spinlock_obtain(&ptdev_lock);
 	entry = ptirq_lookup_entry_by_sid(PTDEV_INTR_MSI, &virt_sid, vm);
 	if (entry == NULL) {
-		/* VM0 we add mapping dynamically */
-		if (is_vm0(vm)) {
+		/* SOS_VM we add mapping dynamically */
+		if (is_sos_vm(vm)) {
 			entry = add_msix_remapping(vm, virt_bdf, virt_bdf, entry_nr);
 			if (entry == NULL) {
 				pr_err("dev-assign: msi entry exist in others");
@@ -599,12 +599,12 @@ int32_t ptirq_intx_pin_remap(struct acrn_vm *vm, uint32_t virt_pin, uint32_t vpi
 	 * Device Model should pre-hold the mapping entries by calling
 	 * ptirq_add_intx_remapping for UOS.
 	 *
-	 * For SOS(vm0), it adds the mapping entries at runtime, if the
+	 * For SOS(sos_vm), it adds the mapping entries at runtime, if the
 	 * entry already be held by others, return error.
 	 */
 
 	/* no remap for hypervisor owned intx */
-	if (is_vm0(vm) && hv_used_dbg_intx(virt_sid.intx_id.pin)) {
+	if (is_sos_vm(vm) && hv_used_dbg_intx(virt_sid.intx_id.pin)) {
 		status = -ENODEV;
 	}
 
@@ -615,9 +615,9 @@ int32_t ptirq_intx_pin_remap(struct acrn_vm *vm, uint32_t virt_pin, uint32_t vpi
 		spinlock_obtain(&ptdev_lock);
 		entry = ptirq_lookup_entry_by_vpin(vm, virt_pin, pic_pin);
 		if (entry == NULL) {
-			if (is_vm0(vm)) {
+			if (is_sos_vm(vm)) {
 
-				/* for vm0, there is chance of vpin source switch
+				/* for sos_vm, there is chance of vpin source switch
 				 * between vPIC & vIOAPIC for one legacy phys_pin.
 				 *
 				 * here checks if there is already mapping entry from
@@ -680,7 +680,7 @@ int32_t ptirq_intx_pin_remap(struct acrn_vm *vm, uint32_t virt_pin, uint32_t vpi
 }
 
 /* @pre vm != NULL
- * except vm0, Device Model should call this function to pre-hold ptdev intx
+ * except sos_vm, Device Model should call this function to pre-hold ptdev intx
  * entries:
  * - the entry is identified by phys_pin:
  *   one entry vs. one phys_pin
@@ -708,7 +708,7 @@ void ptirq_remove_intx_remapping(struct acrn_vm *vm, uint32_t virt_pin, bool pic
 	spinlock_release(&ptdev_lock);
 }
 
-/* except vm0, Device Model should call this function to pre-hold ptdev msi
+/* except sos_vm, Device Model should call this function to pre-hold ptdev msi
  * entries:
  * - the entry is identified by phys_bdf:msi_idx:
  *   one entry vs. one phys_bdf:msi_idx

hypervisor/arch/x86/e820.c

@@ -11,7 +11,7 @@
 
 /*
  * e820.c contains the related e820 operations; like HV to get memory info for its MMU setup;
- * and hide HV memory from VM0...
+ * and hide HV memory from SOS_VM...
  */
 
 static uint32_t e820_entries_count;
@@ -51,8 +51,8 @@ static void obtain_e820_mem_info(void)
 	}
 }
 
-/* before boot vm0(service OS), call it to hide the HV RAM entry in e820 table from vm0 */
-void rebuild_vm0_e820(void)
+/* before boot sos_vm(service OS), call it to hide the HV RAM entry in e820 table from sos_vm */
+void rebuild_sos_vm_e820(void)
 {
 	uint32_t i;
 	uint64_t entry_start;
@@ -116,7 +116,7 @@ void rebuild_vm0_e820(void)
 	e820_mem.total_mem_size -= CONFIG_HV_RAM_SIZE;
 }
 
-/* get some RAM below 1MB in e820 entries, hide it from vm0, return its start address */
+/* get some RAM below 1MB in e820 entries, hide it from sos_vm, return its start address */
 uint64_t e820_alloc_low_memory(uint32_t size_arg)
 {
 	uint32_t i;

hypervisor/arch/x86/ept.c

@@ -67,7 +67,7 @@ uint64_t gpa2hpa(struct acrn_vm *vm, uint64_t gpa)
 /**
  * @pre: the gpa and hpa are identical mapping in SOS.
  */
-uint64_t vm0_hpa2gpa(uint64_t hpa)
+uint64_t sos_vm_hpa2gpa(uint64_t hpa)
 {
 	return hpa;
 }

hypervisor/arch/x86/guest/guest.c

@@ -448,9 +448,9 @@ int32_t copy_to_gva(struct acrn_vcpu *vcpu, void *h_ptr, uint64_t gva,
  * @retval 0 on success
  *
  * @pre vm != NULL
- * @pre is_vm0(vm) == true
+ * @pre is_sos_vm(vm) == true
  */
-void prepare_vm0_memmap(struct acrn_vm *vm)
+void prepare_sos_vm_memmap(struct acrn_vm *vm)
 {
 	uint32_t i;
 	uint64_t attr_uc = (EPT_RWX | EPT_UNCACHED);
@@ -462,11 +462,11 @@ void prepare_vm0_memmap(struct acrn_vm *vm)
 	const struct e820_entry *p_e820 = get_e820_entry();
 	const struct e820_mem_params *p_e820_mem_info = get_e820_mem_info();
 
-	dev_dbg(ACRN_DBG_GUEST, "vm0: bottom memory - 0x%llx, top memory - 0x%llx\n",
+	dev_dbg(ACRN_DBG_GUEST, "sos_vm: bottom memory - 0x%llx, top memory - 0x%llx\n",
 		p_e820_mem_info->mem_bottom, p_e820_mem_info->mem_top);
 
 	if (p_e820_mem_info->mem_top > EPT_ADDRESS_SPACE(CONFIG_SOS_RAM_SIZE)) {
-		panic("Please configure VM0_ADDRESS_SPACE correctly!\n");
+		panic("Please configure SOS_VM_ADDRESS_SPACE correctly!\n");
 	}
 
 	/* create real ept map for all ranges with UC */
@@ -481,7 +481,7 @@ void prepare_vm0_memmap(struct acrn_vm *vm)
 		}
 	}
 
-	dev_dbg(ACRN_DBG_GUEST, "VM0 e820 layout:\n");
+	dev_dbg(ACRN_DBG_GUEST, "SOS_VM e820 layout:\n");
 	for (i = 0U; i < entries_count; i++) {
 		entry = p_e820 + i;
 		dev_dbg(ACRN_DBG_GUEST, "e820 table: %d type: 0x%x", i, entry->type);

hypervisor/arch/x86/guest/pm.c

@@ -10,7 +10,7 @@ int32_t validate_pstate(const struct acrn_vm *vm, uint64_t perf_ctl)
 {
 	int32_t ret = -1;
 
-	if (is_vm0(vm)) {
+	if (is_sos_vm(vm)) {
 		ret = 0;
 	} else {
 		uint8_t i;
@@ -132,7 +132,7 @@ static inline void enter_s3(struct acrn_vm *vm, uint32_t pm1a_cnt_val, uint32_t
 	guest_wakeup_vec32 = *(vm->pm.sx_state_data->wake_vector_32);
 	clac();
 
-	pause_vm(vm);	/* pause vm0 before suspend system */
+	pause_vm(vm);	/* pause sos_vm before suspend system */
 	host_enter_s3(vm->pm.sx_state_data, pm1a_cnt_val, pm1b_cnt_val);
 	resume_vm_from_s3(vm, guest_wakeup_vec32);	/* jump back to vm */
 }

hypervisor/arch/x86/guest/vcpu.c

@@ -308,7 +308,7 @@ void set_ap_entry(struct acrn_vcpu *vcpu, uint64_t entry)
  * vcpu_id/pcpu_id mapping table:
  *
  * if
- *     VM0_CPUS[2] = {0, 2} , VM1_CPUS[2] = {3, 1};
+ *     SOS_VM_CPUS[2] = {0, 2} , VM1_CPUS[2] = {3, 1};
  * then
  *     for physical CPU 0 : vcpu->pcpu_id = 0, vcpu->vcpu_id = 0, vmid = 0;
  *     for physical CPU 2 : vcpu->pcpu_id = 2, vcpu->vcpu_id = 1, vmid = 0;