hermes_rs 0.1.8

A dependency-free disassembler and assembler for the Hermes bytecode
Documentation
use std::io;

use crate::hermes::decode::decode_u32;
use crate::hermes::encode::encode_u32;
use crate::hermes::Serializable;

use super::decode::align_reader;

#[cfg_attr(feature = "specta", derive(specta::Type))]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[derive(Debug, Clone)]
pub struct DebugInfo {
    pub header: DebugInfoHeader,
    pub string_table: Vec<DebugStringTable>,
    pub string_storage: Vec<u8>,
    pub file_regions: Vec<DebugFileRegion>,
    pub sources_data_storage: Vec<u8>,
    pub scope_desc_data_storage: Vec<u8>,
    pub textified_callee_storage: Vec<u8>, // Only present on >= HBC v91
    pub string_table_storage: Vec<u8>,     // Only present on >= HBC v91
}

impl Serializable for DebugInfo {
    type Version = u32;

    fn size(&self) -> usize {
        self.header.size()
            + self.string_table.iter().map(|x| x.size()).sum::<usize>()
            + self.string_storage.len()
            + self.file_regions.iter().map(|x| x.size()).sum::<usize>()
            // + self.offsets.iter().map(|x| x.size()).sum::<usize>()
            + self.sources_data_storage.len()
            + self.scope_desc_data_storage.len()
            + self.textified_callee_storage.len()
            + self.string_table_storage.len()
    }

    fn deserialize<R>(r: &mut R, version: u32) -> Self
    where
        R: io::Read + io::BufRead + io::Seek,
    {
        let header = DebugInfoHeader::deserialize(r, version);
        let string_table = (0..header.filename_count)
            .map(|_| DebugStringTable::deserialize(r, version))
            .collect();

        let string_storage = {
            let mut buf = vec![0; header.filename_storage_size as usize];
            r.read_exact(&mut buf).unwrap();
            buf
        };

        let file_regions = (0..header.file_region_count)
            .map(|_| DebugFileRegion::deserialize(r, version))
            .collect();

        let source_data_size = header.scope_desc_data_offset;
        let sources_data_storage = {
            let mut buf = vec![0; (source_data_size) as usize];
            r.read_exact(&mut buf).unwrap();
            buf
        };

        let scope_desc_data_storage: Vec<u8>;
        let mut textified_callee_storage = vec![];
        let mut string_table_storage = vec![];

        if version >= 91
            && header.textified_callee_offset.is_some()
            && header.string_table_offset.is_some()
        {
            let scope_desc_data_size =
                header.textified_callee_offset.unwrap() - header.scope_desc_data_offset;
            let textified_data_size =
                header.string_table_offset.unwrap() - header.textified_callee_offset.unwrap();
            let string_table_size = header.debug_data_size - header.string_table_offset.unwrap();

            let sdds = {
                let mut buf = vec![0; scope_desc_data_size as usize];
                r.read_exact(&mut buf).unwrap();
                buf
            };

            textified_callee_storage = {
                let mut buf = vec![0; textified_data_size as usize];
                r.read_exact(&mut buf).unwrap();
                buf
            };

            string_table_storage = {
                let mut buf = vec![0; string_table_size as usize];
                r.read_exact(&mut buf).unwrap();
                buf
            };

            scope_desc_data_storage = sdds;
        } else {
            scope_desc_data_storage = {
                let mut buf =
                    vec![0; (header.debug_data_size - header.scope_desc_data_offset) as usize];
                r.read_exact(&mut buf).unwrap();
                buf
            };
        }

        DebugInfo {
            header,
            string_table,
            string_storage,
            file_regions,
            // offsets,
            sources_data_storage,
            scope_desc_data_storage,
            textified_callee_storage,
            string_table_storage,
        }
    }

    fn serialize<W>(&self, w: &mut W)
    where
        W: std::io::Write + std::io::Seek,
    {
        self.header.serialize(w);

        for entry in &self.string_table {
            entry.serialize(w);
        }

        w.write_all(&self.string_storage).unwrap();
        for entry in &self.file_regions {
            entry.serialize(w);
        }

        w.write_all(&self.sources_data_storage).unwrap();
        w.write_all(&self.scope_desc_data_storage).unwrap();
        w.write_all(&self.textified_callee_storage).unwrap();
        w.write_all(&self.string_table_storage).unwrap();
    }
}

#[cfg_attr(feature = "specta", derive(specta::Type))]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[derive(Debug, Clone)]
pub enum DebugInfoOffsets {
    Old(DebugInfoOffsetsOld),
    New(DebugInfoOffsetsNew),
}

impl DebugInfoOffsets {
    pub fn size(&self) -> usize {
        match self {
            DebugInfoOffsets::Old(x) => x.size(),
            DebugInfoOffsets::New(x) => x.size(),
        }
    }

    pub fn deserialize<R>(r: &mut R, version: u32) -> Self
    where
        R: io::Read + io::BufRead + io::Seek,
    {
        if version >= 91 {
            DebugInfoOffsets::New(DebugInfoOffsetsNew::deserialize(r, version))
        } else {
            DebugInfoOffsets::Old(DebugInfoOffsetsOld::deserialize(r, version))
        }
    }

    pub fn serialize<W>(&self, w: &mut W)
    where
        W: io::Write + io::Seek,
    {
        match self {
            DebugInfoOffsets::Old(x) => x.serialize(w),
            DebugInfoOffsets::New(x) => x.serialize(w),
        }
    }
}

