github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-07-06 12:06:25 +00:00
Code Issues Projects Releases Wiki Activity

DOC: add main vcpu API & data structure into HLD.

Browse Source 
add main vcpu API and data structure for doc auto-generated
info into HLD.

Tracked-On: #1595
Signed-off-by: Minggui Cao <minggui.cao@intel.com>
This commit is contained in:
Minggui Cao 2018-10-31 14:19:00 +08:00 committed by David Kinder
parent c885011457
commit bf88e24168
2 changed files with 53 additions and 145 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/acrn.doxyfile
View File

@ -798,10 +798,10 @@ INPUT = custom-doxygen/mainpage.md \
../hypervisor/include/common/hypercall.h \ ../hypervisor/include/common/hypercall.h \
../hypervisor/include/public/acrn_common.h \ ../hypervisor/include/public/acrn_common.h \
../hypervisor/include/public/acrn_hv_defs.h \ ../hypervisor/include/public/acrn_hv_defs.h \
../hypervisor/include/arch/x86/guest/vcpu.h \
../hypervisor/arch/x86/trusty.c \ ../hypervisor/arch/x86/trusty.c \
../devicemodel/include/virtio.h ../devicemodel/include/virtio.h
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv # libiconv (or the iconv built into libc) for the transcoding. See the libiconv

196
doc/developer-guides/hld/hv-cpu-virt.rst
View File

