ppc750cl/disasm/src/disasm.rs

369 lines
10 KiB
Rust

use core::{
fmt,
fmt::{Display, Formatter, LowerHex},
};
use crate::generated::{
Arguments, Opcode, BASE_MNEMONICS, DEFS_FUNCTIONS, SIMPLIFIED_MNEMONICS, USES_FUNCTIONS,
};
/// A PowerPC 750CL instruction.
#[derive(Default, Clone, Debug, Eq, PartialEq)]
pub struct Ins {
pub code: u32,
pub op: Opcode,
}
impl Ins {
/// Create a new instruction from its raw code.
pub fn new(code: u32) -> Self {
Self { code, op: Opcode::_detect(code) }
}
/// Parse the instruction into a simplified mnemonic, if any match.
pub fn simplified(self) -> SimplifiedIns {
SimplifiedIns::new(self)
}
/// Parse the instruction into its basic form.
pub fn basic_form(self) -> SimplifiedIns {
SimplifiedIns::basic_form(self)
}
/// Returns all registers defined by the instruction.
pub fn defs(&self) -> Arguments {
DEFS_FUNCTIONS[self.op as usize](self)
}
/// Returns all registers used by the instruction.
pub fn uses(&self) -> Arguments {
USES_FUNCTIONS[self.op as usize](self)
}
/// Returns the relative branch offset of the instruction, if any.
pub fn branch_offset(&self) -> Option<i32> {
match self.op {
Opcode::B => Some(self.field_li()),
Opcode::Bc => Some(self.field_bd() as i32),
_ => None,
}
}
/// Returns the absolute branch destination of the instruction, if any.
pub fn branch_dest(&self, addr: u32) -> Option<u32> {
self.branch_offset().and_then(|offset| {
if self.field_aa() {
Some(offset as u32)
} else {
addr.checked_add_signed(offset)
}
})
}
/// Whether the instruction is any kind of branch.
pub fn is_branch(&self) -> bool {
matches!(self.op, Opcode::B | Opcode::Bc | Opcode::Bcctr | Opcode::Bclr)
}
/// Whether the instruction is a direct branch.
pub fn is_direct_branch(&self) -> bool {
matches!(self.op, Opcode::B | Opcode::Bc)
}
/// Whether the instruction is an unconditional branch.
pub fn is_unconditional_branch(&self) -> bool {
match self.op {
Opcode::B => true,
Opcode::Bc | Opcode::Bcctr | Opcode::Bclr => {
self.field_bo() == 20 && self.field_bi() == 0
}
_ => false,
}
}
/// Whether the instruction is a conditional branch.
pub fn is_conditional_branch(&self) -> bool {
self.is_branch() && !self.is_unconditional_branch()
}
/// Whether the instruction is a branch with link. (blr)
#[inline]
pub fn is_blr(&self) -> bool {
self.code == 0x4e800020
}
}
macro_rules! field_arg_no_display {
($name:ident, $typ:ident) => {
#[derive(Debug, Copy, Clone, Ord, PartialOrd, Eq, PartialEq)]
pub struct $name(pub $typ);
impl From<$name> for Argument {
fn from(x: $name) -> Argument {
Argument::$name(x)
}
}
impl From<$typ> for $name {
fn from(x: $typ) -> $name {
$name(x)
}
}
};
}
macro_rules! field_arg {
($name:ident, $typ:ident) => {
field_arg_no_display!($name, $typ);
impl Display for $name {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.0)
}
}
};
($name:ident, $typ:ident, $format:literal) => {
field_arg_no_display!($name, $typ);
impl Display for $name {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
write!(f, $format, self.0)
}
}
};
($name:ident, $typ:ident, $format:literal, $format_arg:expr) => {
field_arg_no_display!($name, $typ);
impl Display for $name {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
write!(f, $format, $format_arg(self.0))
}
}
};
}
// General-purpose register.
field_arg!(GPR, u8, "r{}");
// Floating-point register (direct or paired-singles mode).
field_arg!(FPR, u8, "f{}");
// Segment register.
field_arg!(SR, u8);
// Special-purpose register.
field_arg_no_display!(SPR, u16);
impl Display for SPR {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
f.write_str(match self.0 {
1 => "XER",
8 => "LR",
9 => "CTR",
18 => "DSISR",
19 => "DAR",
22 => "DEC",
25 => "SDR1",
26 => "SRR0",
27 => "SRR1",
272 => "SPRG0",
273 => "SPRG1",
274 => "SPRG2",
275 => "SPRG3",
282 => "EAR",
287 => "PVR",
528 => "IBAT0U",
529 => "IBAT0L",
530 => "IBAT1U",
531 => "IBAT1L",
532 => "IBAT2U",
533 => "IBAT2L",
534 => "IBAT3U",
535 => "IBAT3L",
536 => "DBAT0U",
537 => "DBAT0L",
538 => "DBAT1U",
539 => "DBAT1L",
540 => "DBAT2U",
541 => "DBAT2L",
542 => "DBAT3U",
543 => "DBAT3L",
912 => "GQR0",
913 => "GQR1",
914 => "GQR2",
915 => "GQR3",
916 => "GQR4",
917 => "GQR5",
918 => "GQR6",
919 => "GQR7",
920 => "HID2",
921 => "WPAR",
922 => "DMA_U",
923 => "DMA_L",
936 => "UMMCR0",
937 => "UPMC1",
938 => "UPMC2",
939 => "USIA",
940 => "UMMCR1",
941 => "UPMC3",
942 => "UPMC4",
943 => "USDA",
952 => "MMCR0",
953 => "PMC1",
954 => "PMC2",
955 => "SIA",
956 => "MMCR1",
957 => "PMC3",
958 => "PMC4",
959 => "SDA",
1008 => "HID0",
1009 => "HID1",
1010 => "IABR",
1013 => "DABR",
1017 => "L2CR",
1019 => "ICTC",
1020 => "THRM1",
1021 => "THRM2",
1022 => "THRM3",
_ => return write!(f, "{}", self.0),
})
}
}
// Condition register field.
field_arg!(CRField, u8, "cr{}");
// Condition register bit (index + condition case).
field_arg_no_display!(CRBit, u8);
impl Display for CRBit {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
let cr = self.0 >> 2;
let cc = self.0 & 3;
if cr != 0 {
write!(f, "{}", CRField(cr))?;
}
const CR_NAMES: [&str; 4] = ["lt", "gt", "eq", "un"];
f.write_str(CR_NAMES[cc as usize])
}
}
// Paired-single graphics quantization register
field_arg!(GQR, u8, "qr{}");
// Unsigned immediate.
field_arg!(Uimm, u16, "{:#x}");
// Signed immediate.
field_arg!(Simm, i16, "{:#x}", SignedHexLiteral);
// Offset for indirect memory reference.
field_arg!(Offset, i16, "{:#x}", SignedHexLiteral);
// Branch destination.
field_arg!(BranchDest, i32, "{:#x}", SignedHexLiteral);
impl From<i16> for BranchDest {
fn from(x: i16) -> BranchDest {
BranchDest(x as i32)
}
}
// Unsigned opaque argument.
field_arg!(OpaqueU, u16);
impl From<u8> for OpaqueU {
fn from(x: u8) -> OpaqueU {
OpaqueU(x as u16)
}
}
#[derive(Debug, Default, Clone, Eq, PartialEq)]
pub enum Argument {
#[default]
None,
GPR(GPR),
FPR(FPR),
SR(SR),
SPR(SPR),
CRField(CRField),
CRBit(CRBit),
GQR(GQR),
Uimm(Uimm),
Simm(Simm),
Offset(Offset),
BranchDest(BranchDest),
OpaqueU(OpaqueU),
}
impl Display for Argument {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
match self {
Argument::None => Ok(()),
Argument::GPR(x) => x.fmt(f),
Argument::FPR(x) => x.fmt(f),
Argument::SR(x) => x.fmt(f),
Argument::SPR(x) => x.fmt(f),
Argument::CRField(x) => x.fmt(f),
Argument::CRBit(x) => x.fmt(f),
Argument::GQR(x) => x.fmt(f),
Argument::Uimm(x) => x.fmt(f),
Argument::Simm(x) => x.fmt(f),
Argument::Offset(x) => x.fmt(f),
Argument::BranchDest(x) => x.fmt(f),
Argument::OpaqueU(x) => x.fmt(f),
}
}
}
/// A simplified PowerPC 750CL instruction.
pub struct SimplifiedIns {
pub ins: Ins,
pub mnemonic: &'static str,
pub args: Arguments,
}
impl SimplifiedIns {
pub fn new(ins: Ins) -> Self {
let (mnemonic, args) = SIMPLIFIED_MNEMONICS[ins.op as usize](&ins);
Self { ins, mnemonic, args }
}
pub fn basic_form(ins: Ins) -> Self {
let (mnemonic, args) = BASE_MNEMONICS[ins.op as usize](&ins);
Self { ins, mnemonic, args }
}
}
impl Display for SimplifiedIns {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.mnemonic)?;
let mut writing_offset = false;
for (i, argument) in self.args.iter().enumerate() {
if matches!(argument, Argument::None) {
break;
}
if i == 0 {
write!(f, " ")?;
} else if !writing_offset {
write!(f, ", ")?;
}
write!(f, "{}", argument)?;
if let Argument::Offset(_) = argument {
write!(f, "(")?;
writing_offset = true;
continue;
}
if writing_offset {
write!(f, ")")?;
writing_offset = false;
}
}
Ok(())
}
}
pub struct SignedHexLiteral<T>(pub T);
impl LowerHex for SignedHexLiteral<i16> {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
if self.0 < 0 {
write!(f, "-")?;
LowerHex::fmt(&-(self.0 as i32), f)
} else {
LowerHex::fmt(&self.0, f)
}
}
}
impl LowerHex for SignedHexLiteral<i32> {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
if self.0 < 0 {
write!(f, "-")?;
LowerHex::fmt(&-(self.0 as i64), f)
} else {
LowerHex::fmt(&self.0, f)
}
}
}