#[cfg_attr(feature = "specta", derive(specta::Type))]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[derive(Debug, Clone)]
pub struct DebugInfoOffsetsNew {
    pub src: u32,
    pub scope_desc: u32,
    pub callee: u32,
}

impl Serializable for DebugInfoOffsetsNew {
    type Version = u32;
    fn size(&self) -> usize {
        12
    }

    fn deserialize<R>(r: &mut R, _version: u32) -> Self
    where
        R: io::Read + io::BufRead + io::Seek,
    {
        align_reader(r, 4).unwrap();

        let src = decode_u32(r);
        let scope_desc = decode_u32(r);
        let callee = decode_u32(r);

        DebugInfoOffsetsNew {
            src,
            scope_desc,
            callee,
        }
    }

    fn serialize<W>(&self, _w: &mut W)
    where
        W: io::Write,
    {
        // encode_u32(w, self.string_data_off);
        encode_u32(_w, self.src);
        encode_u32(_w, self.scope_desc);
        encode_u32(_w, self.callee);
    }
}

#[cfg_attr(feature = "specta", derive(specta::Type))]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[derive(Debug, Clone)]
pub struct DebugInfoOffsetsOld {
    pub src: u32,
    pub scope_desc: u32,
}

impl Serializable for DebugInfoOffsetsOld {
    type Version = u32;
    fn size(&self) -> usize {
        8
    }

    fn deserialize<R>(r: &mut R, _version: u32) -> Self
    where
        R: io::Read + io::BufRead + io::Seek,
    {
        align_reader(r, 4).unwrap();
        let src = decode_u32(r);
        let scope_desc = decode_u32(r);
        DebugInfoOffsetsOld { src, scope_desc }
    }

    fn serialize<W>(&self, _w: &mut W)
    where
        W: io::Write,
    {
        // encode_u32(w, self.string_data_off);
    }
}

#[cfg_attr(feature = "specta", derive(specta::Type))]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[derive(Debug, Clone)]
pub struct DebugInfoHeader {
    pub filename_count: u32,
    pub filename_storage_size: u32,
    pub file_region_count: u32,
    pub scope_desc_data_offset: u32,
    pub textified_callee_offset: Option<u32>,
    pub string_table_offset: Option<u32>,
    pub debug_data_size: u32,
}

impl Serializable for DebugInfoHeader {
    type Version = u32;
    fn size(&self) -> usize {
        28
    }

    fn deserialize<R>(r: &mut R, _version: u32) -> Self
    where
        R: io::Read + io::BufRead + io::Seek,
    {
        DebugInfoHeader {
            filename_count: decode_u32(r),
            filename_storage_size: decode_u32(r),
            file_region_count: decode_u32(r),
            scope_desc_data_offset: decode_u32(r),
            textified_callee_offset: (_version >= 91).then(|| decode_u32(r)),
            string_table_offset: (_version >= 91).then(|| decode_u32(r)),
            debug_data_size: decode_u32(r),
        }
    }

    fn serialize<W>(&self, w: &mut W)
    where
        W: io::Write,
    {
        // encode_u32(w, self.string_data_off);
        encode_u32(w, self.filename_count);
        encode_u32(w, self.filename_storage_size);
        encode_u32(w, self.file_region_count);
        encode_u32(w, self.scope_desc_data_offset);

        if self.textified_callee_offset.is_some() {
            encode_u32(w, self.textified_callee_offset.unwrap());
        }

        if self.string_table_offset.is_some() {
            encode_u32(w, self.string_table_offset.unwrap());
        }

        // encode_u32(w, self.string_table_offset);
        encode_u32(w, self.debug_data_size);
    }
}

#[cfg_attr(feature = "specta", derive(specta::Type))]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[derive(Debug, Clone)]
pub struct DebugStringTable {
    pub offset: u32,
    pub length: u32,
}

impl Serializable for DebugStringTable {
    type Version = u32;
    fn size(&self) -> usize {
        8
    }

    fn deserialize<R>(r: &mut R, _version: u32) -> Self
    where
        R: io::Read + io::BufRead + io::Seek,
    {
        let offset = decode_u32(r);
        let length = decode_u32(r);
        DebugStringTable { offset, length }
    }

    fn serialize<W>(&self, w: &mut W)
    where
        W: io::Write,
    {
        encode_u32(w, self.offset);
        encode_u32(w, self.length);
    }
}

#[cfg_attr(feature = "specta", derive(specta::Type))]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[derive(Debug, Clone)]
pub struct DebugFileRegion {
    pub from_address: u32,
    pub filename_id: u32,
    pub source_mapping_url_id: u32,
}

impl Serializable for DebugFileRegion {
    type Version = u32;
    fn size(&self) -> usize {
        12
    }

    fn deserialize<R>(r: &mut R, _version: u32) -> Self
    where
        R: io::Read + io::BufRead + io::Seek,
    {
        DebugFileRegion {
            from_address: decode_u32(r),
            filename_id: decode_u32(r),
            source_mapping_url_id: decode_u32(r),
        }
    }

    fn serialize<W>(&self, w: &mut W)
    where
        W: io::Write,
    {
        // encode_u32(w, self.string_data_off);
        encode_u32(w, self.from_address);
        encode_u32(w, self.filename_id);
        encode_u32(w, self.source_mapping_url_id);
    }
}

#[cfg_attr(feature = "specta", derive(specta::Type))]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[derive(Debug, Clone)]
#[allow(dead_code)]
pub struct FunctionDebugInfoDeserializer {
    data: Vec<u8>,
    offset: u32,
    function_index: u32,
    current_line: u32,
    current_column: u32,
}