pcode 0.1.3

Pure Rust implementation of a p-code disassembler and lifter.
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
148
149
150
151
152
153

use super::address::*;
use super::op::*;

use std::fmt::{self, Debug, Display};
use std::collections::HashMap;
use std::hash::{Hash, Hasher};
use std::cmp::Ordering;
use std::clone::Clone;

#[derive(Clone)]
pub struct Varnode {
    pub name: Option<String>,
    pub space: AddressSpace,
    pub offset: u64,
    pub size: u64
}

impl Hash for Varnode {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.space.hash(state);
        self.offset.hash(state);
        self.size.hash(state);
    }
}

impl PartialEq for Varnode {
    fn eq(&self, other: &Self) -> bool {
        self.space == other.space &&
            self.offset == other.offset &&
            self.size == other.size
    }
}

impl Eq for Varnode {}

impl PartialOrd for Varnode {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for Varnode {
    fn cmp(&self, other: &Self) -> Ordering {
        self.offset.cmp(&other.offset)
    }
}

impl Debug for Varnode {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self)
    }
}

impl Display for Varnode {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match &self.name {
            Some(name) => {
                if name.starts_with('"') && name.ends_with('"') {
                    write!(f, "\x1b[1;35m{}\x1b[0m", name)
                } else {
                    write!(f, "\x1b[1;33m{}\x1b[0m", name)
                }
            },
            _ => match self.space {
                AddressSpace::Unique => write!(f, "U{:x}:{}", self.offset, self.size),
                AddressSpace::Const => write!(f, "\x1b[1;32m0x{:x}\x1b[0m", self.offset),
                // AddressSpace::Const => write!(f, "0x{:x}", self.offset),
                AddressSpace::Register => write!(f, "R{:x}:{}", self.offset, self.size), // FIXME
                AddressSpace::Ram => write!(f, "[ram]0x{:x}:{}", self.offset, self.size),
                AddressSpace::Stack => write!(f, "[stack]0x{:x}:{}", self.offset, self.size),
                AddressSpace::Deref => write!(f, "[deref]0x{:x}:{}", self.offset, self.size),
                AddressSpace::Dummy => write!(f, "DUMMY"),
            }
        }
    }
}

impl FmtIface for Varnode {
    fn fmt_call_target(&self) -> String {
        match &self.name {
            Some(name) => name.clone(),
            _ => {
                if self.space.is_ram() || self.space.is_const() {
                    format!("\x1b[1m\x1b[38;5;208mFUN_{:x}\x1b[0m", self.offset)
                } else {
                    self.to_string()
                }
            },
        }
    }

    fn fmt_output(&self) -> String {
        self.to_string()
    }
}

impl Varnode {
    pub fn atom(&self, off: u64) -> Varnode {
        Varnode { name: None, space: self.space, offset: off, size: 1 }
    }

    pub fn dummy() -> Self {
        Self {
            name: None,
            space: AddressSpace::Dummy,
            offset: 0,
            size: 0,
        }
    }

    pub fn constant(off: u64, size: u64) -> Self {
        Self {
            name: None,
            space: AddressSpace::Const,
            offset: off,
            size,
        }
    }

    pub fn is_negative(&self) -> bool {
        self.space.is_const() && self.offset >> ((self.size * 8) - 1) != 0
    }

    pub fn negate(&self) -> Varnode {
        let shift = 64 - self.size * 8;
        let off = (((self.offset << shift) as i64) >> shift) as u64; // sign-extend.
        let signed_off = (off ^ 0xffffffffffffffff) + 1;

        Varnode {
            name: self.name.clone(),
            space: self.space,
            offset: signed_off,
            size: self.size,
        }
    }

    pub fn truncate(&self, addend: u64, new_size: u64, varnode_map: &HashMap<(u64, u64), String>) -> Self {
        let new_offset = self.offset + addend;

        let new_name = if self.space == AddressSpace::Register {
            varnode_map.get(&(new_offset, new_size)).cloned()
        } else {
            None
        };

        Varnode {
            name: new_name,
            space: self.space,
            offset: new_offset,
            size: new_size,
        }
    }
}