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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
use std::borrow::Cow;
use std::collections::HashMap;
use std::io::{self, Cursor, Read, Seek, SeekFrom, Write};

use num_bigint::BigInt;

use crate::magic::{pyc_header_length, python_version_from_magic};
use crate::objects::{CodeObject, Object, ObjectType, StringType};

/// Custom error type for distinguishing different failure modes
#[derive(Debug, thiserror::Error)]
pub enum Error {
    /// Invalid start of object and / or unknown type flag
    #[error("Unknown type {byte:?} at offset {offset}.")]
    UnknownType {
        #[allow(missing_docs)]
        byte: char,
        #[allow(missing_docs)]
        offset: usize,
    },
    /// Invalid file (premature end of file) or I/O error
    #[error("{inner}")]
    Io {
        #[from]
        #[allow(missing_docs)]
        inner: io::Error,
    },
    /// Unsupported Python version (unhandled object type)
    #[error("Handling for type {0:?} is not implemented.")]
    UnhandledType(ObjectType),
    /// Invalid file and / or unsupported Python version (unknown magic number)
    #[error("Cannot determine Python version from file header.")]
    UnknownVersion,
    /// Parsing error resulted in no known objects with this ID
    #[error("Missing object for reference with ID: {index}")]
    UnknownReference {
        #[allow(missing_docs)]
        index: usize,
    },
}

#[derive(Clone, Debug)]
pub(crate) struct ReferencedObject {
    pub(crate) offset: usize,
    pub(crate) index: u32,
    pub(crate) usages: u32,
    pub(crate) typ: ObjectType,
}

/// Parsed contents of a `pyc` file or "marshal dump"
///
/// This data structure contains additional information about which objects are
/// referenced by reference objects. This data can be used to clean up unused
/// reference flags, which are, in general, not reproducible.
#[derive(Debug)]
pub struct MarshalObject {
    pub(crate) object: Object,
    pub(crate) references: HashMap<u32, Vec<usize>>,
    pub(crate) referenced: Vec<ReferencedObject>,
}

impl MarshalObject {
    /// Parse `pyc` file contents (header + marshal dump) from data
    pub fn parse_pyc(data: &[u8]) -> Result<Self, Error> {
        let mut reader = Cursor::new(data);

        let mut buf = [0u8; 4];
        reader.read_exact(&mut buf)?;

        let Some((major, minor)) = python_version_from_magic(&buf) else {
            return Err(Error::UnknownVersion);
        };

        let header_length = pyc_header_length((major, minor));
        reader.seek_relative((header_length - 4) as i64)?;

        let parser = Parser::new((major, minor), header_length);
        let (object, references, referenced) = parser.read_marshal(&mut reader)?;

        Ok(MarshalObject {
            object,
            references,
            referenced,
        })
    }

    /// Parse marshal dump contents from data
    ///
    /// Since plain "marshal dumps" do not contain a `pyc` file header, the
    /// version of Python that was used to create the data must be specified.
    pub fn parse_dump(data: &[u8], (major, minor): (u16, u16)) -> Result<Self, Error> {
        let mut reader = Cursor::new(data);
        let parser = Parser::new((major, minor), 0);
        let (object, references, referenced) = parser.read_marshal(&mut reader)?;

        Ok(MarshalObject {
            object,
            references,
            referenced,
        })
    }

