sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget+/translations/zh_CN/arch/powerpc/ultravisormodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget+/translations/zh_TW/arch/powerpc/ultravisormodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget+/translations/it_IT/arch/powerpc/ultravisormodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget+/translations/ja_JP/arch/powerpc/ultravisormodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget+/translations/ko_KR/arch/powerpc/ultravisormodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget+/translations/sp_SP/arch/powerpc/ultravisormodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhcomment)}(h SPDX-License-Identifier: GPL-2.0h]h SPDX-License-Identifier: GPL-2.0}hhsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhhE/var/lib/git/docbuild/linux/Documentation/arch/powerpc/ultravisor.rsthKubhtarget)}(h.. _ultravisor:h]h}(h]h ]h"]h$]h&]refid ultravisoruh1hhKhhhhhhubhsection)}(hhh](htitle)}(hProtected Execution Facilityh]hProtected Execution Facility}(hhhhhNhNubah}(h]h ]h"]h$]h&]hid65uh1hhhhhhhhKubhtopic)}(h Contents h](h)}(hContentsh]hContents}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhK ubh bullet_list)}(hhh]h list_item)}(hhh](h paragraph)}(hhh]h reference)}(hhh]hProtected Execution Facility}(hhhhhNhNubah}(h]hah ]h"]h$]h&]refidprotected-execution-facilityuh1hhhubah}(h]h ]h"]h$]h&]uh1hhhubh)}(hhh](h)}(hhh](h)}(hhh]h)}(hhh]h Introduction}(hjhhhNhNubah}(h]id66ah ]h"]h$]h&]refid introductionuh1hhjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hhh](h)}(hhh]h)}(hhh]h)}(hhh]hHardware}(hj:hhhNhNubah}(h]id67ah ]h"]h$]h&]refidhardwareuh1hhj7ubah}(h]h ]h"]h$]h&]uh1hhj4ubah}(h]h ]h"]h$]h&]uh1hhj1ubh)}(hhh]h)}(hhh]h)}(hhh]hSoftware/Microcode}(hj\hhhNhNubah}(h]id68ah ]h"]h$]h&]refidsoftware-microcodeuh1hhjYubah}(h]h ]h"]h$]h&]uh1hhjVubah}(h]h ]h"]h$]h&]uh1hhj1ubh)}(hhh]h)}(hhh]h)}(hhh]h Terminology}(hj~hhhNhNubah}(h]id69ah ]h"]h$]h&]refid terminologyuh1hhj{ubah}(h]h ]h"]h$]h&]uh1hhjxubah}(h]h ]h"]h$]h&]uh1hhj1ubeh}(h]h ]h"]h$]h&]uh1hhjubeh}(h]h ]h"]h$]h&]uh1hhjubh)}(hhh](h)}(hhh]h)}(hhh]hUltravisor calls API}(hjhhhNhNubah}(h]id70ah ]h"]h$]h&]refidultravisor-calls-apiuh1hhjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hhh](h)}(hhh]h)}(hhh]h)}(hhh]hUltracalls used by Hypervisor}(hjhhhNhNubah}(h]id71ah ]h"]h$]h&]refidultracalls-used-by-hypervisoruh1hhjubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hhh]h)}(hhh]h)}(hhh]hUltracalls used by SVM}(hjhhhNhNubah}(h]id72ah ]h"]h$]h&]refidultracalls-used-by-svmuh1hhjubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhjubeh}(h]h ]h"]h$]h&]uh1hhjubeh}(h]h ]h"]h$]h&]uh1hhjubh)}(hhh](h)}(hhh]h)}(hhh]hHypervisor Calls API}(hjhhhNhNubah}(h]id73ah ]h"]h$]h&]refidhypervisor-calls-apiuh1hhjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hhh]h)}(hhh]h)}(hhh]h)}(hhh]h&Hypervisor calls to support Ultravisor}(hj:hhhNhNubah}(h]id74ah ]h"]h$]h&]refid&hypervisor-calls-to-support-ultravisoruh1hhj7ubah}(h]h ]h"]h$]h&]uh1hhj4ubah}(h]h ]h"]h$]h&]uh1hhj1ubah}(h]h ]h"]h$]h&]uh1hhjubeh}(h]h ]h"]h$]h&]uh1hhjubh)}(hhh]h)}(hhh]h)}(hhh]h References}(hjhhhhNhNubah}(h]id75ah ]h"]h$]h&]refid referencesuh1hhjeubah}(h]h ]h"]h$]h&]uh1hhjbubah}(h]h ]h"]h$]h&]uh1hhjubeh}(h]h ]h"]h$]h&]uh1hhhubeh}(h]h ]h"]h$]h&]uh1hhhubah}(h]h ]h"]h$]h&]uh1hhhhhhNhNubeh}(h]contentsah ]contentsah"]contentsah$]h&]uh1hhhhK hhhhubh)}(hhh](h)}(h Introductionh]h Introduction}(hjhhhNhNubah}(h]h ]h"]h$]h&]hj$uh1hhjhhhhhK ubh block_quote)}(hXProtected Execution Facility (PEF) is an architectural change for POWER 9 that enables Secure Virtual Machines (SVMs). DD2.3 chips (PVR=0x004e1203) or greater will be PEF-capable. A new ISA release will include the PEF RFC02487 changes. When enabled, PEF adds a new higher privileged mode, called Ultravisor mode, to POWER architecture. Along with the new mode there is new firmware called the Protected Execution Ultravisor (or Ultravisor for short). Ultravisor mode is the highest privileged mode in POWER architecture. +------------------+ | Privilege States | +==================+ | Problem | +------------------+ | Supervisor | +------------------+ | Hypervisor | +------------------+ | Ultravisor | +------------------+ PEF protects SVMs from the hypervisor, privileged users, and other VMs in the system. SVMs are protected while at rest and can only be executed by an authorized machine. All virtual machines utilize hypervisor services. The Ultravisor filters calls between the SVMs and the hypervisor to assure that information does not accidentally leak. All hypercalls except H_RANDOM are reflected to the hypervisor. H_RANDOM is not reflected to prevent the hypervisor from influencing random values in the SVM. To support this there is a refactoring of the ownership of resources in the CPU. Some of the resources which were previously hypervisor privileged are now ultravisor privileged. h](h)}(hProtected Execution Facility (PEF) is an architectural change for POWER 9 that enables Secure Virtual Machines (SVMs). DD2.3 chips (PVR=0x004e1203) or greater will be PEF-capable. A new ISA release will include the PEF RFC02487 changes.h]hProtected Execution Facility (PEF) is an architectural change for POWER 9 that enables Secure Virtual Machines (SVMs). DD2.3 chips (PVR=0x004e1203) or greater will be PEF-capable. A new ISA release will include the PEF RFC02487 changes.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hXWhen enabled, PEF adds a new higher privileged mode, called Ultravisor mode, to POWER architecture. Along with the new mode there is new firmware called the Protected Execution Ultravisor (or Ultravisor for short). Ultravisor mode is the highest privileged mode in POWER architecture.h]hXWhen enabled, PEF adds a new higher privileged mode, called Ultravisor mode, to POWER architecture. Along with the new mode there is new firmware called the Protected Execution Ultravisor (or Ultravisor for short). Ultravisor mode is the highest privileged mode in POWER architecture.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj)}(h+------------------+ | Privilege States | +==================+ | Problem | +------------------+ | Supervisor | +------------------+ | Hypervisor | +------------------+ | Ultravisor | +------------------+ h]htable)}(hhh]htgroup)}(hhh](hcolspec)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubhthead)}(hhh]hrow)}(hhh]hentry)}(hhh]h)}(hPrivilege Statesh]hPrivilege States}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhjubhtbody)}(hhh](j)}(hhh]j)}(hhh]h)}(hProblemh]hProblem}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj#ubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]j)}(hhh]h)}(h Supervisorh]h Supervisor}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjCubah}(h]h ]h"]h$]h&]uh1jhj@ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]j)}(hhh]h)}(h Hypervisorh]h Hypervisor}(hjfhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hjcubah}(h]h ]h"]h$]h&]uh1jhj`ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]j)}(hhh]h)}(h Ultravisorh]h Ultravisor}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK"hjubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]colsKuh1jhjubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhhhKhjubh)}(hXPEF protects SVMs from the hypervisor, privileged users, and other VMs in the system. SVMs are protected while at rest and can only be executed by an authorized machine. All virtual machines utilize hypervisor services. The Ultravisor filters calls between the SVMs and the hypervisor to assure that information does not accidentally leak. All hypercalls except H_RANDOM are reflected to the hypervisor. H_RANDOM is not reflected to prevent the hypervisor from influencing random values in the SVM.h]hXPEF protects SVMs from the hypervisor, privileged users, and other VMs in the system. SVMs are protected while at rest and can only be executed by an authorized machine. All virtual machines utilize hypervisor services. The Ultravisor filters calls between the SVMs and the hypervisor to assure that information does not accidentally leak. All hypercalls except H_RANDOM are reflected to the hypervisor. H_RANDOM is not reflected to prevent the hypervisor from influencing random values in the SVM.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK%hjubh)}(hTo support this there is a refactoring of the ownership of resources in the CPU. Some of the resources which were previously hypervisor privileged are now ultravisor privileged.h]hTo support this there is a refactoring of the ownership of resources in the CPU. Some of the resources which were previously hypervisor privileged are now ultravisor privileged.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK.hjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjhhubh)}(hhh](h)}(hHardwareh]hHardware}(hjhhhNhNubah}(h]h ]h"]h$]h&]hjCuh1hhjhhhhhK3ubj)}(hX The hardware changes include the following: * There is a new bit in the MSR that determines whether the current process is running in secure mode, MSR(S) bit 41. MSR(S)=1, process is in secure mode, MSR(s)=0 process is in normal mode. * The MSR(S) bit can only be set by the Ultravisor. * HRFID cannot be used to set the MSR(S) bit. If the hypervisor needs to return to a SVM it must use an ultracall. It can determine if the VM it is returning to is secure. * There is a new Ultravisor privileged register, SMFCTRL, which has an enable/disable bit SMFCTRL(E). * The privilege of a process is now determined by three MSR bits, MSR(S, HV, PR). In each of the tables below the modes are listed from least privilege to highest privilege. The higher privilege modes can access all the resources of the lower privilege modes. **Secure Mode MSR Settings** +---+---+---+---------------+ | S | HV| PR|Privilege | +===+===+===+===============+ | 1 | 0 | 1 | Problem | +---+---+---+---------------+ | 1 | 0 | 0 | Privileged(OS)| +---+---+---+---------------+ | 1 | 1 | 0 | Ultravisor | +---+---+---+---------------+ | 1 | 1 | 1 | Reserved | +---+---+---+---------------+ **Normal Mode MSR Settings** +---+---+---+---------------+ | S | HV| PR|Privilege | +===+===+===+===============+ | 0 | 0 | 1 | Problem | +---+---+---+---------------+ | 0 | 0 | 0 | Privileged(OS)| +---+---+---+---------------+ | 0 | 1 | 0 | Hypervisor | +---+---+---+---------------+ | 0 | 1 | 1 | Problem (Host)| +---+---+---+---------------+ * Memory is partitioned into secure and normal memory. Only processes that are running in secure mode can access secure memory. * The hardware does not allow anything that is not running secure to access secure memory. This means that the Hypervisor cannot access the memory of the SVM without using an ultracall (asking the Ultravisor). The Ultravisor will only allow the hypervisor to see the SVM memory encrypted. * I/O systems are not allowed to directly address secure memory. This limits the SVMs to virtual I/O only. * The architecture allows the SVM to share pages of memory with the hypervisor that are not protected with encryption. However, this sharing must be initiated by the SVM. * When a process is running in secure mode all hypercalls (syscall lev=1) go to the Ultravisor. * When a process is in secure mode all interrupts go to the Ultravisor. * The following resources have become Ultravisor privileged and require an Ultravisor interface to manipulate: * Processor configurations registers (SCOMs). * Stop state information. * The debug registers CIABR, DAWR, and DAWRX when SMFCTRL(D) is set. If SMFCTRL(D) is not set they do not work in secure mode. When set, reading and writing requires an Ultravisor call, otherwise that will cause a Hypervisor Emulation Assistance interrupt. * PTCR and partition table entries (partition table is in secure memory). An attempt to write to PTCR will cause a Hypervisor Emulation Assistance interrupt. * LDBAR (LD Base Address Register) and IMC (In-Memory Collection) non-architected registers. An attempt to write to them will cause a Hypervisor Emulation Assistance interrupt. * Paging for an SVM, sharing of memory with Hypervisor for an SVM. (Including Virtual Processor Area (VPA) and virtual I/O). h](h)}(h+The hardware changes include the following:h]h+The hardware changes include the following:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK5hjubh)}(hhh](h)}(hThere is a new bit in the MSR that determines whether the current process is running in secure mode, MSR(S) bit 41. MSR(S)=1, process is in secure mode, MSR(s)=0 process is in normal mode. h]h)}(hThere is a new bit in the MSR that determines whether the current process is running in secure mode, MSR(S) bit 41. MSR(S)=1, process is in secure mode, MSR(s)=0 process is in normal mode.h]hThere is a new bit in the MSR that determines whether the current process is running in secure mode, MSR(S) bit 41. MSR(S)=1, process is in secure mode, MSR(s)=0 process is in normal mode.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK7hjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h2The MSR(S) bit can only be set by the Ultravisor. h]h)}(h1The MSR(S) bit can only be set by the Ultravisor.h]h1The MSR(S) bit can only be set by the Ultravisor.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK;hjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hHRFID cannot be used to set the MSR(S) bit. If the hypervisor needs to return to a SVM it must use an ultracall. It can determine if the VM it is returning to is secure. h]h)}(hHRFID cannot be used to set the MSR(S) bit. If the hypervisor needs to return to a SVM it must use an ultracall. It can determine if the VM it is returning to is secure.h]hHRFID cannot be used to set the MSR(S) bit. If the hypervisor needs to return to a SVM it must use an ultracall. It can determine if the VM it is returning to is secure.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK=hj1ubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hdThere is a new Ultravisor privileged register, SMFCTRL, which has an enable/disable bit SMFCTRL(E). h]h)}(hcThere is a new Ultravisor privileged register, SMFCTRL, which has an enable/disable bit SMFCTRL(E).h]hcThere is a new Ultravisor privileged register, SMFCTRL, which has an enable/disable bit SMFCTRL(E).}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKAhjIubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hXThe privilege of a process is now determined by three MSR bits, MSR(S, HV, PR). In each of the tables below the modes are listed from least privilege to highest privilege. The higher privilege modes can access all the resources of the lower privilege modes. **Secure Mode MSR Settings** +---+---+---+---------------+ | S | HV| PR|Privilege | +===+===+===+===============+ | 1 | 0 | 1 | Problem | +---+---+---+---------------+ | 1 | 0 | 0 | Privileged(OS)| +---+---+---+---------------+ | 1 | 1 | 0 | Ultravisor | +---+---+---+---------------+ | 1 | 1 | 1 | Reserved | +---+---+---+---------------+ **Normal Mode MSR Settings** +---+---+---+---------------+ | S | HV| PR|Privilege | +===+===+===+===============+ | 0 | 0 | 1 | Problem | +---+---+---+---------------+ | 0 | 0 | 0 | Privileged(OS)| +---+---+---+---------------+ | 0 | 1 | 0 | Hypervisor | +---+---+---+---------------+ | 0 | 1 | 1 | Problem (Host)| +---+---+---+---------------+ h](h)}(hXThe privilege of a process is now determined by three MSR bits, MSR(S, HV, PR). In each of the tables below the modes are listed from least privilege to highest privilege. The higher privilege modes can access all the resources of the lower privilege modes.h]hXThe privilege of a process is now determined by three MSR bits, MSR(S, HV, PR). In each of the tables below the modes are listed from least privilege to highest privilege. The higher privilege modes can access all the resources of the lower privilege modes.}(hjehhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKDhjaubh)}(h**Secure Mode MSR Settings**h]hstrong)}(hjuh]hSecure Mode MSR Settings}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1jwhjsubah}(h]h ]h"]h$]h&]uh1hhhhKIhjaubj)}(hhh]j)}(hhh](j)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubj)}(hhh]j)}(hhh](j)}(hhh]h)}(hSh]hS}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKLhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hHVh]hHV}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKLhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hPRh]hPR}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKLhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(h Privilegeh]h Privilege}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKLhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh](j)}(hhh]h)}(h1h]h1}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKNhj.ubah}(h]h ]h"]h$]h&]uh1jhj+ubj)}(hhh]h)}(h0h]h0}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKNhjEubah}(h]h ]h"]h$]h&]uh1jhj+ubj)}(hhh]h)}(hj3h]h1}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKNhj\ubah}(h]h ]h"]h$]h&]uh1jhj+ubj)}(hhh]h)}(hProblemh]hProblem}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKNhjrubah}(h]h ]h"]h$]h&]uh1jhj+ubeh}(h]h ]h"]h$]h&]uh1jhj(ubj)}(hhh](j)}(hhh]h)}(hj3h]h1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKPhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hjJh]h0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKPhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hjJh]h0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKPhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hPrivileged(OS)h]hPrivileged(OS)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKPhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj(ubj)}(hhh](j)}(hhh]h)}(hj3h]h1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKRhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hj3h]h1}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKRhj ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hjJh]h0}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKRhj ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(h Ultravisorh]h Ultravisor}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKRhj6ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj(ubj)}(hhh](j)}(hhh]h)}(hj3h]h1}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKThjVubah}(h]h ]h"]h$]h&]uh1jhjSubj)}(hhh]h)}(hj3h]h1}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKThjlubah}(h]h ]h"]h$]h&]uh1jhjSubj)}(hhh]h)}(hj3h]h1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKThjubah}(h]h ]h"]h$]h&]uh1jhjSubj)}(hhh]h)}(hReservedh]hReserved}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKThjubah}(h]h ]h"]h$]h&]uh1jhjSubeh}(h]h ]h"]h$]h&]uh1jhj(ubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]colsKuh1jhjubah}(h]h ]h"]h$]h&]uh1jhjaubh)}(h**Normal Mode MSR Settings**h]jx)}(hjh]hNormal Mode MSR Settings}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jwhjubah}(h]h ]h"]h$]h&]uh1hhhhKWhjaubj)}(hhh]j)}(hhh](j)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubj)}(hhh]j)}(hhh](j)}(hhh]h)}(hjh]hS}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKZhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hHVh]hHV}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKZhj)ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hPRh]hPR}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKZhj@ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(h Privilegeh]h Privilege}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKZhjWubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh](j)}(hhh]h)}(hjJh]h0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK\hjubah}(h]h ]h"]h$]h&]uh1jhj}ubj)}(hhh]h)}(hjJh]h0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK\hjubah}(h]h ]h"]h$]h&]uh1jhj}ubj)}(hhh]h)}(hj3h]h1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK\hjubah}(h]h ]h"]h$]h&]uh1jhj}ubj)}(hhh]h)}(hProblemh]hProblem}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK\hjubah}(h]h ]h"]h$]h&]uh1jhj}ubeh}(h]h ]h"]h$]h&]uh1jhjzubj)}(hhh](j)}(hhh]h)}(hjJh]h0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK^hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hjJh]h0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK^hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hjJh]h0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK^hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hPrivileged(OS)h]hPrivileged(OS)}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK^hj$ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjzubj)}(hhh](j)}(hhh]h)}(hjJh]h0}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK`hjDubah}(h]h ]h"]h$]h&]uh1jhjAubj)}(hhh]h)}(hj3h]h1}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK`hjZubah}(h]h ]h"]h$]h&]uh1jhjAubj)}(hhh]h)}(hjJh]h0}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK`hjpubah}(h]h ]h"]h$]h&]uh1jhjAubj)}(hhh]h)}(h Hypervisorh]h Hypervisor}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK`hjubah}(h]h ]h"]h$]h&]uh1jhjAubeh}(h]h ]h"]h$]h&]uh1jhjzubj)}(hhh](j)}(hhh]h)}(hjJh]h0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKbhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hj3h]h1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKbhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hj3h]h1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKbhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hProblem (Host)h]hProblem (Host)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKbhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjzubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]colsKuh1jhjubah}(h]h ]h"]h$]h&]uh1jhjaubeh}(h]h ]h"]h$]h&]uh1hhjubh)}(h~Memory is partitioned into secure and normal memory. Only processes that are running in secure mode can access secure memory. h]h)}(h}Memory is partitioned into secure and normal memory. Only processes that are running in secure mode can access secure memory.h]h}Memory is partitioned into secure and normal memory. Only processes that are running in secure mode can access secure memory.}(hj" hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKehj ubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hXThe hardware does not allow anything that is not running secure to access secure memory. This means that the Hypervisor cannot access the memory of the SVM without using an ultracall (asking the Ultravisor). The Ultravisor will only allow the hypervisor to see the SVM memory encrypted. h]h)}(hXThe hardware does not allow anything that is not running secure to access secure memory. This means that the Hypervisor cannot access the memory of the SVM without using an ultracall (asking the Ultravisor). The Ultravisor will only allow the hypervisor to see the SVM memory encrypted.h]hXThe hardware does not allow anything that is not running secure to access secure memory. This means that the Hypervisor cannot access the memory of the SVM without using an ultracall (asking the Ultravisor). The Ultravisor will only allow the hypervisor to see the SVM memory encrypted.}(hj: hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhj6 ubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hiI/O systems are not allowed to directly address secure memory. This limits the SVMs to virtual I/O only. h]h)}(hhI/O systems are not allowed to directly address secure memory. This limits the SVMs to virtual I/O only.h]hhI/O systems are not allowed to directly address secure memory. This limits the SVMs to virtual I/O only.}(hjR hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKnhjN ubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hThe architecture allows the SVM to share pages of memory with the hypervisor that are not protected with encryption. However, this sharing must be initiated by the SVM. h]h)}(hThe architecture allows the SVM to share pages of memory with the hypervisor that are not protected with encryption. However, this sharing must be initiated by the SVM.h]hThe architecture allows the SVM to share pages of memory with the hypervisor that are not protected with encryption. However, this sharing must be initiated by the SVM.}(hjj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKqhjf ubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h^When a process is running in secure mode all hypercalls (syscall lev=1) go to the Ultravisor. h]h)}(h]When a process is running in secure mode all hypercalls (syscall lev=1) go to the Ultravisor.h]h]When a process is running in secure mode all hypercalls (syscall lev=1) go to the Ultravisor.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKuhj~ ubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hFWhen a process is in secure mode all interrupts go to the Ultravisor. h]h)}(hEWhen a process is in secure mode all interrupts go to the Ultravisor.h]hEWhen a process is in secure mode all interrupts go to the Ultravisor.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKxhj ubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hXThe following resources have become Ultravisor privileged and require an Ultravisor interface to manipulate: * Processor configurations registers (SCOMs). * Stop state information. * The debug registers CIABR, DAWR, and DAWRX when SMFCTRL(D) is set. If SMFCTRL(D) is not set they do not work in secure mode. When set, reading and writing requires an Ultravisor call, otherwise that will cause a Hypervisor Emulation Assistance interrupt. * PTCR and partition table entries (partition table is in secure memory). An attempt to write to PTCR will cause a Hypervisor Emulation Assistance interrupt. * LDBAR (LD Base Address Register) and IMC (In-Memory Collection) non-architected registers. An attempt to write to them will cause a Hypervisor Emulation Assistance interrupt. * Paging for an SVM, sharing of memory with Hypervisor for an SVM. (Including Virtual Processor Area (VPA) and virtual I/O). h](h)}(hlThe following resources have become Ultravisor privileged and require an Ultravisor interface to manipulate:h]hlThe following resources have become Ultravisor privileged and require an Ultravisor interface to manipulate:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK{hj ubh)}(hhh](h)}(h,Processor configurations registers (SCOMs). h]h)}(h+Processor configurations registers (SCOMs).h]h+Processor configurations registers (SCOMs).}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK~hj ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(hStop state information. h]h)}(hStop state information.h]hStop state information.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(hThe debug registers CIABR, DAWR, and DAWRX when SMFCTRL(D) is set. If SMFCTRL(D) is not set they do not work in secure mode. When set, reading and writing requires an Ultravisor call, otherwise that will cause a Hypervisor Emulation Assistance interrupt. h]h)}(hThe debug registers CIABR, DAWR, and DAWRX when SMFCTRL(D) is set. If SMFCTRL(D) is not set they do not work in secure mode. When set, reading and writing requires an Ultravisor call, otherwise that will cause a Hypervisor Emulation Assistance interrupt.h]hThe debug registers CIABR, DAWR, and DAWRX when SMFCTRL(D) is set. If SMFCTRL(D) is not set they do not work in secure mode. When set, reading and writing requires an Ultravisor call, otherwise that will cause a Hypervisor Emulation Assistance interrupt.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(hPTCR and partition table entries (partition table is in secure memory). An attempt to write to PTCR will cause a Hypervisor Emulation Assistance interrupt. h]h)}(hPTCR and partition table entries (partition table is in secure memory). An attempt to write to PTCR will cause a Hypervisor Emulation Assistance interrupt.h]hPTCR and partition table entries (partition table is in secure memory). An attempt to write to PTCR will cause a Hypervisor Emulation Assistance interrupt.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(hLDBAR (LD Base Address Register) and IMC (In-Memory Collection) non-architected registers. An attempt to write to them will cause a Hypervisor Emulation Assistance interrupt. h]h)}(hLDBAR (LD Base Address Register) and IMC (In-Memory Collection) non-architected registers. An attempt to write to them will cause a Hypervisor Emulation Assistance interrupt.h]hLDBAR (LD Base Address Register) and IMC (In-Memory Collection) non-architected registers. An attempt to write to them will cause a Hypervisor Emulation Assistance interrupt.}(hj' hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj# ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(h|Paging for an SVM, sharing of memory with Hypervisor for an SVM. (Including Virtual Processor Area (VPA) and virtual I/O). h]h)}(hzPaging for an SVM, sharing of memory with Hypervisor for an SVM. (Including Virtual Processor Area (VPA) and virtual I/O).h]hzPaging for an SVM, sharing of memory with Hypervisor for an SVM. (Including Virtual Processor Area (VPA) and virtual I/O).}(hj? hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj; ubah}(h]h ]h"]h$]h&]uh1hhj ubeh}(h]h ]h"]h$]h&]bullet*uh1hhhhK~hj ubeh}(h]h ]h"]h$]h&]uh1hhjubeh}(h]h ]h"]h$]h&]jY jZ uh1hhhhK7hjubeh}(h]h ]h"]h$]h&]uh1jhhhK5hjhhubeh}(h]jIah ]h"]hardwareah$]h&]uh1hhjhhhhhK3ubh)}(hhh](h)}(hSoftware/Microcodeh]hSoftware/Microcode}(hjw hhhNhNubah}(h]h ]h"]h$]h&]hjeuh1hhjt hhhhhKubj)}(hXThe software changes include: * SVMs are created from normal VM using (open source) tooling supplied by IBM. * All SVMs start as normal VMs and utilize an ultracall, UV_ESM (Enter Secure Mode), to make the transition. * When the UV_ESM ultracall is made the Ultravisor copies the VM into secure memory, decrypts the verification information, and checks the integrity of the SVM. If the integrity check passes the Ultravisor passes control in secure mode. * The verification information includes the pass phrase for the encrypted disk associated with the SVM. This pass phrase is given to the SVM when requested. * The Ultravisor is not involved in protecting the encrypted disk of the SVM while at rest. * For external interrupts the Ultravisor saves the state of the SVM, and reflects the interrupt to the hypervisor for processing. For hypercalls, the Ultravisor inserts neutral state into all registers not needed for the hypercall then reflects the call to the hypervisor for processing. The H_RANDOM hypercall is performed by the Ultravisor and not reflected. * For virtual I/O to work bounce buffering must be done. * The Ultravisor uses AES (IAPM) for protection of SVM memory. IAPM is a mode of AES that provides integrity and secrecy concurrently. * The movement of data between normal and secure pages is coordinated with the Ultravisor by a new HMM plug-in in the Hypervisor. The Ultravisor offers new services to the hypervisor and SVMs. These are accessed through ultracalls. h](h)}(hThe software changes include:h]hThe software changes include:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubh)}(hhh](h)}(hMSVMs are created from normal VM using (open source) tooling supplied by IBM. h]h)}(hLSVMs are created from normal VM using (open source) tooling supplied by IBM.h]hLSVMs are created from normal VM using (open source) tooling supplied by IBM.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(hkAll SVMs start as normal VMs and utilize an ultracall, UV_ESM (Enter Secure Mode), to make the transition. h]h)}(hjAll SVMs start as normal VMs and utilize an ultracall, UV_ESM (Enter Secure Mode), to make the transition.h]hjAll SVMs start as normal VMs and utilize an ultracall, UV_ESM (Enter Secure Mode), to make the transition.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(hWhen the UV_ESM ultracall is made the Ultravisor copies the VM into secure memory, decrypts the verification information, and checks the integrity of the SVM. If the integrity check passes the Ultravisor passes control in secure mode. h]h)}(hWhen the UV_ESM ultracall is made the Ultravisor copies the VM into secure memory, decrypts the verification information, and checks the integrity of the SVM. If the integrity check passes the Ultravisor passes control in secure mode.h]hWhen the UV_ESM ultracall is made the Ultravisor copies the VM into secure memory, decrypts the verification information, and checks the integrity of the SVM. If the integrity check passes the Ultravisor passes control in secure mode.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(hThe verification information includes the pass phrase for the encrypted disk associated with the SVM. This pass phrase is given to the SVM when requested. h]h)}(hThe verification information includes the pass phrase for the encrypted disk associated with the SVM. This pass phrase is given to the SVM when requested.h]hThe verification information includes the pass phrase for the encrypted disk associated with the SVM. This pass phrase is given to the SVM when requested.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(hZThe Ultravisor is not involved in protecting the encrypted disk of the SVM while at rest. h]h)}(hYThe Ultravisor is not involved in protecting the encrypted disk of the SVM while at rest.h]hYThe Ultravisor is not involved in protecting the encrypted disk of the SVM while at rest.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(hXgFor external interrupts the Ultravisor saves the state of the SVM, and reflects the interrupt to the hypervisor for processing. For hypercalls, the Ultravisor inserts neutral state into all registers not needed for the hypercall then reflects the call to the hypervisor for processing. The H_RANDOM hypercall is performed by the Ultravisor and not reflected. h]h)}(hXfFor external interrupts the Ultravisor saves the state of the SVM, and reflects the interrupt to the hypervisor for processing. For hypercalls, the Ultravisor inserts neutral state into all registers not needed for the hypercall then reflects the call to the hypervisor for processing. The H_RANDOM hypercall is performed by the Ultravisor and not reflected.h]hXfFor external interrupts the Ultravisor saves the state of the SVM, and reflects the interrupt to the hypervisor for processing. For hypercalls, the Ultravisor inserts neutral state into all registers not needed for the hypercall then reflects the call to the hypervisor for processing. The H_RANDOM hypercall is performed by the Ultravisor and not reflected.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(h7For virtual I/O to work bounce buffering must be done. h]h)}(h6For virtual I/O to work bounce buffering must be done.h]h6For virtual I/O to work bounce buffering must be done.}(hj. hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj* ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(hThe Ultravisor uses AES (IAPM) for protection of SVM memory. IAPM is a mode of AES that provides integrity and secrecy concurrently. h]h)}(hThe Ultravisor uses AES (IAPM) for protection of SVM memory. IAPM is a mode of AES that provides integrity and secrecy concurrently.h]hThe Ultravisor uses AES (IAPM) for protection of SVM memory. IAPM is a mode of AES that provides integrity and secrecy concurrently.}(hjF hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjB ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(hThe movement of data between normal and secure pages is coordinated with the Ultravisor by a new HMM plug-in in the Hypervisor. h]h)}(hThe movement of data between normal and secure pages is coordinated with the Ultravisor by a new HMM plug-in in the Hypervisor.h]hThe movement of data between normal and secure pages is coordinated with the Ultravisor by a new HMM plug-in in the Hypervisor.}(hj^ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjZ ubah}(h]h ]h"]h$]h&]uh1hhj ubeh}(h]h ]h"]h$]h&]jY jZ uh1hhhhKhj ubh)}(heThe Ultravisor offers new services to the hypervisor and SVMs. These are accessed through ultracalls.h]heThe Ultravisor offers new services to the hypervisor and SVMs. These are accessed through ultracalls.}(hjx hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubeh}(h]h ]h"]h$]h&]uh1jhhhKhjt hhubeh}(h]jkah ]h"]software/microcodeah$]h&]uh1hhjhhhhhKubh)}(hhh](h)}(h Terminologyh]h Terminology}(hj hhhNhNubah}(h]h ]h"]h$]h&]hjuh1hhj hhhhhKubj)}(hX* Hypercalls: special system calls used to request services from Hypervisor. * Normal memory: Memory that is accessible to Hypervisor. * Normal page: Page backed by normal memory and available to Hypervisor. * Shared page: A page backed by normal memory and available to both the Hypervisor/QEMU and the SVM (i.e page has mappings in SVM and Hypervisor/QEMU). * Secure memory: Memory that is accessible only to Ultravisor and SVMs. * Secure page: Page backed by secure memory and only available to Ultravisor and SVM. * SVM: Secure Virtual Machine. * Ultracalls: special system calls used to request services from Ultravisor. h]h)}(hhh](h)}(hKHypercalls: special system calls used to request services from Hypervisor. h]h)}(hJHypercalls: special system calls used to request services from Hypervisor.h]hJHypercalls: special system calls used to request services from Hypervisor.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(h8Normal memory: Memory that is accessible to Hypervisor. h]h)}(h7Normal memory: Memory that is accessible to Hypervisor.h]h7Normal memory: Memory that is accessible to Hypervisor.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(hGNormal page: Page backed by normal memory and available to Hypervisor. h]h)}(hFNormal page: Page backed by normal memory and available to Hypervisor.h]hFNormal page: Page backed by normal memory and available to Hypervisor.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(hShared page: A page backed by normal memory and available to both the Hypervisor/QEMU and the SVM (i.e page has mappings in SVM and Hypervisor/QEMU). h]h)}(hShared page: A page backed by normal memory and available to both the Hypervisor/QEMU and the SVM (i.e page has mappings in SVM and Hypervisor/QEMU).h]hShared page: A page backed by normal memory and available to both the Hypervisor/QEMU and the SVM (i.e page has mappings in SVM and Hypervisor/QEMU).}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(hFSecure memory: Memory that is accessible only to Ultravisor and SVMs. h]h)}(hESecure memory: Memory that is accessible only to Ultravisor and SVMs.h]hESecure memory: Memory that is accessible only to Ultravisor and SVMs.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(hTSecure page: Page backed by secure memory and only available to Ultravisor and SVM. h]h)}(hSSecure page: Page backed by secure memory and only available to Ultravisor and SVM.h]hSSecure page: Page backed by secure memory and only available to Ultravisor and SVM.}(hj' hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj# ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(hSVM: Secure Virtual Machine. h]h)}(hSVM: Secure Virtual Machine.h]hSVM: Secure Virtual Machine.}(hj? hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj; ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(hLUltracalls: special system calls used to request services from Ultravisor. h]h)}(hJUltracalls: special system calls used to request services from Ultravisor.h]hJUltracalls: special system calls used to request services from Ultravisor.}(hjW hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjS ubah}(h]h ]h"]h$]h&]uh1hhj ubeh}(h]h ]h"]h$]h&]jY jZ uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jhhhKhj hhubeh}(h]jah ]h"] terminologyah$]h&]uh1hhjhhhhhKubeh}(h]j*ah ]h"] introductionah$]h&]uh1hhhhhhhhK ubh)}(hhh](h)}(hUltravisor calls APIh]hUltravisor calls API}(hj hhhNhNubah}(h]h ]h"]h$]h&]hjuh1hhj hhhhhKubj)}(hXThis section describes Ultravisor calls (ultracalls) needed to support Secure Virtual Machines (SVM)s and Paravirtualized KVM. The ultracalls allow the SVMs and Hypervisor to request services from the Ultravisor such as accessing a register or memory region that can only be accessed when running in Ultravisor-privileged mode. The specific service needed from an ultracall is specified in register R3 (the first parameter to the ultracall). Other parameters to the ultracall, if any, are specified in registers R4 through R12. Return value of all ultracalls is in register R3. Other output values from the ultracall, if any, are returned in registers R4 through R12. The only exception to this register usage is the ``UV_RETURN`` ultracall described below. Each ultracall returns specific error codes, applicable in the context of the ultracall. However, like with the PowerPC Architecture Platform Reference (PAPR), if no specific error code is defined for a particular situation, then the ultracall will fallback to an erroneous parameter-position based code. i.e U_PARAMETER, U_P2, U_P3 etc depending on the ultracall parameter that may have caused the error. Some ultracalls involve transferring a page of data between Ultravisor and Hypervisor. Secure pages that are transferred from secure memory to normal memory may be encrypted using dynamically generated keys. When the secure pages are transferred back to secure memory, they may be decrypted using the same dynamically generated keys. Generation and management of these keys will be covered in a separate document. For now this only covers ultracalls currently implemented and being used by Hypervisor and SVMs but others can be added here when it makes sense. The full specification for all hypercalls/ultracalls will eventually be made available in the public/OpenPower version of the PAPR specification. .. note:: If PEF is not enabled, the ultracalls will be redirected to the Hypervisor which must handle/fail the calls. h](h)}(hXGThis section describes Ultravisor calls (ultracalls) needed to support Secure Virtual Machines (SVM)s and Paravirtualized KVM. The ultracalls allow the SVMs and Hypervisor to request services from the Ultravisor such as accessing a register or memory region that can only be accessed when running in Ultravisor-privileged mode.h]hXGThis section describes Ultravisor calls (ultracalls) needed to support Secure Virtual Machines (SVM)s and Paravirtualized KVM. The ultracalls allow the SVMs and Hypervisor to request services from the Ultravisor such as accessing a register or memory region that can only be accessed when running in Ultravisor-privileged mode.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubh)}(hThe specific service needed from an ultracall is specified in register R3 (the first parameter to the ultracall). Other parameters to the ultracall, if any, are specified in registers R4 through R12.h]hThe specific service needed from an ultracall is specified in register R3 (the first parameter to the ultracall). Other parameters to the ultracall, if any, are specified in registers R4 through R12.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubh)}(hReturn value of all ultracalls is in register R3. Other output values from the ultracall, if any, are returned in registers R4 through R12. The only exception to this register usage is the ``UV_RETURN`` ultracall described below.h](hReturn value of all ultracalls is in register R3. Other output values from the ultracall, if any, are returned in registers R4 through R12. The only exception to this register usage is the }(hj hhhNhNubhliteral)}(h ``UV_RETURN``h]h UV_RETURN}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj ubh ultracall described below.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj ubh)}(hXEach ultracall returns specific error codes, applicable in the context of the ultracall. However, like with the PowerPC Architecture Platform Reference (PAPR), if no specific error code is defined for a particular situation, then the ultracall will fallback to an erroneous parameter-position based code. i.e U_PARAMETER, U_P2, U_P3 etc depending on the ultracall parameter that may have caused the error.h]hXEach ultracall returns specific error codes, applicable in the context of the ultracall. However, like with the PowerPC Architecture Platform Reference (PAPR), if no specific error code is defined for a particular situation, then the ultracall will fallback to an erroneous parameter-position based code. i.e U_PARAMETER, U_P2, U_P3 etc depending on the ultracall parameter that may have caused the error.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubh)}(hXSome ultracalls involve transferring a page of data between Ultravisor and Hypervisor. Secure pages that are transferred from secure memory to normal memory may be encrypted using dynamically generated keys. When the secure pages are transferred back to secure memory, they may be decrypted using the same dynamically generated keys. Generation and management of these keys will be covered in a separate document.h]hXSome ultracalls involve transferring a page of data between Ultravisor and Hypervisor. Secure pages that are transferred from secure memory to normal memory may be encrypted using dynamically generated keys. When the secure pages are transferred back to secure memory, they may be decrypted using the same dynamically generated keys. Generation and management of these keys will be covered in a separate document.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubh)}(hFor now this only covers ultracalls currently implemented and being used by Hypervisor and SVMs but others can be added here when it makes sense.h]hFor now this only covers ultracalls currently implemented and being used by Hypervisor and SVMs but others can be added here when it makes sense.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubh)}(hThe full specification for all hypercalls/ultracalls will eventually be made available in the public/OpenPower version of the PAPR specification.h]hThe full specification for all hypercalls/ultracalls will eventually be made available in the public/OpenPower version of the PAPR specification.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubhnote)}(hlIf PEF is not enabled, the ultracalls will be redirected to the Hypervisor which must handle/fail the calls.h]h)}(hlIf PEF is not enabled, the ultracalls will be redirected to the Hypervisor which must handle/fail the calls.h]hlIf PEF is not enabled, the ultracalls will be redirected to the Hypervisor which must handle/fail the calls.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1jhhhKhj hhubh)}(hhh](h)}(hUltracalls used by Hypervisorh]hUltracalls used by Hypervisor}(hj3 hhhNhNubah}(h]h ]h"]h$]h&]hjuh1hhj0 hhhhhMubj)}(hgThis section describes the virtual memory management ultracalls used by the Hypervisor to manage SVMs. h]h)}(hfThis section describes the virtual memory management ultracalls used by the Hypervisor to manage SVMs.h]hfThis section describes the virtual memory management ultracalls used by the Hypervisor to manage SVMs.}(hjE hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjA ubah}(h]h ]h"]h$]h&]uh1jhhhMhj0 hhubh)}(hhh](h)}(h UV_PAGE_OUTh]h UV_PAGE_OUT}(hj\ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjY hhhhhM ubj)}(hMEncrypt and move the contents of a page from secure memory to normal memory. h]h)}(hLEncrypt and move the contents of a page from secure memory to normal memory.h]hLEncrypt and move the contents of a page from secure memory to normal memory.}(hjn hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjj ubah}(h]h ]h"]h$]h&]uh1jhhhM hjY hhubh)}(hhh](h)}(hSyntaxh]hSyntax}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhMubh literal_block)}(hXIuint64_t ultracall(const uint64_t UV_PAGE_OUT, uint16_t lpid, /* LPAR ID */ uint64_t dest_ra, /* real address of destination page */ uint64_t src_gpa, /* source guest-physical-address */ uint8_t flags, /* flags */ uint64_t order) /* page size order */h]hXIuint64_t ultracall(const uint64_t UV_PAGE_OUT, uint16_t lpid, /* LPAR ID */ uint64_t dest_ra, /* real address of destination page */ uint64_t src_gpa, /* source guest-physical-address */ uint8_t flags, /* flags */ uint64_t order) /* page size order */}hj sbah}(h]h ]h"]h$]h&]hhforcelanguagechighlight_args}uh1j hhhMhj hhubeh}(h]syntaxah ]h"]h$]syntaxah&]uh1hhjY hhhhhM referencedKubh)}(hhh](h)}(h Return valuesh]h Return values}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhMubj)}(hXOne of the following values: * U_SUCCESS on success. * U_PARAMETER if ``lpid`` is invalid. * U_P2 if ``dest_ra`` is invalid. * U_P3 if the ``src_gpa`` address is invalid. * U_P4 if any bit in the ``flags`` is unrecognized * U_P5 if the ``order`` parameter is unsupported. * U_FUNCTION if functionality is not supported. * U_BUSY if page cannot be currently paged-out. h](h)}(hOne of the following values:h]hOne of the following values:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubj)}(hX* U_SUCCESS on success. * U_PARAMETER if ``lpid`` is invalid. * U_P2 if ``dest_ra`` is invalid. * U_P3 if the ``src_gpa`` address is invalid. * U_P4 if any bit in the ``flags`` is unrecognized * U_P5 if the ``order`` parameter is unsupported. * U_FUNCTION if functionality is not supported. * U_BUSY if page cannot be currently paged-out. h]h)}(hhh](h)}(hU_SUCCESS on success.h]h)}(hj h]hU_SUCCESS on success.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM!hj ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(h%U_PARAMETER if ``lpid`` is invalid.h]h)}(hj h](hU_PARAMETER if }(hj hhhNhNubj )}(h``lpid``h]hlpid}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj ubh is invalid.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM"hj ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(h(U_P2 if ``dest_ra`` is invalid.h]h)}(hjh](hU_P2 if }(hjhhhNhNubj )}(h ``dest_ra``h]hdest_ra}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh is invalid.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM#hjubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(h4U_P3 if the ``src_gpa`` address is invalid.h]h)}(hjFh](hU_P3 if the }(hjHhhhNhNubj )}(h ``src_gpa``h]hsrc_gpa}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjHubh address is invalid.}(hjHhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM$hjDubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(h9U_P4 if any bit in the ``flags`` is unrecognizedh]h)}(hjoh](h U_P4 if any bit in the }(hjqhhhNhNubj )}(h ``flags``h]hflags}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjqubh is unrecognized}(hjqhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM%hjmubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(h8U_P5 if the ``order`` parameter is unsupported.h]h)}(hjh](hU_P5 if the }(hjhhhNhNubj )}(h ``order``h]horder}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh parameter is unsupported.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM&hjubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(h0U_FUNCTION if functionality is not supported.h]h)}(hjh]h0U_FUNCTION if functionality is not supported.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM'hjubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(h5U_BUSY if page cannot be currently paged-out. h]h)}(h4U_BUSY if page cannot be currently paged-out.h]h4U_BUSY if page cannot be currently paged-out.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM(hjubah}(h]h ]h"]h$]h&]uh1hhj ubeh}(h]h ]h"]h$]h&]jY jZ uh1hhhhM!hj ubah}(h]h ]h"]h$]h&]uh1jhhhM!hj ubeh}(h]h ]h"]h$]h&]uh1jhhhMhj hhubeh}(h] return-valuesah ]h"]h$] return valuesah&]uh1hhjY hhhhhMj Kubh)}(hhh](h)}(h Descriptionh]h Description}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhM+ubj)}(hXEncrypt the contents of a secure-page and make it available to Hypervisor in a normal page. By default, the source page is unmapped from the SVM's partition- scoped page table. But the Hypervisor can provide a hint to the Ultravisor to retain the page mapping by setting the ``UV_SNAPSHOT`` flag in ``flags`` parameter. If the source page is already a shared page the call returns U_SUCCESS, without doing anything. h](h)}(h[Encrypt the contents of a secure-page and make it available to Hypervisor in a normal page.h]h[Encrypt the contents of a secure-page and make it available to Hypervisor in a normal page.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM-hjubh)}(hBy default, the source page is unmapped from the SVM's partition- scoped page table. But the Hypervisor can provide a hint to the Ultravisor to retain the page mapping by setting the ``UV_SNAPSHOT`` flag in ``flags`` parameter.h](hBy default, the source page is unmapped from the SVM’s partition- scoped page table. But the Hypervisor can provide a hint to the Ultravisor to retain the page mapping by setting the }(hj+hhhNhNubj )}(h``UV_SNAPSHOT``h]h UV_SNAPSHOT}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj+ubh flag in }(hj+hhhNhNubj )}(h ``flags``h]hflags}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1j hj+ubh parameter.}(hj+hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM0hjubh)}(h_If the source page is already a shared page the call returns U_SUCCESS, without doing anything.h]h_If the source page is already a shared page the call returns U_SUCCESS, without doing anything.}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM5hjubeh}(h]h ]h"]h$]h&]uh1jhhhM-hjhhubeh}(h] descriptionah ]h"]h$] descriptionah&]uh1hhjY hhhhhM+j Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjyhhhhhM9ubj)}(hX#. QEMU attempts to access an address belonging to the SVM but the page frame for that address is not mapped into QEMU's address space. In this case, the Hypervisor will allocate a page frame, map it into QEMU's address space and issue the ``UV_PAGE_OUT`` call to retrieve the encrypted contents of the page. #. When Ultravisor runs low on secure memory and it needs to page-out an LRU page. In this case, Ultravisor will issue the ``H_SVM_PAGE_OUT`` hypercall to the Hypervisor. The Hypervisor will then allocate a normal page and issue the ``UV_PAGE_OUT`` ultracall and the Ultravisor will encrypt and move the contents of the secure page into the normal page. #. When Hypervisor accesses SVM data, the Hypervisor requests the Ultravisor to transfer the corresponding page into a insecure page, which the Hypervisor can access. The data in the normal page will be encrypted though. h]henumerated_list)}(hhh](h)}(hX2QEMU attempts to access an address belonging to the SVM but the page frame for that address is not mapped into QEMU's address space. In this case, the Hypervisor will allocate a page frame, map it into QEMU's address space and issue the ``UV_PAGE_OUT`` call to retrieve the encrypted contents of the page. h]h)}(hX1QEMU attempts to access an address belonging to the SVM but the page frame for that address is not mapped into QEMU's address space. In this case, the Hypervisor will allocate a page frame, map it into QEMU's address space and issue the ``UV_PAGE_OUT`` call to retrieve the encrypted contents of the page.h](hQEMU attempts to access an address belonging to the SVM but the page frame for that address is not mapped into QEMU’s address space. In this case, the Hypervisor will allocate a page frame, map it into QEMU’s address space and issue the }(hjhhhNhNubj )}(h``UV_PAGE_OUT``h]h UV_PAGE_OUT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh5 call to retrieve the encrypted contents of the page.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM;hjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hX_When Ultravisor runs low on secure memory and it needs to page-out an LRU page. In this case, Ultravisor will issue the ``H_SVM_PAGE_OUT`` hypercall to the Hypervisor. The Hypervisor will then allocate a normal page and issue the ``UV_PAGE_OUT`` ultracall and the Ultravisor will encrypt and move the contents of the secure page into the normal page. h]h)}(hX^When Ultravisor runs low on secure memory and it needs to page-out an LRU page. In this case, Ultravisor will issue the ``H_SVM_PAGE_OUT`` hypercall to the Hypervisor. The Hypervisor will then allocate a normal page and issue the ``UV_PAGE_OUT`` ultracall and the Ultravisor will encrypt and move the contents of the secure page into the normal page.h](hxWhen Ultravisor runs low on secure memory and it needs to page-out an LRU page. In this case, Ultravisor will issue the }(hjhhhNhNubj )}(h``H_SVM_PAGE_OUT``h]hH_SVM_PAGE_OUT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh\ hypercall to the Hypervisor. The Hypervisor will then allocate a normal page and issue the }(hjhhhNhNubj )}(h``UV_PAGE_OUT``h]h UV_PAGE_OUT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubhi ultracall and the Ultravisor will encrypt and move the contents of the secure page into the normal page.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMAhjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hWhen Hypervisor accesses SVM data, the Hypervisor requests the Ultravisor to transfer the corresponding page into a insecure page, which the Hypervisor can access. The data in the normal page will be encrypted though. h]h)}(hWhen Hypervisor accesses SVM data, the Hypervisor requests the Ultravisor to transfer the corresponding page into a insecure page, which the Hypervisor can access. The data in the normal page will be encrypted though.h]hWhen Hypervisor accesses SVM data, the Hypervisor requests the Ultravisor to transfer the corresponding page into a insecure page, which the Hypervisor can access. The data in the normal page will be encrypted though.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMHhjubah}(h]h ]h"]h$]h&]uh1hhjubeh}(h]h ]h"]h$]h&]enumtypearabicprefixhsuffix.uh1jhjubah}(h]h ]h"]h$]h&]uh1jhhhM;hjyhhubeh}(h] use-casesah ]h"]h$] use casesah&]uh1hhjY hhhhhM9j Kubeh}(h] uv-page-outah ]h"] uv_page_outah$]h&]uh1hhj0 hhhhhM ubh)}(hhh](h)}(h UV_PAGE_INh]h UV_PAGE_IN}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj2hhhhhMNubj)}(hAMove the contents of a page from normal memory to secure memory. h]h)}(h@Move the contents of a page from normal memory to secure memory.h]h@Move the contents of a page from normal memory to secure memory.}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMPhjCubah}(h]h ]h"]h$]h&]uh1jhhhMPhj2hhubh)}(hhh](h)}(hSyntaxh]hSyntax}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj[hhhhhMSubj )}(hXLuint64_t ultracall(const uint64_t UV_PAGE_IN, uint16_t lpid, /* the LPAR ID */ uint64_t src_ra, /* source real address of page */ uint64_t dest_gpa, /* destination guest physical address */ uint64_t flags, /* flags */ uint64_t order) /* page size order */h]hXLuint64_t ultracall(const uint64_t UV_PAGE_IN, uint16_t lpid, /* the LPAR ID */ uint64_t src_ra, /* source real address of page */ uint64_t dest_gpa, /* destination guest physical address */ uint64_t flags, /* flags */ uint64_t order) /* page size order */}hjlsbah}(h]h ]h"]h$]h&]hhj j j j }uh1j hhhMUhj[hhubeh}(h]id1ah ]h"]h$]j ah&]uh1hhj2hhhhhMSj Kubh)}(hhh](h)}(h Return valuesh]h Return values}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhM_ubj)}(hXOne of the following values: * U_SUCCESS on success. * U_BUSY if page cannot be currently paged-in. * U_FUNCTION if functionality is not supported * U_PARAMETER if ``lpid`` is invalid. * U_P2 if ``src_ra`` is invalid. * U_P3 if the ``dest_gpa`` address is invalid. * U_P4 if any bit in the ``flags`` is unrecognized * U_P5 if the ``order`` parameter is unsupported. h](h)}(hOne of the following values:h]hOne of the following values:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMahjubj)}(hX* U_SUCCESS on success. * U_BUSY if page cannot be currently paged-in. * U_FUNCTION if functionality is not supported * U_PARAMETER if ``lpid`` is invalid. * U_P2 if ``src_ra`` is invalid. * U_P3 if the ``dest_gpa`` address is invalid. * U_P4 if any bit in the ``flags`` is unrecognized * U_P5 if the ``order`` parameter is unsupported. h]h)}(hhh](h)}(hU_SUCCESS on success.h]h)}(hjh]hU_SUCCESS on success.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMchjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h3U_BUSY if page cannot be currently paged-in.h]h)}(hjh]h3U_BUSY if page cannot be currently paged-in.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMdhjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h/U_FUNCTION if functionality is not supportedh]h)}(hjh]h/U_FUNCTION if functionality is not supported}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMehjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h%U_PARAMETER if ``lpid`` is invalid.h]h)}(hjh](hU_PARAMETER if }(hjhhhNhNubj )}(h``lpid``h]hlpid}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh is invalid.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMfhjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h'U_P2 if ``src_ra`` is invalid.h]h)}(hjh](hU_P2 if }(hjhhhNhNubj )}(h ``src_ra``h]hsrc_ra}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh is invalid.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMghjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h5U_P3 if the ``dest_gpa`` address is invalid.h]h)}(hjEh](hU_P3 if the }(hjGhhhNhNubj )}(h ``dest_gpa``h]hdest_gpa}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjGubh address is invalid.}(hjGhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhhjCubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h9U_P4 if any bit in the ``flags`` is unrecognizedh]h)}(hjnh](h U_P4 if any bit in the }(hjphhhNhNubj )}(h ``flags``h]hflags}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjpubh is unrecognized}(hjphhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMihjlubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h9U_P5 if the ``order`` parameter is unsupported. h]h)}(h8U_P5 if the ``order`` parameter is unsupported.h](hU_P5 if the }(hjhhhNhNubj )}(h ``order``h]horder}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh parameter is unsupported.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMjhjubah}(h]h ]h"]h$]h&]uh1hhjubeh}(h]h ]h"]h$]h&]jY jZ uh1hhhhMchjubah}(h]h ]h"]h$]h&]uh1jhhhMchjubeh}(h]h ]h"]h$]h&]uh1jhhhMahjhhubeh}(h]id2ah ]h"]h$]jah&]uh1hhj2hhhhhM_j Kubh)}(hhh](h)}(h Descriptionh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMmubj)}(hXMove the contents of the page identified by ``src_ra`` from normal memory to secure memory and map it to the guest physical address ``dest_gpa``. If `dest_gpa` refers to a shared address, map the page into the partition-scoped page-table of the SVM. If `dest_gpa` is not shared, copy the contents of the page into the corresponding secure page. Depending on the context, decrypt the page before being copied. The caller provides the attributes of the page through the ``flags`` parameter. Valid values for ``flags`` are: * CACHE_INHIBITED * CACHE_ENABLED * WRITE_PROTECTION The Hypervisor must pin the page in memory before making ``UV_PAGE_IN`` ultracall. h](h)}(hMove the contents of the page identified by ``src_ra`` from normal memory to secure memory and map it to the guest physical address ``dest_gpa``.h](h,Move the contents of the page identified by }(hjhhhNhNubj )}(h ``src_ra``h]hsrc_ra}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubhN from normal memory to secure memory and map it to the guest physical address }(hjhhhNhNubj )}(h ``dest_gpa``h]hdest_gpa}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMohjubh)}(hXIf `dest_gpa` refers to a shared address, map the page into the partition-scoped page-table of the SVM. If `dest_gpa` is not shared, copy the contents of the page into the corresponding secure page. Depending on the context, decrypt the page before being copied.h](hIf }(hjhhhNhNubhtitle_reference)}(h `dest_gpa`h]hdest_gpa}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1j'hjubh_ refers to a shared address, map the page into the partition-scoped page-table of the SVM. If }(hjhhhNhNubj()}(h `dest_gpa`h]hdest_gpa}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1j'hjubh is not shared, copy the contents of the page into the corresponding secure page. Depending on the context, decrypt the page before being copied.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMshjubh)}(hoThe caller provides the attributes of the page through the ``flags`` parameter. Valid values for ``flags`` are:h](h;The caller provides the attributes of the page through the }(hjShhhNhNubj )}(h ``flags``h]hflags}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjSubh parameter. Valid values for }(hjShhhNhNubj )}(h ``flags``h]hflags}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjSubh are:}(hjShhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMxhjubj)}(h5* CACHE_INHIBITED * CACHE_ENABLED * WRITE_PROTECTION h]h)}(hhh](h)}(hCACHE_INHIBITEDh]h)}(hjh]hCACHE_INHIBITED}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM{hjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h CACHE_ENABLEDh]h)}(hjh]h CACHE_ENABLED}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM|hjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hWRITE_PROTECTION h]h)}(hWRITE_PROTECTIONh]hWRITE_PROTECTION}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM}hjubah}(h]h ]h"]h$]h&]uh1hhjubeh}(h]h ]h"]h$]h&]jY jZ uh1hhhhM{hjubah}(h]h ]h"]h$]h&]uh1jhhhM{hjubh)}(hRThe Hypervisor must pin the page in memory before making ``UV_PAGE_IN`` ultracall.h](h9The Hypervisor must pin the page in memory before making }(hjhhhNhNubj )}(h``UV_PAGE_IN``h]h UV_PAGE_IN}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh ultracall.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubeh}(h]h ]h"]h$]h&]uh1jhhhMohjhhubeh}(h]id3ah ]h"]h$]jwah&]uh1hhj2hhhhhMmj Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhMubj)}(hX#. When a normal VM switches to secure mode, all its pages residing in normal memory, are moved into secure memory. #. When an SVM requests to share a page with Hypervisor the Hypervisor allocates a page and informs the Ultravisor. #. When an SVM accesses a secure page that has been paged-out, Ultravisor invokes the Hypervisor to locate the page. After locating the page, the Hypervisor uses UV_PAGE_IN to make the page available to Ultravisor. h]j)}(hhh](h)}(hqWhen a normal VM switches to secure mode, all its pages residing in normal memory, are moved into secure memory. h]h)}(hpWhen a normal VM switches to secure mode, all its pages residing in normal memory, are moved into secure memory.h]hpWhen a normal VM switches to secure mode, all its pages residing in normal memory, are moved into secure memory.}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj#ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(hqWhen an SVM requests to share a page with Hypervisor the Hypervisor allocates a page and informs the Ultravisor. h]h)}(hpWhen an SVM requests to share a page with Hypervisor the Hypervisor allocates a page and informs the Ultravisor.h]hpWhen an SVM requests to share a page with Hypervisor the Hypervisor allocates a page and informs the Ultravisor.}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj;ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(hWhen an SVM accesses a secure page that has been paged-out, Ultravisor invokes the Hypervisor to locate the page. After locating the page, the Hypervisor uses UV_PAGE_IN to make the page available to Ultravisor. h]h)}(hWhen an SVM accesses a secure page that has been paged-out, Ultravisor invokes the Hypervisor to locate the page. After locating the page, the Hypervisor uses UV_PAGE_IN to make the page available to Ultravisor.h]hWhen an SVM accesses a secure page that has been paged-out, Ultravisor invokes the Hypervisor to locate the page. After locating the page, the Hypervisor uses UV_PAGE_IN to make the page available to Ultravisor.}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjSubah}(h]h ]h"]h$]h&]uh1hhj ubeh}(h]h ]h"]h$]h&]jjjhjjuh1jhjubah}(h]h ]h"]h$]h&]uh1jhhhMhj hhubeh}(h]id4ah ]h"]h$]j(ah&]uh1hhj2hhhhhMj Kubeh}(h] uv-page-inah ]h"] uv_page_inah$]h&]uh1hhj0 hhhhhMNubh)}(hhh](h)}(h UV_PAGE_INVALh]h UV_PAGE_INVAL}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubj)}(h-Invalidate the Ultravisor mapping of a page. h]h)}(h,Invalidate the Ultravisor mapping of a page.h]h,Invalidate the Ultravisor mapping of a page.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhhhMhjhhubh)}(hhh](h)}(hSyntaxh]hSyntax}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubj )}(huint64_t ultracall(const uint64_t UV_PAGE_INVAL, uint16_t lpid, /* the LPAR ID */ uint64_t guest_pa, /* destination guest-physical-address */ uint64_t order) /* page size order */h]huint64_t ultracall(const uint64_t UV_PAGE_INVAL, uint16_t lpid, /* the LPAR ID */ uint64_t guest_pa, /* destination guest-physical-address */ uint64_t order) /* page size order */}hjsbah}(h]h ]h"]h$]h&]hhj j j j }uh1j hhhMhjhhubeh}(h]id5ah ]h"]h$]syntaxah&]uh1hhjhhhhhMj Kubh)}(hhh](h)}(h Return valuesh]h Return values}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubj)}(hX}One of the following values: * U_SUCCESS on success. * U_PARAMETER if ``lpid`` is invalid. * U_P2 if ``guest_pa`` is invalid (or corresponds to a secure page mapping). * U_P3 if the ``order`` is invalid. * U_FUNCTION if functionality is not supported. * U_BUSY if page cannot be currently invalidated. h](h)}(hOne of the following values:h]hOne of the following values:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubj)}(hXC* U_SUCCESS on success. * U_PARAMETER if ``lpid`` is invalid. * U_P2 if ``guest_pa`` is invalid (or corresponds to a secure page mapping). * U_P3 if the ``order`` is invalid. * U_FUNCTION if functionality is not supported. * U_BUSY if page cannot be currently invalidated. h]h)}(hhh](h)}(hU_SUCCESS on success.h]h)}(hjh]hU_SUCCESS on success.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h%U_PARAMETER if ``lpid`` is invalid.h]h)}(hjh](hU_PARAMETER if }(hjhhhNhNubj )}(h``lpid``h]hlpid}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh is invalid.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(haU_P2 if ``guest_pa`` is invalid (or corresponds to a secure page mapping).h]hdefinition_list)}(hhh]hdefinition_list_item)}(hSU_P2 if ``guest_pa`` is invalid (or corresponds to a secure page mapping).h](hterm)}(hDU_P2 if ``guest_pa`` is invalid (or corresponds to a secureh](hU_P2 if }(hjRhhhNhNubj )}(h ``guest_pa``h]hguest_pa}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjRubh' is invalid (or corresponds to a secure}(hjRhhhNhNubeh}(h]h ]h"]h$]h&]uh1jPhhhMhjLubh definition)}(hhh]h)}(hpage mapping).h]hpage mapping).}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjtubah}(h]h ]h"]h$]h&]uh1jrhjLubeh}(h]h ]h"]h$]h&]uh1jJhhhMhjGubah}(h]h ]h"]h$]h&]uh1jEhjAubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h*U_P3 if the ``order`` is invalid.h]h)}(hjh](hU_P3 if the }(hjhhhNhNubj )}(h ``order``h]horder}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh is invalid.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h0U_FUNCTION if functionality is not supported.h]h)}(hjh]h0U_FUNCTION if functionality is not supported.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h7U_BUSY if page cannot be currently invalidated. h]h)}(h6U_BUSY if page cannot be currently invalidated.h]h6U_BUSY if page cannot be currently invalidated.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1hhjubeh}(h]h ]h"]h$]h&]jY jZ uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhhhMhjubeh}(h]h ]h"]h$]h&]uh1jhhhMhjhhubeh}(h]id6ah ]h"]h$] return valuesah&]uh1hhjhhhhhMj Kubh)}(hhh](h)}(h Descriptionh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubj)}(hXHThis ultracall informs Ultravisor that the page mapping in Hypervisor corresponding to the given guest physical address has been invalidated and that the Ultravisor should not access the page. If the specified ``guest_pa`` corresponds to a secure page, Ultravisor will ignore the attempt to invalidate the page and return U_P2. h]h)}(hXGThis ultracall informs Ultravisor that the page mapping in Hypervisor corresponding to the given guest physical address has been invalidated and that the Ultravisor should not access the page. If the specified ``guest_pa`` corresponds to a secure page, Ultravisor will ignore the attempt to invalidate the page and return U_P2.h](hThis ultracall informs Ultravisor that the page mapping in Hypervisor corresponding to the given guest physical address has been invalidated and that the Ultravisor should not access the page. If the specified }(hj$hhhNhNubj )}(h ``guest_pa``h]hguest_pa}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj$ubhi corresponds to a secure page, Ultravisor will ignore the attempt to invalidate the page and return U_P2.}(hj$hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jhhhMhjhhubeh}(h]id7ah ]h"]h$] descriptionah&]uh1hhjhhhhhMj Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjRhhhhhMubj)}(h#. When a shared page is unmapped from the QEMU's page table, possibly because it is paged-out to disk, Ultravisor needs to know that the page should not be accessed from its side too. h]j)}(hhh]h)}(hWhen a shared page is unmapped from the QEMU's page table, possibly because it is paged-out to disk, Ultravisor needs to know that the page should not be accessed from its side too. h]h)}(hWhen a shared page is unmapped from the QEMU's page table, possibly because it is paged-out to disk, Ultravisor needs to know that the page should not be accessed from its side too.h]hWhen a shared page is unmapped from the QEMU’s page table, possibly because it is paged-out to disk, Ultravisor needs to know that the page should not be accessed from its side too.}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjjubah}(h]h ]h"]h$]h&]uh1hhjgubah}(h]h ]h"]h$]h&]jjjhjjuh1jhjcubah}(h]h ]h"]h$]h&]uh1jhhhMhjRhhubeh}(h]id8ah ]h"]h$] use casesah&]uh1hhjhhhhhMj Kubeh}(h] uv-page-invalah ]h"] uv_page_invalah$]h&]uh1hhj0 hhhhhMubh)}(hhh](h)}(h UV_WRITE_PATEh]h UV_WRITE_PATE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubj)}(hKValidate and write the partition table entry (PATE) for a given partition. h]h)}(hJValidate and write the partition table entry (PATE) for a given partition.h]hJValidate and write the partition table entry (PATE) for a given partition.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhhhMhjhhubh)}(hhh](h)}(hSyntaxh]hSyntax}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubj )}(huint64_t ultracall(const uint64_t UV_WRITE_PATE, uint32_t lpid, /* the LPAR ID */ uint64_t dw0 /* the first double word to write */ uint64_t dw1) /* the second double word to write */h]huint64_t ultracall(const uint64_t UV_WRITE_PATE, uint32_t lpid, /* the LPAR ID */ uint64_t dw0 /* the first double word to write */ uint64_t dw1) /* the second double word to write */}hjsbah}(h]h ]h"]h$]h&]hhj j j j }uh1j hhhMhjhhubeh}(h]id9ah ]h"]h$]syntaxah&]uh1hhjhhhhhMj Kubh)}(hhh](h)}(h Return valuesh]h Return values}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubj)}(hXOne of the following values: * U_SUCCESS on success. * U_BUSY if PATE cannot be currently written to. * U_FUNCTION if functionality is not supported. * U_PARAMETER if ``lpid`` is invalid. * U_P2 if ``dw0`` is invalid. * U_P3 if the ``dw1`` address is invalid. * U_PERMISSION if the Hypervisor is attempting to change the PATE of a secure virtual machine or if called from a context other than Hypervisor. h](h)}(hOne of the following values:h]hOne of the following values:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubj)}(hX* U_SUCCESS on success. * U_BUSY if PATE cannot be currently written to. * U_FUNCTION if functionality is not supported. * U_PARAMETER if ``lpid`` is invalid. * U_P2 if ``dw0`` is invalid. * U_P3 if the ``dw1`` address is invalid. * U_PERMISSION if the Hypervisor is attempting to change the PATE of a secure virtual machine or if called from a context other than Hypervisor. h]h)}(hhh](h)}(hU_SUCCESS on success.h]h)}(hjh]hU_SUCCESS on success.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h5U_BUSY if PATE cannot be currently written to.h]h)}(hj2h]h5U_BUSY if PATE cannot be currently written to.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj0ubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h0U_FUNCTION if functionality is not supported.h]h)}(hjIh]h0U_FUNCTION if functionality is not supported.}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjGubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h%U_PARAMETER if ``lpid`` is invalid.h]h)}(hj`h](hU_PARAMETER if }(hjbhhhNhNubj )}(h``lpid``h]hlpid}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1j hjbubh is invalid.}(hjbhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj^ubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h$U_P2 if ``dw0`` is invalid.h]h)}(hjh](hU_P2 if }(hjhhhNhNubj )}(h``dw0``h]hdw0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh is invalid.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h0U_P3 if the ``dw1`` address is invalid.h]h)}(hjh](hU_P3 if the }(hjhhhNhNubj )}(h``dw1``h]hdw1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh address is invalid.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hU_PERMISSION if the Hypervisor is attempting to change the PATE of a secure virtual machine or if called from a context other than Hypervisor. h]jF)}(hhh]jK)}(hU_PERMISSION if the Hypervisor is attempting to change the PATE of a secure virtual machine or if called from a context other than Hypervisor. h](jQ)}(h@U_PERMISSION if the Hypervisor is attempting to change the PATEh]h@U_PERMISSION if the Hypervisor is attempting to change the PATE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jPhhhMhjubjs)}(hhh]h)}(hNof a secure virtual machine or if called from a context other than Hypervisor.h]hNof a secure virtual machine or if called from a context other than Hypervisor.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jrhjubeh}(h]h ]h"]h$]h&]uh1jJhhhMhjubah}(h]h ]h"]h$]h&]uh1jEhjubah}(h]h ]h"]h$]h&]uh1hhjubeh}(h]h ]h"]h$]h&]jY jZ uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhhhMhjubeh}(h]h ]h"]h$]h&]uh1jhhhMhjhhubeh}(h]id10ah ]h"]h$] return valuesah&]uh1hhjhhhhhMj Kubh)}(hhh](h)}(h Descriptionh]h Description}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5hhhhhMubj)}(hValidate and write a LPID and its partition-table-entry for the given LPID. If the LPID is already allocated and initialized, this call results in changing the partition table entry. h]h)}(hValidate and write a LPID and its partition-table-entry for the given LPID. If the LPID is already allocated and initialized, this call results in changing the partition table entry.h]hValidate and write a LPID and its partition-table-entry for the given LPID. If the LPID is already allocated and initialized, this call results in changing the partition table entry.}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjFubah}(h]h ]h"]h$]h&]uh1jhhhMhj5hhubeh}(h]id11ah ]h"]h$] descriptionah&]uh1hhjhhhhhMj Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1hhjfhhhhhMubj)}(hX#. The Partition table resides in Secure memory and its entries, called PATE (Partition Table Entries), point to the partition- scoped page tables for the Hypervisor as well as each of the virtual machines (both secure and normal). The Hypervisor operates in partition 0 and its partition-scoped page tables reside in normal memory. #. This ultracall allows the Hypervisor to register the partition- scoped and process-scoped page table entries for the Hypervisor and other partitions (virtual machines) with the Ultravisor. #. If the value of the PATE for an existing partition (VM) changes, the TLB cache for the partition is flushed. #. The Hypervisor is responsible for allocating LPID. The LPID and its PATE entry are registered together. The Hypervisor manages the PATE entries for a normal VM and can change the PATE entry anytime. Ultravisor manages the PATE entries for an SVM and Hypervisor is not allowed to modify them. h]j)}(hhh](h)}(hXJThe Partition table resides in Secure memory and its entries, called PATE (Partition Table Entries), point to the partition- scoped page tables for the Hypervisor as well as each of the virtual machines (both secure and normal). The Hypervisor operates in partition 0 and its partition-scoped page tables reside in normal memory. h]h)}(hXIThe Partition table resides in Secure memory and its entries, called PATE (Partition Table Entries), point to the partition- scoped page tables for the Hypervisor as well as each of the virtual machines (both secure and normal). The Hypervisor operates in partition 0 and its partition-scoped page tables reside in normal memory.h]hXIThe Partition table resides in Secure memory and its entries, called PATE (Partition Table Entries), point to the partition- scoped page tables for the Hypervisor as well as each of the virtual machines (both secure and normal). The Hypervisor operates in partition 0 and its partition-scoped page tables reside in normal memory.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj~ubah}(h]h ]h"]h$]h&]uh1hhj{ubh)}(hThis ultracall allows the Hypervisor to register the partition- scoped and process-scoped page table entries for the Hypervisor and other partitions (virtual machines) with the Ultravisor. h]h)}(hThis ultracall allows the Hypervisor to register the partition- scoped and process-scoped page table entries for the Hypervisor and other partitions (virtual machines) with the Ultravisor.h]hThis ultracall allows the Hypervisor to register the partition- scoped and process-scoped page table entries for the Hypervisor and other partitions (virtual machines) with the Ultravisor.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1hhj{ubh)}(hmIf the value of the PATE for an existing partition (VM) changes, the TLB cache for the partition is flushed. h]h)}(hlIf the value of the PATE for an existing partition (VM) changes, the TLB cache for the partition is flushed.h]hlIf the value of the PATE for an existing partition (VM) changes, the TLB cache for the partition is flushed.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1hhj{ubh)}(hX%The Hypervisor is responsible for allocating LPID. The LPID and its PATE entry are registered together. The Hypervisor manages the PATE entries for a normal VM and can change the PATE entry anytime. Ultravisor manages the PATE entries for an SVM and Hypervisor is not allowed to modify them. h]h)}(hX$The Hypervisor is responsible for allocating LPID. The LPID and its PATE entry are registered together. The Hypervisor manages the PATE entries for a normal VM and can change the PATE entry anytime. Ultravisor manages the PATE entries for an SVM and Hypervisor is not allowed to modify them.h]hX$The Hypervisor is responsible for allocating LPID. The LPID and its PATE entry are registered together. The Hypervisor manages the PATE entries for a normal VM and can change the PATE entry anytime. Ultravisor manages the PATE entries for an SVM and Hypervisor is not allowed to modify them.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1hhj{ubeh}(h]h ]h"]h$]h&]jjjhjjuh1jhjwubah}(h]h ]h"]h$]h&]uh1jhhhMhjfhhubeh}(h]id12ah ]h"]h$] use casesah&]uh1hhjhhhhhMj Kubeh}(h] uv-write-pateah ]h"] uv_write_pateah$]h&]uh1hhj0 hhhhhMubh)}(hhh](h)}(h UV_RETURNh]h UV_RETURN}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubj)}(hReturn control from the Hypervisor back to the Ultravisor after processing an hypercall or interrupt that was forwarded (aka *reflected*) to the Hypervisor. h]h)}(hReturn control from the Hypervisor back to the Ultravisor after processing an hypercall or interrupt that was forwarded (aka *reflected*) to the Hypervisor.h](h}Return control from the Hypervisor back to the Ultravisor after processing an hypercall or interrupt that was forwarded (aka }(hjhhhNhNubhemphasis)}(h *reflected*h]h reflected}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh) to the Hypervisor.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jhhhMhjhhubh)}(hhh](h)}(hSyntaxh]hSyntax}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7hhhhhMubj )}(h,uint64_t ultracall(const uint64_t UV_RETURN)h]h,uint64_t ultracall(const uint64_t UV_RETURN)}hjHsbah}(h]h ]h"]h$]h&]hhj j j j }uh1j hhhMhj7hhubeh}(h]id13ah ]h"]h$]syntaxah&]uh1hhjhhhhhMj Kubh)}(hhh](h)}(h Return valuesh]h Return values}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj_hhhhhM ubj)}(h|This call never returns to Hypervisor on success. It returns U_INVALID if ultracall is not made from a Hypervisor context. h]h)}(h{This call never returns to Hypervisor on success. It returns U_INVALID if ultracall is not made from a Hypervisor context.h]h{This call never returns to Hypervisor on success. It returns U_INVALID if ultracall is not made from a Hypervisor context.}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjpubah}(h]h ]h"]h$]h&]uh1jhhhM hj_hhubeh}(h]id14ah ]h"]h$] return valuesah&]uh1hhjhhhhhM j Kubh)}(hhh](h)}(h Descriptionh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubj)}(hXWhen an SVM makes an hypercall or incurs some other exception, the Ultravisor usually forwards (aka *reflects*) the exceptions to the Hypervisor. After processing the exception, Hypervisor uses the ``UV_RETURN`` ultracall to return control back to the SVM. The expected register state on entry to this ultracall is: * Non-volatile registers are restored to their original values. * If returning from an hypercall, register R0 contains the return value (**unlike other ultracalls**) and, registers R4 through R12 contain any output values of the hypercall. * R3 contains the ultracall number, i.e UV_RETURN. * If returning with a synthesized interrupt, R2 contains the synthesized interrupt number. h](h)}(hXWhen an SVM makes an hypercall or incurs some other exception, the Ultravisor usually forwards (aka *reflects*) the exceptions to the Hypervisor. After processing the exception, Hypervisor uses the ``UV_RETURN`` ultracall to return control back to the SVM.h](hdWhen an SVM makes an hypercall or incurs some other exception, the Ultravisor usually forwards (aka }(hjhhhNhNubj)}(h *reflects*h]hreflects}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhY) the exceptions to the Hypervisor. After processing the exception, Hypervisor uses the }(hjhhhNhNubj )}(h ``UV_RETURN``h]h UV_RETURN}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh- ultracall to return control back to the SVM.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(h:The expected register state on entry to this ultracall is:h]h:The expected register state on entry to this ultracall is:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(hhh](h)}(h=Non-volatile registers are restored to their original values.h]h)}(hjh]h=Non-volatile registers are restored to their original values.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hIf returning from an hypercall, register R0 contains the return value (**unlike other ultracalls**) and, registers R4 through R12 contain any output values of the hypercall.h]h)}(hIf returning from an hypercall, register R0 contains the return value (**unlike other ultracalls**) and, registers R4 through R12 contain any output values of the hypercall.h](hGIf returning from an hypercall, register R0 contains the return value (}(hjhhhNhNubjx)}(h**unlike other ultracalls**h]hunlike other ultracalls}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jwhjubhK) and, registers R4 through R12 contain any output values of the hypercall.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h0R3 contains the ultracall number, i.e UV_RETURN.h]h)}(hj+h]h0R3 contains the ultracall number, i.e UV_RETURN.}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj)ubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hYIf returning with a synthesized interrupt, R2 contains the synthesized interrupt number. h]h)}(hXIf returning with a synthesized interrupt, R2 contains the synthesized interrupt number.h]hXIf returning with a synthesized interrupt, R2 contains the synthesized interrupt number.}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj@ubah}(h]h ]h"]h$]h&]uh1hhjubeh}(h]h ]h"]h$]h&]jY jZ uh1hhhhMhjubeh}(h]h ]h"]h$]h&]uh1jhhhMhjhhubeh}(h]id15ah ]h"]h$] descriptionah&]uh1hhjhhhhhMj Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hhjlhhhhhM!ubj)}(hX6#. Ultravisor relies on the Hypervisor to provide several services to the SVM such as processing hypercall and other exceptions. After processing the exception, Hypervisor uses UV_RETURN to return control back to the Ultravisor. #. Hypervisor has to use this ultracall to return control to the SVM. h]j)}(hhh](h)}(hUltravisor relies on the Hypervisor to provide several services to the SVM such as processing hypercall and other exceptions. After processing the exception, Hypervisor uses UV_RETURN to return control back to the Ultravisor. h]h)}(hUltravisor relies on the Hypervisor to provide several services to the SVM such as processing hypercall and other exceptions. After processing the exception, Hypervisor uses UV_RETURN to return control back to the Ultravisor.h]hUltravisor relies on the Hypervisor to provide several services to the SVM such as processing hypercall and other exceptions. After processing the exception, Hypervisor uses UV_RETURN to return control back to the Ultravisor.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM#hjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hDHypervisor has to use this ultracall to return control to the SVM. h]h)}(hBHypervisor has to use this ultracall to return control to the SVM.h]hBHypervisor has to use this ultracall to return control to the SVM.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM(hjubah}(h]h ]h"]h$]h&]uh1hhjubeh}(h]h ]h"]h$]h&]jjjhjjuh1jhj}ubah}(h]h ]h"]h$]h&]uh1jhhhM#hjlhhubeh}(h]id16ah ]h"]h$] use casesah&]uh1hhjhhhhhM!j Kubeh}(h] uv-returnah ]h"] uv_returnah$]h&]uh1hhj0 hhhhhMubh)}(hhh](h)}(hUV_REGISTER_MEM_SLOTh]hUV_REGISTER_MEM_SLOT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhM,ubj)}(h9Register an SVM address-range with specified properties. h]h)}(h8Register an SVM address-range with specified properties.h]h8Register an SVM address-range with specified properties.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM.hjubah}(h]h ]h"]h$]h&]uh1jhhhM.hjhhubh)}(hhh](h)}(hSyntaxh]hSyntax}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhM1ubj )}(hXruint64_t ultracall(const uint64_t UV_REGISTER_MEM_SLOT, uint64_t lpid, /* LPAR ID of the SVM */ uint64_t start_gpa, /* start guest physical address */ uint64_t size, /* size of address range in bytes */ uint64_t flags /* reserved for future expansion */ uint16_t slotid) /* slot identifier */h]hXruint64_t ultracall(const uint64_t UV_REGISTER_MEM_SLOT, uint64_t lpid, /* LPAR ID of the SVM */ uint64_t start_gpa, /* start guest physical address */ uint64_t size, /* size of address range in bytes */ uint64_t flags /* reserved for future expansion */ uint16_t slotid) /* slot identifier */}hj sbah}(h]h ]h"]h$]h&]hhj j j j }uh1j hhhM3hjhhubeh}(h]id17ah ]h"]h$]syntaxah&]uh1hhjhhhhhM1j Kubh)}(hhh](h)}(h Return valuesh]h Return values}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj!hhhhhM=ubj)}(hXOne of the following values: * U_SUCCESS on success. * U_PARAMETER if ``lpid`` is invalid. * U_P2 if ``start_gpa`` is invalid. * U_P3 if ``size`` is invalid. * U_P4 if any bit in the ``flags`` is unrecognized. * U_P5 if the ``slotid`` parameter is unsupported. * U_PERMISSION if called from context other than Hypervisor. * U_FUNCTION if functionality is not supported. h](h)}(hOne of the following values:h]hOne of the following values:}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM?hj2ubj)}(hX* U_SUCCESS on success. * U_PARAMETER if ``lpid`` is invalid. * U_P2 if ``start_gpa`` is invalid. * U_P3 if ``size`` is invalid. * U_P4 if any bit in the ``flags`` is unrecognized. * U_P5 if the ``slotid`` parameter is unsupported. * U_PERMISSION if called from context other than Hypervisor. * U_FUNCTION if functionality is not supported. h]h)}(hhh](h)}(hU_SUCCESS on success.h]h)}(hjMh]hU_SUCCESS on success.}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMAhjKubah}(h]h ]h"]h$]h&]uh1hhjHubh)}(h%U_PARAMETER if ``lpid`` is invalid.h]h)}(hjdh](hU_PARAMETER if }(hjfhhhNhNubj )}(h``lpid``h]hlpid}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjfubh is invalid.}(hjfhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMBhjbubah}(h]h ]h"]h$]h&]uh1hhjHubh)}(h*U_P2 if ``start_gpa`` is invalid.h]h)}(hjh](hU_P2 if }(hjhhhNhNubj )}(h ``start_gpa``h]h start_gpa}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh is invalid.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMChjubah}(h]h ]h"]h$]h&]uh1hhjHubh)}(h%U_P3 if ``size`` is invalid.h]h)}(hjh](hU_P3 if }(hjhhhNhNubj )}(h``size``h]hsize}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh is invalid.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMDhjubah}(h]h ]h"]h$]h&]uh1hhjHubh)}(h:U_P4 if any bit in the ``flags`` is unrecognized.h]h)}(hjh](h U_P4 if any bit in the }(hjhhhNhNubj )}(h ``flags``h]hflags}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh is unrecognized.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMEhjubah}(h]h ]h"]h$]h&]uh1hhjHubh)}(h9U_P5 if the ``slotid`` parameter is unsupported.h]h)}(hjh](hU_P5 if the }(hj hhhNhNubj )}(h ``slotid``h]hslotid}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hj ubh parameter is unsupported.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMFhjubah}(h]h ]h"]h$]h&]uh1hhjHubh)}(h;U_PERMISSION if called from context other than Hypervisor.h]h)}(hj1h]h;U_PERMISSION if called from context other than Hypervisor.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMGhj/ubah}(h]h ]h"]h$]h&]uh1hhjHubh)}(h2U_FUNCTION if functionality is not supported. h]h)}(h0U_FUNCTION if functionality is not supported.h]h0U_FUNCTION if functionality is not supported.}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMHhjFubah}(h]h ]h"]h$]h&]uh1hhjHubeh}(h]h ]h"]h$]h&]jY jZ uh1hhhhMAhjDubah}(h]h ]h"]h$]h&]uh1jhhhMAhj2ubeh}(h]h ]h"]h$]h&]uh1jhhhM?hj!hhubeh}(h]id18ah ]h"]h$] return valuesah&]uh1hhjhhhhhM=j Kubh)}(hhh](h)}(h Descriptionh]h Description}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjxhhhhhMLubj)}(hRegister a memory range for an SVM. The memory range starts at the guest physical address ``start_gpa`` and is ``size`` bytes long. h]h)}(hRegister a memory range for an SVM. The memory range starts at the guest physical address ``start_gpa`` and is ``size`` bytes long.h](h[Register a memory range for an SVM. The memory range starts at the guest physical address }(hjhhhNhNubj )}(h ``start_gpa``h]h start_gpa}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh and is }(hjhhhNhNubj )}(h``size``h]hsize}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh bytes long.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMNhjubah}(h]h ]h"]h$]h&]uh1jhhhMNhjxhhubeh}(h]id19ah ]h"]h$] descriptionah&]uh1hhjhhhhhMLj Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMRubj)}(hXl#. When a virtual machine goes secure, all the memory slots managed by the Hypervisor move into secure memory. The Hypervisor iterates through each of memory slots, and registers the slot with Ultravisor. Hypervisor may discard some slots such as those used for firmware (SLOF). #. When new memory is hot-plugged, a new memory slot gets registered. h]j)}(hhh](h)}(hXWhen a virtual machine goes secure, all the memory slots managed by the Hypervisor move into secure memory. The Hypervisor iterates through each of memory slots, and registers the slot with Ultravisor. Hypervisor may discard some slots such as those used for firmware (SLOF). h]h)}(hXWhen a virtual machine goes secure, all the memory slots managed by the Hypervisor move into secure memory. The Hypervisor iterates through each of memory slots, and registers the slot with Ultravisor. Hypervisor may discard some slots such as those used for firmware (SLOF).h]hXWhen a virtual machine goes secure, all the memory slots managed by the Hypervisor move into secure memory. The Hypervisor iterates through each of memory slots, and registers the slot with Ultravisor. Hypervisor may discard some slots such as those used for firmware (SLOF).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMUhjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hDWhen new memory is hot-plugged, a new memory slot gets registered. h]h)}(hBWhen new memory is hot-plugged, a new memory slot gets registered.h]hBWhen new memory is hot-plugged, a new memory slot gets registered.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM[hjubah}(h]h ]h"]h$]h&]uh1hhjubeh}(h]h ]h"]h$]h&]jjjhjjuh1jhjubah}(h]h ]h"]h$]h&]uh1jhhhMUhjhhubeh}(h]id20ah ]h"]h$] use casesah&]uh1hhjhhhhhMRj Kubeh}(h]uv-register-mem-slotah ]h"]uv_register_mem_slotah$]h&]uh1hhj0 hhhhhM,ubh)}(hhh](h)}(hUV_UNREGISTER_MEM_SLOTh]hUV_UNREGISTER_MEM_SLOT}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj1hhhhhM_ubj)}(h[Unregister an SVM address-range that was previously registered using UV_REGISTER_MEM_SLOT. h]h)}(hZUnregister an SVM address-range that was previously registered using UV_REGISTER_MEM_SLOT.h]hZUnregister an SVM address-range that was previously registered using UV_REGISTER_MEM_SLOT.}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMahjBubah}(h]h ]h"]h$]h&]uh1jhhhMahj1hhubh)}(hhh](h)}(hSyntaxh]hSyntax}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjZhhhhhMeubj )}(huint64_t ultracall(const uint64_t UV_UNREGISTER_MEM_SLOT, uint64_t lpid, /* LPAR ID of the SVM */ uint64_t slotid) /* reservation slotid */h]huint64_t ultracall(const uint64_t UV_UNREGISTER_MEM_SLOT, uint64_t lpid, /* LPAR ID of the SVM */ uint64_t slotid) /* reservation slotid */}hjksbah}(h]h ]h"]h$]h&]hhj j j j }uh1j hhhMghjZhhubeh}(h]id21ah ]h"]h$]syntaxah&]uh1hhj1hhhhhMej Kubh)}(hhh](h)}(h Return valuesh]h Return values}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMnubj)}(hXOne of the following values: * U_SUCCESS on success. * U_FUNCTION if functionality is not supported. * U_PARAMETER if ``lpid`` is invalid. * U_P2 if ``slotid`` is invalid. * U_PERMISSION if called from context other than Hypervisor. h](h)}(hOne of the following values:h]hOne of the following values:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMphjubj)}(h* U_SUCCESS on success. * U_FUNCTION if functionality is not supported. * U_PARAMETER if ``lpid`` is invalid. * U_P2 if ``slotid`` is invalid. * U_PERMISSION if called from context other than Hypervisor. h]h)}(hhh](h)}(hU_SUCCESS on success.h]h)}(hjh]hU_SUCCESS on success.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMrhjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h0U_FUNCTION if functionality is not supported.h]h)}(hjh]h0U_FUNCTION if functionality is not supported.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMshjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h%U_PARAMETER if ``lpid`` is invalid.h]h)}(hjh](hU_PARAMETER if }(hjhhhNhNubj )}(h``lpid``h]hlpid}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh is invalid.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMthjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(h'U_P2 if ``slotid`` is invalid.h]h)}(hjh](hU_P2 if }(hjhhhNhNubj )}(h ``slotid``h]hslotid}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh is invalid.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMuhjubah}(h]h ]h"]h$]h&]uh1hhjubh)}(hhhhhhMubj)}(hXOne of the following values: * U_SUCCESS on success. * U_FUNCTION if functionality is not supported. * U_PARAMETER if ``lpid`` is invalid. * U_INVALID if VM is not secure. * U_PERMISSION if not called from a Hypervisor context. h](h)}(hOne of the following values:h]hOne of the following values:}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjOubj)}(h* U_SUCCESS on success. * U_FUNCTION if functionality is not supported. * U_PARAMETER if ``lpid`` is invalid. * U_INVALID if VM is not secure. * U_PERMISSION if not called from a Hypervisor context. h]h)}(hhh](h)}(hU_SUCCESS on success.h]h)}(hjjh]hU_SUCCESS on success.}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhubah}(h]h ]h"]h$]h&]uh1hhjeubh)}(h0U_FUNCTION if functionality is not supported.h]h)}(hjh]h0U_FUNCTION if functionality is not supported.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1hhjeubh)}(h%U_PARAMETER if ``lpid`` is invalid.h]h)}(hjh](hU_PARAMETER if }(hjhhhNhNubj )}(h``lpid``h]hlpid}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh is invalid.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1hhjeubh)}(h"U_INVALID if VM is not secure.h]h)}(hjh]h"U_INVALID if VM is not secure.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1hhjeubh)}(h7U_PERMISSION if not called from a Hypervisor context. h]h)}(h6U_PERMISSION if not called from a Hypervisor context.h]h6U_PERMISSION if not called from a Hypervisor context.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1hhjeubeh}(h]h ]h"]h$]h&]jY jZ uh1hhhhMhjaubah}(h]h ]h"]h$]h&]uh1jhhhMhjOubeh}(h]h ]h"]h$]h&]uh1jhhhMhj>hhubeh}(h]id26ah ]h"]h$] return valuesah&]uh1hhjhhhhhMj Kubh)}(hhh](h)}(h Descriptionh]h Description}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubj)}(h0Terminate an SVM and release all its resources. h]h)}(h/Terminate an SVM and release all its resources.h]h/Terminate an SVM and release all its resources.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhhhMhjhhubeh}(h]id27ah ]h"]h$] descriptionah&]uh1hhjhhhhhMj Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj9hhhhhMubj)}(h2#. Called by Hypervisor when terminating an SVM. h]j)}(hhh]h)}(h/Called by Hypervisor when terminating an SVM. h]h)}(h-Called by Hypervisor when terminating an SVM.h]h-Called by Hypervisor when terminating an SVM.}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjQubah}(h]h ]h"]h$]h&]uh1hhjNubah}(h]h ]h"]h$]h&]jjjhjjuh1jhjJubah}(h]h ]h"]h$]h&]uh1jhhhMhj9hhubeh}(h]id28ah ]h"]h$] use casesah&]uh1hhjhhhhhMj Kubeh}(h]uv-svm-terminateah ]h"]uv_svm_terminateah$]h&]uh1hhj0 hhhhhMubeh}(h]jah ]h"]ultracalls used by hypervisorah$]h&]uh1hhj hhhhhMubh)}(hhh](h)}(hUltracalls used by SVMh]hUltracalls used by SVM}(hjhhhNhNubah}(h]h ]h"]h$]h&]hjuh1hhjhhhhhMubh)}(hhh](h)}(h UV_SHARE_PAGEh]h UV_SHARE_PAGE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubj)}(h9Share a set of guest physical pages with the Hypervisor. h]h)}(h8Share a set of guest physical pages with the Hypervisor.h]h8Share a set of guest physical pages with the Hypervisor.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhhhMhjhhubh)}(hhh](h)}(hSyntaxh]hSyntax}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubj )}(huint64_t ultracall(const uint64_t UV_SHARE_PAGE, uint64_t gfn, /* guest page frame number */ uint64_t num) /* number of pages of size PAGE_SIZE */h]huint64_t ultracall(const uint64_t UV_SHARE_PAGE, uint64_t gfn, /* guest page frame number */ uint64_t num) /* number of pages of size PAGE_SIZE */}hjsbah}(h]h ]h"]h$]h&]hhj j j j }uh1j hhhMhjhhubeh}(h]id29ah ]h"]h$]syntaxah&]uh1hhjhhhhhMj Kubh)}(hhh](h)}(h Return valuesh]h Return values}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubj)}(hOne of the following values: * U_SUCCESS on success. * U_FUNCTION if functionality is not supported. * U_INVALID if the VM is not secure. * U_PARAMETER if ``gfn`` is invalid. * U_P2 if ``num`` is invalid. h](h)}(hOne of the following values:h]hOne of the following values:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubj)}(h* U_SUCCESS on success. * U_FUNCTION if functionality is not supported. * U_INVALID if the VM is not secure. * U_PARAMETER if ``gfn`` is invalid. * U_P2 if ``num`` is invalid. h]h)}(hhh](h)}(hU_SUCCESS on success.h]h)}(hj h]hU_SUCCESS on success.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(h0U_FUNCTION if functionality is not supported.h]h)}(hj1 h]h0U_FUNCTION if functionality is not supported.}(hj3 hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj/ ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(h&U_INVALID if the VM is not secure.h]h)}(hjH h]h&U_INVALID if the VM is not secure.}(hjJ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjF ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(h$U_PARAMETER if ``gfn`` is invalid.h]h)}(hj_ h](hU_PARAMETER if }(hja hhhNhNubj )}(h``gfn``h]hgfn}(hjh hhhNhNubah}(h]h ]h"]h$]h&]uh1j hja ubh is invalid.}(hja hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj] ubah}(h]h ]h"]h$]h&]uh1hhj ubh)}(h%U_P2 if ``num`` is invalid. h]h)}(h$U_P2 if ``num`` is invalid.h](hU_P2 if }(hj hhhNhNubj )}(h``num``h]hnum}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj ubh is invalid.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1hhj ubeh}(h]h ]h"]h$]h&]jY jZ uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jhhhMhjubeh}(h]h ]h"]h$]h&]uh1jhhhMhjhhubeh}(h]id30ah ]h"]h$] return valuesah&]uh1hhjhhhhhMj Kubh)}(hhh](h)}(h Descriptionh]h Description}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhMubj)}(hXShare the ``num`` pages starting at guest physical frame number ``gfn`` with the Hypervisor. Assume page size is PAGE_SIZE bytes. Zero the pages before returning. If the address is already backed by a secure page, unmap the page and back it with an insecure page, with the help of the Hypervisor. If it is not backed by any page yet, mark the PTE as insecure and back it with an insecure page when the address is accessed. If it is already backed by an insecure page, zero the page and return. h](h)}(hShare the ``num`` pages starting at guest physical frame number ``gfn`` with the Hypervisor. Assume page size is PAGE_SIZE bytes. Zero the pages before returning.h](h Share the }(hj hhhNhNubj )}(h``num``h]hnum}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj ubh/ pages starting at guest physical frame number }(hj hhhNhNubj )}(h``gfn``h]hgfn}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj ubh[ with the Hypervisor. Assume page size is PAGE_SIZE bytes. Zero the pages before returning.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj ubh)}(hXJIf the address is already backed by a secure page, unmap the page and back it with an insecure page, with the help of the Hypervisor. If it is not backed by any page yet, mark the PTE as insecure and back it with an insecure page when the address is accessed. If it is already backed by an insecure page, zero the page and return.h]hXJIf the address is already backed by a secure page, unmap the page and back it with an insecure page, with the help of the Hypervisor. If it is not backed by any page yet, mark the PTE as insecure and back it with an insecure page when the address is accessed. If it is already backed by an insecure page, zero the page and return.}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubeh}(h]h ]h"]h$]h&]uh1jhhhMhj hhubeh}(h]id31ah ]h"]h$] descriptionah&]uh1hhjhhhhhMj Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hj0!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj-!hhhhhMubj)}(hX#. The Hypervisor cannot access the SVM pages since they are backed by secure pages. Hence an SVM must explicitly request Ultravisor for pages it can share with Hypervisor. #. Shared pages are needed to support virtio and Virtual Processor Area (VPA) in SVMs. h]j)}(hhh](h)}(hThe Hypervisor cannot access the SVM pages since they are backed by secure pages. Hence an SVM must explicitly request Ultravisor for pages it can share with Hypervisor. h]h)}(hThe Hypervisor cannot access the SVM pages since they are backed by secure pages. Hence an SVM must explicitly request Ultravisor for pages it can share with Hypervisor.h]hThe Hypervisor cannot access the SVM pages since they are backed by secure pages. Hence an SVM must explicitly request Ultravisor for pages it can share with Hypervisor.}(hjI!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjE!ubah}(h]h ]h"]h$]h&]uh1hhjB!ubh)}(hUShared pages are needed to support virtio and Virtual Processor Area (VPA) in SVMs. h]h)}(hSShared pages are needed to support virtio and Virtual Processor Area (VPA) in SVMs.h]hSShared pages are needed to support virtio and Virtual Processor Area (VPA) in SVMs.}(hja!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj]!ubah}(h]h ]h"]h$]h&]uh1hhjB!ubeh}(h]h ]h"]h$]h&]jjjhjjuh1jhj>!ubah}(h]h ]h"]h$]h&]uh1jhhhMhj-!hhubeh}(h]id32ah ]h"]h$] use casesah&]uh1hhjhhhhhMj Kubeh}(h] uv-share-pageah ]h"] uv_share_pageah$]h&]uh1hhjhhhhhMubh)}(hhh](h)}(hUV_UNSHARE_PAGEh]hUV_UNSHARE_PAGE}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj!hhhhhMubj)}(h0Restore a shared SVM page to its initial state. h]h)}(h/Restore a shared SVM page to its initial state.h]h/Restore a shared SVM page to its initial state.}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj!ubah}(h]h ]h"]h$]h&]uh1jhhhMhj!hhubh)}(hhh](h)}(hSyntaxh]hSyntax}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj!hhhhhMubj )}(huint64_t ultracall(const uint64_t UV_UNSHARE_PAGE, uint64_t gfn, /* guest page frame number */ uint73 num) /* number of pages of size PAGE_SIZE*/h]huint64_t ultracall(const uint64_t UV_UNSHARE_PAGE, uint64_t gfn, /* guest page frame number */ uint73 num) /* number of pages of size PAGE_SIZE*/}hj!sbah}(h]h ]h"]h$]h&]hhj j j j }uh1j hhhMhj!hhubeh}(h]id33ah ]h"]h$]syntaxah&]uh1hhj!hhhhhMj Kubh)}(hhh](h)}(h Return valuesh]h Return values}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj!hhhhhMubj)}(hOne of the following values: * U_SUCCESS on success. * U_FUNCTION if functionality is not supported. * U_INVALID if VM is not secure. * U_PARAMETER if ``gfn`` is invalid. * U_P2 if ``num`` is invalid. h](h)}(hOne of the following values:h]hOne of the following values:}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj!ubj)}(h* U_SUCCESS on success. * U_FUNCTION if functionality is not supported. * U_INVALID if VM is not secure. * U_PARAMETER if ``gfn`` is invalid. * U_P2 if ``num`` is invalid. h]h)}(hhh](h)}(hU_SUCCESS on success.h]h)}(hj"h]hU_SUCCESS on success.}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj "ubah}(h]h ]h"]h$]h&]uh1hhj "ubh)}(h0U_FUNCTION if functionality is not supported.h]h)}(hj%"h]h0U_FUNCTION if functionality is not supported.}(hj'"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj#"ubah}(h]h ]h"]h$]h&]uh1hhj "ubh)}(h"U_INVALID if VM is not secure.h]h)}(hj<"h]h"U_INVALID if VM is not secure.}(hj>"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj:"ubah}(h]h ]h"]h$]h&]uh1hhj "ubh)}(h$U_PARAMETER if ``gfn`` is invalid.h]h)}(hjS"h](hU_PARAMETER if }(hjU"hhhNhNubj )}(h``gfn``h]hgfn}(hj\"hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjU"ubh is invalid.}(hjU"hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjQ"ubah}(h]h ]h"]h$]h&]uh1hhj "ubh)}(h%U_P2 if ``num`` is invalid. h]h)}(h$U_P2 if ``num`` is invalid.h](hU_P2 if }(hj~"hhhNhNubj )}(h``num``h]hnum}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj~"ubh is invalid.}(hj~"hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjz"ubah}(h]h ]h"]h$]h&]uh1hhj "ubeh}(h]h ]h"]h$]h&]jY jZ uh1hhhhMhj"ubah}(h]h ]h"]h$]h&]uh1jhhhMhj!ubeh}(h]h ]h"]h$]h&]uh1jhhhMhj!hhubeh}(h]id34ah ]h"]h$] return valuesah&]uh1hhj!hhhhhMj Kubh)}(hhh](h)}(h Descriptionh]h Description}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj"hhhhhMubj)}(hXStop sharing ``num`` pages starting at ``gfn`` with the Hypervisor. Assume that the page size is PAGE_SIZE. Zero the pages before returning. If the address is already backed by an insecure page, unmap the page and back it with a secure page. Inform the Hypervisor to release reference to its shared page. If the address is not backed by a page yet, mark the PTE as secure and back it with a secure page when that address is accessed. If it is already backed by an secure page zero the page and return. h](h)}(hStop sharing ``num`` pages starting at ``gfn`` with the Hypervisor. Assume that the page size is PAGE_SIZE. Zero the pages before returning.h](h Stop sharing }(hj"hhhNhNubj )}(h``num``h]hnum}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj"ubh pages starting at }(hj"hhhNhNubj )}(h``gfn``h]hgfn}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj"ubh^ with the Hypervisor. Assume that the page size is PAGE_SIZE. Zero the pages before returning.}(hj"hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj"ubh)}(hXhIf the address is already backed by an insecure page, unmap the page and back it with a secure page. Inform the Hypervisor to release reference to its shared page. If the address is not backed by a page yet, mark the PTE as secure and back it with a secure page when that address is accessed. If it is already backed by an secure page zero the page and return.h]hXhIf the address is already backed by an insecure page, unmap the page and back it with a secure page. Inform the Hypervisor to release reference to its shared page. If the address is not backed by a page yet, mark the PTE as secure and back it with a secure page when that address is accessed. If it is already backed by an secure page zero the page and return.}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj"ubeh}(h]h ]h"]h$]h&]uh1jhhhMhj"hhubeh}(h]id35ah ]h"]h$] descriptionah&]uh1hhj!hhhhhMj Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hj$#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj!#hhhhhMubj)}(h>#. The SVM may decide to unshare a page from the Hypervisor. h]j)}(hhh]h)}(h;The SVM may decide to unshare a page from the Hypervisor. h]h)}(h9The SVM may decide to unshare a page from the Hypervisor.h]h9The SVM may decide to unshare a page from the Hypervisor.}(hj=#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj9#ubah}(h]h ]h"]h$]h&]uh1hhj6#ubah}(h]h ]h"]h$]h&]jjjhjjuh1jhj2#ubah}(h]h ]h"]h$]h&]uh1jhhhMhj!#hhubeh}(h]id36ah ]h"]h$] use casesah&]uh1hhj!hhhhhMj Kubeh}(h]uv-unshare-pageah ]h"]uv_unshare_pageah$]h&]uh1hhjhhhhhMubh)}(hhh](h)}(hUV_UNSHARE_ALL_PAGESh]hUV_UNSHARE_ALL_PAGES}(hjp#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjm#hhhhhM ubj)}(h6Unshare all pages the SVM has shared with Hypervisor. h]h)}(h5Unshare all pages the SVM has shared with Hypervisor.h]h5Unshare all pages the SVM has shared with Hypervisor.}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hj~#ubah}(h]h ]h"]h$]h&]uh1jhhhM hjm#hhubh)}(hhh](h)}(hSyntaxh]hSyntax}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#hhhhhMubj )}(h7uint64_t ultracall(const uint64_t UV_UNSHARE_ALL_PAGES)h]h7uint64_t ultracall(const uint64_t UV_UNSHARE_ALL_PAGES)}hj#sbah}(h]h ]h"]h$]h&]hhj j j j }uh1j hhhMhj#hhubeh}(h]id37ah ]h"]h$]syntaxah&]uh1hhjm#hhhhhMj Kubh)}(hhh](h)}(h Return valuesh]h Return values}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#hhhhhMubj)}(hOne of the following values: * U_SUCCESS on success. * U_FUNCTION if functionality is not supported. * U_INVAL if VM is not secure. h](h)}(hOne of the following values:h]hOne of the following values:}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj#ubj)}(ht* U_SUCCESS on success. * U_FUNCTION if functionality is not supported. * U_INVAL if VM is not secure. h]h)}(hhh](h)}(hU_SUCCESS on success.h]h)}(hj#h]hU_SUCCESS on success.}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj#ubah}(h]h ]h"]h$]h&]uh1hhj#ubh)}(h0U_FUNCTION if functionality is not supported.h]h)}(hj$h]h0U_FUNCTION if functionality is not supported.}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj#ubah}(h]h ]h"]h$]h&]uh1hhj#ubh)}(h#U_INVAL if VM is not secure. h]h)}(h"U_INVAL if VM is not secure.h]h"U_INVAL if VM is not secure.}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj$ubah}(h]h ]h"]h$]h&]uh1hhj#ubeh}(h]h ]h"]h$]h&]jY jZ uh1hhhhMhj#ubah}(h]h ]h"]h$]h&]uh1jhhhMhj#ubeh}(h]h ]h"]h$]h&]uh1jhhhMhj#hhubeh}(h]id38ah ]h"]h$] return valuesah&]uh1hhjm#hhhhhMj Kubh)}(hhh](h)}(h Descriptionh]h Description}(hjK$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjH$hhhhhMubj)}(hX\Unshare all shared pages from the Hypervisor. All unshared pages are zeroed on return. Only pages explicitly shared by the SVM with the Hypervisor (using UV_SHARE_PAGE ultracall) are unshared. Ultravisor may internally share some pages with the Hypervisor without explicit request from the SVM. These pages will not be unshared by this ultracall. h]h)}(hX[Unshare all shared pages from the Hypervisor. All unshared pages are zeroed on return. Only pages explicitly shared by the SVM with the Hypervisor (using UV_SHARE_PAGE ultracall) are unshared. Ultravisor may internally share some pages with the Hypervisor without explicit request from the SVM. These pages will not be unshared by this ultracall.h]hX[Unshare all shared pages from the Hypervisor. All unshared pages are zeroed on return. Only pages explicitly shared by the SVM with the Hypervisor (using UV_SHARE_PAGE ultracall) are unshared. Ultravisor may internally share some pages with the Hypervisor without explicit request from the SVM. These pages will not be unshared by this ultracall.}(hj]$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjY$ubah}(h]h ]h"]h$]h&]uh1jhhhM hjH$hhubeh}(h]id39ah ]h"]h$] descriptionah&]uh1hhjm#hhhhhMj Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hj|$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjy$hhhhhM(ubj)}(hu#. This call is needed when ``kexec`` is used to boot a different kernel. It may also be needed during SVM reset. h]j)}(hhh]h)}(hoThis call is needed when ``kexec`` is used to boot a different kernel. It may also be needed during SVM reset. h]h)}(hnThis call is needed when ``kexec`` is used to boot a different kernel. It may also be needed during SVM reset.h](hThis call is needed when }(hj$hhhNhNubj )}(h ``kexec``h]hkexec}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj$ubhL is used to boot a different kernel. It may also be needed during SVM reset.}(hj$hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM*hj$ubah}(h]h ]h"]h$]h&]uh1hhj$ubah}(h]h ]h"]h$]h&]jjjhjjuh1jhj$ubah}(h]h ]h"]h$]h&]uh1jhhhM*hjy$hhubeh}(h]id40ah ]h"]h$] use casesah&]uh1hhjm#hhhhhM(j Kubeh}(h]uv-unshare-all-pagesah ]h"]uv_unshare_all_pagesah$]h&]uh1hhjhhhhhM ubh)}(hhh](h)}(hUV_ESMh]hUV_ESM}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj$hhhhhM.ubj)}(h2Secure the virtual machine (*enter secure mode*). h]h)}(h1Secure the virtual machine (*enter secure mode*).h](hSecure the virtual machine (}(hj$hhhNhNubj)}(h*enter secure mode*h]henter secure mode}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj$ubh).}(hj$hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM0hj$ubah}(h]h ]h"]h$]h&]uh1jhhhM0hj$hhubh)}(hhh](h)}(hSyntaxh]hSyntax}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hhhhhM3ubj )}(huint64_t ultracall(const uint64_t UV_ESM, uint64_t esm_blob_addr, /* location of the ESM blob */ unint64_t fdt) /* Flattened device tree */h]huint64_t ultracall(const uint64_t UV_ESM, uint64_t esm_blob_addr, /* location of the ESM blob */ unint64_t fdt) /* Flattened device tree */}hj#%sbah}(h]h ]h"]h$]h&]hhj j j j }uh1j hhhM5hj%hhubeh}(h]id41ah ]h"]h$]syntaxah&]uh1hhj$hhhhhM3j Kubh)}(hhh](h)}(h Return valuesh]h Return values}(hj=%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj:%hhhhhM<ubj)}(hXOne of the following values: * U_SUCCESS on success (including if VM is already secure). * U_FUNCTION if functionality is not supported. * U_INVALID if VM is not secure. * U_PARAMETER if ``esm_blob_addr`` is invalid. * U_P2 if ``fdt`` is invalid. * U_PERMISSION if any integrity checks fail. * U_RETRY insufficient memory to create SVM. * U_NO_KEY symmetric key unavailable. h](h)}(hOne of the following values:h]hOne of the following values:}(hjO%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM>hjK%ubj)}(hX|* U_SUCCESS on success (including if VM is already secure). * U_FUNCTION if functionality is not supported. * U_INVALID if VM is not secure. * U_PARAMETER if ``esm_blob_addr`` is invalid. * U_P2 if ``fdt`` is invalid. * U_PERMISSION if any integrity checks fail. * U_RETRY insufficient memory to create SVM. * U_NO_KEY symmetric key unavailable. h]h)}(hhh](h)}(h=U_SUCCESS on success (including if VM is already secure).h]h)}(hjf%h]h=U_SUCCESS on success (including if VM is already secure).}(hjh%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM@hjd%ubah}(h]h ]h"]h$]h&]uh1hhja%ubh)}(h0U_FUNCTION if functionality is not supported.h]h)}(hj}%h]h0U_FUNCTION if functionality is not supported.}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMAhj{%ubah}(h]h ]h"]h$]h&]uh1hhja%ubh)}(h"U_INVALID if VM is not secure.h]h)}(hj%h]h"U_INVALID if VM is not secure.}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMBhj%ubah}(h]h ]h"]h$]h&]uh1hhja%ubh)}(h.U_PARAMETER if ``esm_blob_addr`` is invalid.h]h)}(hj%h](hU_PARAMETER if }(hj%hhhNhNubj )}(h``esm_blob_addr``h]h esm_blob_addr}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj%ubh is invalid.}(hj%hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMChj%ubah}(h]h ]h"]h$]h&]uh1hhja%ubh)}(h$U_P2 if ``fdt`` is invalid.h]h)}(hj%h](hU_P2 if }(hj%hhhNhNubj )}(h``fdt``h]hfdt}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj%ubh is invalid.}(hj%hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMDhj%ubah}(h]h ]h"]h$]h&]uh1hhja%ubh)}(h+U_PERMISSION if any integrity checks fail.h]h)}(hj%h]h+U_PERMISSION if any integrity checks fail.}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMEhj%ubah}(h]h ]h"]h$]h&]uh1hhja%ubh)}(h0U_RETRY insufficient memory to create SVM.h]h)}(hj&h]h0U_RETRY insufficient memory to create SVM.}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMFhj&ubah}(h]h ]h"]h$]h&]uh1hhja%ubh)}(h)U_NO_KEY symmetric key unavailable. h]h)}(h(U_NO_KEY symmetric key unavailable.h]h(U_NO_KEY symmetric key unavailable.}(hj-&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMGhj)&ubah}(h]h ]h"]h$]h&]uh1hhja%ubeh}(h]h ]h"]h$]h&]jY jZ uh1hhhhM@hj]%ubah}(h]h ]h"]h$]h&]uh1jhhhM@hjK%ubeh}(h]h ]h"]h$]h&]uh1jhhhM>hj:%hhubeh}(h]id42ah ]h"]h$] return valuesah&]uh1hhj$hhhhhM<j Kubh)}(hhh](h)}(h Descriptionh]h Description}(hj^&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj[&hhhhhMJubj)}(hSecure the virtual machine. On successful completion, return control to the virtual machine at the address specified in the ESM blob. h]h)}(hSecure the virtual machine. On successful completion, return control to the virtual machine at the address specified in the ESM blob.h]hSecure the virtual machine. On successful completion, return control to the virtual machine at the address specified in the ESM blob.}(hjp&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMLhjl&ubah}(h]h ]h"]h$]h&]uh1jhhhMLhj[&hhubeh}(h]id43ah ]h"]h$] descriptionah&]uh1hhj$hhhhhMJj Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj&hhhhhMQubj)}(hC#. A normal virtual machine can choose to switch to a secure mode. h]j)}(hhh]h)}(h@A normal virtual machine can choose to switch to a secure mode. h]h)}(h?A normal virtual machine can choose to switch to a secure mode.h]h?A normal virtual machine can choose to switch to a secure mode.}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMShj&ubah}(h]h ]h"]h$]h&]uh1hhj&ubah}(h]h ]h"]h$]h&]jjjhjjuh1jhj&ubah}(h]h ]h"]h$]h&]uh1jhhhMShj&hhubeh}(h]id44ah ]h"]h$] use casesah&]uh1hhj$hhhhhMQj Kubeh}(h]uv-esmah ]h"]uv_esmah$]h&]uh1hhjhhhhhM.ubeh}(h]jah ]h"]ultracalls used by svmah$]h&]uh1hhj hhhhhMubeh}(h]jah ]h"]ultravisor calls apiah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hHypervisor Calls APIh]hHypervisor Calls API}(hj&hhhNhNubah}(h]h ]h"]h$]h&]hj$uh1hhj&hhhhhMVubj)}(hXThis document describes the Hypervisor calls (hypercalls) that are needed to support the Ultravisor. Hypercalls are services provided by the Hypervisor to virtual machines and Ultravisor. Register usage for these hypercalls is identical to that of the other hypercalls defined in the Power Architecture Platform Reference (PAPR) document. i.e on input, register R3 identifies the specific service that is being requested and registers R4 through R11 contain additional parameters to the hypercall, if any. On output, register R3 contains the return value and registers R4 through R9 contain any other output values from the hypercall. This document only covers hypercalls currently implemented/planned for Ultravisor usage but others can be added here when it makes sense. The full specification for all hypercalls/ultracalls will eventually be made available in the public/OpenPower version of the PAPR specification. h](h)}(hThis document describes the Hypervisor calls (hypercalls) that are needed to support the Ultravisor. Hypercalls are services provided by the Hypervisor to virtual machines and Ultravisor.h]hThis document describes the Hypervisor calls (hypercalls) that are needed to support the Ultravisor. Hypercalls are services provided by the Hypervisor to virtual machines and Ultravisor.}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMXhj&ubh)}(hXRegister usage for these hypercalls is identical to that of the other hypercalls defined in the Power Architecture Platform Reference (PAPR) document. i.e on input, register R3 identifies the specific service that is being requested and registers R4 through R11 contain additional parameters to the hypercall, if any. On output, register R3 contains the return value and registers R4 through R9 contain any other output values from the hypercall.h]hXRegister usage for these hypercalls is identical to that of the other hypercalls defined in the Power Architecture Platform Reference (PAPR) document. i.e on input, register R3 identifies the specific service that is being requested and registers R4 through R11 contain additional parameters to the hypercall, if any. On output, register R3 contains the return value and registers R4 through R9 contain any other output values from the hypercall.}(hj 'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM\hj&ubh)}(hThis document only covers hypercalls currently implemented/planned for Ultravisor usage but others can be added here when it makes sense.h]hThis document only covers hypercalls currently implemented/planned for Ultravisor usage but others can be added here when it makes sense.}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMdhj&ubh)}(hThe full specification for all hypercalls/ultracalls will eventually be made available in the public/OpenPower version of the PAPR specification.h]hThe full specification for all hypercalls/ultracalls will eventually be made available in the public/OpenPower version of the PAPR specification.}(hj%'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMghj&ubeh}(h]h ]h"]h$]h&]uh1jhhhMXhj&hhubh)}(hhh](h)}(h&Hypervisor calls to support Ultravisorh]h&Hypervisor calls to support Ultravisor}(hj<'hhhNhNubah}(h]h ]h"]h$]h&]hjCuh1hhj9'hhhhhMlubj)}(hBFollowing are the set of hypercalls needed to support Ultravisor. h]h)}(hAFollowing are the set of hypercalls needed to support Ultravisor.h]hAFollowing are the set of hypercalls needed to support Ultravisor.}(hjN'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMnhjJ'ubah}(h]h ]h"]h$]h&]uh1jhhhMnhj9'hhubh)}(hhh](h)}(hH_SVM_INIT_STARTh]hH_SVM_INIT_START}(hje'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjb'hhhhhMqubj)}(hFBegin the process of converting a normal virtual machine into an SVM. h]h)}(hEBegin the process of converting a normal virtual machine into an SVM.h]hEBegin the process of converting a normal virtual machine into an SVM.}(hjw'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMshjs'ubah}(h]h ]h"]h$]h&]uh1jhhhMshjb'hhubh)}(hhh](h)}(hSyntaxh]hSyntax}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj'hhhhhMvubj )}(h3uint64_t hypercall(const uint64_t H_SVM_INIT_START)h]h3uint64_t hypercall(const uint64_t H_SVM_INIT_START)}hj'sbah}(h]h ]h"]h$]h&]hhj j j j }uh1j hhhMxhj'hhubeh}(h]id45ah ]h"]h$]syntaxah&]uh1hhjb'hhhhhMvj Kubh)}(hhh](h)}(h Return valuesh]h Return values}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj'hhhhhM}ubj)}(hOne of the following values: * H_SUCCESS on success. * H_STATE if the VM is not in a position to switch to secure. h](h)}(hOne of the following values:h]hOne of the following values:}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj'ubj)}(hb* H_SUCCESS on success. * H_STATE if the VM is not in a position to switch to secure. h]h)}(hhh](h)}(hH_SUCCESS on success.h]h)}(hj'h]hH_SUCCESS on success.}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj'ubah}(h]h ]h"]h$]h&]uh1hhj'ubh)}(hCH_STATE if the VM is not in a position to switch to secure. h]h)}(hBH_STATE if the VM is not in a position to switch to secure.h]hBH_STATE if the VM is not in a position to switch to secure.}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj'ubah}(h]h ]h"]h$]h&]uh1hhj'ubeh}(h]h ]h"]h$]h&]jY jZ uh1hhhhMhj'ubah}(h]h ]h"]h$]h&]uh1jhhhMhj'ubeh}(h]h ]h"]h$]h&]uh1jhhhMhj'hhubeh}(h]id46ah ]h"]h$] return valuesah&]uh1hhjb'hhhhhM}j Kubh)}(hhh](h)}(h Descriptionh]h Description}(hj)(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj&(hhhhhMubj)}(hX=Initiate the process of securing a virtual machine. This involves coordinating with the Ultravisor, using ultracalls, to allocate resources in the Ultravisor for the new SVM, transferring the VM's pages from normal to secure memory etc. When the process is completed, Ultravisor issues the H_SVM_INIT_DONE hypercall. h]h)}(hX<Initiate the process of securing a virtual machine. This involves coordinating with the Ultravisor, using ultracalls, to allocate resources in the Ultravisor for the new SVM, transferring the VM's pages from normal to secure memory etc. When the process is completed, Ultravisor issues the H_SVM_INIT_DONE hypercall.h]hX>Initiate the process of securing a virtual machine. This involves coordinating with the Ultravisor, using ultracalls, to allocate resources in the Ultravisor for the new SVM, transferring the VM’s pages from normal to secure memory etc. When the process is completed, Ultravisor issues the H_SVM_INIT_DONE hypercall.}(hj;(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj7(ubah}(h]h ]h"]h$]h&]uh1jhhhMhj&(hhubeh}(h]id47ah ]h"]h$] descriptionah&]uh1hhjb'hhhhhMj Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hjZ(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjW(hhhhhMubj)}(h|#. Ultravisor uses this hypercall to inform Hypervisor that a VM has initiated the process of switching to secure mode. h]j)}(hhh]h)}(hvUltravisor uses this hypercall to inform Hypervisor that a VM has initiated the process of switching to secure mode. h]h)}(htUltravisor uses this hypercall to inform Hypervisor that a VM has initiated the process of switching to secure mode.h]htUltravisor uses this hypercall to inform Hypervisor that a VM has initiated the process of switching to secure mode.}(hjs(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjo(ubah}(h]h ]h"]h$]h&]uh1hhjl(ubah}(h]h ]h"]h$]h&]jjjhjjuh1jhjh(ubah}(h]h ]h"]h$]h&]uh1jhhhMhjW(hhubeh}(h]id48ah ]h"]h$] use casesah&]uh1hhjb'hhhhhMj Kubeh}(h]h-svm-init-startah ]h"]h_svm_init_startah$]h&]uh1hhj9'hhhhhMqubh)}(hhh](h)}(hH_SVM_INIT_DONEh]hH_SVM_INIT_DONE}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(hhhhhMubj)}(h)Complete the process of securing an SVM. h]h)}(h(Complete the process of securing an SVM.h]h(Complete the process of securing an SVM.}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj(ubah}(h]h ]h"]h$]h&]uh1jhhhMhj(hhubh)}(hhh](h)}(hSyntaxh]hSyntax}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(hhhhhMubj )}(h2uint64_t hypercall(const uint64_t H_SVM_INIT_DONE)h]h2uint64_t hypercall(const uint64_t H_SVM_INIT_DONE)}hj(sbah}(h]h ]h"]h$]h&]hhj j j j }uh1j hhhMhj(hhubeh}(h]id49ah ]h"]h$]syntaxah&]uh1hhj(hhhhhMj Kubh)}(hhh](h)}(h Return valuesh]h Return values}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(hhhhhMubj)}(hXxOne of the following values: * H_SUCCESS on success. * H_UNSUPPORTED if called from the wrong context (e.g. from an SVM or before an H_SVM_INIT_START hypercall). * H_STATE if the hypervisor could not successfully transition the VM to Secure VM. h](h)}(hOne of the following values:h]hOne of the following values:}(hj )hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj)ubj)}(hXB* H_SUCCESS on success. * H_UNSUPPORTED if called from the wrong context (e.g. from an SVM or before an H_SVM_INIT_START hypercall). * H_STATE if the hypervisor could not successfully transition the VM to Secure VM. h]h)}(hhh](h)}(h!H_SUCCESS on success.h]h)}(hj )h]h!H_SUCCESS on success.}(hj")hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj)ubah}(h]h ]h"]h$]h&]uh1hhj)ubh)}(hH_UNSUPPORTED if called from the wrong context (e.g. from an SVM or before an H_SVM_INIT_START hypercall).h]jF)}(hhh]jK)}(hrH_UNSUPPORTED if called from the wrong context (e.g. from an SVM or before an H_SVM_INIT_START hypercall).h](jQ)}(hH_STATE if the hypervisor could not successfullyh]h>H_STATE if the hypervisor could not successfully}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1jPhhhMhj~)ubjs)}(hhh]h)}(htransition the VM to Secure VM.h]htransition the VM to Secure VM.}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj)ubah}(h]h ]h"]h$]h&]uh1jrhj~)ubeh}(h]h ]h"]h$]h&]uh1jJhhhMhj{)ubah}(h]h ]h"]h$]h&]uh1jEhjw)ubah}(h]h ]h"]h$]h&]uh1hhj)ubeh}(h]h ]h"]h$]h&]jY jZ uh1hhhhMhj)ubah}(h]h ]h"]h$]h&]uh1jhhhMhj)ubeh}(h]h ]h"]h$]h&]uh1jhhhMhj(hhubeh}(h]id50ah ]h"]h$] return valuesah&]uh1hhj(hhhhhMj Kubh)}(hhh](h)}(h Descriptionh]h Description}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj)hhhhhMubj)}(hComplete the process of securing a virtual machine. This call must be made after a prior call to ``H_SVM_INIT_START`` hypercall. h]h)}(hComplete the process of securing a virtual machine. This call must be made after a prior call to ``H_SVM_INIT_START`` hypercall.h](haComplete the process of securing a virtual machine. This call must be made after a prior call to }(hj)hhhNhNubj )}(h``H_SVM_INIT_START``h]hH_SVM_INIT_START}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj)ubh hypercall.}(hj)hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj)ubah}(h]h ]h"]h$]h&]uh1jhhhMhj)hhubeh}(h]id51ah ]h"]h$] descriptionah&]uh1hhj(hhhhhMj Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj*hhhhhMubj)}(hOn successfully securing a virtual machine, the Ultravisor informs Hypervisor about it. Hypervisor can use this call to finish setting up its internal state for this virtual machine. h]h)}(hOn successfully securing a virtual machine, the Ultravisor informs Hypervisor about it. Hypervisor can use this call to finish setting up its internal state for this virtual machine.h]hOn successfully securing a virtual machine, the Ultravisor informs Hypervisor about it. Hypervisor can use this call to finish setting up its internal state for this virtual machine.}(hj+*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj'*ubah}(h]h ]h"]h$]h&]uh1jhhhMhj*hhubeh}(h]id52ah ]h"]h$] use casesah&]uh1hhj(hhhhhMj Kubeh}(h]h-svm-init-doneah ]h"]h_svm_init_doneah$]h&]uh1hhj9'hhhhhMubh)}(hhh](h)}(hH_SVM_INIT_ABORTh]hH_SVM_INIT_ABORT}(hjR*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjO*hhhhhMubj)}(h&Abort the process of securing an SVM. h]h)}(h%Abort the process of securing an SVM.h]h%Abort the process of securing an SVM.}(hjd*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj`*ubah}(h]h ]h"]h$]h&]uh1jhhhMhjO*hhubh)}(hhh](h)}(hSyntaxh]hSyntax}(hj{*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjx*hhhhhMubj )}(h3uint64_t hypercall(const uint64_t H_SVM_INIT_ABORT)h]h3uint64_t hypercall(const uint64_t H_SVM_INIT_ABORT)}hj*sbah}(h]h ]h"]h$]h&]hhj j j j }uh1j hhhMhjx*hhubeh}(h]id53ah ]h"]h$]syntaxah&]uh1hhjO*hhhhhMj Kubh)}(hhh](h)}(h Return valuesh]h Return values}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj*hhhhhMubj)}(hX!One of the following values: * H_PARAMETER on successfully cleaning up the state, Hypervisor will return this value to the **guest**, to indicate that the underlying UV_ESM ultracall failed. * H_STATE if called after a VM has gone secure (i.e H_SVM_INIT_DONE hypercall was successful). * H_UNSUPPORTED if called from a wrong context (e.g. from a normal VM). h](h)}(hOne of the following values:h]hOne of the following values:}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj*ubj)}(hX* H_PARAMETER on successfully cleaning up the state, Hypervisor will return this value to the **guest**, to indicate that the underlying UV_ESM ultracall failed. * H_STATE if called after a VM has gone secure (i.e H_SVM_INIT_DONE hypercall was successful). * H_UNSUPPORTED if called from a wrong context (e.g. from a normal VM). h]h)}(hhh](h)}(hH_PARAMETER on successfully cleaning up the state, Hypervisor will return this value to the **guest**, to indicate that the underlying UV_ESM ultracall failed. h]jF)}(hhh]jK)}(hH_PARAMETER on successfully cleaning up the state, Hypervisor will return this value to the **guest**, to indicate that the underlying UV_ESM ultracall failed. h](jQ)}(h.hhhhhMubj)}(hXRetrieve the content of the page, belonging to the VM at the specified guest physical address. Only valid value(s) in ``flags`` are: * H_PAGE_IN_SHARED which indicates that the page is to be shared with the Ultravisor. * H_PAGE_IN_NONSHARED indicates that the UV is not anymore interested in the page. Applicable if the page is a shared page. The ``order`` parameter must correspond to the configured page size. h](h)}(h^Retrieve the content of the page, belonging to the VM at the specified guest physical address.h]h^Retrieve the content of the page, belonging to the VM at the specified guest physical address.}(hjS.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjO.ubh)}(h%Only valid value(s) in ``flags`` are:h](hOnly valid value(s) in }(hja.hhhNhNubj )}(h ``flags``h]hflags}(hji.hhhNhNubah}(h]h ]h"]h$]h&]uh1j hja.ubh are:}(hja.hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjO.ubj)}(h* H_PAGE_IN_SHARED which indicates that the page is to be shared with the Ultravisor. * H_PAGE_IN_NONSHARED indicates that the UV is not anymore interested in the page. Applicable if the page is a shared page. h]h)}(hhh](h)}(hTH_PAGE_IN_SHARED which indicates that the page is to be shared with the Ultravisor. h]h)}(hSH_PAGE_IN_SHARED which indicates that the page is to be shared with the Ultravisor.h]hSH_PAGE_IN_SHARED which indicates that the page is to be shared with the Ultravisor.}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj.ubah}(h]h ]h"]h$]h&]uh1hhj.ubh)}(hzH_PAGE_IN_NONSHARED indicates that the UV is not anymore interested in the page. Applicable if the page is a shared page. h]h)}(hyH_PAGE_IN_NONSHARED indicates that the UV is not anymore interested in the page. Applicable if the page is a shared page.h]hyH_PAGE_IN_NONSHARED indicates that the UV is not anymore interested in the page. Applicable if the page is a shared page.}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj.ubah}(h]h ]h"]h$]h&]uh1hhj.ubeh}(h]h ]h"]h$]h&]jY jZ uh1hhhhMhj.ubah}(h]h ]h"]h$]h&]uh1jhhhMhjO.ubh)}(hDThe ``order`` parameter must correspond to the configured page size.h](hThe }(hj.hhhNhNubj )}(h ``order``h]horder}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj.ubh7 parameter must correspond to the configured page size.}(hj.hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjO.ubeh}(h]h ]h"]h$]h&]uh1jhhhMhj>.hhubeh}(h]id59ah ]h"]h$] descriptionah&]uh1hhj-hhhhhMj Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj.hhhhhM ubj)}(hX#. When a normal VM becomes a secure VM (using the UV_ESM ultracall), the Ultravisor uses this hypercall to move contents of each page of the VM from normal memory to secure memory. #. Ultravisor uses this hypercall to ask Hypervisor to provide a page in normal memory that can be shared between the SVM and Hypervisor. #. Ultravisor uses this hypercall to page-in a paged-out page. This can happen when the SVM touches a paged-out page. #. If SVM wants to disable sharing of pages with Hypervisor, it can inform Ultravisor to do so. Ultravisor will then use this hypercall and inform Hypervisor that it has released access to the normal page. h]j)}(hhh](h)}(hWhen a normal VM becomes a secure VM (using the UV_ESM ultracall), the Ultravisor uses this hypercall to move contents of each page of the VM from normal memory to secure memory. h]h)}(hWhen a normal VM becomes a secure VM (using the UV_ESM ultracall), the Ultravisor uses this hypercall to move contents of each page of the VM from normal memory to secure memory.h]hWhen a normal VM becomes a secure VM (using the UV_ESM ultracall), the Ultravisor uses this hypercall to move contents of each page of the VM from normal memory to secure memory.}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM"hj /ubah}(h]h ]h"]h$]h&]uh1hhj/ubh)}(hUltravisor uses this hypercall to ask Hypervisor to provide a page in normal memory that can be shared between the SVM and Hypervisor. h]h)}(hUltravisor uses this hypercall to ask Hypervisor to provide a page in normal memory that can be shared between the SVM and Hypervisor.h]hUltravisor uses this hypercall to ask Hypervisor to provide a page in normal memory that can be shared between the SVM and Hypervisor.}(hj&/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM&hj"/ubah}(h]h ]h"]h$]h&]uh1hhj/ubh)}(hsUltravisor uses this hypercall to page-in a paged-out page. This can happen when the SVM touches a paged-out page. h]h)}(hrUltravisor uses this hypercall to page-in a paged-out page. This can happen when the SVM touches a paged-out page.h]hrUltravisor uses this hypercall to page-in a paged-out page. This can happen when the SVM touches a paged-out page.}(hj>/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM)hj:/ubah}(h]h ]h"]h$]h&]uh1hhj/ubh)}(hIf SVM wants to disable sharing of pages with Hypervisor, it can inform Ultravisor to do so. Ultravisor will then use this hypercall and inform Hypervisor that it has released access to the normal page. h]h)}(hIf SVM wants to disable sharing of pages with Hypervisor, it can inform Ultravisor to do so. Ultravisor will then use this hypercall and inform Hypervisor that it has released access to the normal page.h]hIf SVM wants to disable sharing of pages with Hypervisor, it can inform Ultravisor to do so. Ultravisor will then use this hypercall and inform Hypervisor that it has released access to the normal page.}(hjV/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM,hjR/ubah}(h]h ]h"]h$]h&]uh1hhj/ubeh}(h]h ]h"]h$]h&]jjjhjjuh1jhj/ubah}(h]h ]h"]h$]h&]uh1jhhhM"hj.hhubeh}(h]id60ah ]h"]h$] use casesah&]uh1hhj-hhhhhM j Kubeh}(h] h-svm-page-inah ]h"] h_svm_page_inah$]h&]uh1hhj9'hhhhhMubh)}(hhh](h)}(hH_SVM_PAGE_OUTh]hH_SVM_PAGE_OUT}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj/hhhhhM2ubj)}(h0Move the contents of the page to normal memory. h]h)}(h/Move the contents of the page to normal memory.h]h/Move the contents of the page to normal memory.}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM4hj/ubah}(h]h ]h"]h$]h&]uh1jhhhM4hj/hhubh)}(hhh](h)}(hSyntaxh]hSyntax}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj/hhhhhM7ubj )}(huint64_t hypercall(const uint64_t H_SVM_PAGE_OUT, uint64_t guest_pa, /* guest-physical-address */ uint64_t flags, /* flags (currently none) */ uint64_t order) /* page size order */h]huint64_t hypercall(const uint64_t H_SVM_PAGE_OUT, uint64_t guest_pa, /* guest-physical-address */ uint64_t flags, /* flags (currently none) */ uint64_t order) /* page size order */}hj/sbah}(h]h ]h"]h$]h&]hhj j j j }uh1j hhhM9hj/hhubeh}(h]id61ah ]h"]h$]syntaxah&]uh1hhj/hhhhhM7j Kubh)}(hhh](h)}(h Return valuesh]h Return values}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj/hhhhhMAubj)}(hOne of the following values: * H_SUCCESS on success. * H_PARAMETER if ``guest_pa`` is invalid. * H_P2 if ``flags`` is invalid. * H_P3 if ``order`` is invalid. h](h)}(hOne of the following values:h]hOne of the following values:}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMChj/ubj)}(h* H_SUCCESS on success. * H_PARAMETER if ``guest_pa`` is invalid. * H_P2 if ``flags`` is invalid. * H_P3 if ``order`` is invalid. h]h)}(hhh](h)}(hH_SUCCESS on success.h]h)}(hj0h]hH_SUCCESS on success.}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMEhj0ubah}(h]h ]h"]h$]h&]uh1hhj/ubh)}(h)H_PARAMETER if ``guest_pa`` is invalid.h]h)}(hj0h](hH_PARAMETER if }(hj0hhhNhNubj )}(h ``guest_pa``h]hguest_pa}(hj#0hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj0ubh is invalid.}(hj0hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMFhj0ubah}(h]h ]h"]h$]h&]uh1hhj/ubh)}(h&H_P2 if ``flags`` is invalid.h]h)}(hjC0h](hH_P2 if }(hjE0hhhNhNubj )}(h ``flags``h]hflags}(hjL0hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjE0ubh is invalid.}(hjE0hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMGhjA0ubah}(h]h ]h"]h$]h&]uh1hhj/ubh)}(h'H_P3 if ``order`` is invalid. h]h)}(h&H_P3 if ``order`` is invalid.h](hH_P3 if }(hjn0hhhNhNubj )}(h ``order``h]horder}(hjv0hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjn0ubh is invalid.}(hjn0hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMHhjj0ubah}(h]h ]h"]h$]h&]uh1hhj/ubeh}(h]h ]h"]h$]h&]jY jZ uh1hhhhMEhj/ubah}(h]h ]h"]h$]h&]uh1jhhhMEhj/ubeh}(h]h ]h"]h$]h&]uh1jhhhMChj/hhubeh}(h]id62ah ]h"]h$] return valuesah&]uh1hhj/hhhhhMAj Kubh)}(hhh](h)}(h Descriptionh]h Description}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj0hhhhhMKubj)}(hMove the contents of the page identified by ``guest_pa`` to normal memory. Currently ``flags`` is unused and must be set to 0. The ``order`` parameter must correspond to the configured page size. h](h)}(hJMove the contents of the page identified by ``guest_pa`` to normal memory.h](h,Move the contents of the page identified by }(hj0hhhNhNubj )}(h ``guest_pa``h]hguest_pa}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj0ubh to normal memory.}(hj0hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMMhj0ubh)}(hxCurrently ``flags`` is unused and must be set to 0. The ``order`` parameter must correspond to the configured page size.hh](h Currently }(hj0hhhNhNubj )}(h ``flags``h]hflags}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj0ubh% is unused and must be set to 0. The }(hj0hhhNhNubj )}(h ``order``h]horder}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj0ubh7 parameter must correspond to the configured page size.}(hj0hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMPhj0ubeh}(h]h ]h"]h$]h&]uh1jhhhMMhj0hhubeh}(h]id63ah ]h"]h$] descriptionah&]uh1hhj/hhhhhMKj Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hj&1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#1hhhhhMTubj)}(h#. If Ultravisor is running low on secure pages, it can move the contents of some secure pages, into normal pages using this hypercall. The content will be encrypted. h]j)}(hhh]h)}(hIf Ultravisor is running low on secure pages, it can move the contents of some secure pages, into normal pages using this hypercall. The content will be encrypted. h]h)}(hIf Ultravisor is running low on secure pages, it can move the contents of some secure pages, into normal pages using this hypercall. The content will be encrypted.h]hIf Ultravisor is running low on secure pages, it can move the contents of some secure pages, into normal pages using this hypercall. The content will be encrypted.}(hj?1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMVhj;1ubah}(h]h ]h"]h$]h&]uh1hhj81ubah}(h]h ]h"]h$]h&]jjjhjjuh1jhj41ubah}(h]h ]h"]h$]h&]uh1jhhhMVhj#1hhubeh}(h]id64ah ]h"]h$] use casesah&]uh1hhj/hhhhhMTj Kubeh}(h]h-svm-page-outah ]h"]h_svm_page_outah$]h&]uh1hhj9'hhhhhM2ubeh}(h]jIah ]h"]&hypervisor calls to support ultravisorah$]h&]uh1hhj&hhhhhMlubeh}(h]j*ah ]h"]hypervisor calls apiah$]h&]uh1hhhhhhhhMVubh)}(hhh](h)}(h Referencesh]h References}(hj1hhhNhNubah}(h]h ]h"]h$]h&]hjquh1hhj}1hhhhhM[ubh)}(hhh]h)}(h`Supporting Protected Computing on IBM Power Architecture `_h]h)}(hj1h](h)}(hj1h]h8Supporting Protected Computing on IBM Power Architecture}(hj1hhhNhNubah}(h]h ]h"]h$]h&]name8Supporting Protected Computing on IBM Power ArchitecturerefuriAhttps://developer.ibm.com/articles/l-support-protected-computing/uh1hhj1ubh)}(hD h]h}(h]8supporting-protected-computing-on-ibm-power-architectureah ]h"]8supporting protected computing on ibm power architectureah$]h&]refurij1uh1hj Khj1ubeh}(h]h ]h"]h$]h&]uh1hhhhM]hj1ubah}(h]h ]h"]h$]h&]uh1hhj1hhhhhNubah}(h]h ]h"]h$]h&]jY -uh1hhhhM]hj}1hhubeh}(h]jwah ]h"] referencesah$]h&]uh1hhhhhhhhM[ubeh}(h](j heh ]h"](protected execution facility ultravisoreh$]h&]uh1hhhhhhhhKexpect_referenced_by_name}j1hsexpect_referenced_by_id}hhsubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksjfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerj1error_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourceh _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}h]hasnameids}(j1hj1j jjj j*jq jIj jkj{ jj&jjjj/j,syntaxN return valuesN descriptionN use casesNjjjjjjjjj.j+jjjjj&jj!j!jj#jg#j$j$j&j&jz1j*js1jIj(j(jL*jI*j-j-j/j/jl1ji1j1jwj1j1u nametypes}(j1j1jj jq j j{ j&jj/jC2jD2jE2jF2jjjjj.jjj&j!jj#j$j&jz1js1j(jL*j-j/jl1j1j1uh}(hhj hjhj*jjIjjkjt jj jj jj0 j,jY j j jj jsjj$jyjj2j}j[jjjjjyj jjjjj jjLjjjRjjjjj/jj`j5jjfjjjYj7jj_jfjjjlj+jjjjrj!jjxj#jjj1j|jZjXjjj^jjjjj8jjj>j3jjwj9jjj!jjjj jj'!j j!j-!jg#j!j!j!j"j!j#j"j_#j!#j$jm#j#j#jB$j#js$jH$j$jy$j&j$j4%j%jU&j:%j&j[&j&j&j*j&jIj9'j(jb'j'j'j (j'jQ(j&(j(jW(jI*j(j(j(j)j(j*j)jA*j*j-jO*j*jx*j+j*j,j+j-j,j/j-ja-j?-j8.jg-j.j>.jx/j.ji1j/j/j/j0j/j1j0ja1j#1jwj}1j1j1hhj$jjCj:jej\jj~jjjjjjj$jjCj:jqjhu footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}j 2KKsRparse_messages](hsystem_message)}(hhh]h)}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hjj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjg2ubah}(h]h ]h"]h$]h&]j}alevelKtypeINFOsourcehlineMSuh1je2hj[hhhhhMSubjf2)}(hhh]h)}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj2ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehlineM_uh1je2hjhhhhhM_ubjf2)}(hhh]h)}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj2ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehlineMmuh1je2hjhhhhhMmubjf2)}(hhh]h)}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj2ubah}(h]h ]h"]h$]h&]jyalevelKtypej2sourcehlineMuh1je2hj hhhhhMubjf2)}(hhh]h)}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj2ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehlineMuh1je2hjhhhhhMubjf2)}(hhh]h)}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj2ubah}(h]h ]h"]h$]h&]j alevelKtypej2sourcehlineMuh1je2hjhhhhhMubjf2)}(hhh]h)}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj 3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj 3ubah}(h]h ]h"]h$]h&]jLalevelKtypej2sourcehlineMuh1je2hjhhhhhMubjf2)}(hhh]h)}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj(3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%3ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehlineMuh1je2hjRhhhhhMubjf2)}(hhh]h)}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hjC3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj@3ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehlineMuh1je2hjhhhhhMubjf2)}(hhh]h)}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj^3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj[3ubah}(h]h ]h"]h$]h&]j/alevelKtypej2sourcehlineMuh1je2hjhhhhhMubjf2)}(hhh]h)}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hjy3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjv3ubah}(h]h ]h"]h$]h&]j`alevelKtypej2sourcehlineMuh1je2hj5hhhhhMubjf2)}(hhh]h)}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj3ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehlineMuh1je2hjfhhhhhMubjf2)}(hhh]h)}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj3ubah}(h]h ]h"]h$]h&]jYalevelKtypej2sourcehlineMuh1je2hj7hhhhhMubjf2)}(hhh]h)}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj3ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehlineM uh1je2hj_hhhhhM ubjf2)}(hhh]h)}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj3ubah}(h]h ]h"]h$]h&]jfalevelKtypej2sourcehlineMuh1je2hjhhhhhMubjf2)}(hhh]h)}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj3ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehlineM!uh1je2hjlhhhhhM!ubjf2)}(hhh]h)}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj4ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehlineM1uh1je2hjhhhhhM1ubjf2)}(hhh]h)}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj64hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj34ubah}(h]h ]h"]h$]h&]jralevelKtypej2sourcehlineM=uh1je2hj!hhhhhM=ubjf2)}(hhh]h)}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hjQ4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjN4ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehlineMLuh1je2hjxhhhhhMLubjf2)}(hhh]h)}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hjl4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhji4ubah}(h]h ]h"]h$]h&]j#alevelKtypej2sourcehlineMRuh1je2hjhhhhhMRubjf2)}(hhh]h)}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj4ubah}(h]h ]h"]h$]h&]j|alevelKtypej2sourcehlineMeuh1je2hjZhhhhhMeubjf2)}(hhh]h)}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj4ubah}(h]h ]h"]h$]h&]jXalevelKtypej2sourcehlineMnuh1je2hjhhhhhMnubjf2)}(hhh]h)}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj4ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehlineMyuh1je2hj^hhhhhMyubjf2)}(hhh]h)}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj4ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehlineMuh1je2hjhhhhhMubjf2)}(hhh]h)}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj4ubah}(h]h ]h"]h$]h&]j8alevelKtypej2sourcehlineMuh1je2hjhhhhhMubjf2)}(hhh]h)}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj 5ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehlineMuh1je2hj>hhhhhMubjf2)}(hhh]h)}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj)5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj&5ubah}(h]h ]h"]h$]h&]j3alevelKtypej2sourcehlineMuh1je2hjhhhhhMubjf2)}(hhh]h)}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hjD5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjA5ubah}(h]h ]h"]h$]h&]jwalevelKtypej2sourcehlineMuh1je2hj9hhhhhMubjf2)}(hhh]h)}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj_5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj\5ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehlineMuh1je2hjhhhhhMubjf2)}(hhh]h)}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hjz5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjw5ubah}(h]h ]h"]h$]h&]j alevelKtypej2sourcehlineMuh1je2hjhhhhhMubjf2)}(hhh]h)}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5ubah}(h]h ]h"]h$]h&]j'!alevelKtypej2sourcehlineMuh1je2hj hhhhhMubjf2)}(hhh]h)}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5ubah}(h]h ]h"]h$]h&]j!alevelKtypej2sourcehlineMuh1je2hj-!hhhhhMubjf2)}(hhh]h)}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5ubah}(h]h ]h"]h$]h&]j!alevelKtypej2sourcehlineMuh1je2hj!hhhhhMubjf2)}(hhh]h)}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5ubah}(h]h ]h"]h$]h&]j"alevelKtypej2sourcehlineMuh1je2hj!hhhhhMubjf2)}(hhh]h)}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5ubah}(h]h ]h"]h$]h&]j#alevelKtypej2sourcehlineMuh1je2hj"hhhhhMubjf2)}(hhh]h)}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6ubah}(h]h ]h"]h$]h&]j_#alevelKtypej2sourcehlineMuh1je2hj!#hhhhhMubjf2)}(hhh]h)}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj76hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj46ubah}(h]h ]h"]h$]h&]j#alevelKtypej2sourcehlineMuh1je2hj#hhhhhMubjf2)}(hhh]h)}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hjR6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjO6ubah}(h]h ]h"]h$]h&]jB$alevelKtypej2sourcehlineMuh1je2hj#hhhhhMubjf2)}(hhh]h)}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hjm6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjj6ubah}(h]h ]h"]h$]h&]js$alevelKtypej2sourcehlineMuh1je2hjH$hhhhhMubjf2)}(hhh]h)}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6ubah}(h]h ]h"]h$]h&]j$alevelKtypej2sourcehlineM(uh1je2hjy$hhhhhM(ubjf2)}(hhh]h)}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6ubah}(h]h ]h"]h$]h&]j4%alevelKtypej2sourcehlineM3uh1je2hj%hhhhhM3ubjf2)}(hhh]h)}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6ubah}(h]h ]h"]h$]h&]jU&alevelKtypej2sourcehlineM<uh1je2hj:%hhhhhM<ubjf2)}(hhh]h)}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6ubah}(h]h ]h"]h$]h&]j&alevelKtypej2sourcehlineMJuh1je2hj[&hhhhhMJubjf2)}(hhh]h)}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6ubah}(h]h ]h"]h$]h&]j&alevelKtypej2sourcehlineMQuh1je2hj&hhhhhMQubjf2)}(hhh]h)}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj 7ubah}(h]h ]h"]h$]h&]j'alevelKtypej2sourcehlineMvuh1je2hj'hhhhhMvubjf2)}(hhh]h)}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj*7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj'7ubah}(h]h ]h"]h$]h&]j (alevelKtypej2sourcehlineM}uh1je2hj'hhhhhM}ubjf2)}(hhh]h)}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hjE7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjB7ubah}(h]h ]h"]h$]h&]jQ(alevelKtypej2sourcehlineMuh1je2hj&(hhhhhMubjf2)}(hhh]h)}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj`7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj]7ubah}(h]h ]h"]h$]h&]j(alevelKtypej2sourcehlineMuh1je2hjW(hhhhhMubjf2)}(hhh]h)}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj{7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjx7ubah}(h]h ]h"]h$]h&]j(alevelKtypej2sourcehlineMuh1je2hj(hhhhhMubjf2)}(hhh]h)}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7ubah}(h]h ]h"]h$]h&]j)alevelKtypej2sourcehlineMuh1je2hj(hhhhhMubjf2)}(hhh]h)}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7ubah}(h]h ]h"]h$]h&]j*alevelKtypej2sourcehlineMuh1je2hj)hhhhhMubjf2)}(hhh]h)}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7ubah}(h]h ]h"]h$]h&]jA*alevelKtypej2sourcehlineMuh1je2hj*hhhhhMubjf2)}(hhh]h)}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7ubah}(h]h ]h"]h$]h&]j*alevelKtypej2sourcehlineMuh1je2hjx*hhhhhMubjf2)}(hhh]h)}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7ubah}(h]h ]h"]h$]h&]j+alevelKtypej2sourcehlineMuh1je2hj*hhhhhMubjf2)}(hhh]h)}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj8ubah}(h]h ]h"]h$]h&]j,alevelKtypej2sourcehlineMuh1je2hj+hhhhhMubjf2)}(hhh]h)}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj88hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj58ubah}(h]h ]h"]h$]h&]j-alevelKtypej2sourcehlineMuh1je2hj,hhhhhMubjf2)}(hhh]h)}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hjS8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjP8ubah}(h]h ]h"]h$]h&]ja-alevelKtypej2sourcehlineMuh1je2hj?-hhhhhMubjf2)}(hhh]h)}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hjn8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjk8ubah}(h]h ]h"]h$]h&]j8.alevelKtypej2sourcehlineMuh1je2hjg-hhhhhMubjf2)}(hhh]h)}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj8ubah}(h]h ]h"]h$]h&]j.alevelKtypej2sourcehlineMuh1je2hj>.hhhhhMubjf2)}(hhh]h)}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj8ubah}(h]h ]h"]h$]h&]jx/alevelKtypej2sourcehlineM uh1je2hj.hhhhhM ubjf2)}(hhh]h)}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj8ubah}(h]h ]h"]h$]h&]j/alevelKtypej2sourcehlineM7uh1je2hj/hhhhhM7ubjf2)}(hhh]h)}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj8ubah}(h]h ]h"]h$]h&]j0alevelKtypej2sourcehlineMAuh1je2hj/hhhhhMAubjf2)}(hhh]h)}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj8ubah}(h]h ]h"]h$]h&]j1alevelKtypej2sourcehlineMKuh1je2hj0hhhhhMKubjf2)}(hhh]h)}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj 9ubah}(h]h ]h"]h$]h&]ja1alevelKtypej2sourcehlineMTuh1je2hj#1hhhhhMTubetransform_messages]jf2)}(hhh]h)}(hhh]h0Hyperlink target "ultravisor" is not referenced.}hj-9sbah}(h]h ]h"]h$]h&]uh1hhj*9ubah}(h]h ]h"]h$]h&]levelKtypej2sourcehlineKuh1je2uba transformerN include_log] decorationNhhub.