falcon 0.2.0

A Binary Analysis Framework in Rust
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

/// A concrete state for execution over Falcon IL.

use executor::*;
use executor::successor::*;
use std::collections::BTreeMap;

/// A concrete `State`.
#[derive(Debug, Clone)]
pub struct State<'e> {
    scalars: BTreeMap<String, il::Constant>,
    memory: Memory<'e>,
}


impl<'e> State<'e> {
    /// Create a new `State` from the given memory model.
    pub fn new(memory: Memory<'e>) -> State<'e> {
        State {
            scalars: BTreeMap::new(),
            memory: memory
        }
    }


    /// Retrieve the `Memory` associated with this `State`.
    pub fn memory(&self) -> &Memory {
        &self.memory
    }


    /// Retrieve a mutable reference to the `Memory` associated with this
    /// `State`.
    pub fn memory_mut(&'e mut self) -> &'e mut Memory {
        &mut self.memory
    }


    /// Set the value of the given scalar to a concrete value.
    pub fn set_scalar<S: Into<String>>(&mut self, name: S, value: il::Constant) {
        self.scalars.insert(name.into(), value);
    }


    /// Get the concrete value of the given scalar.
    pub fn get_scalar(&self, name: &str) -> Option<&il::Constant> {
        self.scalars.get(name)
    }


    /// Symbolize an expression, replacing all scalars with the concrete values
    /// stored in this state.
    pub fn symbolize_expression(&self, expression: &il::Expression)
    -> Result<il::Expression> {

        Ok(match *expression {
            il::Expression::Scalar(ref scalar) => {
                match self.scalars.get(scalar.name()) {
                    Some(expr) => expr.clone().into(),
                    None => il::Expression::Scalar(scalar.clone())
                }
            },
            il::Expression::Constant(_) => expression.clone(),
            il::Expression::Add(ref lhs, ref rhs) => 
                il::Expression::add(self.symbolize_expression(lhs)?,
                                    self.symbolize_expression(rhs)?)?,
            il::Expression::Sub(ref lhs, ref rhs) => 
                il::Expression::sub(self.symbolize_expression(lhs)?,
                                    self.symbolize_expression(rhs)?)?,
            il::Expression::Mul(ref lhs, ref rhs) => 
                il::Expression::mul(self.symbolize_expression(lhs)?,
                                    self.symbolize_expression(rhs)?)?,
            il::Expression::Divu(ref lhs, ref rhs) => 
                il::Expression::divu(self.symbolize_expression(lhs)?,
                                    self.symbolize_expression(rhs)?)?,
            il::Expression::Modu(ref lhs, ref rhs) => 
                il::Expression::modu(self.symbolize_expression(lhs)?,
                                    self.symbolize_expression(rhs)?)?,
            il::Expression::Divs(ref lhs, ref rhs) => 
                il::Expression::divs(self.symbolize_expression(lhs)?,
                                    self.symbolize_expression(rhs)?)?,
            il::Expression::Mods(ref lhs, ref rhs) => 
                il::Expression::mods(self.symbolize_expression(lhs)?,
                                    self.symbolize_expression(rhs)?)?,
            il::Expression::And(ref lhs, ref rhs) => 
                il::Expression::and(self.symbolize_expression(lhs)?,
                                    self.symbolize_expression(rhs)?)?,
            il::Expression::Or(ref lhs, ref rhs) => 
                il::Expression::or(self.symbolize_expression(lhs)?,
                                    self.symbolize_expression(rhs)?)?,
            il::Expression::Xor(ref lhs, ref rhs) => 
                il::Expression::xor(self.symbolize_expression(lhs)?,
                                    self.symbolize_expression(rhs)?)?,
            il::Expression::Shl(ref lhs, ref rhs) => 
                il::Expression::shl(self.symbolize_expression(lhs)?,
                                    self.symbolize_expression(rhs)?)?,
            il::Expression::Shr(ref lhs, ref rhs) => 
                il::Expression::shr(self.symbolize_expression(lhs)?,
                                    self.symbolize_expression(rhs)?)?,
            il::Expression::Cmpeq(ref lhs, ref rhs) => 
                il::Expression::cmpeq(self.symbolize_expression(lhs)?,
                                    self.symbolize_expression(rhs)?)?,
            il::Expression::Cmpneq(ref lhs, ref rhs) => 
                il::Expression::cmpneq(self.symbolize_expression(lhs)?,
                                    self.symbolize_expression(rhs)?)?,
            il::Expression::Cmplts(ref lhs, ref rhs) => 
                il::Expression::cmplts(self.symbolize_expression(lhs)?,
                                    self.symbolize_expression(rhs)?)?,
            il::Expression::Cmpltu(ref lhs, ref rhs) => 
                il::Expression::cmpltu(self.symbolize_expression(lhs)?,
                                    self.symbolize_expression(rhs)?)?,
            il::Expression::Zext(bits, ref src) => 
                il::Expression::zext(bits, self.symbolize_expression(src)?)?,
            il::Expression::Sext(bits, ref src) => 
                il::Expression::sext(bits, self.symbolize_expression(src)?)?,
            il::Expression::Trun(bits, ref src) => 
                il::Expression::trun(bits, self.symbolize_expression(src)?)?,
        })
    }


    /// Symbolize the given expression, replacing all scalars with the concrete
    /// values held in this state, and evaluate the expression to a single
    /// concrete value.
    pub fn symbolize_and_eval(&self, expression: &il::Expression)
    -> Result<il::Constant> {
        let expression = self.symbolize_expression(expression)?;
        Ok(eval(&expression)?)
    }


    /// Execute an `il::Operation`, returning the post-execution `State`.
    pub fn execute(mut self, operation: &il::Operation) -> Result<Successor<'e>> {
        Ok(match *operation {
            il::Operation::Assign { ref dst, ref src } => {
                let src = self.symbolize_and_eval(src)?;
                self.set_scalar(dst.name(), src);
                Successor::new(self, SuccessorType::FallThrough)
            },
            il::Operation::Store { ref index, ref src, .. } => {
                let src = self.symbolize_and_eval(src)?;
                let index = self.symbolize_and_eval(index)?;
                self.memory.store(index.value(), src)?;
                Successor::new(self, SuccessorType::FallThrough)
            },
            il::Operation::Load { ref dst, ref index, .. } => {
                let index = self.symbolize_and_eval(index)?;
                let value = self.memory.load(index.value(), dst.bits())?;
                match value {
                    Some(v) => {
                        self.set_scalar(dst.name(), v.into());
                        Successor::new(self, SuccessorType::FallThrough)
                    },
                    None => {
                        bail!("Got invalid concretized address {}", index.value());
                    }
                }
            },
            il::Operation::Brc { ref target, ref condition } => {
                let condition_result = self.symbolize_and_eval(condition)?;
                if condition_result.value() == 1 {
                    let target = self.symbolize_and_eval(target)?;
                    Successor::new(self, SuccessorType::Branch(target.value()))
                }
                else {
                    Successor::new(self, SuccessorType::FallThrough)
                }
            },
            il::Operation::Raise { ref expr } => {
                Successor::new(self, SuccessorType::Raise(expr.clone()))
            }
        })
    }
}