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

//! Data for use in rbspy tests and benchmarks :-)

use std::fs::File;
use std::io::{self, BufReader, Read};
use std::path::Path;

use anyhow::{Context, Result};
use goblin::elf;
use remoteprocess::{Error as ProcessError, ProcessMemory};

use flate2::bufread::GzDecoder;

/// Open data file `name`.
fn data_file(name: &str) -> Result<File> {
    let path = Path::new(env!("CARGO_MANIFEST_DIR"))
        .join("data")
        .join(name);

    Ok(File::open(&path).context(format!("could not open data file `{}`", path.display()))?)
}

/// Get contents of gzipped data file `name`.
fn data_file_gz_contents(name: &str) -> Result<Vec<u8>> {
    let file = BufReader::new(data_file(&name)?);
    let mut data = vec![];
    GzDecoder::new(file)
        .read_to_end(&mut data)
        .context(format!("failed to read gzipped data file `{}`", name))?;
    Ok(data)
}

/// Load coredump from gzipped data file `name`.
fn load_coredump(name: &str) -> Result<CoreDump> {
    CoreDump::new(data_file_gz_contents(name)?)
}

pub fn coredump_1_9_3() -> CoreDump {
    load_coredump("ruby-coredump-1.9.3.gz").unwrap()
}
pub fn coredump_2_1_6() -> CoreDump {
    load_coredump("ruby-coredump-2.1.6.gz").unwrap()
}
pub fn coredump_2_1_6_c_function() -> CoreDump {
    load_coredump("ruby-coredump-2.1.6_c_function.gz").unwrap()
}
pub fn coredump_2_4_0() -> CoreDump {
    load_coredump("ruby-coredump-2.4.0.gz").unwrap()
}
pub fn coredump_2_5_0() -> CoreDump {
    load_coredump("ruby-coredump-2.5.0.gz").unwrap()
}

pub fn coredump_2_7_2() -> CoreDump {
    load_coredump("ruby-coredump-2.7.2.gz").unwrap()
}

pub fn coredump_3_0_0() -> CoreDump {
    load_coredump("ruby-coredump-3.0.0.gz").unwrap()
}

pub fn coredump_3_1_0() -> CoreDump {
    load_coredump("ruby-coredump-3.1.0.gz").unwrap()
}

pub fn coredump_3_2_0() -> CoreDump {
    load_coredump("ruby-coredump-3.2.0.gz").unwrap()
}

pub fn coredump_3_3_0() -> CoreDump {
    load_coredump("ruby-coredump-3.3.0.gz").unwrap()
}

/// Allows testing offline with a core dump of a Ruby process.
pub struct CoreDump {
    raw_memory: Vec<u8>,
    elf_section_headers: Vec<elf::SectionHeader>,
}

impl CoreDump {
    pub fn new(raw_memory: Vec<u8>) -> Result<Self> {
        let elf = elf::Elf::parse(&raw_memory).context("failed to parse ELF header")?;
        let elf_section_headers = elf.section_headers;
        Ok(CoreDump {
            raw_memory,
            elf_section_headers,
        })
    }
}

impl ProcessMemory for CoreDump {
    fn read(&self, addr: usize, buf: &mut [u8]) -> Result<(), ProcessError> {
        let start = addr as u64;
        let end = (addr + buf.len()) as u64;
        match self
            .elf_section_headers
            .iter()
            .find(|section| section.sh_addr <= start && end <= section.sh_addr + section.sh_size)
        {
            Some(sec) => {
                let start = sec.sh_offset as usize + addr - sec.sh_addr as usize;
                let end = start + buf.len();
                buf.copy_from_slice(&self.raw_memory[start..end]);
                Ok(())
            }
            None => {
                let io_error = io::Error::from_raw_os_error(libc::EFAULT);
                Err(ProcessError::IOError(io_error))
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_load_coredump() {
        let coredump = load_coredump("ruby-coredump-1.9.3.gz").unwrap();
        assert_eq!(coredump.elf_section_headers.len(), 36);
        let buf = &mut [0u8; 16];
        coredump.read(0x823930, buf).expect("read failed");
        assert_eq!(buf, &[32, 21, 73, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]);

        let coredump = load_coredump("ruby-coredump-2.1.6.gz").unwrap();
        assert_eq!(coredump.elf_section_headers.len(), 40);
        let buf = &mut [0u8; 16];
        coredump.read(0x562658abd7f0, buf).expect("read failed");
        assert_eq!(
            buf,
            &[176, 165, 200, 89, 38, 86, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
        );

        let coredump = load_coredump("ruby-coredump-2.1.6_c_function.gz").unwrap();
        assert_eq!(coredump.elf_section_headers.len(), 102);
        let buf = &mut [0u8; 16];
        coredump.read(0x562efcd577f0, buf).expect("read failed");
        assert_eq!(
            buf,
            &[176, 198, 255, 254, 46, 86, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
        );

        let coredump = load_coredump("ruby-coredump-2.4.0.gz").unwrap();
        assert_eq!(coredump.elf_section_headers.len(), 38);
        let buf = &mut [0u8; 16];
        coredump.read(0x55df44959920, buf).expect("read failed");
        assert_eq!(
            buf,
            &[208, 165, 37, 70, 223, 85, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
        );

        let coredump = load_coredump("ruby-coredump-2.5.0.gz").unwrap();
        assert_eq!(coredump.elf_section_headers.len(), 38);
        let buf = &mut [0u8; 16];
        coredump.read(0x55dd8c3b7758, buf).expect("read failed");
        assert_eq!(
            buf,
            &[216, 136, 151, 140, 221, 85, 0, 0, 32, 127, 151, 140, 221, 85, 0, 0]
        );

        let coredump = load_coredump("ruby-coredump-2.7.2.gz").unwrap();
        assert_eq!(coredump.elf_section_headers.len(), 119);
        let buf = &mut [0u8; 16];
        coredump.read(0x7fdd8d626070, buf).expect("read failed");
        assert_eq!(
            buf,
            &[208, 166, 207, 100, 196, 85, 0, 0, 160, 155, 207, 100, 196, 85, 0, 0]
        );

        let coredump = load_coredump("ruby-coredump-3.0.0.gz").unwrap();
        assert_eq!(coredump.elf_section_headers.len(), 119);
        let buf = &mut [0u8; 16];
        coredump.read(0x7fdacdab7470, buf).expect("read failed");
        assert_eq!(
            buf,
            &[160, 235, 191, 181, 200, 85, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
        );

        let coredump = load_coredump("ruby-coredump-3.1.0.gz").unwrap();
        assert_eq!(coredump.elf_section_headers.len(), 119);
        let buf = &mut [0u8; 16];
        coredump.read(0x7f0dc0c83c58, buf).expect("read failed");
        assert_eq!(
            buf,
            &[64, 186, 97, 2, 255, 85, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
        );

        let coredump = load_coredump("ruby-coredump-3.2.0.gz").unwrap();
        assert_eq!(coredump.elf_section_headers.len(), 120);
        let buf = &mut [0u8; 16];
        coredump.read(0xffffb8034578, buf).expect("read failed");
        assert_eq!(
            buf,
            &[208, 250, 146, 227, 170, 170, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
        );

        let coredump = load_coredump("ruby-coredump-3.3.0.gz").unwrap();
        assert_eq!(coredump.elf_section_headers.len(), 122);
        let buf = &mut [0u8; 16];
        coredump.read(0x7f7ff21f1868, buf).expect("read failed");
        assert_eq!(buf, &[16, 3, 62, 88, 13, 86, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]);
    }
}