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

//! An `Array` is designed to represent memory locations.
//!
//! Arrays are used to represent memory. Typically, we will just use one array to represent
//! all of addressable memory space. Using a variable to explicitly identify memory allows for
//! things like, "Versioned," memory, or applying SSA to memory accesses.
//!
//! Falcon's IL does not support things like passing an `Array` in a `Scalar`, or
//! an index into to an `Array` through a `Scalar`. This prevents certain interesting types
//! of analyses, and may change in future iterations of the IL.

use std::fmt;
use il::*;

/// An Array in Falcon IL
#[derive(Clone, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
pub struct Array {
    name: String,
    size: u64
}


impl Array {
    /// Create a new array.
    ///
    /// Size is the size of the `Array` in bytes. This does not trigger an allocation, but
    /// sets the, "Size," of the `Array`.
    pub fn new<S>(name: S, size: u64) -> Array where S: Into<String> {
        Array {
            name: name.into(),
            size: size,
        }
    }

    /// Get the size of the `Array`.
    pub fn size(&self) -> u64 {
        self.size
    }

    /// Get the name of the `Array`.
    pub fn name(&self) -> &str {
        &self.name
    }
}


impl Variable for Array {
    fn name(&self) -> &str {
        &self.name
    }

    /// An identifier uniquely identifies the variable in the form
    /// `<name>[]#<ssa>`
    fn identifier(&self) -> String {
        format!("{}[]", self.name)
    }

    fn multi_var_clone(&self) -> MultiVar {
        MultiVar::Array(self.clone())
    }
}



impl fmt::Display for Array {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.identifier())
    }
}