    /// Clear unused reference flags from objects
    ///
    /// This method can be used to make `pyc` files more reproducible.
    ///
    /// Reference flags are removed from objects that are never referenced, and
    /// remaining references are adjusted for the shuffled index numbers.
    ///
    /// If no changes are made, data is returned without modifications in a
    /// [`Cow::Borrowed`], otherwise a [`Cow::Owned`] with new file contents is
    /// returned.
    pub fn clear_unused_ref_flags(self, data: &[u8]) -> Result<Cow<[u8]>, Error> {
        // this method consumes self because it invalidates the unmarshaled object

        let unreferenced: Vec<_> = self.referenced.iter().filter(|x| x.usages == 0).collect();
        if unreferenced.is_empty() {
            log::info!("No unused references found.");
            return Ok(Cow::Borrowed(data));
        }

        let mut data = data.to_vec();

        let mut dropped_indices = Vec::new();
        for unref in &unreferenced {
            log::info!(
                "Clearing unused reference bit from object at offset {} with index {}",
                unref.offset,
                unref.index
            );

            data[unref.offset] = clear_bit(data[unref.offset], 7);
            dropped_indices.push(unref.index);
        }

        let mut new_indices = Vec::new();
        for (index, offsets) in &self.references {
            let diff = dropped_indices.iter().filter(|x| **x < *index).count() as u32;

            for offset in offsets {
                new_indices.push((*offset, index - diff));
            }
        }

        // sorting by offset costs more time than doing random memory accesses

        let mut writer = Cursor::new(&mut data);
        for (offset, new_index) in new_indices {
            writer.seek(SeekFrom::Start(offset as u64))?;
            writer.write_all(&new_index.to_le_bytes())?;
        }

        log::info!("Removed {} unused references.", unreferenced.len());
        Ok(Cow::Owned(data))
    }

    /// Print objects with unused reference flags to stdout
    pub fn print_unused_ref_flags(&self) {
        for r in &self.referenced {
            if r.usages == 0 {
                println!(
                    "Unused reference bit: {} object with reference index {} at offset {}",
                    r.typ, r.index, r.offset
                );
            }
        }
    }

    /// Obtain a reference to the inner [`Object`]
    pub fn inner(&self) -> &Object {
        &self.object
    }

    /// Consume this [`MarshalObject`] to obtain the inner [`Object`]
    pub fn into_inner(self) -> Object {
        self.object
    }
}

type References = HashMap<u32, Vec<usize>>;
type Referenced = Vec<ReferencedObject>;

#[derive(Debug)]
pub(crate) struct Parser {
    version: (u16, u16),
    offset: usize,
    references: References,
    referenced: Referenced,
}

impl Parser {
    fn new(version: (u16, u16), offset: usize) -> Self {
        Parser {
            version,
            offset,
            references: HashMap::new(),
            referenced: Vec::new(),
        }
    }

    fn read_marshal<T: Read>(mut self, reader: &mut T) -> Result<(Object, References, Referenced), Error> {
        let object = self.read_object(reader)?;

        for (index, usages) in &self.references {
            let index = *index as usize;

            if let Some(r) = self.referenced.get_mut(index) {
                r.usages = usages.len() as u32;
            } else {
                return Err(Error::UnknownReference { index });
            }
        }

        Ok((object, self.references, self.referenced))
    }

