charm 0.0.1

ARM assembler & disassembler generated from the ARM exploration tools.
Documentation
//! # PACGA
//!
//! This instruction calculates the Pointer Authentication Code for a 64-bit value in the first source register, using a modifier in the second source register, and the generic key. The calculated Pointer Authentication Code is written to the most significant 32 bits of the destination register, and the least significant 32 bits of the destination register are set to zero.

#![allow(non_snake_case)]
#![allow(unused)]
use crate::error::Result;
use crate::utils::*;
use super::super::formatter::*;
use super::super::instruction::*;
use super::super::operand::*;
use super::super::consts::*;
use super::super::config::*;
use super::super::decoder::*;

// ---------------------------------------------------------------------------
// Iclass IclassPacga64pDp2src
// ---------------------------------------------------------------------------

/// Type that represents the IclassPacga64pDp2src instruction class.
pub(crate) struct IclassPacga64pDp2src;

impl IclassPacga64pDp2src {
    /// Tries to decode the instruction in `data`.
    pub(crate) fn decode(data: u32, decoder: &mut Decoder) -> Result<Instruction> {
        let Rm = (data >> 16) & 31;
        let Rm_post = Rm;
        let S = (data >> 29) & 1;
        let S_post = S;
        let field_27 = (data >> 25) & 7;
        let field_27_post = field_27;
        let Rd = (data >> 0) & 31;
        let Rd_post = Rd;
        let Rn = (data >> 5) & 31;
        let Rn_post = Rn;
        let sf = (data >> 31) & 1;
        let sf_post = sf;
        let opcode = (data >> 10) & 63;
        let opcode_post = opcode;
        let field_24 = (data >> 21) & 15;
        let field_24_post = field_24;
        let field_28 = (data >> 28) & 1;
        let field_28_post = field_28;
        let field_30 = (data >> 30) & 1;
        let field_30_post = field_30;


        return Pacga64pDp2src::decode(data as u32, decoder);

        unreachable!()
    }
}

/// None-bit encoding.
///
/// # Encoding
///
/// <table style="font-family: courier, monospace">
///     <tr>
///         <td style="border: none">31</td>
///         <td style="border: none">30</td>
///         <td style="border: none">29</td>
///         <td style="border: none">28</td>
///         <td style="border: none">27</td>
///         <td style="border: none">26</td>
///         <td style="border: none">25</td>
///         <td style="border: none">24</td>
///         <td style="border: none">23</td>
///         <td style="border: none">22</td>
///         <td style="border: none">21</td>
///         <td style="border: none">20</td>
///         <td style="border: none">19</td>
///         <td style="border: none">18</td>
///         <td style="border: none">17</td>
///         <td style="border: none">16</td>
///         <td style="border: none">15</td>
///         <td style="border: none">14</td>
///         <td style="border: none">13</td>
///         <td style="border: none">12</td>
///         <td style="border: none">11</td>
///         <td style="border: none">10</td>
///         <td style="border: none">9</td>
///         <td style="border: none">8</td>
///         <td style="border: none">7</td>
///         <td style="border: none">6</td>
///         <td style="border: none">5</td>
///         <td style="border: none">4</td>
///         <td style="border: none">3</td>
///         <td style="border: none">2</td>
///         <td style="border: none">1</td>
///         <td style="border: none">0</td>
///     </tr>
///     <tr>
///          <td style="text-align: center; border-right: none" colspan="1">1</td>
///          <td style="text-align: center; border-right: none" colspan="1">0</td>
///          <td style="text-align: center; border-right: none" colspan="1">0</td>
///          <td style="text-align: center; border-right: none" colspan="1">1</td>
///          <td style="text-align: center; border-right: none" colspan="1">1</td>
///          <td style="text-align: center; border-left: none; border-right: none" colspan="1">0</td>
///          <td style="text-align: center; border-left: none" colspan="1">1</td>
///          <td style="text-align: center; border-right: none" colspan="1">0</td>
///          <td style="text-align: center; border-left: none; border-right: none" colspan="1">1</td>
///          <td style="text-align: center; border-left: none; border-right: none" colspan="1">1</td>
///          <td style="text-align: center; border-left: none" colspan="1">0</td>
/// <td style="text-align: center" colspan="5">Rm</td>
///          <td style="text-align: center; border-right: none" colspan="1">0</td>
///          <td style="text-align: center; border-left: none; border-right: none" colspan="1">0</td>
///          <td style="text-align: center; border-left: none; border-right: none" colspan="1">1</td>
///          <td style="text-align: center; border-left: none; border-right: none" colspan="1">1</td>
///          <td style="text-align: center; border-left: none; border-right: none" colspan="1">0</td>
///          <td style="text-align: center; border-left: none" colspan="1">0</td>
/// <td style="text-align: center" colspan="5">Rn</td>
/// <td style="text-align: center" colspan="5">Rd</td>
///     </tr>
///     <tr>
/// <td style="text-align: center; border: none" colspan="1">sf</td>
/// <td style="text-align: center; border: none" colspan="1"></td>
/// <td style="text-align: center; border: none" colspan="1">S</td>
/// <td style="text-align: center; border: none" colspan="1"></td>
/// <td style="text-align: center; border: none" colspan="3"></td>
/// <td style="text-align: center; border: none" colspan="4"></td>
/// <td style="text-align: center; border: none" colspan="5"></td>
/// <td style="text-align: center; border: none" colspan="6">opcode</td>
/// <td style="text-align: center; border: none" colspan="5"></td>
/// <td style="text-align: center; border: none" colspan="5"></td>
///     </tr>
/// </table>
pub struct Pacga64pDp2src;

