arch-ops 0.1.1

A library to encode and decode instructions for several architectures
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

use std::io::{Read, Write};

#[derive(Clone, Debug, Hash, PartialEq, Eq)]
pub enum Address {
    Abs(u128),
    Disp(i64),
    Symbol { name: String, disp: i64 },
    PltSym { name: String },
}

impl core::fmt::Display for Address {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Abs(n) => f.write_fmt(format_args!("{:#x}", n)),
            Self::Disp(n) => f.write_fmt(format_args!("{:+}", n)),
            Self::Symbol { name, disp: 0 } => f.write_str(name),
            Self::Symbol { name, disp } => f.write_fmt(format_args!("{}{:+}", name, disp)),
            Self::PltSym { name } => f.write_fmt(format_args!("{}@plt", name)),
        }
    }
}

pub trait InsnRead: Read {
    fn read_addr(&mut self, size: usize, rel: bool) -> std::io::Result<Address>;
    /// Reads a relocation
    /// If `offset` is `None`, reads from the head of the stream. Otherwise, reads from the given offset from the head.
    ///
    /// If `offset` is not-None, the function may error if it is not between -size and size in bytes, rounded away from zero
    fn read_reloc(
        &mut self,
        size: usize,
        rel: bool,
        offset: Option<isize>,
    ) -> std::io::Result<Option<Address>>;
}

impl<R: InsnRead + ?Sized> InsnRead for &mut R {
    fn read_addr(&mut self, size: usize, rel: bool) -> std::io::Result<Address> {
        <R as InsnRead>::read_addr(self, size, rel)
    }

    fn read_reloc(
        &mut self,
        size: usize,
        rel: bool,
        offset: Option<isize>,
    ) -> std::io::Result<Option<Address>> {
        <R as InsnRead>::read_reloc(self, size, rel, offset)
    }
}

impl<R: InsnRead + ?Sized> InsnRead for Box<R> {
    fn read_addr(&mut self, size: usize, rel: bool) -> std::io::Result<Address> {
        <R as InsnRead>::read_addr(self, size, rel)
    }

    fn read_reloc(
        &mut self,
        size: usize,
        rel: bool,
        offset: Option<isize>,
    ) -> std::io::Result<Option<Address>> {
        <R as InsnRead>::read_reloc(self, size, rel, offset)
    }
}

pub fn default_write_zeroes<W: Write>(mut out: W, mut count: usize) -> std::io::Result<()> {
    let val: [u8; 1024] = [0; 1024];
    while count >= 1024 {
        out.write_all(&val)?;
        count -= 1024;
    }
    out.write_all(&val[..count])
}

pub trait InsnWrite: Write {
    fn write_addr(&mut self, size: usize, addr: Address, rel: bool) -> std::io::Result<()>;
    fn write_reloc(&mut self, reloc: Reloc) -> std::io::Result<()>;
    fn offset(&self) -> usize;
    fn write_zeroes(&mut self, count: usize) -> std::io::Result<()> {
        default_write_zeroes(self, count)
    }
}

impl<W: InsnWrite + ?Sized> InsnWrite for &mut W {
    fn write_addr(&mut self, size: usize, addr: Address, rel: bool) -> std::io::Result<()> {
        <W as InsnWrite>::write_addr(self, size, addr, rel)
    }
    fn offset(&self) -> usize {
        <W as InsnWrite>::offset(self)
    }

    fn write_reloc(&mut self, reloc: Reloc) -> std::io::Result<()> {
        <W as InsnWrite>::write_reloc(self, reloc)
    }
    fn write_zeroes(&mut self, count: usize) -> std::io::Result<()> {
        <W as InsnWrite>::write_zeroes(self, count)
    }
}

impl<W: InsnWrite + ?Sized> InsnWrite for Box<W> {
    fn write_addr(&mut self, size: usize, addr: Address, rel: bool) -> std::io::Result<()> {
        <W as InsnWrite>::write_addr(self, size, addr, rel)
    }
    fn offset(&self) -> usize {
        <W as InsnWrite>::offset(self)
    }

    fn write_reloc(&mut self, reloc: Reloc) -> std::io::Result<()> {
        <W as InsnWrite>::write_reloc(self, reloc)
    }
    fn write_zeroes(&mut self, count: usize) -> std::io::Result<()> {
        <W as InsnWrite>::write_zeroes(self, count)
    }
}

#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq)]
pub enum RelocCode {
    None,
    Abs { addr_width: usize },
    BaseRel { addr_width: usize },
    Rel { addr_width: usize },
    AbsShifted { addr_width: usize, shift: usize },
    RelShifted { addr_width: usize, shift: usize },
    Got { addr_width: usize },
    RelGot { addr_wdith: usize },
    Plt { addr_width: usize },
    RelPlt { addr_width: usize },
    DynSymEntry { width: usize },
    W65Direct,
    W65RelaxJsl,
    W65RelaxJml,
    W65RelaxBrl,
    W65RelaxDirect,
    W65RelaxAbs,
    W65RelaxJmp,
    CleverShort,
    CleverShortPcrel,
}

#[derive(Clone, Debug, Hash, PartialEq, Eq)]
pub struct Reloc {
    pub code: RelocCode,
    pub symbol: String,
    pub addend: Option<i64>,
    pub offset: u64,
}