    fn read_object<T: Read>(&mut self, bytes: &mut T) -> Result<Object, Error> {
        log::debug!("Reading object at offset {}", self.offset);

        let offset = self.offset;
        let mut byte = self.read_u8(bytes)?;

        let mut ref_id = None;

        // check if this object has the reference flag bit set
        if test_bit(byte, 7) {
            let index = self.referenced.len() as u32;
            log::debug!("Object at offset {} assigned reference index {}", self.offset, index);

            byte = clear_bit(byte, 7);
            ref_id = Some(index);
        }

        let Some(typ) = ObjectType::try_from(byte).ok() else {
            return Err(Error::UnknownType {
                byte: byte.into(),
                offset,
            });
        };

        if let Some(index) = ref_id {
            let obj = ReferencedObject {
                offset,
                index,
                usages: 0,
                typ,
            };

            self.referenced.push(obj);
        }

        let result = match typ {
            // singleton objects
            ObjectType::Null => Object::Null,
            ObjectType::None => Object::None,
            ObjectType::False => Object::False,
            ObjectType::True => Object::True,
            ObjectType::StopIteration => Object::StopIteration,
            ObjectType::Ellipsis => Object::Ellipsis,

            // simple objects
            ObjectType::Int => Object::Int(self.read_u32(bytes)?),
            ObjectType::BinaryFloat => Object::BinaryFloat(self.read_f64(bytes)?),
            ObjectType::BinaryComplex => Object::BinaryComplex((self.read_f64(bytes)?, self.read_f64(bytes)?)),

            // string objects
            ObjectType::String => Object::String {
                typ: StringType::String,
                bytes: self.read_string(bytes, false)?,
            },
            ObjectType::Interned => Object::String {
                typ: StringType::Interned,
                bytes: self.read_string(bytes, false)?,
            },
            ObjectType::Unicode => Object::String {
                typ: StringType::Unicode,
                bytes: self.read_string(bytes, false)?,
            },
            ObjectType::Ascii => Object::String {
                typ: StringType::Ascii,
                bytes: self.read_string(bytes, false)?,
            },
            ObjectType::AsciiInterned => Object::String {
                typ: StringType::AsciiInterned,
                bytes: self.read_string(bytes, false)?,
            },
            ObjectType::ShortAscii => Object::String {
                typ: StringType::Ascii,
                bytes: self.read_string(bytes, true)?,
            },
            ObjectType::ShortAsciiInterned => Object::String {
                typ: StringType::AsciiInterned,
                bytes: self.read_string(bytes, true)?,
            },

            // collection objects
            ObjectType::Tuple => Object::Tuple(self.read_collection(bytes, false)?),
            ObjectType::List => Object::List(self.read_collection(bytes, false)?),
            ObjectType::Set => Object::Set(self.read_collection(bytes, false)?),
            ObjectType::FrozenSet => Object::FrozenSet(self.read_collection(bytes, false)?),
            ObjectType::SmallTuple => Object::Tuple(self.read_collection(bytes, true)?),
            ObjectType::Dict => Object::Dict(self.read_dict(bytes)?),

            // special cases
            ObjectType::Long => Object::Long(self.read_long(bytes)?),
            ObjectType::Ref => Object::Ref(self.read_ref(bytes)?),
            ObjectType::Code => Object::Code(Box::new(self.read_code_object(bytes)?)),

            // unhandled types:
            // ObjectType::{Int64,Float,Complex,Unknown}
            x => return Err(Error::UnhandledType(x)),
        };

        Ok(result)
    }

    #[inline(always)]
    fn read_bytes<T: Read>(&mut self, bytes: &mut T, n: usize) -> Result<Vec<u8>, Error> {
        let mut buf = vec![0u8; n];
        bytes.read_exact(&mut buf)?;
        self.offset += n;
        Ok(buf)
    }

    #[inline(always)]
    fn read_bytes_const<T: Read, const N: usize>(&mut self, bytes: &mut T) -> Result<[u8; N], Error> {
        let mut buf = [0u8; N];
        bytes.read_exact(&mut buf)?;
        self.offset += N;
        Ok(buf)
    }

    #[inline(always)]
    fn read_u8<T: Read>(&mut self, bytes: &mut T) -> Result<u8, Error> {
        log::debug!("Reading u8 at offset {}", self.offset);
        Ok(u8::from_le_bytes(self.read_bytes_const(bytes)?))
    }

    #[inline(always)]
    fn read_u32<T: Read>(&mut self, bytes: &mut T) -> Result<u32, Error> {
        log::debug!("Reading u32 at offset {}", self.offset);
        Ok(u32::from_le_bytes(self.read_bytes_const(bytes)?))
    }

    #[inline(always)]
    fn read_i32<T: Read>(&mut self, bytes: &mut T) -> Result<i32, Error> {
        log::debug!("Reading i32 at offset {}", self.offset);
        Ok(i32::from_le_bytes(self.read_bytes_const(bytes)?))
    }

    #[inline(always)]
    fn read_f64<T: Read>(&mut self, bytes: &mut T) -> Result<f64, Error> {
        log::debug!("Reading f64 at offset {}", self.offset);
        Ok(f64::from_le_bytes(self.read_bytes_const(bytes)?))
    }

    fn read_string<T: Read>(&mut self, bytes: &mut T, short: bool) -> Result<Vec<u8>, Error> {
        let size = if short {
            log::debug!("Reading short string at offset {}", self.offset);
            self.read_u8(bytes)? as usize
        } else {
            log::debug!("Reading string at offset {}", self.offset);
            self.read_u32(bytes)? as usize
        };

        let bytes = self.read_bytes(bytes, size)?;
        Ok(bytes)
    }

