€•Œsphinx.addnodes”Œdocument”“”)�”}”(Œ rawsource”Œ”Œchildren”]”(Œ translations”Œ LanguagesNode”“”)�”}”(hhh]”(hŒ pending_xref”“”)�”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…”�”}”Œparent”hsbaŒ attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ refdomain”Œstd”Œreftype”Œdoc”Œ reftarget”Œ+/translations/zh_CN/arch/powerpc/ultravisor”Œmodname”NŒ classname”NŒ refexplicit”ˆuŒtagname”hhh ubh)�”}”(hhh]”hŒChinese (Traditional)”…”�”}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ+/translations/zh_TW/arch/powerpc/ultravisor”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)�”}”(hhh]”hŒItalian”…”�”}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ+/translations/it_IT/arch/powerpc/ultravisor”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)�”}”(hhh]”hŒJapanese”…”�”}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ+/translations/ja_JP/arch/powerpc/ultravisor”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)�”}”(hhh]”hŒKorean”…”�”}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ+/translations/ko_KR/arch/powerpc/ultravisor”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)�”}”(hhh]”hŒPortuguese (Brazilian)”…”�”}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ+/translations/pt_BR/arch/powerpc/ultravisor”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)�”}”(hhh]”hŒSpanish”…”�”}”hh–sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ+/translations/sp_SP/arch/powerpc/ultravisor”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h hhŒ _document”hŒsource”NŒline”NubhŒcomment”“”)�”}”(hŒ SPDX-License-Identifier: GPL-2.0”h]”hŒ SPDX-License-Identifier: GPL-2.0”…”�”}”hh·sbah}”(h]”h ]”h"]”h$]”h&]”Œ xml:space”Œpreserve”uh1hµhhh²hh³ŒE/var/lib/git/docbuild/linux/Documentation/arch/powerpc/ultravisor.rst”h´KubhŒtarget”“”)�”}”(hŒ.. _ultravisor:”h]”h}”(h]”h ]”h"]”h$]”h&]”Œrefid”Œ ultravisor”uh1hÈh´Khhh²hh³hÇubhŒsection”“”)�”}”(hhh]”(hŒtitle”“”)�”}”(hŒProtected Execution Facility”h]”hŒProtected Execution Facility”…”�”}”(hhÝh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”hÔŒid65”uh1hÛhhØh²hh³hÇh´KubhŒtopic”“”)�”}”(hŒ Contents ”h]”(hÜ)�”}”(hŒContents”h]”hŒContents”…”�”}”(hhòh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhhîh³hÇh´K ubhŒ bullet_list”“”)�”}”(hhh]”hŒ list_item”“”)�”}”(hhh]”(hŒ paragraph”“”)�”}”(hhh]”hŒ reference”“”)�”}”(hhh]”hŒProtected Execution Facility”…”�”}”(hjh²hh³Nh´Nubah}”(h]”hëah ]”h"]”h$]”h&]”Œrefid”Œprotected-execution-facility”uh1jhj ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjubj)�”}”(hhh]”(j)�”}”(hhh]”(j )�”}”(hhh]”j)�”}”(hhh]”hŒ Introduction”…”�”}”(hj/h²hh³Nh´Nubah}”(h]”Œid66”ah ]”h"]”h$]”h&]”Œrefid”Œ introduction”uh1jhj,ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj)ubj)�”}”(hhh]”(j)�”}”(hhh]”j )�”}”(hhh]”j)�”}”(hhh]”hŒHardware”…”�”}”(hjNh²hh³Nh´Nubah}”(h]”Œid67”ah ]”h"]”h$]”h&]”Œrefid”Œhardware”uh1jhjKubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjHubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjEubj)�”}”(hhh]”j )�”}”(hhh]”j)�”}”(hhh]”hŒSoftware/Microcode”…”�”}”(hjph²hh³Nh´Nubah}”(h]”Œid68”ah ]”h"]”h$]”h&]”Œrefid”Œsoftware-microcode”uh1jhjmubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjjubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjEubj)�”}”(hhh]”j )�”}”(hhh]”j)�”}”(hhh]”hŒ Terminology”…”�”}”(hj’h²hh³Nh´Nubah}”(h]”Œid69”ah ]”h"]”h$]”h&]”Œrefid”Œ terminology”uh1jhj�ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjŒubah}”(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]”hŒUltravisor calls API”…”�”}”(hjÀh²hh³Nh´Nubah}”(h]”Œid70”ah ]”h"]”h$]”h&]”Œrefid”Œultravisor-calls-api”uh1jhj½ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjºubj)�”}”(hhh]”(j)�”}”(hhh]”j )�”}”(hhh]”j)�”}”(hhh]”hŒUltracalls used by Hypervisor”…”�”}”(hjßh²hh³Nh´Nubah}”(h]”Œid71”ah ]”h"]”h$]”h&]”Œrefid”Œultracalls-used-by-hypervisor”uh1jhjÜubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjÙubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjÖubj)�”}”(hhh]”j )�”}”(hhh]”j)�”}”(hhh]”hŒUltracalls used by SVM”…”�”}”(hjh²hh³Nh´Nubah}”(h]”Œid72”ah ]”h"]”h$]”h&]”Œrefid”Œultracalls-used-by-svm”uh1jhjþubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjûubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjÖubeh}”(h]”h ]”h"]”h$]”h&]”uh1jhjºubeh}”(h]”h ]”h"]”h$]”h&]”uh1jhj&ubj)�”}”(hhh]”(j )�”}”(hhh]”j)�”}”(hhh]”hŒHypervisor Calls API”…”�”}”(hj/h²hh³Nh´Nubah}”(h]”Œid73”ah ]”h"]”h$]”h&]”Œrefid”Œhypervisor-calls-api”uh1jhj,ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj)ubj)�”}”(hhh]”j)�”}”(hhh]”j )�”}”(hhh]”j)�”}”(hhh]”hŒ&Hypervisor calls to support Ultravisor”…”�”}”(hjNh²hh³Nh´Nubah}”(h]”Œid74”ah ]”h"]”h$]”h&]”Œrefid”Œ&hypervisor-calls-to-support-ultravisor”uh1jhjKubah}”(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|h²hh³Nh´Nubah}”(h]”Œid75”ah ]”h"]”h$]”h&]”Œrefid”Œ references”uh1jhjyubah}”(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&]”uh1jhhîh²hh³Nh´Nubeh}”(h]”Œcontents”ah ]”Œcontents”ah"]”Œcontents”ah$]”h&]”uh1hìh³hÇh´K hhØh²hubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Introduction”h]”hŒ Introduction”…”�”}”(hj¶h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”hÔj8uh1hÛhj³h²hh³hÇh´K ubhŒ block_quote”“”)�”}”(hXÆProtected 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 )�”}”(hŒìProtected 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]”hŒìProtected 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.”…”�”}”(hjÊh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KhjÆubj )�”}”(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.”…”�”}”(hjØh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KhjÆubjÅ)�”}”(hŒç+------------------+ | Privilege States | +==================+ | Problem | +------------------+ | Supervisor | +------------------+ | Hypervisor | +------------------+ | Ultravisor | +------------------+ ”h]”hŒtable”“”)�”}”(hhh]”hŒtgroup”“”)�”}”(hhh]”(hŒcolspec”“”)�”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1jôhjñubhŒthead”“”)�”}”(hhh]”hŒrow”“”)�”}”(hhh]”hŒentry”“”)�”}”(hhh]”j )�”}”(hŒPrivilege States”h]”hŒPrivilege States”…”�”}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Khj ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjñubhŒtbody”“”)�”}”(hhh]”(j)�”}”(hhh]”j )�”}”(hhh]”j )�”}”(hŒProblem”h]”hŒProblem”…”�”}”(hj:h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Khj7ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj4ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj1ubj)�”}”(hhh]”j )�”}”(hhh]”j )�”}”(hŒ Supervisor”h]”hŒ Supervisor”…”�”}”(hjZh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KhjWubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjTubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj1ubj)�”}”(hhh]”j )�”}”(hhh]”j )�”}”(hŒ Hypervisor”h]”hŒ Hypervisor”…”�”}”(hjzh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K hjwubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjtubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj1ubj)�”}”(hhh]”j )�”}”(hhh]”j )�”}”(hŒ Ultravisor”h]”hŒ Ultravisor”…”�”}”(hjšh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K"hj—ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj”ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj1ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j/hjñubeh}”(h]”h ]”h"]”h$]”h&]”Œcols”Kuh1jïhjìubah}”(h]”h ]”h"]”h$]”h&]”uh1jêhjæubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´KhjÆubj )�”}”(hXò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.”h]”hXò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.”…”�”}”(hjÍh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K%hjÆubj )�”}”(hŒ±To support this there is a refactoring of the ownership of resources in the CPU. Some of the resources which were previously hypervisor privileged are now ultravisor privileged.”h]”hŒ±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.”…”�”}”(hjÛh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K.hjÆubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´Khj³h²hubh×)�”}”(hhh]”(hÜ)�”}”(hŒHardware”h]”hŒHardware”…”�”}”(hjòh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”hÔjWuh1hÛhjïh²hh³hÇh´K3ubjÅ)�”}”(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:”…”�”}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K5hjubj)�”}”(hhh]”(j)�”}”(hŒ½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. ”h]”j )�”}”(hŒ¼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.”h]”hŒ¼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.”…”�”}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K7hjubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubj)�”}”(hŒ2The MSR(S) bit can only be set by the Ultravisor. ”h]”j )�”}”(hŒ1The MSR(S) bit can only be set by the Ultravisor.”h]”hŒ1The MSR(S) bit can only be set by the Ultravisor.”…”�”}”(hj1h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K;hj-ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubj)�”}”(hŒª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. ”h]”j )�”}”(hŒ©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.”h]”hŒ©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.”…”�”}”(hjIh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K=hjEubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubj)�”}”(hŒdThere is a new Ultravisor privileged register, SMFCTRL, which has an enable/disable bit SMFCTRL(E). ”h]”j )�”}”(hŒcThere is a new Ultravisor privileged register, SMFCTRL, which has an enable/disable bit SMFCTRL(E).”h]”hŒcThere is a new Ultravisor privileged register, SMFCTRL, which has an enable/disable bit SMFCTRL(E).”…”�”}”(hjah²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KAhj]ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubj)�”}”(hXÔ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)| +---+---+---+---------------+ ”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.”…”�”}”(hjyh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KDhjuubj )�”}”(hŒ**Secure Mode MSR Settings**”h]”hŒstrong”“”)�”}”(hj‰h]”hŒSecure Mode MSR Settings”…”�”}”(hj�h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j‹hj‡ubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KIhjuubjë)�”}”(hhh]”jð)�”}”(hhh]”(jõ)�”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1jôhj£ubjõ)�”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1jôhj£ubjõ)�”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1jôhj£ubjõ)�”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1jôhj£ubj)�”}”(hhh]”j)�”}”(hhh]”(j )�”}”(hhh]”j )�”}”(hŒS”h]”hŒS”…”�”}”(hj×h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KLhjÔubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjÑubj )�”}”(hhh]”j )�”}”(hŒHV”h]”hŒHV”…”�”}”(hjîh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KLhjëubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjÑubj )�”}”(hhh]”j )�”}”(hŒPR”h]”hŒPR”…”�”}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KLhjubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjÑubj )�”}”(hhh]”j )�”}”(hŒ Privilege”h]”hŒ Privilege”…”�”}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KLhjubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjÑubeh}”(h]”h ]”h"]”h$]”h&]”uh1jhjÎubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj£ubj0)�”}”(hhh]”(j)�”}”(hhh]”(j )�”}”(hhh]”j )�”}”(hŒ1”h]”hŒ1”…”�”}”(hjEh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KNhjBubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj?ubj )�”}”(hhh]”j )�”}”(hŒ0”h]”hŒ0”…”�”}”(hj\h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KNhjYubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj?ubj )�”}”(hhh]”j )�”}”(hjGh]”hŒ1”…”�”}”(hjsh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KNhjpubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj?ubj )�”}”(hhh]”j )�”}”(hŒProblem”h]”hŒProblem”…”�”}”(hj‰h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KNhj†ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj?ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jhj<ubj)�”}”(hhh]”(j )�”}”(hhh]”j )�”}”(hjGh]”hŒ1”…”�”}”(hj©h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KPhj¦ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj£ubj )�”}”(hhh]”j )�”}”(hj^h]”hŒ0”…”�”}”(hj¿h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KPhj¼ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj£ubj )�”}”(hhh]”j )�”}”(hj^h]”hŒ0”…”�”}”(hjÕh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KPhjÒubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj£ubj )�”}”(hhh]”j )�”}”(hŒPrivileged(OS)”h]”hŒPrivileged(OS)”…”�”}”(hjëh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KPhjèubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj£ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jhj<ubj)�”}”(hhh]”(j )�”}”(hhh]”j )�”}”(hjGh]”hŒ1”…”�”}”(hj h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KRhjubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjubj )�”}”(hhh]”j )�”}”(hjGh]”hŒ1”…”�”}”(hj!h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KRhjubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjubj )�”}”(hhh]”j )�”}”(hj^h]”hŒ0”…”�”}”(hj7h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KRhj4ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjubj )�”}”(hhh]”j )�”}”(hŒ Ultravisor”h]”hŒ Ultravisor”…”�”}”(hjMh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KRhjJubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjubeh}”(h]”h ]”h"]”h$]”h&]”uh1jhj<ubj)�”}”(hhh]”(j )�”}”(hhh]”j )�”}”(hjGh]”hŒ1”…”�”}”(hjmh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KThjjubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjgubj )�”}”(hhh]”j )�”}”(hjGh]”hŒ1”…”�”}”(hjƒh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KThj€ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjgubj )�”}”(hhh]”j )�”}”(hjGh]”hŒ1”…”�”}”(hj™h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KThj–ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjgubj )�”}”(hhh]”j )�”}”(hŒReserved”h]”hŒReserved”…”�”}”(hj¯h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KThj¬ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjgubeh}”(h]”h ]”h"]”h$]”h&]”uh1jhj<ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j/hj£ubeh}”(h]”h ]”h"]”h$]”h&]”Œcols”Kuh1jïhj ubah}”(h]”h ]”h"]”h$]”h&]”uh1jêhjuubj )�”}”(hŒ**Normal Mode MSR Settings**”h]”jŒ)�”}”(hjÞh]”hŒNormal Mode MSR Settings”…”�”}”(hjàh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j‹hjÜubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KWhjuubjë)�”}”(hhh]”jð)�”}”(hhh]”(jõ)�”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1jôhjöubjõ)�”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1jôhjöubjõ)�”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1jôhjöubjõ)�”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1jôhjöubj)�”}”(hhh]”j)�”}”(hhh]”(j )�”}”(hhh]”j )�”}”(hjÙh]”hŒS”…”�”}”(hj*h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KZhj'ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj$ubj )�”}”(hhh]”j )�”}”(hŒHV”h]”hŒHV”…”�”}”(hj@h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KZhj=ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj$ubj )�”}”(hhh]”j )�”}”(hŒPR”h]”hŒPR”…”�”}”(hjWh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KZhjTubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj$ubj )�”}”(hhh]”j )�”}”(hŒ Privilege”h]”hŒ Privilege”…”�”}”(hjnh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KZhjkubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj$ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jhj!ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjöubj0)�”}”(hhh]”(j)�”}”(hhh]”(j )�”}”(hhh]”j )�”}”(hj^h]”hŒ0”…”�”}”(hj—h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K\hj”ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj‘ubj )�”}”(hhh]”j )�”}”(hj^h]”hŒ0”…”�”}”(hj­h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K\hjªubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj‘ubj )�”}”(hhh]”j )�”}”(hjGh]”hŒ1”…”�”}”(hjÃh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K\hjÀubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj‘ubj )�”}”(hhh]”j )�”}”(hŒProblem”h]”hŒProblem”…”�”}”(hjÙh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K\hjÖubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj‘ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jhjŽubj)�”}”(hhh]”(j )�”}”(hhh]”j )�”}”(hj^h]”hŒ0”…”�”}”(hjùh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K^hjöubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjóubj )�”}”(hhh]”j )�”}”(hj^h]”hŒ0”…”�”}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K^hj ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjóubj )�”}”(hhh]”j )�”}”(hj^h]”hŒ0”…”�”}”(hj%h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K^hj"ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjóubj )�”}”(hhh]”j )�”}”(hŒPrivileged(OS)”h]”hŒPrivileged(OS)”…”�”}”(hj;h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K^hj8ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjóubeh}”(h]”h ]”h"]”h$]”h&]”uh1jhjŽubj)�”}”(hhh]”(j )�”}”(hhh]”j )�”}”(hj^h]”hŒ0”…”�”}”(hj[h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K`hjXubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjUubj )�”}”(hhh]”j )�”}”(hjGh]”hŒ1”…”�”}”(hjqh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K`hjnubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjUubj )�”}”(hhh]”j )�”}”(hj^h]”hŒ0”…”�”}”(hj‡h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K`hj„ubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjUubj )�”}”(hhh]”j )�”}”(hŒ Hypervisor”h]”hŒ Hypervisor”…”�”}”(hj�h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K`hjšubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjUubeh}”(h]”h ]”h"]”h$]”h&]”uh1jhjŽubj)�”}”(hhh]”(j )�”}”(hhh]”j )�”}”(hj^h]”hŒ0”…”�”}”(hj½h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Kbhjºubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj·ubj )�”}”(hhh]”j )�”}”(hjGh]”hŒ1”…”�”}”(hjÓh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KbhjÐubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj·ubj )�”}”(hhh]”j )�”}”(hjGh]”hŒ1”…”�”}”(hjéh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Kbhjæubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj·ubj )�”}”(hhh]”j )�”}”(hŒProblem (Host)”h]”hŒProblem (Host)”…”�”}”(hjÿh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Kbhjüubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj·ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jhjŽubeh}”(h]”h ]”h"]”h$]”h&]”uh1j/hjöubeh}”(h]”h ]”h"]”h$]”h&]”Œcols”Kuh1jïhjóubah}”(h]”h ]”h"]”h$]”h&]”uh1jêhjuubeh}”(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 h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Kehj2 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 h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KhhjJ ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubj)�”}”(hŒiI/O systems are not allowed to directly address secure memory. This limits the SVMs to virtual I/O only. ”h]”j )�”}”(hŒhI/O systems are not allowed to directly address secure memory. This limits the SVMs to virtual I/O only.”h]”hŒhI/O systems are not allowed to directly address secure memory. This limits the SVMs to virtual I/O only.”…”�”}”(hjf h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Knhjb ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubj)�”}”(hŒ©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. ”h]”j )�”}”(hŒ¨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.”h]”hŒ¨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.”…”�”}”(hj~ h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Kqhjz 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– h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Kuhj’ ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubj)�”}”(hŒFWhen a process is in secure mode all interrupts go to the Ultravisor. ”h]”j )�”}”(hŒEWhen a process is in secure mode all interrupts go to the Ultravisor.”h]”hŒEWhen a process is in secure mode all interrupts go to the Ultravisor.”…”�”}”(hj® h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Kxhjª ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubj)�”}”(hX™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ŒlThe following resources have become Ultravisor privileged and require an Ultravisor interface to manipulate:”h]”hŒlThe following resources have become Ultravisor privileged and require an Ultravisor interface to manipulate:”…”�”}”(hjÆ h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K{hj ubj)�”}”(hhh]”(j)�”}”(hŒ,Processor configurations registers (SCOMs). ”h]”j )�”}”(hŒ+Processor configurations registers (SCOMs).”h]”hŒ+Processor configurations registers (SCOMs).”…”�”}”(hjÛ h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K~hj× ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjÔ ubj)�”}”(hŒStop state information. ”h]”j )�”}”(hŒStop state information.”h]”hŒStop state information.”…”�”}”(hjó h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K€hjï ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjÔ ubj)�”}”(hŒÿ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. ”h]”j )�”}”(hŒþ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.”h]”hŒþ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.”…”�”}”(hj h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K‚hj ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjÔ ubj)�”}”(hŒœPTCR 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 )�”}”(hŒ›PTCR and partition table entries (partition table is in secure memory). An attempt to write to PTCR will cause a Hypervisor Emulation Assistance interrupt.”h]”hŒ›PTCR and partition table entries (partition table is in secure memory). An attempt to write to PTCR will cause a Hypervisor Emulation Assistance interrupt.”…”�”}”(hj# h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K‡hj ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjÔ ubj)�”}”(hŒ¯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. ”h]”j )�”}”(hŒ®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.”h]”hŒ®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.”…”�”}”(hj; h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K‹hj7 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 )�”}”(hŒzPaging for an SVM, sharing of memory with Hypervisor for an SVM. (Including Virtual Processor Area (VPA) and virtual I/O).”h]”hŒzPaging for an SVM, sharing of memory with Hypervisor for an SVM. (Including Virtual Processor Area (VPA) and virtual I/O).”…”�”}”(hjS h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K�hjO ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjÔ ubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ*”uh1jh³hÇh´K~hj ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jhjubeh}”(h]”h ]”h"]”h$]”h&]”jm jn uh1jh³hÇh´K7hjubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´K5hjïh²hubeh}”(h]”j]ah ]”h"]”Œhardware”ah$]”h&]”uh1hÖhj³h²hh³hÇh´K3ubh×)�”}”(hhh]”(hÜ)�”}”(hŒSoftware/Microcode”h]”hŒSoftware/Microcode”…”�”}”(hj‹ h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”hÔjyuh1hÛhjˆ h²hh³hÇh´K”ubjÅ)�”}”(hXùThe 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 )�”}”(hŒThe software changes include:”h]”hŒThe software changes include:”…”�”}”(hj� h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K–hj™ ubj)�”}”(hhh]”(j)�”}”(hŒMSVMs are created from normal VM using (open source) tooling supplied by IBM. ”h]”j )�”}”(hŒLSVMs are created from normal VM using (open source) tooling supplied by IBM.”h]”hŒLSVMs are created from normal VM using (open source) tooling supplied by IBM.”…”�”}”(hj² h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K˜hj® ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj« ubj)�”}”(hŒkAll SVMs start as normal VMs and utilize an ultracall, UV_ESM (Enter Secure Mode), to make the transition. ”h]”j )�”}”(hŒjAll SVMs start as normal VMs and utilize an ultracall, UV_ESM (Enter Secure Mode), to make the transition.”h]”hŒjAll SVMs start as normal VMs and utilize an ultracall, UV_ESM (Enter Secure Mode), to make the transition.”…”�”}”(hjÊ h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K›hjÆ ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj« ubj)�”}”(hŒë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. ”h]”j )�”}”(hŒê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.”h]”hŒê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.”…”�”}”(hjâ h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KžhjÞ ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj« ubj)�”}”(hŒ›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. ”h]”j )�”}”(hŒš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.”h]”hŒš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.”…”�”}”(hjú h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K£hjö ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj« ubj)�”}”(hŒZThe Ultravisor is not involved in protecting the encrypted disk of the SVM while at rest. ”h]”j )�”}”(hŒYThe Ultravisor is not involved in protecting the encrypted disk of the SVM while at rest.”h]”hŒYThe Ultravisor is not involved in protecting the encrypted disk of the SVM while at rest.”…”�”}”(hj h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K§hj 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* h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Kªhj& ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj« ubj)�”}”(hŒ7For virtual I/O to work bounce buffering must be done. ”h]”j )�”}”(hŒ6For virtual I/O to work bounce buffering must be done.”h]”hŒ6For virtual I/O to work bounce buffering must be done.”…”�”}”(hjB h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K±hj> ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj« ubj)�”}”(hŒ…The Ultravisor uses AES (IAPM) for protection of SVM memory. IAPM is a mode of AES that provides integrity and secrecy concurrently. ”h]”j )�”}”(hŒ„The Ultravisor uses AES (IAPM) for protection of SVM memory. IAPM is a mode of AES that provides integrity and secrecy concurrently.”h]”hŒ„The Ultravisor uses AES (IAPM) for protection of SVM memory. IAPM is a mode of AES that provides integrity and secrecy concurrently.”…”�”}”(hjZ h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K³hjV ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj« ubj)�”}”(hŒ€The movement of data between normal and secure pages is coordinated with the Ultravisor by a new HMM plug-in in the Hypervisor. ”h]”j )�”}”(hŒThe movement of data between normal and secure pages is coordinated with the Ultravisor by a new HMM plug-in in the Hypervisor.”h]”hŒThe movement of data between normal and secure pages is coordinated with the Ultravisor by a new HMM plug-in in the Hypervisor.”…”�”}”(hjr h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K¶hjn ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj« ubeh}”(h]”h ]”h"]”h$]”h&]”jm jn uh1jh³hÇh´K˜hj™ ubj )�”}”(hŒeThe Ultravisor offers new services to the hypervisor and SVMs. These are accessed through ultracalls.”h]”hŒeThe Ultravisor offers new services to the hypervisor and SVMs. These are accessed through ultracalls.”…”�”}”(hjŒ h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K¹hj™ ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´K–hjˆ h²hubeh}”(h]”jah ]”h"]”Œsoftware/microcode”ah$]”h&]”uh1hÖhj³h²hh³hÇh´K”ubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Terminology”h]”hŒ Terminology”…”�”}”(hjª h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”hÔj›uh1hÛhj§ h²hh³hÇh´K½ubjÅ)�”}”(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)�”}”(hŒKHypercalls: special system calls used to request services from Hypervisor. ”h]”j )�”}”(hŒJHypercalls: special system calls used to request services from Hypervisor.”h]”hŒJHypercalls: special system calls used to request services from Hypervisor.”…”�”}”(hjà h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K¿hj¿ ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj¼ ubj)�”}”(hŒ8Normal memory: Memory that is accessible to Hypervisor. ”h]”j )�”}”(hŒ7Normal memory: Memory that is accessible to Hypervisor.”h]”hŒ7Normal memory: Memory that is accessible to Hypervisor.”…”�”}”(hjÛ h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KÂhj× ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj¼ ubj)�”}”(hŒGNormal page: Page backed by normal memory and available to Hypervisor. ”h]”j )�”}”(hŒFNormal page: Page backed by normal memory and available to Hypervisor.”h]”hŒFNormal page: Page backed by normal memory and available to Hypervisor.”…”�”}”(hjó h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KÄhjï ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj¼ ubj)�”}”(hŒ–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). ”h]”j )�”}”(hŒ•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).”h]”hŒ•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).”…”�”}”(hj h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KÇhj ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj¼ ubj)�”}”(hŒFSecure memory: Memory that is accessible only to Ultravisor and SVMs. ”h]”j )�”}”(hŒESecure memory: Memory that is accessible only to Ultravisor and SVMs.”h]”hŒESecure memory: Memory that is accessible only to Ultravisor and SVMs.”…”�”}”(hj# h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KËhj ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj¼ ubj)�”}”(hŒTSecure page: Page backed by secure memory and only available to Ultravisor and SVM. ”h]”j )�”}”(hŒSSecure page: Page backed by secure memory and only available to Ultravisor and SVM.”h]”hŒSSecure page: Page backed by secure memory and only available to Ultravisor and SVM.”…”�”}”(hj; h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KÎhj7 ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj¼ ubj)�”}”(hŒSVM: Secure Virtual Machine. ”h]”j )�”}”(hŒSVM: Secure Virtual Machine.”h]”hŒSVM: Secure Virtual Machine.”…”�”}”(hjS h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KÑhjO ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj¼ ubj)�”}”(hŒLUltracalls: special system calls used to request services from Ultravisor. ”h]”j )�”}”(hŒJUltracalls: special system calls used to request services from Ultravisor.”h]”hŒJUltracalls: special system calls used to request services from Ultravisor.”…”�”}”(hjk h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KÓhjg ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj¼ ubeh}”(h]”h ]”h"]”h$]”h&]”jm jn uh1jh³hÇh´K¿hj¸ ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´K¿hj§ h²hubeh}”(h]”j¡ah ]”h"]”Œ terminology”ah$]”h&]”uh1hÖhj³h²hh³hÇh´K½ubeh}”(h]”j>ah ]”h"]”Œ introduction”ah$]”h&]”uh1hÖhhØh²hh³hÇh´K ubh×)�”}”(hhh]”(hÜ)�”}”(hŒUltravisor calls API”h]”hŒUltravisor calls API”…”�”}”(hjœ h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”hÔjÉuh1hÛhj™ h²hh³hÇh´KØubjÅ)�”}”(hXÖThis 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® h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´KÚhjª ubj )�”}”(hŒÇ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.”h]”hŒÇ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.”…”�”}”(hj¼ h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Kàhjª ubj )�”}”(hŒå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.”h]”(hŒ½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 ”…”�”}”(hjÊ h²hh³Nh´NubhŒliteral”“”)�”}”(hŒ ``UV_RETURN``”h]”hŒ UV_RETURN”…”�”}”(hjÔ h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjÊ ubhŒ ultracall described below.”…”�”}”(hjÊ h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Kähjª ubj )�”}”(hX•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.”h]”hX•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.”…”�”}”(hjì h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Kéhjª ubj )�”}”(hXž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.”h]”hXž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.”…”�”}”(hjú h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Kðhjª ubj )�”}”(hŒ‘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.”h]”hŒ‘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.”…”�”}”(hj h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K÷hjª ubj )�”}”(hŒ‘The full specification for all hypercalls/ultracalls will eventually be made available in the public/OpenPower version of the PAPR specification.”h]”hŒ‘The full specification for all hypercalls/ultracalls will eventually be made available in the public/OpenPower version of the PAPR specification.”…”�”}”(hj h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Kûhjª ubhŒnote”“”)�”}”(hŒlIf PEF is not enabled, the ultracalls will be redirected to the Hypervisor which must handle/fail the calls.”h]”j )�”}”(hŒlIf PEF is not enabled, the ultracalls will be redirected to the Hypervisor which must handle/fail the calls.”h]”hŒlIf PEF is not enabled, the ultracalls will be redirected to the Hypervisor which must handle/fail the calls.”…”�”}”(hj* h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mhj& ubah}”(h]”h ]”h"]”h$]”h&]”uh1j$ hjª ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´KÚhj™ h²hubh×)�”}”(hhh]”(hÜ)�”}”(hŒUltracalls used by Hypervisor”h]”hŒUltracalls used by Hypervisor”…”�”}”(hjG h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”hÔjèuh1hÛhjD h²hh³hÇh´MubjÅ)�”}”(hŒgThis section describes the virtual memory management ultracalls used by the Hypervisor to manage SVMs. ”h]”j )�”}”(hŒfThis section describes the virtual memory management ultracalls used by the Hypervisor to manage SVMs.”h]”hŒfThis section describes the virtual memory management ultracalls used by the Hypervisor to manage SVMs.”…”�”}”(hjY h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MhjU ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´MhjD h²hubh×)�”}”(hhh]”(hÜ)�”}”(hŒ UV_PAGE_OUT”h]”hŒ UV_PAGE_OUT”…”�”}”(hjp h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjm h²hh³hÇh´M ubjÅ)�”}”(hŒMEncrypt and move the contents of a page from secure memory to normal memory. ”h]”j )�”}”(hŒLEncrypt and move the contents of a page from secure memory to normal memory.”h]”hŒLEncrypt and move the contents of a page from secure memory to normal memory.”…”�”}”(hj‚ h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M hj~ ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M hjm h²hubh×)�”}”(hhh]”(hÜ)�”}”(hŒSyntax”h]”hŒSyntax”…”�”}”(hj™ h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhj– h²hh³hÇh´MubhŒ 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&]”hÅhÆŒforce”‰Œlanguage”Œc”Œhighlight_args”}”uh1j§ h³hÇh´Mhj– h²hubeh}”(h]”Œsyntax”ah ]”h"]”h$]”Œsyntax”ah&]”uh1hÖhjm h²hh³hÇh´MŒ referenced”Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Return values”h]”hŒ Return values”…”�”}”(hjÈ h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjÅ h²hh³hÇh´MubjÅ)�”}”(hXÅOne 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 )�”}”(hŒOne of the following values:”h]”hŒOne of the following values:”…”�”}”(hjÚ h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MhjÖ 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)�”}”(hŒU_SUCCESS on success.”h]”j )�”}”(hjñ h]”hŒU_SUCCESS on success.”…”�”}”(hjó h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M!hjï ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjì ubj)�”}”(hŒ%U_PARAMETER if ``lpid`` is invalid.”h]”j )�”}”(hjh]”(hŒU_PARAMETER if ”…”�”}”(hj h²hh³Nh´NubjÓ )�”}”(hŒ``lpid``”h]”hŒlpid”…”�”}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hj ubhŒ is invalid.”…”�”}”(hj h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M"hjubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjì ubj)�”}”(hŒ(U_P2 if ``dest_ra`` is invalid.”h]”j )�”}”(hj1h]”(hŒU_P2 if ”…”�”}”(hj3h²hh³Nh´NubjÓ )�”}”(hŒ ``dest_ra``”h]”hŒdest_ra”…”�”}”(hj:h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hj3ubhŒ is invalid.”…”�”}”(hj3h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M#hj/ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjì ubj)�”}”(hŒ4U_P3 if the ``src_gpa`` address is invalid.”h]”j )�”}”(hjZh]”(hŒU_P3 if the ”…”�”}”(hj\h²hh³Nh´NubjÓ )�”}”(hŒ ``src_gpa``”h]”hŒsrc_gpa”…”�”}”(hjch²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hj\ubhŒ address is invalid.”…”�”}”(hj\h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M$hjXubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjì ubj)�”}”(hŒ9U_P4 if any bit in the ``flags`` is unrecognized”h]”j )�”}”(hjƒh]”(hŒ U_P4 if any bit in the ”…”�”}”(hj…h²hh³Nh´NubjÓ )�”}”(hŒ ``flags``”h]”hŒflags”…”�”}”(hjŒh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hj…ubhŒ is unrecognized”…”�”}”(hj…h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M%hj�ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjì ubj)�”}”(hŒ8U_P5 if the ``order`` parameter is unsupported.”h]”j )�”}”(hj¬h]”(hŒU_P5 if the ”…”�”}”(hj®h²hh³Nh´NubjÓ )�”}”(hŒ ``order``”h]”hŒorder”…”�”}”(hjµh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hj®ubhŒ parameter is unsupported.”…”�”}”(hj®h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M&hjªubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjì ubj)�”}”(hŒ0U_FUNCTION if functionality is not supported.”h]”j )�”}”(hjÕh]”hŒ0U_FUNCTION if functionality is not supported.”…”�”}”(hj×h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M'hjÓubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjì ubj)�”}”(hŒ5U_BUSY if page cannot be currently paged-out. ”h]”j )�”}”(hŒ4U_BUSY if page cannot be currently paged-out.”h]”hŒ4U_BUSY if page cannot be currently paged-out.”…”�”}”(hjîh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M(hjêubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjì ubeh}”(h]”h ]”h"]”h$]”h&]”jm jn uh1jh³hÇh´M!hjè ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M!hjÖ ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´MhjÅ h²hubeh}”(h]”Œ return-values”ah ]”h"]”h$]”Œ return values”ah&]”uh1hÖhjm h²hh³hÇh´MjÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Description”h]”hŒ Description”…”�”}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjh²hh³hÇh´M+ubjÅ)�”}”(hX¢Encrypt 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.”…”�”}”(hj1h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M-hj-ubj )�”}”(hŒã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.”h]”(hŒ¹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 ”…”�”}”(hj?h²hh³Nh´NubjÓ )�”}”(hŒ``UV_SNAPSHOT``”h]”hŒ UV_SNAPSHOT”…”�”}”(hjGh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hj?ubhŒ flag in ”…”�”}”(hj?h²hh³Nh´NubjÓ )�”}”(hŒ ``flags``”h]”hŒflags”…”�”}”(hjYh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hj?ubhŒ parameter.”…”�”}”(hj?h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M0hj-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.”…”�”}”(hjqh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M5hj-ubeh}”(h]”h ]”h"]”h$]”•h&]”uh1jÄh³hÇh´M-hjh²hubeh}”(h]”Œ description”ah ]”h"]”h$]”Œ description”ah&]”uh1hÖhjm h²hh³hÇh´M+jÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Use cases”h]”hŒ Use cases”…”�”}”(hj�h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhj�h²hh³hÇh´M9ubjÅ)�”}”(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]”hŒenumerated_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]”(hŒñ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 ”…”�”}”(hj«h²hh³Nh´NubjÓ )�”}”(hŒ``UV_PAGE_OUT``”h]”hŒ UV_PAGE_OUT”…”�”}”(hj³h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hj«ubhŒ5 call to retrieve the encrypted contents of the page.”…”�”}”(hj«h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M;hj§ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj¤ubj)�”}”(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]”(hŒxWhen Ultravisor runs low on secure memory and it needs to page-out an LRU page. In this case, Ultravisor will issue the ”…”�”}”(hjÕh²hh³Nh´NubjÓ )�”}”(hŒ``H_SVM_PAGE_OUT``”h]”hŒH_SVM_PAGE_OUT”…”�”}”(hjÝh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjÕubhŒ\ hypercall to the Hypervisor. The Hypervisor will then allocate a normal page and issue the ”…”�”}”(hjÕh²hh³Nh´NubjÓ )�”}”(hŒ``UV_PAGE_OUT``”h]”hŒ UV_PAGE_OUT”…”�”}”(hjïh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjÕubhŒi ultracall and the Ultravisor will encrypt and move the contents of the secure page into the normal page.”…”�”}”(hjÕh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MAhjÑubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj¤ubj)�”}”(hŒÚ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]”j )�”}”(hŒÙ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]”hŒÙ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.”…”�”}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MHhj ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj¤ubeh}”(h]”h ]”h"]”h$]”h&]”Œenumtype”Œarabic”Œprefix”hŒsuffix”Œ.”uh1j¢hjžubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M;hj�h²hubeh}”(h]”Œ use-cases”ah ]”h"]”h$]”Œ use cases”ah&]”uh1hÖhjm h²hh³hÇh´M9jÄ Kubeh}”(h]”Œ uv-page-out”ah ]”h"]”Œ uv_page_out”ah$]”h&]”uh1hÖhjD h²hh³hÇh´M ubh×)�”}”(hhh]”(hÜ)�”}”(hŒ UV_PAGE_IN”h]”hŒ UV_PAGE_IN”…”�”}”(hjIh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjFh²hh³hÇh´MNubjÅ)�”}”(hŒAMove 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[h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MPhjWubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´MPhjFh²hubh×)�”}”(hhh]”(hÜ)�”}”(hŒSyntax”h]”hŒSyntax”…”�”}”(hjrh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjoh²hh³hÇh´MSubj¨ )�”}”(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 */”…”�”}”hj€sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆj· ‰j¸ j¹ jº }”uh1j§ h³hÇh´MUhjoh²hubeh}”(h]”Œid1”ah ]”h"]”h$]”j ah&]”uh1hÖhjFh²hh³hÇh´MSjÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Return values”h]”hŒ Return values”…”�”}”(hj™h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhj–h²hh³hÇh´M_ubjÅ)�”}”(hXÃOne 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 )�”}”(hŒOne of the following values:”h]”hŒOne of the following values:”…”�”}”(hj«h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mahj§ubjÅ)�”}”(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)�”}”(hŒU_SUCCESS on success.”h]”j )�”}”(hjÂh]”hŒU_SUCCESS on success.”…”�”}”(hjÄh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MchjÀubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj½ubj)�”}”(hŒ3U_BUSY if page cannot be currently paged-in.”h]”j )�”}”(hjÙh]”hŒ3U_BUSY if page cannot be currently paged-in.”…”�”}”(hjÛh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mdhj×ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj½ubj)�”}”(hŒ/U_FUNCTION if functionality is not supported”h]”j )�”}”(hjðh]”hŒ/U_FUNCTION if functionality is not supported”…”�”}”(hjòh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mehjîubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj½ubj)�”}”(hŒ%U_PARAMETER if ``lpid`` is invalid.”h]”j )�”}”(hjh]”(hŒU_PARAMETER if ”…”�”}”(hj h²hh³Nh´NubjÓ )�”}”(hŒ``lpid``”h]”hŒlpid”…”�”}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hj ubhŒ is invalid.”…”�”}”(hj h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mfhjubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj½ubj)�”}”(hŒ'U_P2 if ``src_ra`` is invalid.”h]”j )�”}”(hj0h]”(hŒU_P2 if ”…”�”}”(hj2h²hh³Nh´NubjÓ )�”}”(hŒ ``src_ra``”h]”hŒsrc_ra”…”�”}”(hj9h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hj2ubhŒ is invalid.”…”�”}”(hj2h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mghj.ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj½ubj)�”}”(hŒ5U_P3 if the ``dest_gpa`` address is invalid.”h]”j )�”}”(hjYh]”(hŒU_P3 if the ”…”�”}”(hj[h²hh³Nh´NubjÓ )�”}”(hŒ ``dest_gpa``”h]”hŒdest_gpa”…”�”}”(hjbh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hj[ubhŒ address is invalid.”…”�”}”(hj[h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MhhjWubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj½ubj)�”}”(hŒ9U_P4 if any bit in the ``flags`` is unrecognized”h]”j )�”}”(hj‚h]”(hŒ U_P4 if any bit in the ”…”�”}”(hj„h²hh³Nh´NubjÓ )�”}”(hŒ ``flags``”h]”hŒflags”…”�”}”(hj‹h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hj„ubhŒ is unrecognized”…”�”}”(hj„h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mihj€ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj½ubj)�”}”(hŒ9U_P5 if the ``order`` parameter is unsupported. ”h]”j )�”}”(hŒ8U_P5 if the ``order`` parameter is unsupported.”h]”(hŒU_P5 if the ”…”�”}”(hj­h²hh³Nh´NubjÓ )�”}”(hŒ ``order``”h]”hŒorder”…”�”}”(hjµh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hj­ubhŒ parameter is unsupported.”…”�”}”(hj­h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mjhj©ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj½ubeh}”(h]”h ]”h"]”h$]”h&]”jm jn uh1jh³hÇh´Mchj¹ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´Mchj§ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´Mahj–h²hubeh}”(h]”Œid2”ah ]”h"]”h$]”jah&]”uh1hÖhjFh²hh³hÇh´M_jÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Description”h]”hŒ Description”…”�”}”(hjïh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjìh²hh³hÇh´MmubjÅ)�”}”(hX¢Move 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 )�”}”(hŒ‘Move 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 ”…”�”}”(hjh²hh³Nh´NubjÓ )�”}”(hŒ ``src_ra``”h]”hŒsrc_ra”…”�”}”(hj h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjubhŒN from normal memory to secure memory and map it to the guest physical address ”…”�”}”(hjh²hh³Nh´NubjÓ )�”}”(hŒ ``dest_gpa``”h]”hŒdest_gpa”…”�”}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjubhŒ.”…”�”}”(hjh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mohjýubj )�”}”(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]”(hŒIf ”…”�”}”(hj3h²hh³Nh´NubhŒtitle_reference”“”)�”}”(hŒ `dest_gpa`”h]”hŒdest_gpa”…”�”}”(hj=h²hh³Nh´Nubah}”(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 ”…”�”}”(hj3h²hh³Nh´Nubj<)�”}”(hŒ `dest_gpa`”h]”hŒdest_gpa”…”�”}”(hjOh²hh³Nh´Nubah}”(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.”…”�”}”(hj3h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mshjýubj )�”}”(hŒoThe 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 ”…”�”}”(hjgh²hh³Nh´NubjÓ )�”}”(hŒ ``flags``”h]”hŒflags”…”�”}”(hjoh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjgubhŒ parameter. Valid values for ”…”�”}”(hjgh²hh³Nh´NubjÓ )�”}”(hŒ ``flags``”h]”hŒflags”…”�”}”(hj�h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjgubhŒ are:”…”�”}”(hjgh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MxhjýubjÅ)�”}”(hŒ5* CACHE_INHIBITED * CACHE_ENABLED * WRITE_PROTECTION ”h]”j)�”}”(hhh]”(j)�”}”(hŒCACHE_INHIBITED”h]”j )�”}”(hj¢h]”hŒCACHE_INHIBITED”…”�”}”(hj¤h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M{hj ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj�ubj)�”}”(hŒ CACHE_ENABLED”h]”j )�”}”(hj¹h]”hŒ CACHE_ENABLED”…”�”}”(hj»h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M|hj·ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj�ubj)�”}”(hŒWRITE_PROTECTION ”h]”j )�”}”(hŒWRITE_PROTECTION”h]”hŒWRITE_PROTECTION”…”�”}”(hjÒh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M}hjÎubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj�ubeh}”(h]”h ]”h"]”h$]”h&]”jm jn uh1jh³hÇh´M{hj™ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M{hjýubj )�”}”(hŒRThe Hypervisor must pin the page in memory before making ``UV_PAGE_IN`` ultracall.”h]”(hŒ9The Hypervisor must pin the page in memory before making ”…”�”}”(hjòh²hh³Nh´NubjÓ )�”}”(hŒ``UV_PAGE_IN``”h]”hŒ UV_PAGE_IN”…”�”}”(hjúh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjòubhŒ ultracall.”…”�”}”(hjòh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mhjýubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´Mohjìh²hubeh}”(h]”Œid3”ah ]”h"]”h$]”j‹ah&]”uh1hÖhjFh²hh³hÇh´MmjÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Use cases”h]”hŒ Use cases”…”�”}”(hj"h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjh²hh³hÇh´MƒubjÅ)�”}”(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)�”}”(hŒqWhen a normal VM switches to secure mode, all its pages residing in normal memory, are moved into secure memory. ”h]”j )�”}”(hŒpWhen a normal VM switches to secure mode, all its pages residing in normal memory, are moved into secure memory.”h]”hŒpWhen a normal VM switches to secure mode, all its pages residing in normal memory, are moved into secure memory.”…”�”}”(hj;h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M…hj7ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj4ubj)�”}”(hŒqWhen an SVM requests to share a page with Hypervisor the Hypervisor allocates a page and informs the Ultravisor. ”h]”j )�”}”(hŒpWhen an SVM requests to share a page with Hypervisor the Hypervisor allocates a page and informs the Ultravisor.”h]”hŒpWhen an SVM requests to share a page with Hypervisor the Hypervisor allocates a page and informs the Ultravisor.”…”�”}”(hjSh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MˆhjOubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj4ubj)�”}”(hŒÔ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 )�”}”(hŒÓ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]”hŒÓ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.”…”�”}”(hjkh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M‹hjgubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj4ubeh}”(h]”h ]”h"]”h$]”h&]”j+j,j-hj.j/uh1j¢hj0ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M…hjh²hubeh}”(h]”Œid4”ah ]”h"]”h$]”j<ah&]”uh1hÖhjFh²hh³hÇh´MƒjÄ Kubeh}”(h]”Œ uv-page-in”ah ]”h"]”Œ uv_page_in”ah$]”h&]”uh1hÖhjD h²hh³hÇh´MNubh×)�”}”(hhh]”(hÜ)�”}”(hŒ UV_PAGE_INVAL”h]”hŒ UV_PAGE_INVAL”…”�”}”(hj�h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjšh²hh³hÇh´M‘ubjÅ)�”}”(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.”…”�”}”(hj¯h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M“hj«ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M“hjšh²hubh×)�”}”(hhh]”(hÜ)�”}”(hŒSyntax”h]”hŒSyntax”…”�”}”(hjÆh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjÃh²hh³hÇh´M–ubj¨ )�”}”(hŒáuint64_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]”hŒáuint64_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 */”…”�”}”hjÔsbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆj· ‰j¸ j¹ jº }”uh1j§ h³hÇh´M˜hjÃh²hubeh}”(h]”Œid5”ah ]”h"]”h$]”Œsyntax”ah&]”uh1hÖhjšh²hh³hÇh´M–jÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Return values”h]”hŒ Return values”…”�”}”(hjîh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjëh²hh³hÇh´M ubjÅ)�”}”(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 )�”}”(hŒOne of the following values:”h]”hŒOne of the following values:”…”�”}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M¢hjüubjÅ)�”}”(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)�”}”(hŒU_SUCCESS on success.”h]”j )�”}”(hjh]”hŒU_SUCCESS on success.”…”�”}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M¤hjubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubj)�”}”(hŒ%U_PARAMETER if ``lpid`` is invalid.”h]”j )�”}”(hj.h]”(hŒU_PARAMETER if ”…”�”}”(hj0h²hh³Nh´NubjÓ )�”}”(hŒ``lpid``”h]”hŒlpid”…”�”}”(hj7h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hj0ubhŒ is invalid.”…”�”}”(hj0h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M¥hj,ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubj)�”}”(hŒaU_P2 if ``guest_pa`` is invalid (or corresponds to a secure page mapping).”h]”hŒdefinition_list”“”)�”}”(hhh]”hŒdefinition_list_item”“”)�”}”(hŒSU_P2 if ``guest_pa`` is invalid (or corresponds to a secure page mapping).”h]”(hŒterm”“”)�”}”(hŒDU_P2 if ``guest_pa`` is invalid (or corresponds to a secure”h]”(hŒU_P2 if ”…”�”}”(hjfh²hh³Nh´NubjÓ )�”}”(hŒ ``guest_pa``”h]”hŒguest_pa”…”�”}”(hjnh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjfubhŒ' is invalid (or corresponds to a secure”…”�”}”(hjfh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1jdh³hÇh´M¦hj`ubhŒ definition”“”)�”}”(hhh]”j )�”}”(hŒpage mapping).”h]”hŒpage mapping).”…”�”}”(hj‹h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M§hjˆubah}”(h]”h ]”h"]”h$]”h&]”uh1j†hj`ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j^h³hÇh´M¦hj[ubah}”(h]”h ]”h"]”h$]”h&]”uh1jYhjUubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubj)�”}”(hŒ*U_P3 if the ``order`` is invalid.”h]”j )�”}”(hj³h]”(hŒU_P3 if the ”…”�”}”(hjµh²hh³Nh´NubjÓ )�”}”(hŒ ``order``”h]”hŒorder”…”�”}”(hj¼h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjµubhŒ is invalid.”…”�”}”(hjµh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M¨hj±ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubj)�”}”(hŒ0U_FUNCTION if functionality is not supported.”h]”j )�”}”(hjÜh]”hŒ0U_FUNCTION if functionality is not supported.”…”�”}”(hjÞh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M©hjÚubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubj)�”}”(hŒ7U_BUSY if page cannot be currently invalidated. ”h]”j )�”}”(hŒ6U_BUSY if page cannot be currently invalidated.”h]”hŒ6U_BUSY if page cannot be currently invalidated.”…”�”}”(hjõh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mªhjñubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubeh}”(h]”h ]”h"]”h$]”h&]”jm jn uh1jh³hÇh´M¤hjubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M¤hjüubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M¢hjëh²hubeh}”(h]”Œid6”ah ]”h"]”h$]”Œ return values”ah&]”uh1hÖhjšh²hh³hÇh´M jÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Description”h]”hŒ Description”…”�”}”(hj&h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhj#h²hh³hÇh´M­ubjÅ)�”}”(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]”(hŒÒThis 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 ”…”�”}”(hj8h²hh³Nh´NubjÓ )�”}”(hŒ ``guest_pa``”h]”hŒguest_pa”…”�”}”(hj@h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hj8ubhŒi corresponds to a secure page, Ultravisor will ignore the attempt to invalidate the page and return U_P2.”…”�”}”(hj8h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M¯hj4ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M¯hj#h²hubeh}”(h]”Œid7”ah ]”h"]”h$]”Œ description”ah&]”uh1hÖhjšh²hh³hÇh´M­jÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Use cases”h]”hŒ Use cases”…”�”}”(hjih²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjfh²hh³hÇh´M¶ubjÅ)�”}”(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)�”}”(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 )�”}”(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]”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.”…”�”}”(hj‚h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M¸hj~ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj{ubah}”(h]”h ]”h"]”h$]”h&]”j+j,j-hj.j/uh1j¢hjwubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M¸hjfh²hubeh}”(h]”Œid8”ah ]”h"]”h$]”Œ use cases”ah&]”uh1hÖhjšh²hh³hÇh´M¶jÄ Kubeh}”(h]”Œ uv-page-inval”ah ]”h"]”Œ uv_page_inval”ah$]”h&]”uh1hÖhjD h²hh³hÇh´M‘ubh×)�”}”(hhh]”(hÜ)�”}”(hŒ UV_WRITE_PATE”h]”hŒ UV_WRITE_PATE”…”�”}”(hjµh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhj²h²hh³hÇh´M¾ubjÅ)�”}”(hŒKValidate and write the partition table entry (PATE) for a given partition. ”h]”j )�”}”(hŒJValidate and write the partition table entry (PATE) for a given partition.”h]”hŒJValidate and write the partition table entry (PATE) for a given partition.”…”�”}”(hjÇh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MÀhjÃubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´MÀhj²h²hubh×)�”}”(hhh]”(hÜ)�”}”(hŒSyntax”h]”hŒSyntax”…”�”}”(hjÞh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjÛh²hh³hÇh´MÄubj¨ )�”}”(hŒíuint64_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]”hŒíuint64_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 */”…”�”}”hjìsbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆj· ‰j¸ j¹ jº }”uh1j§ h³hÇh´MÆhjÛh²hubeh}”(h]”Œid9”ah ]”h"]”h$]”Œsyntax”ah&]”uh1hÖhj²h²hh³hÇh´MÄjÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Return values”h]”hŒ Return values”…”�”}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjh²hh³hÇh´MÎubjÅ)�”}”(hXýOne 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 )�”}”(hŒOne of the following values:”h]”hŒOne of the following values:”…”�”}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MÐhjubjÅ)�”}”(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)�”}”(hŒU_SUCCESS on success.”h]”j )�”}”(hj/h]”hŒU_SUCCESS on success.”…”�”}”(hj1h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MÒhj-ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj*ubj)�”}”(hŒ5U_BUSY if PATE cannot be currently written to.”h]”j )�”}”(hjFh]”hŒ5U_BUSY if PATE cannot be currently written to.”…”�”}”(hjHh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MÓhjDubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj*ubj)�”}”(hŒ0U_FUNCTION if functionality is not supported.”h]”j )�”}”(hj]h]”hŒ0U_FUNCTION if functionality is not supported.”…”�”}”(hj_h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MÔhj[ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj*ubj)�”}”(hŒ%U_PARAMETER if ``lpid`` is invalid.”h]”j )�”}”(hjth]”(hŒU_PARAMETER if ”…”�”}”(hjvh²hh³Nh´NubjÓ )�”}”(hŒ``lpid``”h]”hŒlpid”…”�”}”(hj}h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjvubhŒ is invalid.”…”�”}”(hjvh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MÕhjrubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj*ubj)�”}”(hŒ$U_P2 if ``dw0`` is invalid.”h]”j )�”}”(hj�h]”(hŒU_P2 if ”…”�”}”(hjŸh²hh³Nh´NubjÓ )�”}”(hŒ``dw0``”h]”hŒdw0”…”�”}”(hj¦h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjŸubhŒ is invalid.”…”�”}”(hjŸh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MÖhj›ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj*ubj)�”}”(hŒ0U_P3 if the ``dw1`` address is invalid.”h]”j )�”}”(hjÆh]”(hŒU_P3 if the ”…”�”}”(hjÈh²hh³Nh´NubjÓ )�”}”(hŒ``dw1``”h]”hŒdw1”…”�”}”(hjÏh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjÈubhŒ address is invalid.”…”�”}”(hjÈh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M×hjÄubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj*ubj)�”}”(hŒ¬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]”jZ)�”}”(hhh]”j_)�”}”(hŒ�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]”(je)�”}”(hŒ@U_PERMISSION if the Hypervisor is attempting to change the PATE”h]”hŒ@U_PERMISSION if the Hypervisor is attempting to change the PATE”…”�”}”(hjøh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jdh³hÇh´MÚhjôubj‡)�”}”(hhh]”j )�”}”(hŒNof a secure virtual machine or if called from a context other than Hypervisor.”h]”hŒNof a secure virtual machine or if called from a context other than Hypervisor.”…”�”}”(hj h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MÙhjubah}”(h]”h ]”h"]”h$]”h&]”uh1j†hjôubeh}”(h]”h ]”h"]”h$]”h&]”uh1j^h³hÇh´MÚhjñubah}”(h]”h ]”h"]”h$]”h&]”uh1jYhjíubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj*ubeh}”(h]”h ]”h"]”h$]”h&]”jm jn uh1jh³hÇh´MÒhj&ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´MÒhjubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´MÐhjh²hubeh}”(h]”Œid10”ah ]”h"]”h$]”Œ return values”ah&]”uh1hÖhj²h²hh³hÇh´MÎjÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Description”h]”hŒ Description”…”�”}”(hjLh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjIh²hh³hÇh´MÝubjÅ)�”}”(hŒ¸Validate 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 )�”}”(hŒ·Validate and write a LPID and its partition-table-entry for the given LPID. If the LPID is already allocated and initialized, this call results in changing the partition table entry.”h]”hŒ·Validate 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^h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MßhjZubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´MßhjIh²hubeh}”(h]”Œid11”ah ]”h"]”h$]”Œ description”ah&]”uh1hÖhj²h²hh³hÇh´MÝjÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Use cases”h]”hŒ Use cases”…”�”}”(hj}h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjzh²hh³hÇh´MäubjÅ)�”}”(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.”…”�”}”(hj–h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mæhj’ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj�ubj)�”}”(hŒ½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. ”h]”j )�”}”(hŒ¼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.”h]”hŒ¼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.”…”�”}”(hj®h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Míhjªubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj�ubj)�”}”(hŒmIf the value of the PATE for an existing partition (VM) changes, the TLB cache for the partition is flushed. ”h]”j )�”}”(hŒlIf the value of the PATE for an existing partition (VM) changes, the TLB cache for the partition is flushed.”h]”hŒlIf the value of the PATE for an existing partition (VM) changes, the TLB cache for the partition is flushed.”…”�”}”(hjÆh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MñhjÂubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj�ubj)�”}”(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.”…”�”}”(hjÞh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MôhjÚubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj�ubeh}”(h]”h ]”h"]”h$]”h&]”j+j,j-hj.j/uh1j¢hj‹ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´Mæhjzh²hubeh}”(h]”Œid12”ah ]”h"]”h$]”Œ use cases”ah&]”uh1hÖhj²h²hh³hÇh´MäjÄ Kubeh}”(h]”Œ uv-write-pate”ah ]”h"]”Œ uv_write_pate”ah$]”h&]”uh1hÖhjD h²hh³hÇh´M¾ubh×)�”}”(hhh]”(hÜ)�”}”(hŒ UV_RETURN”h]”hŒ UV_RETURN”…”�”}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjh²hh³hÇh´MûubjÅ)�”}”(hŒ�Return control from the Hypervisor back to the Ultravisor after processing an hypercall or interrupt that was forwarded (aka *reflected*) to the Hypervisor. ”h]”j )�”}”(hŒœReturn 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#h²hh³Nh´NubhŒemphasis”“”)�”}”(hŒ *reflected*”h]”hŒ reflected”…”�”}”(hj-h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j+hj#ubhŒ) to the Hypervisor.”…”�”}”(hj#h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mýhjubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´Mýhjh²hubh×)�”}”(hhh]”(hÜ)�”}”(hŒSyntax”h]”hŒSyntax”…”�”}”(hjNh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjKh²hh³hÇh´Mubj¨ )�”}”(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&]”hÅhÆj· ‰j¸ j¹ jº }”uh1j§ h³hÇh´MhjKh²hubeh}”(h]”Œid13”ah ]”h"]”h$]”Œsyntax”ah&]”uh1hÖhjh²hh³hÇh´MjÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Return values”h]”hŒ Return values”…”�”}”(hjvh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjsh²hh³hÇh´M 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.”…”�”}”(hjˆh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M hj„ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M hjsh²hubeh}”(h]”Œid14”ah ]”h"]”h$]”Œ return values”ah&]”uh1hÖhjh²hh³hÇh´M jÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Description”h]”hŒ Description”…”�”}”(hj§h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhj¤h²hh³hÇh´MubjÅ)�”}”(hXÃWhen 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]”(hŒdWhen an SVM makes an hypercall or incurs some other exception, the Ultravisor usually forwards (aka ”…”�”}”(hj¹h²hh³Nh´Nubj,)�”}”(hŒ *reflects*”h]”hŒreflects”…”�”}”(hjÁh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j+hj¹ubhŒY) the exceptions to the Hypervisor. After processing the exception, Hypervisor uses the ”…”�”}”(hj¹h²hh³Nh´NubjÓ )�”}”(hŒ ``UV_RETURN``”h]”hŒ UV_RETURN”…”�”}”(hjÓh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hj¹ubhŒ- ultracall to return control back to the SVM.”…”�”}”(hj¹h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mhjµubj )�”}”(hŒ:The expected register state on entry to this ultracall is:”h]”hŒ:The expected register state on entry to this ultracall is:”…”�”}”(hjëh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mhjµubj)�”}”(hhh]”(j)�”}”(hŒ=Non-volatile registers are restored to their original values.”h]”j )�”}”(hjþh]”hŒ=Non-volatile registers are restored to their original values.”…”�”}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mhjüubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjùubj)�”}”(hŒ­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.”h]”j )�”}”(hŒ­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.”h]”(hŒGIf returning from an hypercall, register R0 contains the return value (”…”�”}”(hjh²hh³Nh´NubjŒ)�”}”(hŒ**unlike other ultracalls**”h]”hŒunlike other ultracalls”…”�”}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j‹hjubhŒK) and, registers R4 through R12 contain any output values of the hypercall.”…”�”}”(hjh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mhjubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjùubj)�”}”(hŒ0R3 contains the ultracall number, i.e UV_RETURN.”h]”j )�”}”(hj?h]”hŒ0R3 contains the ultracall number, i.e UV_RETURN.”…”�”}”(hjAh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mhj=ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjùubj)�”}”(hŒYIf returning with a synthesized interrupt, R2 contains the synthesized interrupt number. ”h]”j )�”}”(hŒXIf returning with a synthesized interrupt, R2 contains the synthesized interrupt number.”h]”hŒXIf returning with a synthesized interrupt, R2 contains the synthesized interrupt number.”…”�”}”(hjXh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MhjTubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjùubeh}”(h]”h ]”h"]”h$]”h&]”jm jn uh1jh³hÇh´Mhjµubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´Mhj¤h²hubeh}”(h]”Œid15”ah ]”h"]”h$]”Œ description”ah&]”uh1hÖhjh²hh³hÇh´MjÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Use cases”h]”hŒ Use cases”…”�”}”(hjƒh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhj€h²hh³hÇh´M!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)�”}”(hŒâ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. ”h]”j )�”}”(hŒá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.”h]”hŒá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.”…”�”}”(hjœh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M#hj˜ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj•ubj)�”}”(hŒDHypervisor has to use this ultracall to return control to the SVM. ”h]”j )�”}”(hŒBHypervisor has to use this ultracall to return control to the SVM.”h]”hŒBHypervisor has to use this ultracall to return control to the SVM.”…”�”}”(hj´h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M(hj°ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj•ubeh}”(h]”h ]”h"]”h$]”h&]”j+j,j-hj.j/uh1j¢hj‘ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M#hj€h²hubeh}”(h]”Œid16”ah ]”h"]”h$]”Œ use cases”ah&]”uh1hÖhjh²hh³hÇh´M!jÄ Kubeh}”(h]”Œ uv-return”ah ]”h"]”Œ uv_return”ah$]”h&]”uh1hÖhjD h²hh³hÇh´Mûubh×)�”}”(hhh]”(hÜ)�”}”(hŒUV_REGISTER_MEM_SLOT”h]”hŒUV_REGISTER_MEM_SLOT”…”�”}”(hjçh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjäh²hh³hÇh´M,ubjÅ)�”}”(hŒ9Register an SVM address-range with specified properties. ”h]”j )�”}”(hŒ8Register an SVM address-range with specified properties.”h]”hŒ8Register an SVM address-range with specified properties.”…”�”}”(hjùh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M.hjõubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M.hjäh²hubh×)�”}”(hhh]”(hÜ)�”}”(hŒSyntax”h]”hŒSyntax”…”�”}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhj h²hh³hÇh´M1ubj¨ )�”}”(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&]”hÅhÆj· ‰j¸ j¹ jº }”uh1j§ h³hÇh´M3hj h²hubeh}”(h]”Œid17”ah ]”h"]”h$]”Œsyntax”ah&]”uh1hÖhjäh²hh³hÇh´M1jÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Return values”h]”hŒ Return values”…”�”}”(hj8h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhj5h²hh³hÇh´M=ubjÅ)�”}”(hXÂOne 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 )�”}”(hŒOne of the following values:”h]”hŒOne of the following values:”…”�”}”(hjJh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M?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)�”}”(hŒU_SUCCESS on success.”h]”j )�”}”(hjah]”hŒU_SUCCESS on success.”…”�”}”(hjch²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MAhj_ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj\ubj)�”}”(hŒ%U_PARAMETER if ``lpid`` is invalid.”h]”j )�”}”(hjxh]”(hŒU_PARAMETER if ”…”�”}”(hjzh²hh³Nh´NubjÓ )�”}”(hŒ``lpid``”h]”hŒlpid”…”�”}”(hj�h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjzubhŒ is invalid.”…”�”}”(hjzh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MBhjvubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj\ubj)�”}”(hŒ*U_P2 if ``start_gpa`` is invalid.”h]”j )�”}”(hj¡h]”(hŒU_P2 if ”…”�”}”(hj£h²hh³Nh´NubjÓ )�”}”(hŒ ``start_gpa``”h]”hŒ start_gpa”…”�”}”(hjªh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hj£ubhŒ is invalid.”…”�”}”(hj£h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MChjŸubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj\ubj)�”}”(hŒ%U_P3 if ``size`` is invalid.”h]”j )�”}”(hjÊh]”(hŒU_P3 if ”…”�”}”(hjÌh²hh³Nh´NubjÓ )�”}”(hŒ``size``”h]”hŒsize”…”�”}”(hjÓh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjÌubhŒ is invalid.”…”�”}”(hjÌh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MDhjÈubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj\ubj)�”}”(hŒ:U_P4 if any bit in the ``flags`` is unrecognized.”h]”j )�”}”(hjóh]”(hŒ U_P4 if any bit in the ”…”�”}”(hjõh²hh³Nh´NubjÓ )�”}”(hŒ ``flags``”h]”hŒflags”…”�”}”(hjüh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjõubhŒ is unrecognized.”…”�”}”(hjõh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MEhjñubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj\ubj)�”}”(hŒ9U_P5 if the ``slotid`` parameter is unsupported.”h]”j )�”}”(hjh]”(hŒU_P5 if the ”…”�”}”(hjh²hh³Nh´NubjÓ )�”}”(hŒ ``slotid``”h]”hŒslotid”…”�”}”(hj%h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjubhŒ parameter is unsupported.”…”�”}”(hjh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MFhjubah}”(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.”…”�”}”(hjGh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MGhjCubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj\ubj)�”}”(hŒ2U_FUNCTION if functionality is not supported. ”h]”j )�”}”(hŒ0U_FUNCTION if functionality is not supported.”h]”hŒ0U_FUNCTION if functionality is not supported.”…”�”}”(hj^h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MHhjZubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj\ubeh}”(h]”h ]”h"]”h$]”h&]”jm jn uh1jh³hÇh´MAhjXubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´MAhjFubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M?hj5h²hubeh}”(h]”Œid18”ah ]”h"]”h$]”Œ return values”ah&]”uh1hÖhjäh²hh³hÇh´M=jÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Description”h]”hŒ Description”…”�”}”(hj�h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjŒh²hh³hÇh´MLubjÅ)�”}”(hŒ…Register a memory range for an SVM. The memory range starts at the guest physical address ``start_gpa`` and is ``size`` bytes long. ”h]”j )�”}”(hŒ„Register 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 ”…”�”}”(hj¡h²hh³Nh´NubjÓ )�”}”(hŒ ``start_gpa``”h]”hŒ start_gpa”…”�”}”(hj©h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hj¡ubhŒ and is ”…”�”}”(hj¡h²hh³Nh´NubjÓ )�”}”(hŒ``size``”h]”hŒsize”…”�”}”(hj»h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hj¡ubhŒ bytes long.”…”�”}”(hj¡h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MNhj�ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´MNhjŒh²hubeh}”(h]”Œid19”ah ]”h"]”h$]”Œ description”ah&]”uh1hÖhjäh²hh³hÇh´MLjÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Use cases”h]”hŒ Use cases”…”�”}”(hjäh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjáh²hh³hÇh´MRubjÅ)�”}”(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).”…”�”}”(hjýh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MUhjùubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjöubj)�”}”(hŒDWhen new memory is hot-plugged, a new memory slot gets registered. ”h]”j )�”}”(hŒBWhen new memory is hot-plugged, a new memory slot gets registered.”h]”hŒBWhen new memory is hot-plugged, a new memory slot gets registered.”…”�”}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M[hjubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjöubeh}”(h]”h ]”h"]”h$]”h&]”j+j,j-hj.j/uh1j¢hjòubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´MUhjáh²hubeh}”(h]”Œid20”ah ]”h"]”h$]”Œ use cases”ah&]”uh1hÖhjäh²hh³hÇh´MRjÄ Kubeh}”(h]”Œuv-register-mem-slot”ah ]”h"]”Œuv_register_mem_slot”ah$]”h&]”uh1hÖhjD h²hh³hÇh´M,ubh×)�”}”(hhh]”(hÜ)�”}”(hŒUV_UNREGISTER_MEM_SLOT”h]”hŒUV_UNREGISTER_MEM_SLOT”…”�”}”(hjHh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjEh²hh³hÇh´M_ubjÅ)�”}”(hŒ[Unregister an SVM address-range that was previously registered using UV_REGISTER_MEM_SLOT. ”h]”j )�”}”(hŒZUnregister an SVM address-range that was previously registered using UV_REGISTER_MEM_SLOT.”h]”hŒZUnregister an SVM address-range that was previously registered using UV_REGISTER_MEM_SLOT.”…”�”}”(hjZh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MahjVubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´MahjEh²hubh×)�”}”(hhh]”(hÜ)�”}”(hŒSyntax”h]”hŒSyntax”…”�”}”(hjqh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjnh²hh³hÇh´Meubj¨ )�”}”(hŒ«uint64_t ultracall(const uint64_t UV_UNREGISTER_MEM_SLOT, uint64_t lpid, /* LPAR ID of the SVM */ uint64_t slotid) /* reservation slotid */”h]”hŒ«uint64_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&]”hÅhÆj· ‰j¸ j¹ jº }”uh1j§ h³hÇh´Mghjnh²hubeh}”(h]”Œid21”ah ]”h"]”h$]”Œsyntax”ah&]”uh1hÖhjEh²hh³hÇh´MejÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Return values”h]”hŒ Return values”…”�”}”(hj™h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhj–h²hh³hÇh´MnubjÅ)�”}”(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 )�”}”(hŒOne of the following values:”h]”hŒOne of the following values:”…”�”}”(hj«h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mphj§ubjÅ)�”}”(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)�”}”(hŒU_SUCCESS on success.”h]”j )�”}”(hjÂh]”hŒU_SUCCESS on success.”…”�”}”(hjÄh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MrhjÀubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj½ubj)�”}”(hŒ0U_FUNCTION if functionality is not supported.”h]”j )�”}”(hjÙh]”hŒ0U_FUNCTION if functionality is not supported.”…”�”}”(hjÛh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mshj×ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj½ubj)�”}”(hŒ%U_PARAMETER if ``lpid`` is invalid.”h]”j )�”}”(hjðh]”(hŒU_PARAMETER if ”…”�”}”(hjòh²hh³Nh´NubjÓ )�”}”(hŒ``lpid``”h]”hŒlpid”…”�”}”(hjùh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjòubhŒ is invalid.”…”�”}”(hjòh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mthjîubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj½ubj)�”}”(hŒ'U_P2 if ``slotid`` is invalid.”h]”j )�”}”(hjh]”(hŒU_P2 if ”…”�”}”(hjh²hh³Nh´NubjÓ )�”}”(hŒ ``slotid``”h]”hŒslotid”…”�”}”(hj"h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjubhŒ is invalid.”…”�”}”(hjh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Muhjubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj½ubj)�”}”(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 )�”}”(hŒ9The SVM may decide to unshare a page from the Hypervisor.”h]”hŒ9The SVM may decide to unshare a page from the Hypervisor.”…”�”}”(hjQ#h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MhjM#ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjJ#ubah}”(h]”h ]”h"]”h$]”h&]”j+j,j-hj.j/uh1j¢hjF#ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´Mhj5#h²hubeh}”(h]”Œid36”ah ]”h"]”h$]”Œ use cases”ah&]”uh1hÖhj¥!h²hh³hÇh´MjÄ Kubeh}”(h]”Œuv-unshare-page”ah ]”h"]”Œuv_unshare_page”ah$]”h&]”uh1hÖhj h²hh³hÇh´MÜubh×)�”}”(hhh]”(hÜ)�”}”(hŒUV_UNSHARE_ALL_PAGES”h]”hŒUV_UNSHARE_ALL_PAGES”…”�”}”(hj„#h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhj�#h²hh³hÇh´M ubjÅ)�”}”(hŒ6Unshare all pages the SVM has shared with Hypervisor. ”h]”j )�”}”(hŒ5Unshare all pages the SVM has shared with Hypervisor.”h]”hŒ5Unshare all pages the SVM has shared with Hypervisor.”…”�”}”(hj–#h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M hj’#ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M hj�#h²hubh×)�”}”(hhh]”(hÜ)�”}”(hŒSyntax”h]”hŒSyntax”…”�”}”(hj­#h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjª#h²hh³hÇh´Mubj¨ )�”}”(hŒ7uint64_t ultracall(const uint64_t UV_UNSHARE_ALL_PAGES)”h]”hŒ7uint64_t ultracall(const uint64_t UV_UNSHARE_ALL_PAGES)”…”�”}”hj»#sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆj· ‰j¸ j¹ jº }”uh1j§ h³hÇh´Mhjª#h²hubeh}”(h]”Œid37”ah ]”h"]”h$]”Œsyntax”ah&]”uh1hÖhj�#h²hh³hÇh´MjÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Return values”h]”hŒ Return values”…”�”}”(hjÕ#h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjÒ#h²hh³hÇh´MubjÅ)�”}”(hŒžOne of the following values: * U_SUCCESS on success. * U_FUNCTION if functionality is not supported. * U_INVAL if VM is not secure. ”h]”(j )�”}”(hŒOne of the following values:”h]”hŒOne of the following values:”…”�”}”(hjç#h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mhjã#ubjÅ)�”}”(hŒt* U_SUCCESS on success. * U_FUNCTION if functionality is not supported. * U_INVAL if VM is not secure. ”h]”j)�”}”(hhh]”(j)�”}”(hŒU_SUCCESS on success.”h]”j )�”}”(hjþ#h]”hŒU_SUCCESS on success.”…”�”}”(hj$h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mhjü#ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjù#ubj)�”}”(hŒ0U_FUNCTION if functionality is not supported.”h]”j )�”}”(hj$h]”hŒ0U_FUNCTION if functionality is not supported.”…”�”}”(hj$h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mhj$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.$h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mhj*$ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjù#ubeh}”(h]”h ]”h"]”h$]”h&]”jm jn uh1jh³hÇh´Mhjõ#ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´Mhjã#ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´MhjÒ#h²hubeh}”(h]”Œid38”ah ]”h"]”h$]”Œ return values”ah&]”uh1hÖhj�#h²hh³hÇh´MjÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Description”h]”hŒ Description”…”�”}”(hj_$h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhj\$h²hh³hÇh´MubjÅ)�”}”(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$h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M hjm$ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M hj\$h²hubeh}”(h]”Œid39”ah ]”h"]”h$]”Œ description”ah&]”uh1hÖhj�#h²hh³hÇh´MjÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Use cases”h]”hŒ Use cases”…”�”}”(hj�$h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhj�$h²hh³hÇh´M(ubjÅ)�”}”(hŒu#. 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)�”}”(hŒoThis call is needed when ``kexec`` is used to boot a different kernel. It may also be needed during SVM reset. ”h]”j )�”}”(hŒnThis call is needed when ``kexec`` is used to boot a different kernel. It may also be needed during SVM reset.”h]”(hŒThis call is needed when ”…”�”}”(hj©$h²hh³Nh´NubjÓ )�”}”(hŒ ``kexec``”h]”hŒkexec”…”�”}”(hj±$h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hj©$ubhŒL is used to boot a different kernel. It may also be needed during SVM reset.”…”�”}”(hj©$h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M*hj¥$ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj¢$ubah}”(h]”h ]”h"]”h$]”h&]”j+j,j-hj.j/uh1j¢hjž$ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M*hj�$h²hubeh}”(h]”Œid40”ah ]”h"]”h$]”Œ use cases”ah&]”uh1hÖhj�#h²hh³hÇh´M(jÄ Kubeh}”(h]”Œuv-unshare-all-pages”ah ]”h"]”Œuv_unshare_all_pages”ah$]”h&]”uh1hÖhj h²hh³hÇh´M ubh×)�”}”(hhh]”(hÜ)�”}”(hŒUV_ESM”h]”hŒUV_ESM”…”�”}”(hjî$h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjë$h²hh³hÇh´M.ubjÅ)�”}”(hŒ2Secure the virtual machine (*enter secure mode*). ”h]”j )�”}”(hŒ1Secure the virtual machine (*enter secure mode*).”h]”(hŒSecure the virtual machine (”…”�”}”(hj%h²hh³Nh´Nubj,)�”}”(hŒ*enter secure mode*”h]”hŒenter secure mode”…”�”}”(hj%h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j+hj%ubhŒ).”…”�”}”(hj%h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M0hjü$ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M0hjë$h²hubh×)�”}”(hhh]”(hÜ)�”}”(hŒSyntax”h]”hŒSyntax”…”�”}”(hj)%h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhj&%h²hh³hÇh´M3ubj¨ )�”}”(hŒ¤uint64_t ultracall(const uint64_t UV_ESM, uint64_t esm_blob_addr, /* location of the ESM blob */ unint64_t fdt) /* Flattened device tree */”h]”hŒ¤uint64_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&]”hÅhÆj· ‰j¸ j¹ jº }”uh1j§ h³hÇh´M5hj&%h²hubeh}”(h]”Œid41”ah ]”h"]”h$]”Œsyntax”ah&]”uh1hÖhjë$h²hh³hÇh´M3jÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Return values”h]”hŒ Return values”…”�”}”(hjQ%h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjN%h²hh³hÇh´M<ubjÅ)�”}”(hXºOne 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 )�”}”(hŒOne of the following values:”h]”hŒOne of the following values:”…”�”}”(hjc%h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M>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|%h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M@hjx%ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhju%ubj)�”}”(hŒ0U_FUNCTION if functionality is not supported.”h]”j )�”}”(hj‘%h]”hŒ0U_FUNCTION if functionality is not supported.”…”�”}”(hj“%h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MAhj�%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ª%h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MBhj¦%ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhju%ubj)�”}”(hŒ.U_PARAMETER if ``esm_blob_addr`` is invalid.”h]”j )�”}”(hj¿%h]”(hŒU_PARAMETER if ”…”�”}”(hjÁ%h²hh³Nh´NubjÓ )�”}”(hŒ``esm_blob_addr``”h]”hŒ esm_blob_addr”…”�”}”(hjÈ%h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjÁ%ubhŒ is invalid.”…”�”}”(hjÁ%h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MChj½%ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhju%ubj)�”}”(hŒ$U_P2 if ``fdt`` is invalid.”h]”j )�”}”(hjè%h]”(hŒU_P2 if ”…”�”}”(hjê%h²hh³Nh´NubjÓ )�”}”(hŒ``fdt``”h]”hŒfdt”…”�”}”(hjñ%h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjê%ubhŒ is invalid.”…”�”}”(hjê%h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MDhjæ%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&h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MEhj&ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhju%ubj)�”}”(hŒ0U_RETRY insufficient memory to create SVM.”h]”j )�”}”(hj(&h]”hŒ0U_RETRY insufficient memory to create SVM.”…”�”}”(hj*&h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MFhj&&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&h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MGhj=&ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhju%ubeh}”(h]”h ]”h"]”h$]”h&]”jm jn uh1jh³hÇh´M@hjq%ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M@hj_%ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M>hjN%h²hubeh}”(h]”Œid42”ah ]”h"]”h$]”Œ return values”ah&]”uh1hÖhjë$h²hh³hÇh´M<jÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Description”h]”hŒ Description”…”�”}”(hjr&h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjo&h²hh³hÇh´MJubjÅ)�”}”(hŒ†Secure the virtual machine. On successful completion, return control to the virtual machine at the address specified in the ESM blob. ”h]”j )�”}”(hŒ…Secure the virtual machine. On successful completion, return control to the virtual machine at the address specified in the ESM blob.”h]”hŒ…Secure the virtual machine. On successful completion, return control to the virtual machine at the address specified in the ESM blob.”…”�”}”(hj„&h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MLhj€&ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´MLhjo&h²hubeh}”(h]”Œid43”ah ]”h"]”h$]”Œ description”ah&]”uh1hÖhjë$h²hh³hÇh´MJjÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Use cases”h]”hŒ Use cases”…”�”}”(hj£&h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhj &h²hh³hÇh´MQubjÅ)�”}”(hŒC#. 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¼&h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MShj¸&ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjµ&ubah}”(h]”h ]”h"]”h$]”h&]”j+j,j-hj.j/uh1j¢hj±&ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´MShj &h²hubeh}”(h]”Œid44”ah ]”h"]”h$]”Œ use cases”ah&]”uh1hÖhjë$h²hh³hÇh´MQjÄ Kubeh}”(h]”Œuv-esm”ah ]”h"]”Œuv_esm”ah$]”h&]”uh1hÖhj h²hh³hÇh´M.ubeh}”(h]”jah ]”h"]”Œultracalls used by svm”ah$]”h&]”uh1hÖhj™ h²hh³hÇh´M¨ubeh}”(h]”jÏah ]”h"]”Œultravisor calls api”ah$]”h&]”uh1hÖhhØh²hh³hÇh´KØubh×)�”}”(hhh]”(hÜ)�”}”(hŒHypervisor Calls API”h]”hŒHypervisor Calls API”…”�”}”(hjý&h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”hÔj8uh1hÛhjú&h²hh³hÇh´MVubjÅ)�”}”(hX›This 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 )�”}”(hŒ»This 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]”hŒ»This 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'h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MXhj 'ubj )�”}”(hX¿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.”h]”hX¿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.”…”�”}”(hj'h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M\hj 'ubj )�”}”(hŒ‰This document only covers hypercalls currently implemented/planned for Ultravisor usage but others can be added here when it makes sense.”h]”hŒ‰This document only covers hypercalls currently implemented/planned for Ultravisor usage but others can be added here when it makes sense.”…”�”}”(hj+'h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mdhj 'ubj )�”}”(hŒ‘The full specification for all hypercalls/ultracalls will eventually be made available in the public/OpenPower version of the PAPR specification.”h]”hŒ‘The full specification for all hypercalls/ultracalls will eventually be made available in the public/OpenPower version of the PAPR specification.”…”�”}”(hj9'h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mghj 'ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´MXhjú&h²hubh×)�”}”(hhh]”(hÜ)�”}”(hŒ&Hypervisor calls to support Ultravisor”h]”hŒ&Hypervisor calls to support Ultravisor”…”�”}”(hjP'h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”hÔjWuh1hÛhjM'h²hh³hÇh´MlubjÅ)�”}”(hŒBFollowing are the set of hypercalls needed to support Ultravisor. ”h]”j )�”}”(hŒAFollowing are the set of hypercalls needed to support Ultravisor.”h]”hŒAFollowing are the set of hypercalls needed to support Ultravisor.”…”�”}”(hjb'h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mnhj^'ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´MnhjM'h²hubh×)�”}”(hhh]”(hÜ)�”}”(hŒH_SVM_INIT_START”h]”hŒH_SVM_INIT_START”…”�”}”(hjy'h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjv'h²hh³hÇh´MqubjÅ)�”}”(hŒFBegin the process of converting a normal virtual machine into an SVM. ”h]”j )�”}”(hŒEBegin the process of converting a normal virtual machine into an SVM.”h]”hŒEBegin the process of converting a normal virtual machine into an SVM.”…”�”}”(hj‹'h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mshj‡'ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´Mshjv'h²hubh×)�”}”(hhh]”(hÜ)�”}”(hŒSyntax”h]”hŒSyntax”…”�”}”(hj¢'h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjŸ'h²hh³hÇh´Mvubj¨ )�”}”(hŒ3uint64_t hypercall(const uint64_t H_SVM_INIT_START)”h]”hŒ3uint64_t hypercall(const uint64_t H_SVM_INIT_START)”…”�”}”hj°'sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆj· ‰j¸ j¹ jº }”uh1j§ h³hÇh´MxhjŸ'h²hubeh}”(h]”Œid45”ah ]”h"]”h$]”Œsyntax”ah&]”uh1hÖhjv'h²hh³hÇh´MvjÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Return values”h]”hŒ Return values”…”�”}”(hjÊ'h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjÇ'h²hh³hÇh´M}ubjÅ)�”}”(hŒˆOne of the following values: * H_SUCCESS on success. * H_STATE if the VM is not in a position to switch to secure. ”h]”(j )�”}”(hŒOne of the following values:”h]”hŒOne of the following values:”…”�”}”(hjÜ'h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MhjØ'ubjÅ)�”}”(hŒb* H_SUCCESS on success. * H_STATE if the VM is not in a position to switch to secure. ”h]”j)�”}”(hhh]”(j)�”}”(hŒH_SUCCESS on success.”h]”j )�”}”(hjó'h]”hŒH_SUCCESS on success.”…”�”}”(hjõ'h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M�hjñ'ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjî'ubj)�”}”(hŒCH_STATE if the VM is not in a position to switch to secure. ”h]”j )�”}”(hŒBH_STATE if the VM is not in a position to switch to secure.”h]”hŒBH_STATE if the VM is not in a position to switch to secure.”…”�”}”(hj (h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M‚hj(ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjî'ubeh}”(h]”h ]”h"]”h$]”h&]”jm jn uh1jh³hÇh´M�hjê'ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M�hjØ'ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´MhjÇ'h²hubeh}”(h]”Œid46”ah ]”h"]”h$]”Œ return values”ah&]”uh1hÖhjv'h²hh³hÇh´M}jÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Description”h]”hŒ Description”…”�”}”(hj=(h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhj:(h²hh³hÇh´M…ubjÅ)�”}”(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(h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M‡hjK(ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M‡hj:(h²hubeh}”(h]”Œid47”ah ]”h"]”h$]”Œ description”ah&]”uh1hÖhjv'h²hh³hÇh´M…jÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Use cases”h]”hŒ Use cases”…”�”}”(hjn(h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjk(h²hh³hÇh´MŽubjÅ)�”}”(hŒ|#. Ultravisor uses this hypercall to inform Hypervisor that a VM has initiated the process of switching to secure mode. ”h]”j£)�”}”(hhh]”j)�”}”(hŒvUltravisor uses this hypercall to inform Hypervisor that a VM has initiated the process of switching to secure mode. ”h]”j )�”}”(hŒtUltravisor uses this hypercall to inform Hypervisor that a VM has initiated the process of switching to secure mode.”h]”hŒtUltravisor uses this hypercall to inform Hypervisor that a VM has initiated the process of switching to secure mode.”…”�”}”(hj‡(h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M�hjƒ(ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj€(ubah}”(h]”h ]”h"]”h$]”h&]”j+j,j-hj.j/uh1j¢hj|(ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M�hjk(h²hubeh}”(h]”Œid48”ah ]”h"]”h$]”Œ use cases”ah&]”uh1hÖhjv'h²hh³hÇh´MŽjÄ Kubeh}”(h]”Œh-svm-init-start”ah ]”h"]”Œh_svm_init_start”ah$]”h&]”uh1hÖhjM'h²hh³hÇh´Mqubh×)�”}”(hhh]”(hÜ)�”}”(hŒH_SVM_INIT_DONE”h]”hŒH_SVM_INIT_DONE”…”�”}”(hjº(h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhj·(h²hh³hÇh´M•ubjÅ)�”}”(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Ì(h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M—hjÈ(ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M—hj·(h²hubh×)�”}”(hhh]”(hÜ)�”}”(hŒSyntax”h]”hŒSyntax”…”�”}”(hjã(h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjà(h²hh³hÇh´Mšubj¨ )�”}”(hŒ2uint64_t hypercall(const uint64_t H_SVM_INIT_DONE)”h]”hŒ2uint64_t hypercall(const uint64_t H_SVM_INIT_DONE)”…”�”}”hjñ(sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆj· ‰j¸ j¹ jº }”uh1j§ h³hÇh´Mœhjà(h²hubeh}”(h]”Œid49”ah ]”h"]”h$]”Œsyntax”ah&]”uh1hÖhj·(h²hh³hÇh´MšjÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Return values”h]”hŒ Return values”…”�”}”(hj )h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhj)h²hh³hÇh´M¡ubjÅ)�”}”(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 )�”}”(hŒOne of the following values:”h]”hŒOne of the following values:”…”�”}”(hj)h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M£hj)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)h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M¥hj2)ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj/)ubj)�”}”(hŒžH_UNSUPPORTED if called from the wrong context (e.g. from an SVM or before an H_SVM_INIT_START hypercall).”h]”jZ)�”}”(hhh]”j_)�”}”(hŒrH_UNSUPPORTED if called from the wrong context (e.g. from an SVM or before an H_SVM_INIT_START hypercall).”h]”(je)�”}”(hŒH_STATE if the hypervisor could not successfully”h]”hŒ>H_STATE if the hypervisor could not successfully”…”�”}”(hj–)h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jdh³hÇh´Mªhj’)ubj‡)�”}”(hhh]”j )�”}”(hŒtransition the VM to Secure VM.”h]”hŒtransition the VM to Secure VM.”…”�”}”(hj§)h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mªhj¤)ubah}”(h]”h ]”h"]”h$]”h&]”uh1j†hj’)ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j^h³hÇh´Mªhj�)ubah}”(h]”h ]”h"]”h$]”h&]”uh1jYhj‹)ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj/)ubeh}”(h]”h ]”h"]”h$]”h&]”jm jn uh1jh³hÇh´M¥hj+)ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M¥hj)ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M£hj)h²hubeh}”(h]”Œid50”ah ]”h"]”h$]”Œ return values”ah&]”uh1hÖhj·(h²hh³hÇh´M¡jÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Description”h]”hŒ Description”…”�”}”(hjê)h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjç)h²hh³hÇh´M­ubjÅ)�”}”(hŒ�Complete the process of securing a virtual machine. This call must be made after a prior call to ``H_SVM_INIT_START`` hypercall. ”h]”j )�”}”(hŒ€Complete the process of securing a virtual machine. This call must be made after a prior call to ``H_SVM_INIT_START`` hypercall.”h]”(hŒaComplete the process of securing a virtual machine. This call must be made after a prior call to ”…”�”}”(hjü)h²hh³Nh´NubjÓ )�”}”(hŒ``H_SVM_INIT_START``”h]”hŒH_SVM_INIT_START”…”�”}”(hj*h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jÒ hjü)ubhŒ hypercall.”…”�”}”(hjü)h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M¯hjø)ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M¯hjç)h²hubeh}”(h]”Œid51”ah ]”h"]”h$]”Œ description”ah&]”uh1hÖhj·(h²hh³hÇh´M­jÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Use cases”h]”hŒ Use cases”…”�”}”(hj-*h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhj**h²hh³hÇh´M³ubjÅ)�”}”(hŒ¸On 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 )�”}”(hŒ¶On successfully securing a virtual machine, the Ultravisor informs Hypervisor about it. Hypervisor can use this call to finish setting up its internal state for this virtual machine.”h]”hŒ¶On 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?*h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´Mµhj;*ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´Mµhj**h²hubeh}”(h]”Œid52”ah ]”h"]”h$]”Œ use cases”ah&]”uh1hÖhj·(h²hh³hÇh´M³jÄ Kubeh}”(h]”Œh-svm-init-done”ah ]”h"]”Œh_svm_init_done”ah$]”h&]”uh1hÖhjM'h²hh³hÇh´M•ubh×)�”}”(hhh]”(hÜ)�”}”(hŒH_SVM_INIT_ABORT”h]”hŒH_SVM_INIT_ABORT”…”�”}”(hjf*h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjc*h²hh³hÇh´M»ubjÅ)�”}”(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*h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M½hjt*ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄh³hÇh´M½hjc*h²hubh×)�”}”(hhh]”(hÜ)�”}”(hŒSyntax”h]”hŒSyntax”…”�”}”(hj�*h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhjŒ*h²hh³hÇh´MÀubj¨ )�”}”(hŒ3uint64_t hypercall(const uint64_t H_SVM_INIT_ABORT)”h]”hŒ3uint64_t hypercall(const uint64_t H_SVM_INIT_ABORT)”…”�”}”hj�*sbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆj· ‰j¸ j¹ jº }”uh1j§ h³hÇh´MÂhjŒ*h²hubeh}”(h]”Œid53”ah ]”h"]”h$]”Œsyntax”ah&]”uh1hÖhjc*h²hh³hÇh´MÀjÄ Kubh×)�”}”(hhh]”(hÜ)�”}”(hŒ Return values”h]”hŒ Return values”…”�”}”(hj·*h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhj´*h²hh³hÇh´MÇubjÅ)�”}”(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 )�”}”(hŒOne of the following values:”h]”hŒOne of the following values:”…”�”}”(hjÉ*h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´MÉhjÅ*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)�”}”(hŒì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]”jZ)�”}”(hhh]”j_)�”}”(hŒª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]”(je)�”}”(hŒah ]”h"]”Œhypervisor calls api”ah$]”h&]”uh1hÖhhØh²hh³hÇh´MVubh×)�”}”(hhh]”(hÜ)�”}”(hŒ References”h]”hŒ References”…”�”}”(hj”1h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”hÔj…uh1hÛhj‘1h²hh³hÇh´M[ubj)�”}”(hhh]”j)�”}”(hŒ`Supporting Protected Computing on IBM Power Architecture `_”h]”j )�”}”(hj§1h]”(j)�”}”(hj§1h]”hŒ8Supporting Protected Computing on IBM Power Architecture”…”�”}”(hj¬1h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”Œname”Œ8Supporting Protected Computing on IBM Power Architecture”Œrefuri”ŒAhttps://developer.ibm.com/articles/l-support-protected-computing/”uh1jhj©1ubhÉ)�”}”(hŒD ”h]”h}”(h]”Œ8supporting-protected-computing-on-ibm-power-architecture”ah ]”h"]”Œ8supporting protected computing on ibm power architecture”ah$]”h&]”Œrefuri”j¼1uh1hÈjÄ Khj©1ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´M]hj¥1ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj¢1h²hh³hÇh´Nubah}”(h]”h ]”h"]”h$]”h&]”jm Œ-”uh1jh³hÇh´M]hj‘1h²hubeh}”(h]”j‹ah ]”h"]”Œ references”ah$]”h&]”uh1hÖhhØh²hh³hÇh´M[ubeh}”(h]”(jhÕeh ]”h"]”(Œprotected execution facility”Œ ultravisor”eh$]”h&]”uh1hÖhhh²hh³hÇh´KŒexpect_referenced_by_name”}”jé1hÊsŒexpect_referenced_by_id”}”hÕhÊsubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”hÇuh1hŒcurrent_source”NŒ current_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)�”}”(hÛNŒ generator”NŒ datestamp”NŒ source_link”NŒ source_url”NŒ toc_backlinks”j Œfootnote_backlinks”KŒ sectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒ strip_classes”NŒ report_level”KŒ halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ traceback”ˆŒinput_encoding”Œ utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”j2Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œ language_code”Œen”Œrecord_dependencies”NŒconfig”NŒ id_prefix”hŒauto_id_prefix”Œid”Œ dump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”hÇŒ _destination”NŒ _config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒ raw_enabled”KŒline_length_limit”M'Œpep_references”NŒ pep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒ rfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œ smart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œ docinfo_xform”KŒsectsubtitle_xform”‰Œ image_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”hÕ]”hÊasŒnameids”}”(jé1hÕjè1jj°j¬j– j>j… j]j¤ jj� j¡j÷&jÏj�jîjCj@Œsyntax”NŒ return values”NŒ description”NŒ use cases”Nj—j”j¯j¬j jjájÞjBj?jþjûj–j“jð&jj¢!jŸ!j~#j{#jè$jå$jé&jæ&jŽ1j>j‡1j]j´(j±(j`*j]*j'-j$-j—/j”/j€1j}1já1j‹jÆ1jÃ1uŒ nametypes”}”(jé1ˆjè1‰j°‰j– ‰j… ‰j¤ ‰j� ‰j÷&‰j�‰jC‰jW2‰jX2‰jY2‰jZ2‰j—‰j¯‰j ‰já‰jB‰jþ‰j–‰jð&‰j¢!‰j~#‰jè$‰jé&‰jŽ1‰j‡1‰j´(‰j`*‰j'-‰j—/‰j€1‰já1‰jÆ1ˆuh}”(hÕhØjhØj¬hîj>j³j]jïjjˆ j¡j§ jÏj™ jîjD j@jm j¾ j– jjÅ j‡jj8j�j”jFj‘jojçj–jjìj�jj¬jšjåjÃjjëj`j#j¤jfjj²jýjÛjCjjtjIjjzjÞjjmjKjžjsjzj¤jÖj€j?jäj/j j†j5jÛjŒj7jájûjEj�jnjlj–j¯jrjójµj“jjLj*jjRjGjj‹jMjj jŸ!j±jüjÚjØ 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Ã/j¼0jë/j11jÂ0ju1j71j‹j‘1jÃ1j½1hëjj8j/jWjNjyjpj›j’jÉjÀjèjßj jj8j/jWjNj…j|uŒ footnote_refs”}”Œ citation_refs”}”Œ autofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ footnotes”]”Œ citations”]”Œautofootnote_start”KŒsymbol_footnote_start”KŒ id_counter”Œ collections”ŒCounter”“”}”j 2KKs…”R”Œparse_messages”]”(hŒsystem_message”“”)�”}”(hhh]”j )�”}”(hŒ)Duplicate implicit target name: "syntax".”h]”hŒ-Duplicate implicit target name: “syntaxâ€�.”…”�”}”(hj~2h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj{2ubah}”(h]”h ]”h"]”h$]”h&]”j‘aŒlevel”KŒtype”ŒINFO”Œsource”hÇŒline”MSuh1jy2hjoh²hh³hÇh´MSubjz2)�”}”(hhh]”j )�”}”(hŒ0Duplicate implicit target name: "return values".”h]”hŒ4Duplicate implicit target name: “return valuesâ€�.”…”�”}”(hjš2h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj—2ubah}”(h]”h ]”h"]”h$]”h&]”jçaŒlevel”KŒtype”j”2Œsource”hÇŒline”M_uh1jy2hj–h²hh³hÇh´M_ubjz2)�”}”(hhh]”j )�”}”(hŒ.Duplicate implicit target name: "description".”h]”hŒ2Duplicate implicit target name: “descriptionâ€�.”…”�”}”(hjµ2h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj²2ubah}”(h]”h ]”h"]”h$]”h&]”jaŒlevel”KŒtype”j”2Œsource”hÇŒline”Mmuh1jy2hjìh²hh³hÇh´Mmubjz2)�”}”(hhh]”j )�”}”(hŒ,Duplicate implicit target name: "use cases".”h]”hŒ0Duplicate implicit target name: “use casesâ€�.”…”�”}”(hjÐ2h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjÍ2ubah}”(h]”h ]”h"]”h$]”h&]”j�aŒlevel”KŒtype”j”2Œsource”hÇŒline”Mƒuh1jy2hjh²hh³hÇh´Mƒubjz2)�”}”(hhh]”j )�”}”(hŒ)Duplicate implicit target name: "syntax".”h]”hŒ-Duplicate implicit target name: “syntaxâ€�.”…”�”}”(hjë2h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjè2ubah}”(h]”h ]”h"]”h$]”h&]”jåaŒlevel”KŒtype”j”2Œsource”hÇŒline”M–uh1jy2hjÃh²hh³hÇh´M–ubjz2)�”}”(hhh]”j )�”}”(hŒ0Duplicate implicit target name: "return values".”h]”hŒ4Duplicate implicit target name: “return valuesâ€�.”…”�”}”(hj3h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj3ubah}”(h]”h ]”h"]”h$]”h&]”jaŒlevel”KŒtype”j”2Œsource”hÇŒline”M uh1jy2hjëh²hh³hÇh´M ubjz2)�”}”(hhh]”j )�”}”(hŒ.Duplicate implicit target name: "description".”h]”hŒ2Duplicate implicit target name: “descriptionâ€�.”…”�”}”(hj!3h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj3ubah}”(h]”h ]”h"]”h$]”h&]”j`aŒlevel”KŒtype”j”2Œsource”hÇŒline”M­uh1jy2hj#h²hh³hÇh´M­ubjz2)�”}”(hhh]”j )�”}”(hŒ,Duplicate implicit target name: "use cases".”h]”hŒ0Duplicate implicit target name: “use casesâ€�.”…”�”}”(hj<3h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj93ubah}”(h]”h ]”h"]”h$]”h&]”j¤aŒlevel”KŒtype”j”2Œsource”hÇŒline”M¶uh1jy2hjfh²hh³hÇh´M¶ubjz2)�”}”(hhh]”j )�”}”(hŒ)Duplicate implicit target name: "syntax".”h]”hŒ-Duplicate implicit target name: “syntaxâ€�.”…”�”}”(hjW3h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjT3ubah}”(h]”h ]”h"]”h$]”h&]”jýaŒlevel”KŒtype”j”2Œsource”hÇŒline”MÄuh1jy2hjÛh²hh³hÇh´MÄubjz2)�”}”(hhh]”j )�”}”(hŒ0Duplicate implicit target name: "return values".”h]”hŒ4Duplicate implicit target name: “return valuesâ€�.”…”�”}”(hjr3h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjo3ubah}”(h]”h ]”h"]”h$]”h&]”jCaŒlevel”KŒtype”j”2Œsource”hÇŒline”MÎuh1jy2hjh²hh³hÇh´MÎubjz2)�”}”(hhh]”j )�”}”(hŒ.Duplicate implicit target name: "description".”h]”hŒ2Duplicate implicit target name: “descriptionâ€�.”…”�”}”(hj�3h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjŠ3ubah}”(h]”h ]”h"]”h$]”h&]”jtaŒlevel”KŒtype”j”2Œsource”hÇŒline”MÝuh1jy2hjIh²hh³hÇh´MÝubjz2)�”}”(hhh]”j )�”}”(hŒ,Duplicate implicit target name: "use cases".”h]”hŒ0Duplicate implicit target name: “use casesâ€�.”…”�”}”(hj¨3h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj¥3ubah}”(h]”h ]”h"]”h$]”h&]”jaŒlevel”KŒtype”j”2Œsource”hÇŒline”Mäuh1jy2hjzh²hh³hÇh´Mäubjz2)�”}”(hhh]”j )�”}”(hŒ)Duplicate implicit target name: "syntax".”h]”hŒ-Duplicate implicit target name: “syntaxâ€�.”…”�”}”(hjÃ3h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjÀ3ubah}”(h]”h ]”h"]”h$]”h&]”jmaŒlevel”KŒtype”j”2Œsource”hÇŒline”Muh1jy2hjKh²hh³hÇh´Mubjz2)�”}”(hhh]”j )�”}”(hŒ0Duplicate implicit target name: "return values".”h]”hŒ4Duplicate implicit target name: “return valuesâ€�.”…”�”}”(hjÞ3h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjÛ3ubah}”(h]”h ]”h"]”h$]”h&]”jžaŒlevel”KŒtype”j”2Œsource”hÇŒline”M uh1jy2hjsh²hh³hÇh´M ubjz2)�”}”(hhh]”j )�”}”(hŒ.Duplicate implicit target name: "description".”h]”hŒ2Duplicate implicit target name: “descriptionâ€�.”…”�”}”(hjù3h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjö3ubah}”(h]”h ]”h"]”h$]”h&]”jzaŒlevel”KŒtype”j”2Œsource”hÇŒline”Muh1jy2hj¤h²hh³hÇh´Mubjz2)�”}”(hhh]”j )�”}”(hŒ,Duplicate implicit target name: "use cases".”h]”hŒ0Duplicate implicit target name: “use casesâ€�.”…”�”}”(hj4h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj4ubah}”(h]”h ]”h"]”h$]”h&]”jÖaŒlevel”KŒtype”j”2Œsource”hÇŒline”M!uh1jy2hj€h²hh³hÇh´M!ubjz2)�”}”(hhh]”j )�”}”(hŒ)Duplicate implicit target name: "syntax".”h]”hŒ-Duplicate implicit target name: “syntaxâ€�.”…”�”}”(hj/4h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj,4ubah}”(h]”h ]”h"]”h$]”h&]”j/aŒlevel”KŒtype”j”2Œsource”hÇŒline”M1uh1jy2hj h²hh³hÇh´M1ubjz2)�”}”(hhh]”j )�”}”(hŒ0Duplicate implicit target name: "return values".”h]”hŒ4Duplicate implicit target name: “return valuesâ€�.”…”�”}”(hjJ4h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjG4ubah}”(h]”h ]”h"]”h$]”h&]”j†aŒlevel”KŒtype”j”2Œsource”hÇŒline”M=uh1jy2hj5h²hh³hÇh´M=ubjz2)�”}”(hhh]”j )�”}”(hŒ.Duplicate implicit target name: "description".”h]”hŒ2Duplicate implicit target name: “descriptionâ€�.”…”�”}”(hje4h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjb4ubah}”(h]”h ]”h"]”h$]”h&]”jÛaŒlevel”KŒtype”j”2Œsource”hÇŒline”MLuh1jy2hjŒh²hh³hÇh´MLubjz2)�”}”(hhh]”j )�”}”(hŒ,Duplicate implicit target name: "use cases".”h]”hŒ0Duplicate implicit target name: “use casesâ€�.”…”�”}”(hj€4h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj}4ubah}”(h]”h ]”h"]”h$]”h&]”j7aŒlevel”KŒtype”j”2Œsource”hÇŒline”MRuh1jy2hjáh²hh³hÇh´MRubjz2)�”}”(hhh]”j )�”}”(hŒ)Duplicate implicit target name: "syntax".”h]”hŒ-Duplicate implicit target name: “syntaxâ€�.”…”�”}”(hj›4h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj˜4ubah}”(h]”h ]”h"]”h$]”h&]”j�aŒlevel”KŒtype”j”2Œsource”hÇŒline”Meuh1jy2hjnh²hh³hÇh´Meubjz2)�”}”(hhh]”j )�”}”(hŒ0Duplicate implicit target name: "return values".”h]”hŒ4Duplicate implicit target name: “return valuesâ€�.”…”�”}”(hj¶4h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj³4ubah}”(h]”h ]”h"]”h$]”h&]”jlaŒlevel”KŒtype”j”2Œsource”hÇŒline”Mnuh1jy2hj–h²hh³hÇh´Mnubjz2)�”}”(hhh]”j )�”}”(hŒ.Duplicate implicit target name: "description".”h]”hŒ2Duplicate implicit target name: “descriptionâ€�.”…”�”}”(hjÑ4h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjÎ4ubah}”(h]”h ]”h"]”h$]”h&]”j¯aŒlevel”KŒtype”j”2Œsource”hÇŒline”Myuh1jy2hjrh²hh³hÇh´Myubjz2)�”}”(hhh]”j )�”}”(hŒ,Duplicate implicit target name: "use cases".”h]”hŒ0Duplicate implicit target name: “use casesâ€�.”…”�”}”(hjì4h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjé4ubah}”(h]”h ]”h"]”h$]”h&]”jóaŒlevel”KŒtype”j”2Œsource”hÇŒline”Muh1jy2hjµh²hh³hÇh´Mubjz2)�”}”(hhh]”j )�”}”(hŒ)Duplicate implicit target name: "syntax".”h]”hŒ-Duplicate implicit target name: “syntaxâ€�.”…”�”}”(hj5h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj5ubah}”(h]”h ]”h"]”h$]”h&]”jLaŒlevel”KŒtype”j”2Œsource”hÇŒline”MŠuh1jy2hj*h²hh³hÇh´MŠubjz2)�”}”(hhh]”j )�”}”(hŒ0Duplicate implicit target name: "return values".”h]”hŒ4Duplicate implicit target name: “return valuesâ€�.”…”�”}”(hj"5h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj5ubah}”(h]”h ]”h"]”h$]”h&]”jaŒlevel”KŒtype”j”2Œsource”hÇŒline”M’uh1jy2hjRh²hh³hÇh´M’ubjz2)�”}”(hhh]”j )�”}”(hŒ.Duplicate implicit target name: "description".”h]”hŒ2Duplicate implicit target name: “descriptionâ€�.”…”�”}”(hj=5h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj:5ubah}”(h]”h ]”h"]”h$]”h&]”jGaŒlevel”KŒtype”j”2Œsource”hÇŒline”M�uh1jy2hjh²hh³hÇh´M�ubjz2)�”}”(hhh]”j )�”}”(hŒ,Duplicate implicit target name: "use cases".”h]”hŒ0Duplicate implicit target name: “use casesâ€�.”…”�”}”(hjX5h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjU5ubah}”(h]”h ]”h"]”h$]”h&]”j‹aŒlevel”KŒtype”j”2Œsource”hÇŒline”M¢uh1jy2hjMh²hh³hÇh´M¢ubjz2)�”}”(hhh]”j )�”}”(hŒ)Duplicate implicit target name: "syntax".”h]”hŒ-Duplicate implicit target name: “syntaxâ€�.”…”�”}”(hjs5h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjp5ubah}”(h]”h ]”h"]”h$]”h&]”jüaŒlevel”KŒtype”j”2Œsource”hÇŒline”M°uh1jy2hjÚh²hh³hÇh´M°ubjz2)�”}”(hhh]”j )�”}”(hŒ0Duplicate implicit target name: "return values".”h]”hŒ4Duplicate implicit target name: “return valuesâ€�.”…”�”}”(hjŽ5h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj‹5ubah}”(h]”h ]”h"]”h$]”h&]”jØ aŒlevel”KŒtype”j”2Œsource”hÇŒline”M¹uh1jy2hj h²hh³hÇh´M¹ubjz2)�”}”(hhh]”j )�”}”(hŒ.Duplicate implicit target name: "description".”h]”hŒ2Duplicate implicit target name: “descriptionâ€�.”…”�”}”(hj©5h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj¦5ubah}”(h]”h ]”h"]”h$]”h&]”j;!aŒlevel”KŒtype”j”2Œsource”hÇŒline”MÄuh1jy2hjÞ h²hh³hÇh´MÄubjz2)�”}”(hhh]”j )�”}”(hŒ,Duplicate implicit target name: "use cases".”h]”hŒ0Duplicate implicit target name: “use casesâ€�.”…”�”}”(hjÄ5h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjÁ5ubah}”(h]”h ]”h"]”h$]”h&]”j—!aŒlevel”KŒtype”j”2Œsource”hÇŒline”MÑuh1jy2hjA!h²hh³hÇh´MÑubjz2)�”}”(hhh]”j )�”}”(hŒ)Duplicate implicit target name: "syntax".”h]”hŒ-Duplicate implicit target name: “syntaxâ€�.”…”�”}”(hjß5h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjÜ5ubah}”(h]”h ]”h"]”h$]”h&]”jð!aŒlevel”KŒtype”j”2Œsource”hÇŒline”Máuh1jy2hjÎ!h²hh³hÇh´Máubjz2)�”}”(hhh]”j )�”}”(hŒ0Duplicate implicit target name: "return values".”h]”hŒ4Duplicate implicit target name: “return valuesâ€�.”…”�”}”(hjú5h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj÷5ubah}”(h]”h ]”h"]”h$]”h&]”jÌ"aŒlevel”KŒtype”j”2Œsource”hÇŒline”Mêuh1jy2hjö!h²hh³hÇh´Mêubjz2)�”}”(hhh]”j )�”}”(hŒ.Duplicate implicit target name: "description".”h]”hŒ2Duplicate implicit target name: “descriptionâ€�.”…”�”}”(hj6h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj6ubah}”(h]”h ]”h"]”h$]”h&]”j/#aŒlevel”KŒtype”j”2Œsource”hÇŒline”Mõuh1jy2hjÒ"h²hh³hÇh´Mõubjz2)�”}”(hhh]”j )�”}”(hŒ,Duplicate implicit target name: "use cases".”h]”hŒ0Duplicate implicit target name: “use casesâ€�.”…”�”}”(hj06h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj-6ubah}”(h]”h ]”h"]”h$]”h&]”js#aŒlevel”KŒtype”j”2Œsource”hÇŒline”Muh1jy2hj5#h²hh³hÇh´Mubjz2)�”}”(hhh]”j )�”}”(hŒ)Duplicate implicit target name: "syntax".”h]”hŒ-Duplicate implicit target name: “syntaxâ€�.”…”�”}”(hjK6h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjH6ubah}”(h]”h ]”h"]”h$]”h&]”jÌ#aŒlevel”KŒtype”j”2Œsource”hÇŒline”Muh1jy2hjª#h²hh³hÇh´Mubjz2)�”}”(hhh]”j )�”}”(hŒ0Duplicate implicit target name: "return values".”h]”hŒ4Duplicate implicit target name: “return valuesâ€�.”…”�”}”(hjf6h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjc6ubah}”(h]”h ]”h"]”h$]”h&]”jV$aŒlevel”KŒtype”j”2Œsource”hÇŒline”Muh1jy2hjÒ#h²hh³hÇh´Mubjz2)�”}”(hhh]”j )�”}”(hŒ.Duplicate implicit target name: "description".”h]”hŒ2Duplicate implicit target name: “descriptionâ€�.”…”�”}”(hj�6h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj~6ubah}”(h]”h ]”h"]”h$]”h&]”j‡$aŒlevel”KŒtype”j”2Œsource”hÇŒline”Muh1jy2hj\$h²hh³hÇh´Mubjz2)�”}”(hhh]”j )�”}”(hŒ,Duplicate implicit target name: "use cases".”h]”hŒ0Duplicate implicit target name: “use casesâ€�.”…”�”}”(hjœ6h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj™6ubah}”(h]”h ]”h"]”h$]”h&]”jÝ$aŒlevel”KŒtype”j”2Œsource”hÇŒline”M(uh1jy2hj�$h²hh³hÇh´M(ubjz2)�”}”(hhh]”j )�”}”(hŒ)Duplicate implicit target name: "syntax".”h]”hŒ-Duplicate implicit target name: “syntaxâ€�.”…”�”}”(hj·6h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj´6ubah}”(h]”h ]”h"]”h$]”h&]”jH%aŒlevel”KŒtype”j”2Œsource”hÇŒline”M3uh1jy2hj&%h²hh³hÇh´M3ubjz2)�”}”(hhh]”j )�”}”(hŒ0Duplicate implicit target name: "return values".”h]”hŒ4Duplicate implicit target name: “return valuesâ€�.”…”�”}”(hjÒ6h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjÏ6ubah}”(h]”h ]”h"]”h$]”h&]”ji&aŒlevel”KŒtype”j”2Œsource”hÇŒline”M<uh1jy2hjN%h²hh³hÇh´M<ubjz2)�”}”(hhh]”j )�”}”(hŒ.Duplicate implicit target name: "description".”h]”hŒ2Duplicate implicit target name: “descriptionâ€�.”…”�”}”(hjí6h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjê6ubah}”(h]”h ]”h"]”h$]”h&]”jš&aŒlevel”KŒtype”j”2Œsource”hÇŒline”MJuh1jy2hjo&h²hh³hÇh´MJubjz2)�”}”(hhh]”j )�”}”(hŒ,Duplicate implicit target name: "use cases".”h]”hŒ0Duplicate implicit target name: “use casesâ€�.”…”�”}”(hj7h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj7ubah}”(h]”h ]”h"]”h$]”h&]”jÞ&aŒlevel”KŒtype”j”2Œsource”hÇŒline”MQuh1jy2hj &h²hh³hÇh´MQubjz2)�”}”(hhh]”j )�”}”(hŒ)Duplicate implicit target name: "syntax".”h]”hŒ-Duplicate implicit target name: “syntaxâ€�.”…”�”}”(hj#7h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj 7ubah}”(h]”h ]”h"]”h$]”h&]”jÁ'aŒlevel”KŒtype”j”2Œsource”hÇŒline”Mvuh1jy2hjŸ'h²hh³hÇh´Mvubjz2)�”}”(hhh]”j )�”}”(hŒ0Duplicate implicit target name: "return values".”h]”hŒ4Duplicate implicit target name: “return valuesâ€�.”…”�”}”(hj>7h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj;7ubah}”(h]”h ]”h"]”h$]”h&]”j4(aŒlevel”KŒtype”j”2Œsource”hÇŒline”M}uh1jy2hjÇ'h²hh³hÇh´M}ubjz2)�”}”(hhh]”j )�”}”(hŒ.Duplicate implicit target name: "description".”h]”hŒ2Duplicate implicit target name: “descriptionâ€�.”…”�”}”(hjY7h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjV7ubah}”(h]”h ]”h"]”h$]”h&]”je(aŒlevel”KŒtype”j”2Œsource”hÇŒline”M…uh1jy2hj:(h²hh³hÇh´M…ubjz2)�”}”(hhh]”j )�”}”(hŒ,Duplicate implicit target name: "use cases".”h]”hŒ0Duplicate implicit target name: “use casesâ€�.”…”�”}”(hjt7h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjq7ubah}”(h]”h ]”h"]”h$]”h&]”j©(aŒlevel”KŒtype”j”2Œsource”hÇŒline”MŽuh1jy2hjk(h²hh³hÇh´MŽubjz2)�”}”(hhh]”j )�”}”(hŒ)Duplicate implicit target name: "syntax".”h]”hŒ-Duplicate implicit target name: “syntaxâ€�.”…”�”}”(hj�7h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjŒ7ubah}”(h]”h ]”h"]”h$]”h&]”j)aŒlevel”KŒtype”j”2Œsource”hÇŒline”Mšuh1jy2hjà(h²hh³hÇh´Mšubjz2)�”}”(hhh]”j )�”}”(hŒ0Duplicate implicit target name: "return values".”h]”hŒ4Duplicate implicit target name: “return valuesâ€�.”…”�”}”(hjª7h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj§7ubah}”(h]”h ]”h"]”h$]”h&]”já)aŒlevel”KŒtype”j”2Œsource”hÇŒline”M¡uh1jy2hj)h²hh³hÇh´M¡ubjz2)�”}”(hhh]”j )�”}”(hŒ.Duplicate implicit target name: "description".”h]”hŒ2Duplicate implicit target name: “descriptionâ€�.”…”�”}”(hjÅ7h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjÂ7ubah}”(h]”h ]”h"]”h$]”h&]”j$*aŒlevel”KŒtype”j”2Œsource”hÇŒline”M­uh1jy2hjç)h²hh³hÇh´M­ubjz2)�”}”(hhh]”j )�”}”(hŒ,Duplicate implicit target name: "use cases".”h]”hŒ0Duplicate implicit target name: “use casesâ€�.”…”�”}”(hjà7h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjÝ7ubah}”(h]”h ]”h"]”h$]”h&]”jU*aŒlevel”KŒtype”j”2Œsource”hÇŒline”M³uh1jy2hj**h²hh³hÇh´M³ubjz2)�”}”(hhh]”j )�”}”(hŒ)Duplicate implicit target name: "syntax".”h]”hŒ-Duplicate implicit target name: “syntaxâ€�.”…”�”}”(hjû7h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjø7ubah}”(h]”h ]”h"]”h$]”h&]”j®*aŒlevel”KŒtype”j”2Œsource”hÇŒline”MÀuh1jy2hjŒ*h²hh³hÇh´MÀubjz2)�”}”(hhh]”j )�”}”(hŒ0Duplicate implicit target name: "return values".”h]”hŒ4Duplicate implicit target name: “return valuesâ€�.”…”�”}”(hj8h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj8ubah}”(h]”h ]”h"]”h$]”h&]”jÊ+aŒlevel”KŒtype”j”2Œsource”hÇŒline”MÇuh1jy2hj´*h²hh³hÇh´MÇubjz2)�”}”(hhh]”j )�”}”(hŒ.Duplicate implicit target name: "description".”h]”hŒ2Duplicate implicit target name: “descriptionâ€�.”…”�”}”(hj18h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj.8ubah}”(h]”h ]”h"]”h$]”h&]”jÙ,aŒlevel”KŒtype”j”2Œsource”hÇŒline”M×uh1jy2hjÐ+h²hh³hÇh´M×ubjz2)�”}”(hhh]”j )�”}”(hŒ,Duplicate implicit target name: "use cases".”h]”hŒ0Duplicate implicit target name: “use casesâ€�.”…”�”}”(hjL8h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjI8ubah}”(h]”h ]”h"]”h$]”h&]”j-aŒlevel”KŒtype”j”2Œsource”hÇŒline”Míuh1jy2hjß,h²hh³hÇh´Míubjz2)�”}”(hhh]”j )�”}”(hŒ)Duplicate implicit target name: "syntax".”h]”hŒ-Duplicate implicit target name: “syntaxâ€�.”…”�”}”(hjg8h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjd8ubah}”(h]”h ]”h"]”h$]”h&]”ju-aŒlevel”KŒtype”j”2Œsource”hÇŒline”Müuh1jy2hjS-h²hh³hÇh´Müubjz2)�”}”(hhh]”j )�”}”(hŒ0Duplicate implicit target name: "return values".”h]”hŒ4Duplicate implicit target name: “return valuesâ€�.”…”�”}”(hj‚8h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj8ubah}”(h]”h ]”h"]”h$]”h&]”jL.aŒlevel”KŒtype”j”2Œsource”hÇŒline”Muh1jy2hj{-h²hh³hÇh´Mubjz2)�”}”(hhh]”j )�”}”(hŒ.Duplicate implicit target name: "description".”h]”hŒ2Duplicate implicit target name: “descriptionâ€�.”…”�”}”(hj�8h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjš8ubah}”(h]”h ]”h"]”h$]”h&]”j/aŒlevel”KŒtype”j”2Œsource”hÇŒline”Muh1jy2hjR.h²hh³hÇh´Mubjz2)�”}”(hhh]”j )�”}”(hŒ,Duplicate implicit target name: "use cases".”h]”hŒ0Duplicate implicit target name: “use casesâ€�.”…”�”}”(hj¸8h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjµ8ubah}”(h]”h ]”h"]”h$]”h&]”jŒ/aŒlevel”KŒtype”j”2Œsource”hÇŒline”M uh1jy2hj/h²hh³hÇh´M ubjz2)�”}”(hhh]”j )�”}”(hŒ)Duplicate implicit target name: "syntax".”h]”hŒ-Duplicate implicit target name: “syntaxâ€�.”…”�”}”(hjÓ8h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjÐ8ubah}”(h]”h ]”h"]”h$]”h&]”jå/aŒlevel”KŒtype”j”2Œsource”hÇŒline”M7uh1jy2hjÃ/h²hh³hÇh´M7ubjz2)�”}”(hhh]”j )�”}”(hŒ0Duplicate implicit target name: "return values".”h]”hŒ4Duplicate implicit target name: “return valuesâ€�.”…”�”}”(hjî8h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hjë8ubah}”(h]”h ]”h"]”h$]”h&]”j¼0aŒlevel”KŒtype”j”2Œsource”hÇŒline”MAuh1jy2hjë/h²hh³hÇh´MAubjz2)�”}”(hhh]”j )�”}”(hŒ.Duplicate implicit target name: "description".”h]”hŒ2Duplicate implicit target name: “descriptionâ€�.”…”�”}”(hj 9h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj9ubah}”(h]”h ]”h"]”h$]”h&]”j11aŒlevel”KŒtype”j”2Œsource”hÇŒline”MKuh1jy2hjÂ0h²hh³hÇh´MKubjz2)�”}”(hhh]”j )�”}”(hŒ,Duplicate implicit target name: "use cases".”h]”hŒ0Duplicate implicit target name: “use casesâ€�.”…”�”}”(hj$9h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j hj!9ubah}”(h]”h ]”h"]”h$]”h&]”ju1aŒlevel”KŒtype”j”2Œsource”hÇŒline”MTuh1jy2hj71h²hh³hÇh´MTubeŒtransform_messages”]”jz2)�”}”(hhh]”j )�”}”(hhh]”hŒ0Hyperlink target "ultravisor" is not referenced.”…”�”}”hjA9sbah}”(h]”h ]”h"]”h$]”h&]”uh1j hj>9ubah}”(h]”h ]”h"]”h$]”h&]”Œlevel”KŒtype”j”2Œsource”hÇŒline”Kuh1jy2ubaŒ transformer”NŒ include_log”]”Œ decoration”Nh²hub.