<?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="PACDB" title="PACDB, PACDZB -- A64" type="instruction">
  <docvars>
    <docvar key="instr-class" value="general" />
    <docvar key="isa" value="A64" />
  </docvars>
  <heading>PACDB, PACDZB</heading>
  <desc>
    <brief>
      <para>Pointer Authentication Code for Data address, using key B</para>
    </brief>
    <authored>
      <para>Pointer Authentication Code for Data address, using key B. This instruction computes and inserts a pointer authentication code for a data address, using a modifier and key B.</para>
      <para>The address is in the general-purpose register that is specified by <syntax>&lt;Xd&gt;</syntax>.</para>
      <para>The modifier is:</para>
      <list type="unordered">
        <listitem><content>In the general-purpose register or stack pointer that is specified by <syntax>&lt;Xn|SP&gt;</syntax> for <instruction>PACDB</instruction>.</content></listitem>
        <listitem><content>The value zero, for <instruction>PACDZB</instruction>.</content></listitem>
      </list>
    </authored>
  </desc>
  <alias_list howmany="0"></alias_list>
  <classes>
    <iclass name="Integer" oneof="1" 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/pacdb/dp_1src">
        <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>0</c>
        </box>
        <box hibit="13" name="Z" usename="1">
          <c></c>
        </box>
        <box hibit="12" width="3" name="opcode[2:0]" settings="3">
          <c>0</c>
          <c>1</c>
          <c>1</c>
        </box>
        <box hibit="9" width="5" name="Rn" usename="1">
          <c colspan="5"></c>
        </box>
        <box hibit="4" width="5" name="Rd" usename="1">
          <c colspan="5"></c>
        </box>
      </regdiagram>
      <encoding name="PACDB_64P_dp_1src" oneofinclass="2" oneof="2" label="PACDB" bitdiffs="Z == 0">
        <docvars>
          <docvar key="instr-class" value="general" />
          <docvar key="isa" value="A64" />
          <docvar key="mnemonic" value="PACDB" />
        </docvars>
        <box hibit="13" width="1" name="Z">
          <c>0</c>
        </box>
        <asmtemplate><text>PACDB  </text><a link="sa_xd" hover="64-bit general-purpose destination register (field &quot;Rd&quot;)">&lt;Xd&gt;</a><text>, </text><a link="sa_xn_sp" hover="64-bit general-purpose source register or SP (field &quot;Rn&quot;)">&lt;Xn|SP&gt;</a></asmtemplate>
      </encoding>
      <encoding name="PACDZB_64Z_dp_1src" oneofinclass="2" oneof="2" label="PACDZB" bitdiffs="Z == 1 &amp;&amp; Rn == 11111">
        <docvars>
          <docvar key="instr-class" value="general" />
          <docvar key="isa" value="A64" />
          <docvar key="mnemonic" value="PACDZB" />
        </docvars>
        <box hibit="13" width="1" name="Z">
          <c>1</c>
        </box>
        <box hibit="9" width="5" name="Rn">
          <c>1</c>
          <c>1</c>
          <c>1</c>
          <c>1</c>
          <c>1</c>
        </box>
        <asmtemplate><text>PACDZB  </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/pacdb/dp_1src" mylink="aarch64.instrs.integer.pac.pacdb.dp_1src" enclabels="" sections="1" secttype="noheading">
          <pstext mayhavelinks="1" section="Decode" rep_section="decode">boolean source_is_sp = FALSE;
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 Z == '0' then // PACDB
    if n == 31 then source_is_sp = TRUE;
else // PACDZB
    if n != 31 then UNDEFINED;</pstext>
        </ps>
      </ps_section>
    </iclass>
  </classes>
  <explanations scope="all">
    <explanation enclist="PACDB_64P_dp_1src, PACDZB_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>
    <explanation enclist="PACDB_64P_dp_1src" symboldefcount="1">
      <symbol link="sa_xn_sp">&lt;Xn|SP&gt;</symbol>
      <account encodedin="Rn">
        <intro>
          <para>Is the 64-bit name of the general-purpose source register or stack pointer, encoded in the "Rn" field.</para>
        </intro>
      </account>
    </explanation>
  </explanations>
  <ps_section howmany="1">
    <ps name="aarch64/instrs/integer/pac/pacdb/dp_1src" mylink="execute" enclabels="" sections="1" secttype="Operation">
      <pstext mayhavelinks="1" section="Execute" rep_section="execute">if source_is_sp 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] = AddPACDB(X[d, 64], SP[]);
else
    <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] = AddPACDB(X[d, 64], X[n, 64]);</pstext>
    </ps>
  </ps_section>
</instructionsection>