    fn read_collection<T: Read>(&mut self, bytes: &mut T, small: bool) -> Result<Vec<Object>, Error> {
        let size = if small {
            log::debug!("Reading small tuple at offset {}", self.offset);
            self.read_u8(bytes)? as usize
        } else {
            log::debug!("Reading collection at offset {}", self.offset);
            self.read_u32(bytes)? as usize
        };

        let mut result = Vec::with_capacity(size);
        for _ in 0..size {
            result.push(self.read_object(bytes)?);
        }

        Ok(result)
    }

    fn read_dict<T: Read>(&mut self, bytes: &mut T) -> Result<Vec<(Object, Object)>, Error> {
        log::debug!("Reading collection at offset {}", self.offset);

        let mut result = Vec::new();

        loop {
            let key = self.read_object(bytes)?;
            if key == Object::Null {
                break;
            }

            let value = self.read_object(bytes)?;
            result.push((key, value));
        }

        Ok(result)
    }

    fn read_long<T: Read>(&mut self, bytes: &mut T) -> Result<BigInt, Error> {
        log::debug!("Reading long at offset {}", self.offset);

        let size = self.read_i32(bytes)?;

        let mut result = BigInt::ZERO;
        let mut shift = 0;

        for _ in 0..size.abs() {
            let x = {
                let b = self.read_bytes_const::<T, 2>(bytes)?;

                let mut x = b[0] as i16;
                x |= (b[1] as i16) << 8;
                x |= -(x & 0x8000u16 as i16);

                BigInt::from(x)
            };

            result += x << shift;
            shift += 15;
        }

        if size > 0 {
            Ok(result)
        } else {
            Ok(-result)
        }
    }

    fn read_ref<T: Read>(&mut self, bytes: &mut T) -> Result<u32, Error> {
        log::debug!("Reading reference at offset {}", self.offset);

        let offset = self.offset;
        let index = self.read_u32(bytes)?;
        log::debug!("Found reference at offset {} with index {}", offset, index);

        self.references
            .entry(index)
            .and_modify(|x| x.push(offset))
            .or_insert(vec![offset]);
        Ok(index)
    }

    fn read_code_object<T: Read>(&mut self, bytes: &mut T) -> Result<CodeObject, Error> {
        log::debug!("Reading codeobject at offset {}", self.offset);

        let result = CodeObject {
            argcount: self.read_u32(bytes)?,
            posonlyargcount: if self.version >= (3, 8) {
                Some(self.read_u32(bytes)?)
            } else {
                None
            },
            kwonlyargcount: self.read_u32(bytes)?,
            nlocals: if self.version < (3, 11) {
                Some(self.read_u32(bytes)?)
            } else {
                None
            },
            stacksize: self.read_u32(bytes)?,
            flags: self.read_u32(bytes)?,
            code: self.read_object(bytes)?,
            consts: self.read_object(bytes)?,
            names: self.read_object(bytes)?,
            varnames: if self.version < (3, 11) {
                Some(self.read_object(bytes)?)
            } else {
                None
            },
            freevars: if self.version < (3, 11) {
                Some(self.read_object(bytes)?)
            } else {
                None
            },
            cellvars: if self.version < (3, 11) {
                Some(self.read_object(bytes)?)
            } else {
                None
            },
            localsplusnames: if self.version >= (3, 11) {
                Some(self.read_object(bytes)?)
            } else {
                None
            },
            localspluskinds: if self.version >= (3, 11) {
                Some(self.read_object(bytes)?)
            } else {
                None
            },
            filename: self.read_object(bytes)?,
            name: self.read_object(bytes)?,
            qualname: if self.version >= (3, 11) {
                Some(self.read_object(bytes)?)
            } else {
                None
            },
            firstlineno: self.read_u32(bytes)?,
            linetable: self.read_object(bytes)?,
            exceptiontable: if self.version >= (3, 11) {
                Some(self.read_object(bytes)?)
            } else {
                None
            },
        };

        Ok(result)
    }
}

#[inline(always)]
fn test_bit(b: u8, i: u8) -> bool {
    b & (1 << i) != 0u8
}

#[inline(always)]
fn clear_bit(b: u8, i: u8) -> u8 {
    b & !(1 << i)
}