jingle 0.5.1

SMT Modeling for Ghidra's PCODE
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

use jingle_sleigh::{JingleSleighError, PcodeOperation};
#[cfg(feature = "pyo3")]
use pyo3::PyErr;
#[cfg(feature = "pyo3")]
use pyo3::exceptions::PyRuntimeError;
use thiserror::Error;

#[derive(Debug, Error)]
pub enum JingleError {
    #[error("Error constructing p-code: {0}")]
    Sleigh(#[from] JingleSleighError),
    #[error("Given address disassembles cleanly but does not terminate within the given bound")]
    DisassemblyLengthBound,
    #[error("Attempted to construct an illegally-sized branch target")]
    InvalidBranchTargetSize,
    #[error("A z3 array selection operation returned something other than a bitvector")]
    UnexpectedArraySort,
    #[error("Something referenced a space that isn't declared")]
    UnmodeledSpace,
    #[error("Tried to create a block containing zero instructions")]
    EmptyBlock,
    #[error("Something tried to access a 0-sized varnode")]
    ZeroSizedVarnode,
    #[error("Cannot write values into constant space.")]
    ConstantWrite,
    #[error(
        "Attempt to read an indirect value from the constant space. While this can be modeled, \
    it's almost definitely unintended."
    )]
    IndirectConstantRead,
    #[error(
        "Attempted to perform a write of a bitvector to a VarNode with leftover space. This is \
    a sleigh bug."
    )]
    MismatchedWordSize,
    #[error(
        "Attempted to perform a write to a space using the wrong size of address. This is a \
    sleigh bug."
    )]
    MismatchedAddressSize,
    #[error("Jingle does not yet model this instruction")]
    UnmodeledInstruction(Box<PcodeOperation>),
}

#[cfg(feature = "pyo3")]
impl From<JingleError> for PyErr {
    fn from(value: JingleError) -> Self {
        PyRuntimeError::new_err(value.to_string())
    }
}