impl Pacga64pDp2src {
    /// Returns the instruction mnemonic.
    pub fn mnemonic(_instr: &Instruction) -> Mnemonic {
        Mnemonic::PACGA
    }

    /// Returns the instruction size.
    pub fn size(_instr: &Instruction) -> usize {
        4
    }

    /// Decodes the instruction in `data`.
    pub fn decode(data: u32, decoder: &mut Decoder) -> Result<Instruction> {
        // Fields are extracted from the input value.
        let Rm = (data >> 16) & 31;
        let Rm_post = Rm;
        let Rn = (data >> 5) & 31;
        let Rn_post = Rn;
        let Rd = (data >> 0) & 31;
        let Rd_post = Rd;
        

        // Operand values are computed from the base fields.
        let Rd_post = Rd;
        let op_0 = Register::aarch64(Rd_post, false)?;
        let Rn_post = Rn;
        let op_1 = Register::aarch64(Rn_post, false)?;
        let Rm_post = Rm;
        let op_2 = Register::aarch64(Rm_post, true)?;

        // Instruction creation from the operands.
        let mut instr = Instruction::builder(Code::PACGA_64P_dp_2src)
            .operand(0, op_0)?
            .operand(1, op_1)?
            .operand(2, op_2)?
            .build();
        
        Ok(instr)
    }

    /// Encodes the instruction into `buf`.
    pub fn encode(instr: &Instruction, buf: &mut Vec<u8>) -> Result<usize> {
        // Retrieve all operand values.
        let Rd_pre = instr.op0().as_register()?.encode();
        let Rn_pre = instr.op1().as_register()?.encode();
        let Rm_pre = instr.op2().as_register()?.encode();

        // Compute all instruction fields from the operand values.
        let Rd = (Rd_pre & 31);
        let Rn = (Rn_pre & 31);
        let Rm = (Rm_pre & 31);

        // Add all fields to the base instruction encoding.
        let mut instr: u32 = 0b10011010110000000011000000000000;
        instr |= (Rd & 31) << 0;
        instr |= (Rn & 31) << 5;
        instr |= (Rm & 31) << 16;

        let bytes = instr.to_le_bytes();
        let len = bytes.len();
        buf.extend(bytes);
        Ok(len)
    }

    /// Encode an instruction part of an instruction block into `buf`.
    pub fn encode_block(instr: &mut Instruction, buf: &mut Vec<u8>, labels: &std::collections::HashMap<u64, u64>) -> Result<usize> {
        Self::encode(instr, buf)
    }
    
    /// Verifies that operand #0 is valid.
    pub fn check_op0(instr: &Instruction, op: &Operand) -> Result<()> {
        if let Operand::Register(r) = op {
            if !r.is_aarch64() {
                todo!()
            }
            
            if *r == Register::SP {
                todo!()
            }
            return Ok(())
        }
        todo!()
    }
    
    /// Verifies that operand #1 is valid.
    pub fn check_op1(instr: &Instruction, op: &Operand) -> Result<()> {
        if let Operand::Register(r) = op {
            if !r.is_aarch64() {
                todo!()
            }
            
            if *r == Register::SP {
                todo!()
            }
            return Ok(())
        }
        todo!()
    }
    
    /// Verifies that operand #2 is valid.
    pub fn check_op2(instr: &Instruction, op: &Operand) -> Result<()> {
        if let Operand::Register(r) = op {
            if !r.is_aarch64() {
                todo!()
            }
            
            if *r == Register::XZR {
                todo!()
            }
            return Ok(())
        }
        todo!()
    }
    
    /// Verifies that operand #3 is valid.
    pub fn check_op3(instr: &Instruction, op: &Operand) -> Result<()> {
        todo!()
    }
    
    /// Verifies that operand #4 is valid.
    pub fn check_op4(instr: &Instruction, op: &Operand) -> Result<()> {
        todo!()
    }
    
    /// Verifies that operand #5 is valid.
    pub fn check_op5(instr: &Instruction, op: &Operand) -> Result<()> {
        todo!()
    }
    
    /// Verifies that operand #6 is valid.
    pub fn check_op6(instr: &Instruction, op: &Operand) -> Result<()> {
        todo!()
    }

    /// Formats the instruction.
    pub fn format(instr: &Instruction, fmt: &mut impl Formatter, output: &mut impl FormatterOutput, config: &Config) -> Result<()> {
        fmt.format_mnemonic(output, &config.global, &config.instructions.pacga_64p_dp_2src, instr)?;
        fmt.format_punctuation(output, &config.global, &config.instructions.pacga_64p_dp_2src, instr, FormatterTextKind::Space)?;
        fmt.format_operand(output, &config.global, &config.instructions.pacga_64p_dp_2src, instr, 0)?;
        fmt.format_punctuation(output, &config.global, &config.instructions.pacga_64p_dp_2src, instr, FormatterTextKind::Comma)?;
        fmt.format_operand(output, &config.global, &config.instructions.pacga_64p_dp_2src, instr, 1)?;
        fmt.format_punctuation(output, &config.global, &config.instructions.pacga_64p_dp_2src, instr, FormatterTextKind::Comma)?;
        fmt.format_operand(output, &config.global, &config.instructions.pacga_64p_dp_2src, instr, 2)?;
        Ok(())
    }
}

/// Type that represents alias identifiers for [`Pacga64pDp2src`].
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Debug, Hash)]
pub enum Pacga64pDp2srcAliases {
    None,
}