jingle 0.6.8

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
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
use crate::JingleError;
use crate::modeling::machine::memory::MemoryState;
use jingle_sleigh::PcodeOperation;
use jingle_sleigh::context::{ModelingBehavior, SideEffect};
use std::cmp::{Ordering, min};
use std::ops::{Add, Neg};
use z3::ast::BV;

impl MemoryState {
    pub fn apply(&self, op: &PcodeOperation) -> Result<Self, JingleError> {
        let mut final_state = self.clone();
        match &op {
            PcodeOperation::Copy { input, output } => {
                let val = self.read(input)?;
                final_state.write(output, val)?;
            }
            PcodeOperation::IntZExt { input, output } => {
                let diff = (output.size() - input.size()) as u32;
                let val = self.read(input)?;
                let zext = val.zero_ext(diff * 8);
                final_state.write(output, zext)?;
            }
            PcodeOperation::IntSExt { input, output } => {
                let diff = (output.size() - input.size()) as u32;
                let val = self.read(input)?;
                let zext = val.sign_ext(diff * 8);
                final_state.write(output, zext)?;
            }
            PcodeOperation::Store { output, input } => {
                // read the input we need to STORE
                let bv = self.read(input)?;
                // write the input to the proper space, at the offset we read
                final_state.write(output, bv)?;
            }
            PcodeOperation::Load { input, output } => {
                // read the input we need to LOAD
                let bv = self.read(input)?;
                // read the stored offset for the LOAD destination
                // write the loaded input to the output
                final_state.write(output, bv)?;
            }
            PcodeOperation::IntAdd {
                input0,
                input1,
                output,
            } => {
                let bv1 = self.read(input0)?;
                let bv2 = self.read(input1)?;
                let add = bv1 + bv2;
                final_state.write(output, add)?;
            }
            PcodeOperation::IntSub {
                input0,
                input1,
                output,
            } => {
                let bv1 = self.read(input0)?;
                let bv2 = self.read(input1)?;
                let sub = bv1 - bv2;
                final_state.write(output, sub)?;
            }
            PcodeOperation::IntAnd {
                input0,
                input1,
                output,
            } => {
                let bv1 = self.read(input0)?;
                let bv2 = self.read(input1)?;
                let and = bv1.bvand(&bv2);
                final_state.write(output, and)?;
            }
            PcodeOperation::IntXor {
                input0,
                input1,
                output,
            } => {
                let bv1 = self.read(input0)?;
                let bv2 = self.read(input1)?;
                let and = bv1.bvxor(&bv2);
                final_state.write(output, and)?;
            }
            PcodeOperation::IntOr {
                input0,
                input1,
                output,
            } => {
                let bv1 = self.read(input0)?;
                let bv2 = self.read(input1)?;
                let or = bv1.bvor(&bv2);
                final_state.write(output, or)?;
            }
            PcodeOperation::IntNegate { input, output } => {
                let bv = self.read(input)?;
                let neg = bv.neg();
                final_state.write(output, neg)?;
            }
            PcodeOperation::IntMult {
                input0,
                input1,
                output,
            } => {
                let bv1 = self.read(input0)?;
                let bv2 = self.read(input1)?;
                let mul = bv1.bvmul(&bv2);
                final_state.write(output, mul)?;
            }
            PcodeOperation::IntDiv {
                input0,
                input1,
                output,
            } => {
                let bv1 = self.read(input0)?;
                let bv2 = self.read(input1)?;
                let mul = bv1.bvudiv(&bv2);
                final_state.write(output, mul)?;
            }
            PcodeOperation::IntSignedDiv {
                input0,
                input1,
                output,
            } => {
                let bv1 = self.read(input0)?;
                let bv2 = self.read(input1)?;
                let mul = bv1.bvsdiv(&bv2);
                final_state.write(output, mul)?;
            }
            PcodeOperation::IntRem {
                input0,
                input1,
                output,
            } => {
                let bv1 = self.read(input0)?;
                let bv2 = self.read(input1)?;
                let mul = bv1.bvurem(&bv2);
                final_state.write(output, mul)?;
            }
            PcodeOperation::IntSignedRem {
                input0,
                input1,
                output,
            } => {
                let bv1 = self.read(input0)?;
                let bv2 = self.read(input1)?;
                let mul = bv1.bvsrem(&bv2);
                final_state.write(output, mul)?;
            }
            PcodeOperation::IntRightShift {
                input0,
                input1,
                output,
            } => {
                let bv1 = self.read(input0)?;
                let mut bv2 = self.read(input1)?;
                match bv1.get_size().cmp(&bv2.get_size()) {
                    Ordering::Less => bv2 = bv2.extract(bv1.get_size() - 1, 0),
                    Ordering::Greater => bv2 = bv2.zero_ext(bv1.get_size() - bv2.get_size()),
                    _ => {}
                }
                let rshift = bv1.bvlshr(&bv2);
                final_state.write(output, rshift)?;
            }
            PcodeOperation::IntSignedRightShift {
                input0,
                input1,
                output,
            } => {
                let bv1 = self.read(input0)?;
                let mut bv2 = self.read(input1)?;
                match bv1.get_size().cmp(&bv2.get_size()) {
                    Ordering::Less => bv2 = bv2.extract(bv1.get_size() - 1, 0),
                    Ordering::Greater => bv2 = bv2.zero_ext(bv1.get_size() - bv2.get_size()),
                    _ => {}
                }
                let rshift = bv1.bvashr(&bv2);
                final_state.write(output, rshift)?;
            }
            PcodeOperation::IntLeftShift {
                input0,
                input1,
                output,
            } => {
                let bv1 = self.read(input0)?;
                let mut bv2 = self.read(input1)?;
                match bv1.get_size().cmp(&bv2.get_size()) {
                    Ordering::Less => bv2 = bv2.extract(bv1.get_size() - 1, 0),
                    Ordering::Greater => bv2 = bv2.zero_ext(bv1.get_size() - bv2.get_size()),
                    _ => {}
                }
                let lshift = bv1.bvshl(&bv2);
                final_state.write(output, lshift)?;
            }
            PcodeOperation::IntCarry {
                input0,
                input1,
                output,
            } => {
                let in0 = self.read(input0)?;
                let in1 = self.read(input1)?;
                // bool arg seems to be for whether this check is signed
                let carry_bool = in0.bvadd_no_overflow(&in1, false);
                let out_bv = carry_bool.ite(&BV::from_i64(0, 8), &BV::from_i64(1, 8));
                final_state.write(output, out_bv)?;
            }
            PcodeOperation::IntSignedCarry {
                input0,
                input1,
                output,
            } => {
                let in0 = self.read(input0)?;
                let in1 = self.read(input1)?;
                // bool arg seems to be for whether this check is signed
                let carry_bool = in0.bvadd_no_overflow(&in1, true);
                let out_bv = carry_bool.ite(&BV::from_i64(0, 8), &BV::from_i64(1, 8));
                final_state.write(output, out_bv)?;
            }
            PcodeOperation::IntSignedBorrow {
                input0,
                input1,
                output,
            } => {
                let in0 = self.read(input0)?;
                let in1 = self.read(input1)?;
                // bool arg seems to be for whether this check is signed
                // todo: need to do some experimentation as to what the intended
                // meaning of "overflow" is in sleigh vs what it means in z3
                let borrow_bool = in0.bvsub_no_underflow(&in1, true);
                let out_bv = borrow_bool.ite(&BV::from_i64(0, 8), &BV::from_i64(1, 8));
                final_state.write(output, out_bv)?;
            }
            PcodeOperation::Int2Comp { input, output } => {
                let in0 = self.read(input)?;
                let flipped = in0.bvneg().add(BV::from_u64(1, in0.get_size()));
                final_state.write(output, flipped)?;
            }
            PcodeOperation::IntSignedLess {
                input0,
                input1,
                output,
            } => {
                let in0 = self.read(input0)?;
                let in1 = self.read(input1)?;
                // bool arg seems to be for whether this check is signed
                let out_bool = in0.bvslt(&in1);
                let out_bv = out_bool.ite(&BV::from_i64(1, 8), &BV::from_i64(0, 8));
                final_state.write(output, out_bv)?;
            }
            PcodeOperation::IntSignedLessEqual {
                input0,
                input1,
                output,
            } => {
                let in0 = self.read(input0)?;
                let in1 = self.read(input1)?;
                // bool arg seems to be for whether this check is signed
                let out_bool = in0.bvsle(&in1);
                let out_bv = out_bool.ite(&BV::from_i64(1, 8), &BV::from_i64(0, 8));
                final_state.write(output, out_bv)?;
            }
            PcodeOperation::IntLess {
                input0,
                input1,
                output,
            } => {
                let in0 = self.read(input0)?;
                let in1 = self.read(input1)?;
                // bool arg seems to be for whether this check is signed
                let out_bool = in0.bvult(&in1);
                let out_bv = out_bool.ite(&BV::from_i64(1, 8), &BV::from_i64(0, 8));
                final_state.write(output, out_bv)?;
            }
            PcodeOperation::IntLessEqual {
                input0,
                input1,
                output,
            } => {
                let in0 = self.read(input0)?;
                let in1 = self.read(input1)?;
                // bool arg seems to be for whether this check is signed
                let out_bool = in0.bvule(&in1);
                let out_bv = out_bool.ite(&BV::from_i64(1, 8), &BV::from_i64(0, 8));
                final_state.write(output, out_bv)?;
            }
            PcodeOperation::IntEqual {
                input0,
                input1,
                output,
            } => {
                let in0 = self.read(input0)?;
                let in1 = self.read(input1)?;
                // bool arg seems to be for whether this check is signed
                let outsize = output.size() as u32;
                let out_bool = in0.eq(&in1);
                let out_bv =
                    out_bool.ite(&BV::from_i64(1, outsize * 8), &BV::from_i64(0, outsize * 8));
                final_state.write(output, out_bv)?;
            }
            PcodeOperation::IntNotEqual {
                input0,
                input1,
                output,
            } => {
                let in0 = self.read(input0)?;
                let in1 = self.read(input1)?;
                // bool arg seems to be for whether this check is signed
                let outsize = output.size() as u32;
                let out_bool = in0.eq(&in1).not();
                let out_bv =
                    out_bool.ite(&BV::from_i64(1, outsize * 8), &BV::from_i64(0, outsize * 8));
                final_state.write(output, out_bv)?;
            }
            PcodeOperation::BoolAnd {
                input0,
                input1,
                output,
            } => {
                let in0 = self.read(input0)?;
                let in1 = self.read(input1)?;
                // bool arg seems to be for whether this check is signed
                let result = in0.bvand(&in1).bvand(1);
                final_state.write(output, result)?;
            }
            PcodeOperation::BoolNegate { input, output } => {
                let val = self.read(input)?;
                let negated = val.bvneg().bvand(1);
                final_state.write(output, negated)?;
            }
            PcodeOperation::BoolOr {
                input0,
                input1,
                output,
            } => {
                let i0 = self.read(input0)?;
                let i1 = self.read(input1)?;
                // bool arg seems to be for whether this check is signed
                let result = i0.bvor(&i1).bvand(1);
                final_state.write(output, result)?;
            }
            PcodeOperation::BoolXor {
                input0,
                input1,
                output,
            } => {
                let i0 = self.read(input0)?;
                let i1 = self.read(input1)?;
                // bool arg seems to be for whether this check is signed
                let result = i0.bvxor(&i1).bvand(1);
                final_state.write(output, result)?;
            }
            PcodeOperation::PopCount { input, output } => {
                let size = output.size() as u32;
                let in0 = self.read(input)?;
                let mut outbv = BV::from_i64(0, output.size() as u32 * 8);
                for i in 0..size * 8 {
                    let extract = in0.extract(i, i);
                    let extend = extract.zero_ext((size * 8) - 1);
                    outbv = outbv.bvadd(&extend);
                }

                final_state.write(output, outbv)?;
            }
            PcodeOperation::SubPiece {
                input0,
                input1,
                output,
            } => {
                let bv0 = self.read(input0)?;
                // sleigh asserts that input1 is a constant
                let input_low_byte = input1.offset() as u32;
                let input_size = (input0.size() as u32) - input_low_byte;
                let output_size = output.size() as u32;
                let size = min(input_size, output_size);
                let input = bv0.extract((input_low_byte + size) * 8 - 1, input_low_byte * 8);
                match size.cmp(&output_size) {
                    Ordering::Less => {
                        final_state.write(output, input.zero_ext((output_size - size) * 8))?
                    }
                    Ordering::Greater => {
                        final_state.write(output, input.extract(output_size * 8 - 1, 0))?
                    }
                    Ordering::Equal => final_state.write(output, input)?,
                };
            }
            PcodeOperation::CallOther { call_info, .. } => {
                if let Some(call_info) = call_info {
                    final_state.apply_function_model(&call_info.model_behavior)?;
                }
            }
            PcodeOperation::Call { call_info, .. } => {
                if let Some(call_info) = call_info {
                    final_state.apply_function_model(&call_info.model_behavior)?;
                }
            }
            PcodeOperation::Branch { .. } => {}
            PcodeOperation::Fallthrough { .. } => {}
            PcodeOperation::CBranch { .. } => {}
            PcodeOperation::BranchInd { .. }
            | PcodeOperation::CallInd { .. }
            | PcodeOperation::Return { .. } => {}
            v => return Err(JingleError::UnmodeledInstruction(Box::new((*v).clone()))),
        };
        Ok(final_state)
    }

    fn apply_function_model(
        &mut self,
        modeling_behavior: &ModelingBehavior,
    ) -> Result<(), JingleError> {
        if let ModelingBehavior::Summary(model) = modeling_behavior {
            for ele in model {
                match ele {
                    SideEffect::RegisterIncrement(name, amt) => {
                        if let Some(vn) = self.info.register(name).cloned() {
                            let val = self.read(&vn)?.bvadd(*amt);
                            self.write(vn, val)?;
                        }
                    }
                    SideEffect::RegisterDecrement(name, amt) => {
                        if let Some(vn) = self.info.register(name).cloned() {
                            let val = self.read(&vn)?.bvsub(*amt);
                            self.write(vn, val)?;
                        }
                    }
                    _ => todo!(),
                };
            }
        }
        Ok(())
    }
}