Files
archived-ballistic/spec/arm64_xml/xpac.xml
Ronald Caesar 26a677f8b4 decoder: Add ARM specification docs
Signed-off-by: Ronald Caesar <github43132@proton.me>
2025-12-12 18:11:36 -04:00

218 lines
8.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<?xml-stylesheet type="text/xsl" encoding="UTF-8" href="iform.xsl" version="1.0"?>
<!DOCTYPE instructionsection PUBLIC "-//ARM//DTD instructionsection //EN" "iform-p.dtd">
<!-- Copyright (c) 2010-2022 Arm Limited or its affiliates. All rights reserved. -->
<!-- This document is Non-Confidential. This document may only be used and distributed in accordance with the terms of the agreement entered into by Arm and the party that Arm delivered this document to. -->
<instructionsection id="XPAC" title="XPACD, XPACI, XPACLRI -- A64" type="instruction">
<docvars>
<docvar key="isa" value="A64" />
</docvars>
<heading>XPACD, XPACI, XPACLRI</heading>
<desc>
<brief>
<para>Strip Pointer Authentication Code</para>
</brief>
<authored>
<para>Strip Pointer Authentication Code. This instruction removes the pointer authentication code from an address. The address is in the specified general-purpose register for <instruction>XPACI</instruction> and <instruction>XPACD</instruction>, and is in LR for <instruction>XPACLRI</instruction>.</para>
<para>The <instruction>XPACD</instruction> instruction is used for data addresses, and <instruction>XPACI</instruction> and <instruction>XPACLRI</instruction> are used for instruction addresses.</para>
</authored>
</desc>
<alias_list howmany="0"></alias_list>
<classes>
<classesintro count="2">
<txt>It has encodings from 2 classes:</txt>
<a href="#iclass_general">Integer</a>
<txt> and </txt>
<a href="#iclass_system">System</a>
</classesintro>
<iclass name="Integer" oneof="2" id="iclass_general" no_encodings="2" isa="A64">
<docvars>
<docvar key="instr-class" value="general" />
<docvar key="isa" value="A64" />
</docvars>
<iclassintro count="2"></iclassintro>
<arch_variants>
<arch_variant name="ARMv8.3" feature="FEAT_PAuth" />
</arch_variants>
<regdiagram form="32" psname="aarch64/instrs/integer/pac/strip/dp_1src" tworows="1">
<box hibit="31" name="sf" settings="1">
<c>1</c>
</box>
<box hibit="30" settings="1">
<c>1</c>
</box>
<box hibit="29" name="S" settings="1">
<c>0</c>
</box>
<box hibit="28" width="8" settings="8">
<c>1</c>
<c>1</c>
<c>0</c>
<c>1</c>
<c>0</c>
<c>1</c>
<c>1</c>
<c>0</c>
</box>
<box hibit="20" width="5" name="opcode2" settings="5">
<c>0</c>
<c>0</c>
<c>0</c>
<c>0</c>
<c>1</c>
</box>
<box hibit="15" name="opcode[5]" settings="1">
<c>0</c>
</box>
<box hibit="14" name="opcode[4]" settings="1">
<c>1</c>
</box>
<box hibit="13" width="3" name="opcode[3:1]" settings="3">
<c>0</c>
<c>0</c>
<c>0</c>
</box>
<box hibit="10" name="D" usename="1">
<c></c>
</box>
<box hibit="9" width="5" name="Rn" usename="1" settings="5" psbits="xxxxx">
<c>1</c>
<c>1</c>
<c>1</c>
<c>1</c>
<c>1</c>
</box>
<box hibit="4" width="5" name="Rd" usename="1">
<c colspan="5"></c>
</box>
</regdiagram>
<encoding name="XPACD_64Z_dp_1src" oneofinclass="2" oneof="3" label="XPACD" bitdiffs="D == 1">
<docvars>
<docvar key="instr-class" value="general" />
<docvar key="isa" value="A64" />
<docvar key="mnemonic" value="XPACD" />
</docvars>
<box hibit="10" width="1" name="D">
<c>1</c>
</box>
<asmtemplate><text>XPACD </text><a link="sa_xd" hover="64-bit general-purpose destination register (field &quot;Rd&quot;)">&lt;Xd&gt;</a></asmtemplate>
</encoding>
<encoding name="XPACI_64Z_dp_1src" oneofinclass="2" oneof="3" label="XPACI" bitdiffs="D == 0">
<docvars>
<docvar key="instr-class" value="general" />
<docvar key="isa" value="A64" />
<docvar key="mnemonic" value="XPACI" />
</docvars>
<box hibit="10" width="1" name="D">
<c>0</c>
</box>
<asmtemplate><text>XPACI </text><a link="sa_xd" hover="64-bit general-purpose destination register (field &quot;Rd&quot;)">&lt;Xd&gt;</a></asmtemplate>
</encoding>
<ps_section howmany="1">
<ps name="aarch64/instrs/integer/pac/strip/dp_1src" mylink="aarch64.instrs.integer.pac.strip.dp_1src" enclabels="" sections="1" secttype="noheading">
<pstext mayhavelinks="1" section="Decode" rep_section="decode">boolean data = (D == '1');
integer d = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rd);
integer n = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rn);
if !<a link="impl-aarch64.HavePACExt.0" file="shared_pseudocode.xml" hover="function: boolean HavePACExt()">HavePACExt</a>() then
UNDEFINED;
if n != 31 then UNDEFINED;</pstext>
</ps>
</ps_section>
</iclass>
<iclass name="System" oneof="2" id="iclass_system" no_encodings="1" isa="A64">
<docvars>
<docvar key="instr-class" value="system" />
<docvar key="isa" value="A64" />
<docvar key="mnemonic" value="XPACLRI" />
</docvars>
<iclassintro count="1"></iclassintro>
<arch_variants>
<arch_variant name="ARMv8.3" feature="FEAT_PAuth" />
</arch_variants>
<regdiagram form="32" psname="aarch64/instrs/integer/pac/strip/hint">
<box hibit="31" width="10" settings="10">
<c>1</c>
<c>1</c>
<c>0</c>
<c>1</c>
<c>0</c>
<c>1</c>
<c>0</c>
<c>1</c>
<c>0</c>
<c>0</c>
</box>
<box hibit="21" name="L" settings="1">
<c>0</c>
</box>
<box hibit="20" width="2" name="op0" settings="2">
<c>0</c>
<c>0</c>
</box>
<box hibit="18" width="3" name="op1" settings="3">
<c>0</c>
<c>1</c>
<c>1</c>
</box>
<box hibit="15" width="4" name="CRn" settings="4">
<c>0</c>
<c>0</c>
<c>1</c>
<c>0</c>
</box>
<box hibit="11" width="4" name="CRm" settings="4">
<c>0</c>
<c>0</c>
<c>0</c>
<c>0</c>
</box>
<box hibit="7" width="3" name="op2" settings="3">
<c>1</c>
<c>1</c>
<c>1</c>
</box>
<box hibit="4" width="5" name="Rt" settings="5">
<c>1</c>
<c>1</c>
<c>1</c>
<c>1</c>
<c>1</c>
</box>
</regdiagram>
<encoding name="XPACLRI_HI_hints" oneofinclass="1" oneof="3" label="">
<docvars>
<docvar key="instr-class" value="system" />
<docvar key="isa" value="A64" />
<docvar key="mnemonic" value="XPACLRI" />
</docvars>
<asmtemplate><text>XPACLRI</text></asmtemplate>
</encoding>
<ps_section howmany="1">
<ps name="aarch64/instrs/integer/pac/strip/hint" mylink="aarch64.instrs.integer.pac.strip.hint" enclabels="" sections="1" secttype="noheading">
<pstext mayhavelinks="1" section="Decode" rep_section="decode">integer d = 30;
boolean data = FALSE;</pstext>
</ps>
</ps_section>
</iclass>
</classes>
<explanations scope="all">
<explanation enclist="XPACI_64Z_dp_1src, XPACD_64Z_dp_1src" symboldefcount="1">
<symbol link="sa_xd">&lt;Xd&gt;</symbol>
<account encodedin="Rd">
<intro>
<para>Is the 64-bit name of the general-purpose destination register, encoded in the "Rd" field.</para>
</intro>
</account>
</explanation>
</explanations>
<ps_section howmany="1">
<ps name="aarch64/instrs/integer/pac/strip/dp_1src" mylink="execute" enclabels="" sections="1" secttype="Operation">
<pstext mayhavelinks="1" section="Execute" rep_section="execute">if <a link="impl-aarch64.HavePACExt.0" file="shared_pseudocode.xml" hover="function: boolean HavePACExt()">HavePACExt</a>() then
<a link="impl-aarch64.X.write.2" file="shared_pseudocode.xml" hover="accessor: X[integer n, integer width] = bits(width) value">X</a>[d, 64] = Strip(X[d, 64], data);</pstext>
</ps>
</ps_section>
</instructionsection>