@ -125,14 +125,8 @@ The VHM will respond to the ioctl:
The hypercall ``HC_CREATE_VCPU`` is handled in the hypervisor with The hypercall ``HC_CREATE_VCPU`` is handled in the hypervisor with
the parameter: the parameter:
.. code-block:: c .. doxygenstruct:: acrn_create_vcpu
:project: Project ACRN
struct acrn_create_vcpu {
/** the virtual CPU ID for the VCPU created */
uint16_t vcpu_id;
/** the physical CPU ID for the VCPU created */
uint16_t pcpu_id;
} __attribute__((aligned(8)));
CPU assignment management in HV CPU assignment management in HV
=============================== ===============================
@ -187,43 +181,26 @@ the major states are:
ACRN vCPU state transitions ACRN vCPU state transitions
This table shows the functions which drive the state machine of the vCPU Following functions are used to drive the state machine of the vCPU
lifecycle: lifecycle:
.. list-table:: .. doxygenfunction:: create_vcpu
:widths: 20 80 :project: Project ACRN
:header-rows: 1
* - **Function** .. doxygenfunction:: schedule_vcpu
- **Description** :project: Project ACRN
* - create_vcpu .. doxygenfunction:: pause_vcpu
- Creates/allocates a vCPU instance, with initialization for its :project: Project ACRN
vcpu_id, vpid, vmcs, vlapic, etc. It sets the init vCPU state
to VCPU_INIT.
* - schedule_vcpu .. doxygenfunction:: resume_vcpu
- Adds a vCPU into the run queue and make a reschedule request for it. :project: Project ACRN
It sets the vCPU state to VCPU_RUNNING.
* - pause_vcpu .. doxygenfunction:: reset_vcpu
- Change a vCPU state to VCPU_PAUSED or VCPU_ZOMBIE, and make a :project: Project ACRN
reschedule request for it.
* - resume_vcpu .. doxygenfunction:: run_vcpu
- Change a vCPU state to VCPU_RUNNING, and make a reschedule request :project: Project ACRN
for it.
* - reset_vcpu
- Reset all fields in a vCPU instance, the vCPU state is reset to
VCPU_INIT.
* - destroy_vcpu
- Destroy/free a vCPU instance.
* - start/run_vcpu
- An interface in vCPU thread to implement VM entry and VM exit.
A CPU switches between VMX root mode and non-root mode based on it.
vCPU Scheduling vCPU Scheduling
@ -322,37 +299,8 @@ vCPU Run Context
During a vCPU switch between root and non-root mode, the run context of During a vCPU switch between root and non-root mode, the run context of
the vCPU is saved and restored using this structure: the vCPU is saved and restored using this structure:
.. code-block:: c .. doxygenstruct:: run_context
:project: Project ACRN
struct run_context {
/* Contains the guest register set.
* NOTE: This must be the first element in the structure, so that
* the offsets in vmx_asm.S match
*/
union {
struct cpu_gp_regs regs;
uint64_t longs[NUM_GPRS];
} guest_cpu_regs;
/* The guests CR registers 0, 2, 3 and 4. */
uint64_t cr0;
/* CPU_CONTEXT_OFFSET_CR2 =
* offsetof(struct run_context, cr2) = 136
*/
uint64_t cr2;
uint64_t cr4;
uint64_t rip;
uint64_t rflags;
/* CPU_CONTEXT_OFFSET_IA32_SPEC_CTRL =
* offsetof(struct run_context, ia32_spec_ctrl) = 168
*/
uint64_t ia32_spec_ctrl;
uint64_t ia32_efer;
};
The vCPU handles runtime context saving by three different The vCPU handles runtime context saving by three different
categories: categories:
@ -385,54 +333,53 @@ categories:
For the first two categories above, ACRN provides these get/set APIs: For the first two categories above, ACRN provides these get/set APIs:
.. list-table:: .. doxygenfunction:: vcpu_get_gpreg
:widths: 30 70 :project: Project ACRN
:header-rows: 1
* - **APIs** .. doxygenfunction:: vcpu_set_gpreg
- **Desc** :project: Project ACRN
* - vcpu_get_gpreg .. doxygenfunction:: vcpu_get_rip
- Get target vCPU's general purpose registers value in run_context :project: Project ACRN
* - vcpu_set_gpreg .. doxygenfunction:: vcpu_set_rip
- Set target vCPU's general purpose registers value in run_context :project: Project ACRN
* - vcpu_get_rip .. doxygenfunction:: vcpu_get_rsp
- Get & cache target vCPU's RIP in run_context :project: Project ACRN
* - vcpu_set_rip .. doxygenfunction:: vcpu_set_rsp
- Update target vCPU's RIP in run_context :project: Project ACRN
* - vcpu_get_rsp .. doxygenfunction:: vcpu_get_efer
- Get & cache target vCPU's RSP in run_context :project: Project ACRN
* - vcpu_set_rsp .. doxygenfunction:: vcpu_set_efer
- Update target vCPU's RSP in run_context :project: Project ACRN
* - vcpu_get_efer .. doxygenfunction:: vcpu_get_rflags
- Get & cache target vCPU's EFER in run_context :project: Project ACRN
* - vcpu_set_efer .. doxygenfunction:: vcpu_set_rflags
- Update target vCPU's EFER in run_context :project: Project ACRN
* - vcpu_get_rflags .. doxygenfunction:: vcpu_get_cr0
- Get & cache target vCPU's RFLAGS in run_context :project: Project ACRN
* - vcpu_set_rflags .. doxygenfunction:: vcpu_set_cr0
- Update target vCPU's RFLAGS in run_context :project: Project ACRN
* - vcpu_get_cr2 .. doxygenfunction:: vcpu_get_cr2
- Get target vCPU's CR2 register value in run_context :project: Project ACRN
* - vcpu_set_cr2 .. doxygenfunction:: vcpu_set_cr2
- Set target vCPU's CR2 register value in run_context :project: Project ACRN
* - vcpu_get_cr0/4 .. doxygenfunction:: vcpu_get_cr4
- Get & cache target vCPU's CR0/4 register in run_context :project: Project ACRN
* - vcpu_set_cr0/4 .. doxygenfunction:: vcpu_set_cr4
- Update target vCPU's CR0/4 register in run_context :project: Project ACRN
VM Exit Handlers VM Exit Handlers
@ -646,49 +593,10 @@ For a guest vCPU's state initialization:
- UOS BSP: DM context initialization through hypercall - UOS BSP: DM context initialization through hypercall
- If it's AP, then it will always start from real mode, and the start - If it's AP, then it will always start from real mode, and the start
vector will always come from vlapic INIT-SIPI emulation. So there vector will always come from vlapic INIT-SIPI emulation.
is no need for *boot_ctx*. Instead we use a static guest state setting
pre-defined for real mode.
.. code-block:: c
struct acrn_vcpu_state {
struct acrn_gp_regs gprs;
struct acrn_dt_desc gdt;
uint64_t rip;
uint64_t cs_base;
uint64_t cr0;
uint64_t cr4;
uint64_t reserved_64[4];
uint32_t cs_ar;
uint32_t reserved_32[4];
/* don't change the order of following sel */
uint16_t cs_sel;
uint16_t ss_sel;
uint16_t ds_sel;
uint16_t es_sel;
uint16_t fs_sel;
uint16_t gs_sel;
uint16_t reserved_16[4];
};
struct boot_ctx {
struct acrn_vcpu_state vcpu_state;
struct acrn_dt_desc idt;
uint64_t cr3;
uint64_t ia32_efer;
uint64_t rflags;
void *rsdp;
void *ap_trampoline_buf;
uint16_t ldt_sel;
uint16_t tr_sel;
}__attribute__((aligned(8)));
.. doxygenstruct:: acrn_vcpu_regs
:project: Project ACRN
.. list-table:: .. list-table::
:widths: 20 40 10 30 :widths: 20 40 10 30