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]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget+/translations/pt_BR/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&]hԌid65uh1hhhhhhhhKubhtopic)}(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}(hjhhhNhNubah}(h]hah ]h"]h$]h&]refidprotected-execution-facilityuh1jhj ubah}(h]h ]h"]h$]h&]uh1j hjubj)}(hhh](j)}(hhh](j )}(hhh]j)}(hhh]h Introduction}(hj/hhhNhNubah}(h]id66ah ]h"]h$]h&]refid introductionuh1jhj,ubah}(h]h ]h"]h$]h&]uh1j hj)ubj)}(hhh](j)}(hhh]j )}(hhh]j)}(hhh]hHardware}(hjNhhhNhNubah}(h]id67ah ]h"]h$]h&]refidhardwareuh1jhjKubah}(h]h ]h"]h$]h&]uh1j hjHubah}(h]h ]h"]h$]h&]uh1jhjEubj)}(hhh]j )}(hhh]j)}(hhh]hSoftware/Microcode}(hjphhhNhNubah}(h]id68ah ]h"]h$]h&]refidsoftware-microcodeuh1jhjmubah}(h]h ]h"]h$]h&]uh1j hjjubah}(h]h ]h"]h$]h&]uh1jhjEubj)}(hhh]j )}(hhh]j)}(hhh]h Terminology}(hjhhhNhNubah}(h]id69ah ]h"]h$]h&]refid terminologyuh1jhjubah}(h]h ]h"]h$]h&]uh1j hjubah}(h]h ]h"]h$]h&]uh1jhjEubeh}(h]h ]h"]h$]h&]uh1jhj)ubeh}(h]h ]h"]h$]h&]uh1jhj&ubj)}(hhh](j )}(hhh]j)}(hhh]hUltravisor calls API}(hjhhhNhNubah}(h]id70ah ]h"]h$]h&]refidultravisor-calls-apiuh1jhjubah}(h]h ]h"]h$]h&]uh1j hjubj)}(hhh](j)}(hhh]j )}(hhh]j)}(hhh]hUltracalls used by Hypervisor}(hjhhhNhNubah}(h]id71ah ]h"]h$]h&]refidultracalls-used-by-hypervisoruh1jhjubah}(h]h ]h"]h$]h&]uh1j hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]j )}(hhh]j)}(hhh]hUltracalls used by SVM}(hjhhhNhNubah}(h]id72ah ]h"]h$]h&]refidultracalls-used-by-svmuh1jhjubah}(h]h ]h"]h$]h&]uh1j hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj&ubj)}(hhh](j )}(hhh]j)}(hhh]hHypervisor Calls API}(hj/hhhNhNubah}(h]id73ah ]h"]h$]h&]refidhypervisor-calls-apiuh1jhj,ubah}(h]h ]h"]h$]h&]uh1j hj)ubj)}(hhh]j)}(hhh]j )}(hhh]j)}(hhh]h&Hypervisor calls to support Ultravisor}(hjNhhhNhNubah}(h]id74ah ]h"]h$]h&]refid&hypervisor-calls-to-support-ultravisoruh1jhjKubah}(h]h ]h"]h$]h&]uh1j hjHubah}(h]h ]h"]h$]h&]uh1jhjEubah}(h]h ]h"]h$]h&]uh1jhj)ubeh}(h]h ]h"]h$]h&]uh1jhj&ubj)}(hhh]j )}(hhh]j)}(hhh]h References}(hj|hhhNhNubah}(h]id75ah ]h"]h$]h&]refid referencesuh1jhjyubah}(h]h ]h"]h$]h&]uh1j hjvubah}(h]h ]h"]h$]h&]uh1jhj&ubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhhhhhNhNubeh}(h]contentsah ]contentsah"]contentsah$]h&]uh1hhhhK hhhhubh)}(hhh](h)}(h Introductionh]h Introduction}(hjhhhNhNubah}(h]h ]h"]h$]h&]hj8uh1hhjhhhhhK 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](j )}(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&]uh1j hhhKhjubj )}(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&]uh1j hhhKhjubj)}(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]j )}(hPrivilege Statesh]hPrivilege States}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1j hjubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhjubhtbody)}(hhh](j)}(hhh]j )}(hhh]j )}(hProblemh]hProblem}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhj7ubah}(h]h ]h"]h$]h&]uh1j hj4ubah}(h]h ]h"]h$]h&]uh1jhj1ubj)}(hhh]j )}(hhh]j )}(h Supervisorh]h Supervisor}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhjWubah}(h]h ]h"]h$]h&]uh1j hjTubah}(h]h ]h"]h$]h&]uh1jhj1ubj)}(hhh]j )}(hhh]j )}(h Hypervisorh]h Hypervisor}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK hjwubah}(h]h ]h"]h$]h&]uh1j hjtubah}(h]h ]h"]h$]h&]uh1jhj1ubj)}(hhh]j )}(hhh]j )}(h Ultravisorh]h Ultravisor}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK"hjubah}(h]h ]h"]h$]h&]uh1j hjubah}(h]h ]h"]h$]h&]uh1jhj1ubeh}(h]h ]h"]h$]h&]uh1j/hjubeh}(h]h ]h"]h$]h&]colsKuh1jhjubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj )}(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&]uh1j hhhK%hjubj )}(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&]uh1j hhhK.hjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjhhubh)}(hhh](h)}(hHardwareh]hHardware}(hjhhhNhNubah}(h]h ]h"]h$]h&]hjWuh1hhjhhhhhK3ubj)}(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](j )}(h+The hardware changes include the following:h]h+The hardware changes include the following:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK5hjubj)}(hhh](j)}(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]j )}(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&]uh1j hhhK7hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h2The MSR(S) bit can only be set by the Ultravisor. h]j )}(h1The MSR(S) bit can only be set by the Ultravisor.h]h1The MSR(S) bit can only be set by the Ultravisor.}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK;hj-ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(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]j )}(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.}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK=hjEubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hdThere is a new Ultravisor privileged register, SMFCTRL, which has an enable/disable bit SMFCTRL(E). h]j )}(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).}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKAhj]ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(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](j )}(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.}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKDhjuubj )}(h**Secure Mode MSR Settings**h]hstrong)}(hjh]hSecure Mode MSR Settings}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhKIhjuubj)}(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]j )}(hSh]hS}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKLhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]j )}(hHVh]hHV}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKLhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]j )}(hPRh]hPR}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKLhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]j )}(h Privilegeh]h Privilege}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKLhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhjubj0)}(hhh](j)}(hhh](j )}(hhh]j )}(h1h]h1}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKNhjBubah}(h]h ]h"]h$]h&]uh1j hj?ubj )}(hhh]j )}(h0h]h0}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKNhjYubah}(h]h ]h"]h$]h&]uh1j hj?ubj )}(hhh]j )}(hjGh]h1}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKNhjpubah}(h]h ]h"]h$]h&]uh1j hj?ubj )}(hhh]j )}(hProblemh]hProblem}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKNhjubah}(h]h ]h"]h$]h&]uh1j hj?ubeh}(h]h ]h"]h$]h&]uh1jhj<ubj)}(hhh](j )}(hhh]j )}(hjGh]h1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKPhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]j )}(hj^h]h0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKPhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]j )}(hj^h]h0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKPhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]j )}(hPrivileged(OS)h]hPrivileged(OS)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKPhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1jhj<ubj)}(hhh](j )}(hhh]j )}(hjGh]h1}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKRhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]j )}(hjGh]h1}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKRhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]j )}(hj^h]h0}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKRhj4ubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]j )}(h Ultravisorh]h Ultravisor}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKRhjJubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1jhj<ubj)}(hhh](j )}(hhh]j )}(hjGh]h1}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKThjjubah}(h]h ]h"]h$]h&]uh1j hjgubj )}(hhh]j )}(hjGh]h1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKThjubah}(h]h ]h"]h$]h&]uh1j hjgubj )}(hhh]j )}(hjGh]h1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKThjubah}(h]h ]h"]h$]h&]uh1j hjgubj )}(hhh]j )}(hReservedh]hReserved}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKThjubah}(h]h ]h"]h$]h&]uh1j hjgubeh}(h]h ]h"]h$]h&]uh1jhj<ubeh}(h]h ]h"]h$]h&]uh1j/hjubeh}(h]h ]h"]h$]h&]colsKuh1jhjubah}(h]h ]h"]h$]h&]uh1jhjuubj )}(h**Normal Mode MSR Settings**h]j)}(hjh]hNormal Mode MSR Settings}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhKWhjuubj)}(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]j )}(hjh]hS}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKZhj'ubah}(h]h ]h"]h$]h&]uh1j hj$ubj )}(hhh]j )}(hHVh]hHV}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKZhj=ubah}(h]h ]h"]h$]h&]uh1j hj$ubj )}(hhh]j )}(hPRh]hPR}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKZhjTubah}(h]h ]h"]h$]h&]uh1j hj$ubj )}(hhh]j )}(h Privilegeh]h Privilege}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKZhjkubah}(h]h ]h"]h$]h&]uh1j hj$ubeh}(h]h ]h"]h$]h&]uh1jhj!ubah}(h]h ]h"]h$]h&]uh1jhjubj0)}(hhh](j)}(hhh](j )}(hhh]j )}(hj^h]h0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK\hjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]j )}(hj^h]h0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK\hjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]j )}(hjGh]h1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK\hjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]j )}(hProblemh]hProblem}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK\hjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j )}(hhh]j )}(hj^h]h0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK^hjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]j )}(hj^h]h0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK^hj ubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]j )}(hj^h]h0}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK^hj"ubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]j )}(hPrivileged(OS)h]hPrivileged(OS)}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK^hj8ubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j )}(hhh]j )}(hj^h]h0}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK`hjXubah}(h]h ]h"]h$]h&]uh1j hjUubj )}(hhh]j )}(hjGh]h1}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK`hjnubah}(h]h ]h"]h$]h&]uh1j hjUubj )}(hhh]j )}(hj^h]h0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK`hjubah}(h]h ]h"]h$]h&]uh1j hjUubj )}(hhh]j )}(h Hypervisorh]h Hypervisor}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK`hjubah}(h]h ]h"]h$]h&]uh1j hjUubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j )}(hhh]j )}(hj^h]h0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKbhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]j )}(hjGh]h1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKbhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]j )}(hjGh]h1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKbhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]j )}(hProblem (Host)h]hProblem (Host)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKbhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j/hjubeh}(h]h ]h"]h$]h&]colsKuh1jhjubah}(h]h ]h"]h$]h&]uh1jhjuubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(h~Memory is partitioned into secure and normal memory. Only processes that are running in secure mode can access secure memory. h]j )}(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.}(hj6 hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKehj2 ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(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]j )}(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.}(hjN hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhhjJ ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hiI/O systems are not allowed to directly address secure memory. This limits the SVMs to virtual I/O only. h]j )}(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.}(hjf hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKnhjb ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(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]j )}(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.}(hj~ hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKqhjz ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h^When a process is running in secure mode all hypercalls (syscall lev=1) go to the Ultravisor. h]j )}(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&]uh1j hhhKuhj ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hFWhen a process is in secure mode all interrupts go to the Ultravisor. h]j )}(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&]uh1j hhhKxhj ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(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](j )}(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&]uh1j hhhK{hj ubj)}(hhh](j)}(h,Processor configurations registers (SCOMs). h]j )}(h+Processor configurations registers (SCOMs).h]h+Processor configurations registers (SCOMs).}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK~hj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hStop state information. h]j )}(hStop state information.h]hStop state information.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(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]j )}(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&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(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]j )}(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&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(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]j )}(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&]uh1j hhhKhj7 ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(h|Paging for an SVM, sharing of memory with Hypervisor for an SVM. (Including Virtual Processor Area (VPA) and virtual I/O). h]j )}(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).}(hjS hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhjO ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]bullet*uh1jhhhK~hj ubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]jm jn uh1jhhhK7hjubeh}(h]h ]h"]h$]h&]uh1jhhhK5hjhhubeh}(h]j]ah ]h"]hardwareah$]h&]uh1hhjhhhhhK3ubh)}(hhh](h)}(hSoftware/Microcodeh]hSoftware/Microcode}(hj hhhNhNubah}(h]h ]h"]h$]h&]hjyuh1hhj 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](j )}(hThe software changes include:h]hThe software changes include:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhj ubj)}(hhh](j)}(hMSVMs are created from normal VM using (open source) tooling supplied by IBM. h]j )}(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&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hkAll SVMs start as normal VMs and utilize an ultracall, UV_ESM (Enter Secure Mode), to make the transition. h]j )}(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&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(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]j )}(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&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(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]j )}(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&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hZThe Ultravisor is not involved in protecting the encrypted disk of the SVM while at rest. h]j )}(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&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(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]j )}(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&]uh1j hhhKhj& ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(h7For virtual I/O to work bounce buffering must be done. h]j )}(h6For virtual I/O to work bounce buffering must be done.h]h6For virtual I/O to work bounce buffering must be done.}(hjB hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhj> ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hThe Ultravisor uses AES (IAPM) for protection of SVM memory. IAPM is a mode of AES that provides integrity and secrecy concurrently. h]j )}(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.}(hjZ hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhjV ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hThe movement of data between normal and secure pages is coordinated with the Ultravisor by a new HMM plug-in in the Hypervisor. h]j )}(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.}(hjr hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhjn ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]jm jn uh1jhhhKhj ubj )}(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.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhj ubeh}(h]h ]h"]h$]h&]uh1jhhhKhj hhubeh}(h]jah ]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]j)}(hhh](j)}(hKHypercalls: special system calls used to request services from Hypervisor. h]j )}(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&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(h8Normal memory: Memory that is accessible to Hypervisor. h]j )}(h7Normal memory: Memory that is accessible to Hypervisor.h]h7Normal memory: Memory that is accessible to Hypervisor.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hGNormal page: Page backed by normal memory and available to Hypervisor. h]j )}(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&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(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]j )}(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&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hFSecure memory: Memory that is accessible only to Ultravisor and SVMs. h]j )}(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&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hTSecure page: Page backed by secure memory and only available to Ultravisor and SVM. h]j )}(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&]uh1j hhhKhj7 ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hSVM: Secure Virtual Machine. h]j )}(hSVM: Secure Virtual Machine.h]hSVM: Secure Virtual Machine.}(hjS hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhjO ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hLUltracalls: special system calls used to request services from Ultravisor. h]j )}(hJUltracalls: special system calls used to request services from Ultravisor.h]hJUltracalls: special system calls used to request services from Ultravisor.}(hjk hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhjg ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]jm jn uh1jhhhKhj 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](j )}(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&]uh1j hhhKhj ubj )}(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&]uh1j hhhKhj ubj )}(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&]uh1j hhhKhj ubj )}(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&]uh1j hhhKhj ubj )}(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&]uh1j hhhKhj ubj )}(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&]uh1j hhhKhj ubj )}(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&]uh1j hhhKhj ubhnote)}(hlIf PEF is not enabled, the ultracalls will be redirected to the Hypervisor which must handle/fail the calls.h]j )}(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&]uh1j hhhMhj& 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}(hjG hhhNhNubah}(h]h ]h"]h$]h&]hjuh1hhjD hhhhhMubj)}(hgThis section describes the virtual memory management ultracalls used by the Hypervisor to manage SVMs. h]j )}(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.}(hjY hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjU ubah}(h]h ]h"]h$]h&]uh1jhhhMhjD hhubh)}(hhh](h)}(h UV_PAGE_OUTh]h UV_PAGE_OUT}(hjp hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjm hhhhhM ubj)}(hMEncrypt and move the contents of a page from secure memory to normal memory. h]j )}(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.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhM hj~ ubah}(h]h ]h"]h$]h&]uh1jhhhM hjm 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&]hhƌforcelanguagechighlight_args}uh1j hhhMhj hhubeh}(h]syntaxah ]h"]h$]syntaxah&]uh1hhjm 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](j )}(hOne of the following values:h]hOne of the following values:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhj 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]j)}(hhh](j)}(hU_SUCCESS on success.h]j )}(hj h]hU_SUCCESS on success.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhM!hj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(h%U_PARAMETER if ``lpid`` is invalid.h]j )}(hjh](hU_PARAMETER if }(hj hhhNhNubj )}(h``lpid``h]hlpid}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hj ubh is invalid.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhM"hjubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(h(U_P2 if ``dest_ra`` is invalid.h]j )}(hj1h](hU_P2 if }(hj3hhhNhNubj )}(h ``dest_ra``h]hdest_ra}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj3ubh is invalid.}(hj3hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhM#hj/ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(h4U_P3 if the ``src_gpa`` address is invalid.h]j )}(hjZh](hU_P3 if the }(hj\hhhNhNubj )}(h ``src_gpa``h]hsrc_gpa}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1j hj\ubh address is invalid.}(hj\hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhM$hjXubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(h9U_P4 if any bit in the ``flags`` is unrecognizedh]j )}(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&]uh1j hhhM%hjubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(h8U_P5 if the ``order`` parameter is unsupported.h]j )}(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&]uh1j hhhM&hjubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(h0U_FUNCTION if functionality is not supported.h]j )}(hjh]h0U_FUNCTION if functionality is not supported.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhM'hjubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(h5U_BUSY if page cannot be currently paged-out. h]j )}(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&]uh1j hhhM(hjubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]jm jn uh1jhhhM!hj ubah}(h]h ]h"]h$]h&]uh1jhhhM!hj ubeh}(h]h ]h"]h$]h&]uh1jhhhMhj hhubeh}(h] return-valuesah ]h"]h$] return valuesah&]uh1hhjm hhhhhMj Kubh)}(hhh](h)}(h Descriptionh]h Description}(hjhhhNhNubah}(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](j )}(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.}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhM-hj-ubj )}(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}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1j hj?ubh flag in }(hj?hhhNhNubj )}(h ``flags``h]hflags}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1j hj?ubh parameter.}(hj?hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhM0hj-ubj )}(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.}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhM5hj-ubeh}(h]h ]h"]h$]h&]uh1jhhhM-hjhhubeh}(h] descriptionah ]h"]h$] descriptionah&]uh1hhjm hhhhhM+j Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhM9ubj)}(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](j)}(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]j )}(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&]uh1j hhhM;hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(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]j )}(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&]uh1j hhhMAhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(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]j )}(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&]uh1j hhhMHhj ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]enumtypearabicprefixhsuffix.uh1jhjubah}(h]h ]h"]h$]h&]uh1jhhhM;hjhhubeh}(h] use-casesah ]h"]h$] use casesah&]uh1hhjm hhhhhM9j Kubeh}(h] uv-page-outah ]h"] uv_page_outah$]h&]uh1hhjD hhhhhM ubh)}(hhh](h)}(h UV_PAGE_INh]h UV_PAGE_IN}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjFhhhhhMNubj)}(hAMove the contents of a page from normal memory to secure memory. h]j )}(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.}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMPhjWubah}(h]h ]h"]h$]h&]uh1jhhhMPhjFhhubh)}(hhh](h)}(hSyntaxh]hSyntax}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjohhhhhMSubj )}(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 */}hjsbah}(h]h ]h"]h$]h&]hhj j j j }uh1j hhhMUhjohhubeh}(h]id1ah ]h"]h$]j ah&]uh1hhjFhhhhhMSj 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](j )}(hOne of the following values:h]hOne of the following values:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMahjubj)}(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]j)}(hhh](j)}(hU_SUCCESS on success.h]j )}(hjh]hU_SUCCESS on success.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMchjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h3U_BUSY if page cannot be currently paged-in.h]j )}(hjh]h3U_BUSY if page cannot be currently paged-in.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMdhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h/U_FUNCTION if functionality is not supportedh]j )}(hjh]h/U_FUNCTION if functionality is not supported}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMehjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h%U_PARAMETER if ``lpid`` is invalid.h]j )}(hjh](hU_PARAMETER if }(hj hhhNhNubj )}(h``lpid``h]hlpid}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hj ubh is invalid.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhMfhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h'U_P2 if ``src_ra`` is invalid.h]j )}(hj0h](hU_P2 if }(hj2hhhNhNubj )}(h ``src_ra``h]hsrc_ra}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj2ubh is invalid.}(hj2hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhMghj.ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h5U_P3 if the ``dest_gpa`` address is invalid.h]j )}(hjYh](hU_P3 if the }(hj[hhhNhNubj )}(h ``dest_gpa``h]hdest_gpa}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1j hj[ubh address is invalid.}(hj[hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhMhhjWubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h9U_P4 if any bit in the ``flags`` is unrecognizedh]j )}(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&]uh1j hhhMihjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h9U_P5 if the ``order`` parameter is unsupported. h]j )}(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&]uh1j hhhMjhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]jm jn uh1jhhhMchjubah}(h]h ]h"]h$]h&]uh1jhhhMchjubeh}(h]h ]h"]h$]h&]uh1jhhhMahjhhubeh}(h]id2ah ]h"]h$]jah&]uh1hhjFhhhhhM_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](j )}(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}(hj hhhNhNubah}(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&]uh1j hhhMohjubj )}(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 }(hj3hhhNhNubhtitle_reference)}(h `dest_gpa`h]hdest_gpa}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1j;hj3ubh_ refers to a shared address, map the page into the partition-scoped page-table of the SVM. If }(hj3hhhNhNubj<)}(h `dest_gpa`h]hdest_gpa}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1j;hj3ubh is not shared, copy the contents of the page into the corresponding secure page. Depending on the context, decrypt the page before being copied.}(hj3hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhMshjubj )}(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 }(hjghhhNhNubj )}(h ``flags``h]hflags}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1j hjgubh parameter. Valid values for }(hjghhhNhNubj )}(h ``flags``h]hflags}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjgubh are:}(hjghhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhMxhjubj)}(h5* CACHE_INHIBITED * CACHE_ENABLED * WRITE_PROTECTION h]j)}(hhh](j)}(hCACHE_INHIBITEDh]j )}(hjh]hCACHE_INHIBITED}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhM{hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h CACHE_ENABLEDh]j )}(hjh]h CACHE_ENABLED}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhM|hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hWRITE_PROTECTION h]j )}(hWRITE_PROTECTIONh]hWRITE_PROTECTION}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhM}hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]jm jn uh1jhhhM{hjubah}(h]h ]h"]h$]h&]uh1jhhhM{hjubj )}(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&]uh1j hhhMhjubeh}(h]h ]h"]h$]h&]uh1jhhhMohjhhubeh}(h]id3ah ]h"]h$]jah&]uh1hhjFhhhhhMmj Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubj)}(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](j)}(hqWhen a normal VM switches to secure mode, all its pages residing in normal memory, are moved into secure memory. h]j )}(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&]uh1j hhhMhj7ubah}(h]h ]h"]h$]h&]uh1jhj4ubj)}(hqWhen an SVM requests to share a page with Hypervisor the Hypervisor allocates a page and informs the Ultravisor. h]j )}(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.}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjOubah}(h]h ]h"]h$]h&]uh1jhj4ubj)}(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]j )}(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.}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjgubah}(h]h ]h"]h$]h&]uh1jhj4ubeh}(h]h ]h"]h$]h&]j+j,j-hj.j/uh1jhj0ubah}(h]h ]h"]h$]h&]uh1jhhhMhjhhubeh}(h]id4ah ]h"]h$]j<ah&]uh1hhjFhhhhhMj Kubeh}(h] uv-page-inah ]h"] uv_page_inah$]h&]uh1hhjD 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]j )}(h,Invalidate the Ultravisor mapping of a page.h]h,Invalidate the Ultravisor mapping of a page.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjubah}(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](j )}(hOne of the following values:h]hOne of the following values:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjubj)}(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]j)}(hhh](j)}(hU_SUCCESS on success.h]j )}(hjh]hU_SUCCESS on success.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h%U_PARAMETER if ``lpid`` is invalid.h]j )}(hj.h](hU_PARAMETER if }(hj0hhhNhNubj )}(h``lpid``h]hlpid}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj0ubh is invalid.}(hj0hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhMhj,ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(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 }(hjfhhhNhNubj )}(h ``guest_pa``h]hguest_pa}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjfubh' is invalid (or corresponds to a secure}(hjfhhhNhNubeh}(h]h ]h"]h$]h&]uh1jdhhhMhj`ubh definition)}(hhh]j )}(hpage mapping).h]hpage mapping).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjubah}(h]h ]h"]h$]h&]uh1jhj`ubeh}(h]h ]h"]h$]h&]uh1j^hhhMhj[ubah}(h]h ]h"]h$]h&]uh1jYhjUubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h*U_P3 if the ``order`` is invalid.h]j )}(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&]uh1j hhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h0U_FUNCTION if functionality is not supported.h]j )}(hjh]h0U_FUNCTION if functionality is not supported.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h7U_BUSY if page cannot be currently invalidated. h]j )}(h6U_BUSY if page cannot be currently invalidated.h]h6U_BUSY if page cannot be currently invalidated.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]jm jn uh1jhhhMhjubah}(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}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#hhhhhMubj)}(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]j )}(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 }(hj8hhhNhNubj )}(h ``guest_pa``h]hguest_pa}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj8ubhi corresponds to a secure page, Ultravisor will ignore the attempt to invalidate the page and return U_P2.}(hj8hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhMhj4ubah}(h]h ]h"]h$]h&]uh1jhhhMhj#hhubeh}(h]id7ah ]h"]h$] descriptionah&]uh1hhjhhhhhMj Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1hhjfhhhhhMubj)}(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]j)}(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]j )}(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.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhj~ubah}(h]h ]h"]h$]h&]uh1jhj{ubah}(h]h ]h"]h$]h&]j+j,j-hj.j/uh1jhjwubah}(h]h ]h"]h$]h&]uh1jhhhMhjfhhubeh}(h]id8ah ]h"]h$] use casesah&]uh1hhjhhhhhMj Kubeh}(h] uv-page-invalah ]h"] uv_page_invalah$]h&]uh1hhjD 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]j )}(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&]uh1j hhhMhjubah}(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](j )}(hOne of the following values:h]hOne of the following values:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjubj)}(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]j)}(hhh](j)}(hU_SUCCESS on success.h]j )}(hj/h]hU_SUCCESS on success.}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhj-ubah}(h]h ]h"]h$]h&]uh1jhj*ubj)}(h5U_BUSY if PATE cannot be currently written to.h]j )}(hjFh]h5U_BUSY if PATE cannot be currently written to.}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjDubah}(h]h ]h"]h$]h&]uh1jhj*ubj)}(h0U_FUNCTION if functionality is not supported.h]j )}(hj]h]h0U_FUNCTION if functionality is not supported.}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhj[ubah}(h]h ]h"]h$]h&]uh1jhj*ubj)}(h%U_PARAMETER if ``lpid`` is invalid.h]j )}(hjth](hU_PARAMETER if }(hjvhhhNhNubj )}(h``lpid``h]hlpid}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjvubh is invalid.}(hjvhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhMhjrubah}(h]h ]h"]h$]h&]uh1jhj*ubj)}(h$U_P2 if ``dw0`` is invalid.h]j )}(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&]uh1j hhhMhjubah}(h]h ]h"]h$]h&]uh1jhj*ubj)}(h0U_P3 if the ``dw1`` address is invalid.h]j )}(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&]uh1j hhhMhjubah}(h]h ]h"]h$]h&]uh1jhj*ubj)}(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]jZ)}(hhh]j_)}(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](je)}(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&]uh1jdhhhMhjubj)}(hhh]j )}(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.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j^hhhMhjubah}(h]h ]h"]h$]h&]uh1jYhjubah}(h]h ]h"]h$]h&]uh1jhj*ubeh}(h]h ]h"]h$]h&]jm jn uh1jhhhMhj&ubah}(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}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjIhhhhhMubj)}(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]j )}(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.}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjZubah}(h]h ]h"]h$]h&]uh1jhhhMhjIhhubeh}(h]id11ah ]h"]h$] descriptionah&]uh1hhjhhhhhMj Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjzhhhhhMubj)}(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](j)}(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]j )}(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&]uh1j hhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(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]j )}(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&]uh1j hhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hmIf the value of the PATE for an existing partition (VM) changes, the TLB cache for the partition is flushed. h]j )}(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&]uh1j hhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(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]j )}(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&]uh1j hhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]j+j,j-hj.j/uh1jhjubah}(h]h ]h"]h$]h&]uh1jhhhMhjzhhubeh}(h]id12ah ]h"]h$] use casesah&]uh1hhjhhhhhMj Kubeh}(h] uv-write-pateah ]h"] uv_write_pateah$]h&]uh1hhjD 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]j )}(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 }(hj#hhhNhNubhemphasis)}(h *reflected*h]h reflected}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1j+hj#ubh) to the Hypervisor.}(hj#hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhMhjubah}(h]h ]h"]h$]h&]uh1jhhhMhjhhubh)}(hhh](h)}(hSyntaxh]hSyntax}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjKhhhhhMubj )}(h,uint64_t ultracall(const uint64_t UV_RETURN)h]h,uint64_t ultracall(const uint64_t UV_RETURN)}hj\sbah}(h]h ]h"]h$]h&]hhj j j j }uh1j hhhMhjKhhubeh}(h]id13ah ]h"]h$]syntaxah&]uh1hhjhhhhhMj Kubh)}(hhh](h)}(h Return valuesh]h Return values}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjshhhhhM ubj)}(h|This call never returns to Hypervisor on success. It returns U_INVALID if ultracall is not made from a Hypervisor context. h]j )}(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.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhM hjubah}(h]h ]h"]h$]h&]uh1jhhhM hjshhubeh}(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](j )}(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&]uh1j+hjubhY) 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&]uh1j hhhMhjubj )}(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&]uh1j hhhMhjubj)}(hhh](j)}(h=Non-volatile registers are restored to their original values.h]j )}(hjh]h=Non-volatile registers are restored to their original values.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(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]j )}(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 (}(hjhhhNhNubj)}(h**unlike other ultracalls**h]hunlike other ultracalls}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhK) and, registers R4 through R12 contain any output values of the hypercall.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h0R3 contains the ultracall number, i.e UV_RETURN.h]j )}(hj?h]h0R3 contains the ultracall number, i.e UV_RETURN.}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhj=ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hYIf returning with a synthesized interrupt, R2 contains the synthesized interrupt number. h]j )}(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.}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjTubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]jm jn uh1jhhhMhjubeh}(h]h ]h"]h$]h&]uh1jhhhMhjhhubeh}(h]id15ah ]h"]h$] descriptionah&]uh1hhjhhhhhMj Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhM!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](j)}(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]j )}(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&]uh1j hhhM#hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hDHypervisor has to use this ultracall to return control to the SVM. h]j )}(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&]uh1j hhhM(hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]j+j,j-hj.j/uh1jhjubah}(h]h ]h"]h$]h&]uh1jhhhM#hjhhubeh}(h]id16ah ]h"]h$] use casesah&]uh1hhjhhhhhM!j Kubeh}(h] uv-returnah ]h"] uv_returnah$]h&]uh1hhjD 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]j )}(h8Register an SVM address-range with specified properties.h]h8Register an SVM address-range with specified properties.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhM.hjubah}(h]h ]h"]h$]h&]uh1jhhhM.hjhhubh)}(hhh](h)}(hSyntaxh]hSyntax}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhM1ubj )}(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 */}hjsbah}(h]h ]h"]h$]h&]hhj j j j }uh1j hhhM3hj hhubeh}(h]id17ah ]h"]h$]syntaxah&]uh1hhjhhhhhM1j Kubh)}(hhh](h)}(h Return valuesh]h Return values}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5hhhhhM=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](j )}(hOne of the following values:h]hOne of the following values:}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhM?hjFubj)}(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]j)}(hhh](j)}(hU_SUCCESS on success.h]j )}(hjah]hU_SUCCESS on success.}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMAhj_ubah}(h]h ]h"]h$]h&]uh1jhj\ubj)}(h%U_PARAMETER if ``lpid`` is invalid.h]j )}(hjxh](hU_PARAMETER if }(hjzhhhNhNubj )}(h``lpid``h]hlpid}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjzubh is invalid.}(hjzhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhMBhjvubah}(h]h ]h"]h$]h&]uh1jhj\ubj)}(h*U_P2 if ``start_gpa`` is invalid.h]j )}(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&]uh1j hhhMChjubah}(h]h ]h"]h$]h&]uh1jhj\ubj)}(h%U_P3 if ``size`` is invalid.h]j )}(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&]uh1j hhhMDhjubah}(h]h ]h"]h$]h&]uh1jhj\ubj)}(h:U_P4 if any bit in the ``flags`` is unrecognized.h]j )}(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&]uh1j hhhMEhjubah}(h]h ]h"]h$]h&]uh1jhj\ubj)}(h9U_P5 if the ``slotid`` parameter is unsupported.h]j )}(hjh](hU_P5 if the }(hjhhhNhNubj )}(h ``slotid``h]hslotid}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh parameter is unsupported.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhMFhjubah}(h]h ]h"]h$]h&]uh1jhj\ubj)}(h;U_PERMISSION if called from context other than Hypervisor.h]j )}(hjEh]h;U_PERMISSION if called from context other than Hypervisor.}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMGhjCubah}(h]h ]h"]h$]h&]uh1jhj\ubj)}(h2U_FUNCTION if functionality is not supported. h]j )}(h0U_FUNCTION if functionality is not supported.h]h0U_FUNCTION if functionality is not supported.}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMHhjZubah}(h]h ]h"]h$]h&]uh1jhj\ubeh}(h]h ]h"]h$]h&]jm jn uh1jhhhMAhjXubah}(h]h ]h"]h$]h&]uh1jhhhMAhjFubeh}(h]h ]h"]h$]h&]uh1jhhhM?hj5hhubeh}(h]id18ah ]h"]h$] return valuesah&]uh1hhjhhhhhM=j Kubh)}(hhh](h)}(h Descriptionh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMLubj)}(hRegister a memory range for an SVM. The memory range starts at the guest physical address ``start_gpa`` and is ``size`` bytes long. h]j )}(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&]uh1j hhhMNhjubah}(h]h ]h"]h$]h&]uh1jhhhMNhjhhubeh}(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](j)}(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]j )}(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&]uh1j hhhMUhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hDWhen new memory is hot-plugged, a new memory slot gets registered. h]j )}(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&]uh1j hhhM[hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]j+j,j-hj.j/uh1jhjubah}(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&]uh1hhjD hhhhhM,ubh)}(hhh](h)}(hUV_UNREGISTER_MEM_SLOTh]hUV_UNREGISTER_MEM_SLOT}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjEhhhhhM_ubj)}(h[Unregister an SVM address-range that was previously registered using UV_REGISTER_MEM_SLOT. h]j )}(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.}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMahjVubah}(h]h ]h"]h$]h&]uh1jhhhMahjEhhubh)}(hhh](h)}(hSyntaxh]hSyntax}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjnhhhhhMeubj )}(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 */}hjsbah}(h]h ]h"]h$]h&]hhj j j j }uh1j hhhMghjnhhubeh}(h]id21ah ]h"]h$]syntaxah&]uh1hhjEhhhhhMej 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](j )}(hOne of the following values:h]hOne of the following values:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMphjubj)}(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]j)}(hhh](j)}(hU_SUCCESS on success.h]j )}(hjh]hU_SUCCESS on success.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMrhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h0U_FUNCTION if functionality is not supported.h]j )}(hjh]h0U_FUNCTION if functionality is not supported.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMshjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h%U_PARAMETER if ``lpid`` is invalid.h]j )}(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&]uh1j hhhMthjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h'U_P2 if ``slotid`` is invalid.h]j )}(hjh](hU_P2 if }(hjhhhNhNubj )}(h ``slotid``h]hslotid}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh is invalid.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhMuhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h#. The SVM may decide to unshare a page from the Hypervisor. h]j)}(hhh]j)}(h;The SVM may decide to unshare a page from the Hypervisor. h]j )}(h9The SVM may decide to unshare a page from the Hypervisor.h]h9The SVM may decide to unshare a page from the Hypervisor.}(hjQ#hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjM#ubah}(h]h ]h"]h$]h&]uh1jhjJ#ubah}(h]h ]h"]h$]h&]j+j,j-hj.j/uh1jhjF#ubah}(h]h ]h"]h$]h&]uh1jhhhMhj5#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}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#hhhhhM ubj)}(h6Unshare all pages the SVM has shared with Hypervisor. h]j )}(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&]uh1j hhhM hj#ubah}(h]h ]h"]h$]h&]uh1jhhhM hj#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&]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_INVAL if VM is not secure. h](j )}(hOne of the following values:h]hOne of the following values:}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhj#ubj)}(ht* U_SUCCESS on success. * U_FUNCTION if functionality is not supported. * U_INVAL if VM is not secure. h]j)}(hhh](j)}(hU_SUCCESS on success.h]j )}(hj#h]hU_SUCCESS on success.}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhj#ubah}(h]h ]h"]h$]h&]uh1jhj#ubj)}(h0U_FUNCTION if functionality is not supported.h]j )}(hj$h]h0U_FUNCTION if functionality is not supported.}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhj$ubah}(h]h ]h"]h$]h&]uh1jhj#ubj)}(h#U_INVAL if VM is not secure. h]j )}(h"U_INVAL if VM is not secure.h]h"U_INVAL if VM is not secure.}(hj.$hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhj*$ubah}(h]h ]h"]h$]h&]uh1jhj#ubeh}(h]h ]h"]h$]h&]jm jn uh1jhhhMhj#ubah}(h]h ]h"]h$]h&]uh1jhhhMhj#ubeh}(h]h ]h"]h$]h&]uh1jhhhMhj#hhubeh}(h]id38ah ]h"]h$] return valuesah&]uh1hhj#hhhhhMj Kubh)}(hhh](h)}(h Descriptionh]h Description}(hj_$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj\$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]j )}(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.}(hjq$hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhM hjm$ubah}(h]h ]h"]h$]h&]uh1jhhhM hj\$hhubeh}(h]id39ah ]h"]h$] descriptionah&]uh1hhj#hhhhhMj Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj$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]j)}(hoThis call is needed when ``kexec`` is used to boot a different kernel. It may also be needed during SVM reset. h]j )}(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&]uh1j hhhM*hj$ubah}(h]h ]h"]h$]h&]uh1jhj$ubah}(h]h ]h"]h$]h&]j+j,j-hj.j/uh1jhj$ubah}(h]h ]h"]h$]h&]uh1jhhhM*hj$hhubeh}(h]id40ah ]h"]h$] use casesah&]uh1hhj#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]j )}(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&]uh1j+hj%ubh).}(hj%hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhM0hj$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 */}hj7%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}(hjQ%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjN%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](j )}(hOne of the following values:h]hOne of the following values:}(hjc%hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhM>hj_%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]j)}(hhh](j)}(h=U_SUCCESS on success (including if VM is already secure).h]j )}(hjz%h]h=U_SUCCESS on success (including if VM is already secure).}(hj|%hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhM@hjx%ubah}(h]h ]h"]h$]h&]uh1jhju%ubj)}(h0U_FUNCTION if functionality is not supported.h]j )}(hj%h]h0U_FUNCTION if functionality is not supported.}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMAhj%ubah}(h]h ]h"]h$]h&]uh1jhju%ubj)}(h"U_INVALID if VM is not secure.h]j )}(hj%h]h"U_INVALID if VM is not secure.}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMBhj%ubah}(h]h ]h"]h$]h&]uh1jhju%ubj)}(h.U_PARAMETER if ``esm_blob_addr`` is invalid.h]j )}(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&]uh1j hhhMChj%ubah}(h]h ]h"]h$]h&]uh1jhju%ubj)}(h$U_P2 if ``fdt`` is invalid.h]j )}(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&]uh1j hhhMDhj%ubah}(h]h ]h"]h$]h&]uh1jhju%ubj)}(h+U_PERMISSION if any integrity checks fail.h]j )}(hj&h]h+U_PERMISSION if any integrity checks fail.}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMEhj&ubah}(h]h ]h"]h$]h&]uh1jhju%ubj)}(h0U_RETRY insufficient memory to create SVM.h]j )}(hj(&h]h0U_RETRY insufficient memory to create SVM.}(hj*&hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMFhj&&ubah}(h]h ]h"]h$]h&]uh1jhju%ubj)}(h)U_NO_KEY symmetric key unavailable. h]j )}(h(U_NO_KEY symmetric key unavailable.h]h(U_NO_KEY symmetric key unavailable.}(hjA&hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMGhj=&ubah}(h]h ]h"]h$]h&]uh1jhju%ubeh}(h]h ]h"]h$]h&]jm jn uh1jhhhM@hjq%ubah}(h]h ]h"]h$]h&]uh1jhhhM@hj_%ubeh}(h]h ]h"]h$]h&]uh1jhhhM>hjN%hhubeh}(h]id42ah ]h"]h$] return valuesah&]uh1hhj$hhhhhM<j Kubh)}(hhh](h)}(h Descriptionh]h Description}(hjr&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjo&hhhhhMJubj)}(hSecure the virtual machine. On successful completion, return control to the virtual machine at the address specified in the ESM blob. h]j )}(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.}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMLhj&ubah}(h]h ]h"]h$]h&]uh1jhhhMLhjo&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]j)}(h@A normal virtual machine can choose to switch to a secure mode. h]j )}(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&]uh1j hhhMShj&ubah}(h]h ]h"]h$]h&]uh1jhj&ubah}(h]h ]h"]h$]h&]j+j,j-hj.j/uh1jhj&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&]hj8uh1hhj&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](j )}(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&]uh1j hhhMXhj 'ubj )}(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&]uh1j hhhM\hj 'ubj )}(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&]uh1j hhhMdhj 'ubj )}(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.}(hj9'hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMghj 'ubeh}(h]h ]h"]h$]h&]uh1jhhhMXhj&hhubh)}(hhh](h)}(h&Hypervisor calls to support Ultravisorh]h&Hypervisor calls to support Ultravisor}(hjP'hhhNhNubah}(h]h ]h"]h$]h&]hjWuh1hhjM'hhhhhMlubj)}(hBFollowing are the set of hypercalls needed to support Ultravisor. h]j )}(hAFollowing are the set of hypercalls needed to support Ultravisor.h]hAFollowing are the set of hypercalls needed to support Ultravisor.}(hjb'hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMnhj^'ubah}(h]h ]h"]h$]h&]uh1jhhhMnhjM'hhubh)}(hhh](h)}(hH_SVM_INIT_STARTh]hH_SVM_INIT_START}(hjy'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjv'hhhhhMqubj)}(hFBegin the process of converting a normal virtual machine into an SVM. h]j )}(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.}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMshj'ubah}(h]h ]h"]h$]h&]uh1jhhhMshjv'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&]uh1hhjv'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](j )}(hOne of the following values:h]hOne of the following values:}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhj'ubj)}(hb* H_SUCCESS on success. * H_STATE if the VM is not in a position to switch to secure. h]j)}(hhh](j)}(hH_SUCCESS on success.h]j )}(hj'h]hH_SUCCESS on success.}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhj'ubah}(h]h ]h"]h$]h&]uh1jhj'ubj)}(hCH_STATE if the VM is not in a position to switch to secure. h]j )}(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&]uh1j hhhMhj(ubah}(h]h ]h"]h$]h&]uh1jhj'ubeh}(h]h ]h"]h$]h&]jm jn uh1jhhhMhj'ubah}(h]h ]h"]h$]h&]uh1jhhhMhj'ubeh}(h]h ]h"]h$]h&]uh1jhhhMhj'hhubeh}(h]id46ah ]h"]h$] return valuesah&]uh1hhjv'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]j )}(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.}(hjO(hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjK(ubah}(h]h ]h"]h$]h&]uh1jhhhMhj:(hhubeh}(h]id47ah ]h"]h$] descriptionah&]uh1hhjv'hhhhhMj Kubh)}(hhh](h)}(h Use casesh]h Use cases}(hjn(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjk(hhhhhMubj)}(h|#. Ultravisor uses this hypercall to inform Hypervisor that a VM has initiated the process of switching to secure mode. h]j)}(hhh]j)}(hvUltravisor uses this hypercall to inform Hypervisor that a VM has initiated the process of switching to secure mode. h]j )}(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.}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhj(ubah}(h]h ]h"]h$]h&]uh1jhj(ubah}(h]h ]h"]h$]h&]j+j,j-hj.j/uh1jhj|(ubah}(h]h ]h"]h$]h&]uh1jhhhMhjk(hhubeh}(h]id48ah ]h"]h$] use casesah&]uh1hhjv'hhhhhMj Kubeh}(h]h-svm-init-startah ]h"]h_svm_init_startah$]h&]uh1hhjM'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]j )}(h(Complete the process of securing an SVM.h]h(Complete the process of securing an SVM.}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhj(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](j )}(hOne of the following values:h]hOne of the following values:}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhj)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]j)}(hhh](j)}(h!H_SUCCESS on success.h]j )}(hj4)h]h!H_SUCCESS on success.}(hj6)hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhj2)ubah}(h]h ]h"]h$]h&]uh1jhj/)ubj)}(hH_UNSUPPORTED if called from the wrong context (e.g. from an SVM or before an H_SVM_INIT_START hypercall).h]jZ)}(hhh]j_)}(hrH_UNSUPPORTED if called from the wrong context (e.g. from an SVM or before an H_SVM_INIT_START hypercall).h](je)}(hH_STATE if the hypervisor could not successfullyh]h>H_STATE if the hypervisor could not successfully}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1jdhhhMhj)ubj)}(hhh]j )}(htransition the VM to Secure VM.h]htransition the VM to Secure VM.}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhj)ubah}(h]h ]h"]h$]h&]uh1jhj)ubeh}(h]h ]h"]h$]h&]uh1j^hhhMhj)ubah}(h]h ]h"]h$]h&]uh1jYhj)ubah}(h]h ]h"]h$]h&]uh1jhj/)ubeh}(h]h ]h"]h$]h&]jm jn uh1jhhhMhj+)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]j )}(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&]uh1j hhhMhj)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]j )}(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&]uh1j hhhMhj;*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&]uh1hhjM'hhhhhMubh)}(hhh](h)}(hH_SVM_INIT_ABORTh]hH_SVM_INIT_ABORT}(hjf*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjc*hhhhhMubj)}(h&Abort the process of securing an SVM. h]j )}(h%Abort the process of securing an SVM.h]h%Abort the process of securing an SVM.}(hjx*hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjt*ubah}(h]h ]h"]h$]h&]uh1jhhhMhjc*hhubh)}(hhh](h)}(hSyntaxh]hSyntax}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj*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 hhhMhj*hhubeh}(h]id53ah ]h"]h$]syntaxah&]uh1hhjc*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](j )}(hOne of the following values:h]hOne of the following values:}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhj*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]j)}(hhh](j)}(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]jZ)}(hhh]j_)}(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](je)}(hah ]h"]hypervisor calls apiah$]h&]uh1hhhhhhhhMVubh)}(hhh](h)}(h Referencesh]h References}(hj1hhhNhNubah}(h]h ]h"]h$]h&]hjuh1hhj1hhhhhM[ubj)}(hhh]j)}(h`Supporting Protected Computing on IBM Power Architecture `_h]j )}(hj1h](j)}(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/uh1jhj1ubh)}(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&]uh1j hhhM]hj1ubah}(h]h ]h"]h$]h&]uh1jhj1hhhhhNubah}(h]h ]h"]h$]h&]jm -uh1jhhhM]hj1hhubeh}(h]jah ]h"] referencesah$]h&]uh1hhhhhhhhM[ubeh}(h](jheh ]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_backlinksj footnote_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_handlerj2error_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourcehnj _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}(j1hj1jjjj j>j j]j jj jj&jjjjCj@syntaxN return valuesN descriptionN use casesNjjjjj jjjjBj?jjjjj&jj!j!j~#j{#j$j$j&j&j1j>j1j]j(j(j`*j]*j'-j$-j/j/j1j}1j1jj1j1u nametypes}(j1j1jj j j j j&jjCjW2jX2jY2jZ2jjj jjBjjj&j!j~#j$j&j1j1j(j`*j'-j/j1j1j1uh}(hhjhjhj>jj]jjj jj jj jjD j@jm j j jj jjj8jjjFjjojjjjjjjjjjjjj`j#jjfjjjjjCjjtjIjjzjjjmjKjjsjzjjjj?jj/j jj5jjj7jjjEjjnjljjjrjjjjjLj*jjRjGjjjMjjj!jjjj j j;!j j!jA!j{#j!j!j!j"j!j/#j"js#j5#j$j#j#j#jV$j#j$j\$j$j$j&j$jH%j&%ji&jN%j&jo&j&j&j>j&j]jM'j(jv'j'j'j4(j'je(j:(j(jk(j]*j(j)j(j)j)j$*j)jU*j**j$-jc*j*j*j+j*j,j+j-j,j/j*-ju-jS-jL.j{-j/jR.j/j/j}1j/j/j/j0j/j11j0ju1j71jj1j1j1hjj8j/jWjNjyjpjjjjjjj jj8j/jWjNjj|u 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]j )}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj~2hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj{2ubah}(h]h ]h"]h$]h&]jalevelKtypeINFOsourcehnjlineMSuh1jy2hjohhhhhMSubjz2)}(hhh]j )}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj2ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehnjlineM_uh1jy2hjhhhhhM_ubjz2)}(hhh]j )}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj2ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehnjlineMmuh1jy2hjhhhhhMmubjz2)}(hhh]j )}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj2ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehnjlineMuh1jy2hjhhhhhMubjz2)}(hhh]j )}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj2ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehnjlineMuh1jy2hjhhhhhMubjz2)}(hhh]j )}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj3ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehnjlineMuh1jy2hjhhhhhMubjz2)}(hhh]j )}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj!3hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj3ubah}(h]h ]h"]h$]h&]j`alevelKtypej2sourcehnjlineMuh1jy2hj#hhhhhMubjz2)}(hhh]j )}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj<3hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj93ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehnjlineMuh1jy2hjfhhhhhMubjz2)}(hhh]j )}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hjW3hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjT3ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehnjlineMuh1jy2hjhhhhhMubjz2)}(hhh]j )}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hjr3hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjo3ubah}(h]h ]h"]h$]h&]jCalevelKtypej2sourcehnjlineMuh1jy2hjhhhhhMubjz2)}(hhh]j )}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj3ubah}(h]h ]h"]h$]h&]jtalevelKtypej2sourcehnjlineMuh1jy2hjIhhhhhMubjz2)}(hhh]j )}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj3ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehnjlineMuh1jy2hjzhhhhhMubjz2)}(hhh]j )}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj3ubah}(h]h ]h"]h$]h&]jmalevelKtypej2sourcehnjlineMuh1jy2hjKhhhhhMubjz2)}(hhh]j )}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj3ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehnjlineM uh1jy2hjshhhhhM ubjz2)}(hhh]j )}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj3ubah}(h]h ]h"]h$]h&]jzalevelKtypej2sourcehnjlineMuh1jy2hjhhhhhMubjz2)}(hhh]j )}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj4ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehnjlineM!uh1jy2hjhhhhhM!ubjz2)}(hhh]j )}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj/4hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj,4ubah}(h]h ]h"]h$]h&]j/alevelKtypej2sourcehnjlineM1uh1jy2hj hhhhhM1ubjz2)}(hhh]j )}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hjJ4hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjG4ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehnjlineM=uh1jy2hj5hhhhhM=ubjz2)}(hhh]j )}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hje4hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjb4ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehnjlineMLuh1jy2hjhhhhhMLubjz2)}(hhh]j )}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj}4ubah}(h]h ]h"]h$]h&]j7alevelKtypej2sourcehnjlineMRuh1jy2hjhhhhhMRubjz2)}(hhh]j )}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj4ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehnjlineMeuh1jy2hjnhhhhhMeubjz2)}(hhh]j )}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj4ubah}(h]h ]h"]h$]h&]jlalevelKtypej2sourcehnjlineMnuh1jy2hjhhhhhMnubjz2)}(hhh]j )}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj4ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehnjlineMyuh1jy2hjrhhhhhMyubjz2)}(hhh]j )}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj4ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehnjlineMuh1jy2hjhhhhhMubjz2)}(hhh]j )}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj5ubah}(h]h ]h"]h$]h&]jLalevelKtypej2sourcehnjlineMuh1jy2hj*hhhhhMubjz2)}(hhh]j )}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj"5hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj5ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehnjlineMuh1jy2hjRhhhhhMubjz2)}(hhh]j )}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj=5hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj:5ubah}(h]h ]h"]h$]h&]jGalevelKtypej2sourcehnjlineMuh1jy2hjhhhhhMubjz2)}(hhh]j )}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hjX5hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjU5ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehnjlineMuh1jy2hjMhhhhhMubjz2)}(hhh]j )}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hjs5hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjp5ubah}(h]h ]h"]h$]h&]jalevelKtypej2sourcehnjlineMuh1jy2hjhhhhhMubjz2)}(hhh]j )}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj5ubah}(h]h ]h"]h$]h&]j alevelKtypej2sourcehnjlineMuh1jy2hj hhhhhMubjz2)}(hhh]j )}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj5ubah}(h]h ]h"]h$]h&]j;!alevelKtypej2sourcehnjlineMuh1jy2hj hhhhhMubjz2)}(hhh]j )}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj5ubah}(h]h ]h"]h$]h&]j!alevelKtypej2sourcehnjlineMuh1jy2hjA!hhhhhMubjz2)}(hhh]j )}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj5ubah}(h]h ]h"]h$]h&]j!alevelKtypej2sourcehnjlineMuh1jy2hj!hhhhhMubjz2)}(hhh]j )}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj5ubah}(h]h ]h"]h$]h&]j"alevelKtypej2sourcehnjlineMuh1jy2hj!hhhhhMubjz2)}(hhh]j )}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj6ubah}(h]h ]h"]h$]h&]j/#alevelKtypej2sourcehnjlineMuh1jy2hj"hhhhhMubjz2)}(hhh]j )}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj06hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj-6ubah}(h]h ]h"]h$]h&]js#alevelKtypej2sourcehnjlineMuh1jy2hj5#hhhhhMubjz2)}(hhh]j )}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hjK6hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjH6ubah}(h]h ]h"]h$]h&]j#alevelKtypej2sourcehnjlineMuh1jy2hj#hhhhhMubjz2)}(hhh]j )}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hjf6hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjc6ubah}(h]h ]h"]h$]h&]jV$alevelKtypej2sourcehnjlineMuh1jy2hj#hhhhhMubjz2)}(hhh]j )}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj~6ubah}(h]h ]h"]h$]h&]j$alevelKtypej2sourcehnjlineMuh1jy2hj\$hhhhhMubjz2)}(hhh]j )}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj6ubah}(h]h ]h"]h$]h&]j$alevelKtypej2sourcehnjlineM(uh1jy2hj$hhhhhM(ubjz2)}(hhh]j )}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj6ubah}(h]h ]h"]h$]h&]jH%alevelKtypej2sourcehnjlineM3uh1jy2hj&%hhhhhM3ubjz2)}(hhh]j )}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj6ubah}(h]h ]h"]h$]h&]ji&alevelKtypej2sourcehnjlineM<uh1jy2hjN%hhhhhM<ubjz2)}(hhh]j )}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj6ubah}(h]h ]h"]h$]h&]j&alevelKtypej2sourcehnjlineMJuh1jy2hjo&hhhhhMJubjz2)}(hhh]j )}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj7ubah}(h]h ]h"]h$]h&]j&alevelKtypej2sourcehnjlineMQuh1jy2hj&hhhhhMQubjz2)}(hhh]j )}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj#7hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj 7ubah}(h]h ]h"]h$]h&]j'alevelKtypej2sourcehnjlineMvuh1jy2hj'hhhhhMvubjz2)}(hhh]j )}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj>7hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj;7ubah}(h]h ]h"]h$]h&]j4(alevelKtypej2sourcehnjlineM}uh1jy2hj'hhhhhM}ubjz2)}(hhh]j )}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hjY7hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjV7ubah}(h]h ]h"]h$]h&]je(alevelKtypej2sourcehnjlineMuh1jy2hj:(hhhhhMubjz2)}(hhh]j )}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hjt7hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjq7ubah}(h]h ]h"]h$]h&]j(alevelKtypej2sourcehnjlineMuh1jy2hjk(hhhhhMubjz2)}(hhh]j )}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj7ubah}(h]h ]h"]h$]h&]j)alevelKtypej2sourcehnjlineMuh1jy2hj(hhhhhMubjz2)}(hhh]j )}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj7ubah}(h]h ]h"]h$]h&]j)alevelKtypej2sourcehnjlineMuh1jy2hj)hhhhhMubjz2)}(hhh]j )}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj7ubah}(h]h ]h"]h$]h&]j$*alevelKtypej2sourcehnjlineMuh1jy2hj)hhhhhMubjz2)}(hhh]j )}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj7ubah}(h]h ]h"]h$]h&]jU*alevelKtypej2sourcehnjlineMuh1jy2hj**hhhhhMubjz2)}(hhh]j )}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj7ubah}(h]h ]h"]h$]h&]j*alevelKtypej2sourcehnjlineMuh1jy2hj*hhhhhMubjz2)}(hhh]j )}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj8ubah}(h]h ]h"]h$]h&]j+alevelKtypej2sourcehnjlineMuh1jy2hj*hhhhhMubjz2)}(hhh]j )}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj18hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj.8ubah}(h]h ]h"]h$]h&]j,alevelKtypej2sourcehnjlineMuh1jy2hj+hhhhhMubjz2)}(hhh]j )}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hjL8hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjI8ubah}(h]h ]h"]h$]h&]j-alevelKtypej2sourcehnjlineMuh1jy2hj,hhhhhMubjz2)}(hhh]j )}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hjg8hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjd8ubah}(h]h ]h"]h$]h&]ju-alevelKtypej2sourcehnjlineMuh1jy2hjS-hhhhhMubjz2)}(hhh]j )}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj8ubah}(h]h ]h"]h$]h&]jL.alevelKtypej2sourcehnjlineMuh1jy2hj{-hhhhhMubjz2)}(hhh]j )}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj8ubah}(h]h ]h"]h$]h&]j/alevelKtypej2sourcehnjlineMuh1jy2hjR.hhhhhMubjz2)}(hhh]j )}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj8ubah}(h]h ]h"]h$]h&]j/alevelKtypej2sourcehnjlineM uh1jy2hj/hhhhhM ubjz2)}(hhh]j )}(h)Duplicate implicit target name: "syntax".h]h-Duplicate implicit target name: “syntax”.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj8ubah}(h]h ]h"]h$]h&]j/alevelKtypej2sourcehnjlineM7uh1jy2hj/hhhhhM7ubjz2)}(hhh]j )}(h0Duplicate implicit target name: "return values".h]h4Duplicate implicit target name: “return values”.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj8ubah}(h]h ]h"]h$]h&]j0alevelKtypej2sourcehnjlineMAuh1jy2hj/hhhhhMAubjz2)}(hhh]j )}(h.Duplicate implicit target name: "description".h]h2Duplicate implicit target name: “description”.}(hj 9hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj9ubah}(h]h ]h"]h$]h&]j11alevelKtypej2sourcehnjlineMKuh1jy2hj0hhhhhMKubjz2)}(hhh]j )}(h,Duplicate implicit target name: "use cases".h]h0Duplicate implicit target name: “use cases”.}(hj$9hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj!9ubah}(h]h ]h"]h$]h&]ju1alevelKtypej2sourcehnjlineMTuh1jy2hj71hhhhhMTubetransform_messages]jz2)}(hhh]j )}(hhh]h0Hyperlink target "ultravisor" is not referenced.}hjA9sbah}(h]h ]h"]h$]h&]uh1j hj>9ubah}(h]h ]h"]h$]h&]levelKtypej2sourcehnjlineKuh1jy2uba transformerN include_log] decorationNhhub.