wazabin-qcode 0.4.0

Typed SSA-style p-code IR for binary analysis, modelled after Ghidra's p-code
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

use std::borrow::Cow;

use crate::{
    context::Context,
    error::{Error, ErrorTy, Result},
    value::ValueId,
};

pub trait Named {
    fn name(&self) -> Option<&str>;
}

/// Attempts to set the name in the reverse name table that owns `id`'s kind
/// (function-local for block/instruction/param/Temp, global otherwise).
pub fn update_context_name<'str>(
    id: ValueId,
    ctx: &mut Context<'str>,
    name: Cow<'str, str>,
    old_name: Option<&str>,
) -> Result<()> {
    if let Some(existing_id) = ctx.get_named_in_scope(id, &name) {
        if existing_id != id {
            Err(Error::spanless(ErrorTy::DuplicateName(name.to_string())))
        } else {
            Ok(())
        }
    } else {
        ctx.update_name(name, id, old_name)
    }
}

pub trait Renameable<'str, 'ctx>: Named {
    fn rename(&mut self, name: Cow<'str, str>) -> Result<()>;

    fn with_name(mut self, name: Cow<'str, str>) -> Result<Self>
    where
        Self: Sized,
    {
        self.rename(name)?;
        Ok(self)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{
        context::Context,
        error::{Error, ErrorTy},
        value::{Varnode, util::base_ref::WithCtx},
    };

    #[test]
    fn test_update_name() {
        let mut ctx = Context::new();
        let space_id = ctx.shared.default_space;
        let mut var = Varnode::make(&mut ctx, 0, 1, space_id);

        assert_eq!(var.ctx().get_named("var"), None);

        var.rename("var".into()).unwrap();

        assert_eq!(var.ctx().get_named("var"), Some(var.id()));
        assert_eq!(var.name(), Some("var"));
    }

    #[test]
    fn test_update_to_same_name() {
        let mut ctx = Context::new();
        let space_id = ctx.shared.default_space;
        let mut var = Varnode::make(&mut ctx, 0, 1, space_id);

        assert_eq!(var.ctx().get_named("var"), None);

        var.rename("var".into()).unwrap();

        assert_eq!(var.ctx().get_named("var"), Some(var.id()));
        assert_eq!(var.name(), Some("var"));

        var.rename("var".into()).unwrap();

        assert_eq!(var.ctx().get_named("var"), Some(var.id()));
        assert_eq!(var.name(), Some("var"));
    }

    #[test]
    fn test_update_name_conflict() {
        let mut ctx = Context::new();
        let space_id = ctx.shared.default_space;
        let mut var1 = Varnode::make(&mut ctx, 0, 1, space_id);
        var1.rename("var".into()).unwrap();

        let mut var2 = Varnode::make(&mut ctx, 1, 1, space_id);
        assert_eq!(
            var2.rename("var".into()),
            Err(Error::spanless(ErrorTy::DuplicateName("var".into())))
        );
    }
}