sbpf-disassembler 0.1.9

Disassembler for SBPF (Solana BPF) bytecode
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
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
524
525
526
527
528
529
530
531
532
533
use {
    crate::{
        elf_header::{E_MACHINE, E_MACHINE_SBPF, ELFHeader},
        errors::DisassemblerError,
        program_header::ProgramHeader,
        relocation::Relocation,
        rodata::RodataSection,
        section_header::SectionHeader,
        section_header_entry::SectionHeaderEntry,
    },
    either::Either,
    object::{Endianness, read::elf::ElfFile64},
    sbpf_common::{inst_param::Number, instruction::Instruction, opcode::Opcode},
    serde::{Deserialize, Serialize},
    std::collections::{BTreeSet, HashMap},
};

pub type DisassembleResult =
    Result<(Vec<Instruction>, Option<RodataSection>, Option<usize>), DisassemblerError>;

#[derive(Debug, Serialize, Deserialize)]
pub struct Program {
    pub elf_header: ELFHeader,
    pub program_headers: Vec<ProgramHeader>,
    pub section_headers: Vec<SectionHeader>,
    pub section_header_entries: Vec<SectionHeaderEntry>,
    pub relocations: Vec<Relocation>,
}

impl Program {
    pub fn from_bytes(b: &[u8]) -> Result<Self, DisassemblerError> {
        let elf_file = ElfFile64::<Endianness>::parse(b).map_err(|e| {
            eprintln!("ELF parse error: {}", e);
            DisassemblerError::NonStandardElfHeader
        })?;

        // Parse elf header.
        let elf_header = ELFHeader::from_elf_file(&elf_file)?;

        // Parse program headers.
        let program_headers = ProgramHeader::from_elf_file(&elf_file)?;

        // Parse section headers and section header entries.
        let (section_headers, section_header_entries) = SectionHeader::from_elf_file(&elf_file)?;

        // Parse relocations.
        let relocations = Relocation::from_elf_file(&elf_file)?;

        Ok(Self {
            elf_header,
            program_headers,
            section_headers,
            section_header_entries,
            relocations,
        })
    }

    pub fn to_ixs(self) -> DisassembleResult {
        self.into_ixs_inner(true)
    }

    pub fn to_ixs_raw(self) -> DisassembleResult {
        self.into_ixs_inner(false)
    }

    fn into_ixs_inner(self, resolve_offsets: bool) -> DisassembleResult {
        // Find and populate instructions for the .text section
        let text_section = self
            .section_header_entries
            .iter()
            .find(|e| e.label.eq(".text\0"))
            .ok_or(DisassemblerError::MissingTextSection)?;
        let text_section_offset = text_section.offset as u64;

        // Build syscall map
        let syscall_map = self.build_syscall_map(text_section_offset);

        let data = &text_section.data;
        if !data.len().is_multiple_of(8) {
            return Err(DisassemblerError::InvalidDataLength);
        }

        let is_sbpf_v2 =
            self.elf_header.e_flags == 0x02 && self.elf_header.e_machine == E_MACHINE_SBPF;

        // Get rodata info
        let rodata_info = self.get_rodata_info();
        let (rodata_base, rodata_end) = rodata_info
            .as_ref()
            .map(|(d, addr)| (*addr, *addr + d.len() as u64))
            .unwrap_or((0, 0));

        // Parse instructions and build slot mappings
        let mut ixs: Vec<Instruction> = Vec::new();
        let mut idx_to_slot: Vec<usize> = Vec::new();
        let mut pos: usize = 0;
        let mut slot: usize = 0;

        while pos < data.len() {
            let remaining = &data[pos..];
            if remaining.len() < 8 {
                break;
            }

            // ugly v2 shit we need to fix goes here:
            let mut ix = if is_sbpf_v2 {
                Instruction::from_bytes_sbpf_v2(remaining)?
            } else {
                Instruction::from_bytes(remaining)?
            };

            // Handle syscall relocation
            if ix.opcode == Opcode::Call
                && let Some(Either::Right(Number::Int(-1))) = ix.imm
                && let Some(syscall_name) = syscall_map.get(&(pos as u64))
            {
                ix.imm = Some(Either::Left(syscall_name.clone()));
            }

            idx_to_slot.push(slot);

            if ix.opcode == Opcode::Lddw {
                pos += 16;
                slot += 2;
            } else {
                pos += 8;
                slot += 1;
            }

            ixs.push(ix);
        }

        let mut slot_to_idx = vec![0usize; slot];
        for (idx, &slot) in idx_to_slot.iter().enumerate() {
            slot_to_idx[slot] = idx;
        }

        let text_sh_addr = self
            .section_headers
            .iter()
            .find(|h| {
                self.section_header_entries
                    .iter()
                    .any(|e| e.label.eq(".text\0") && e.offset == h.sh_offset as usize)
            })
            .map(|h| h.sh_addr)
            .unwrap_or(0);
        let text_end_addr = text_sh_addr + text_section.data.len() as u64;

        let mut rodata_refs = BTreeSet::new();

        if resolve_offsets {
            // Resolve jump/call labels and collect rodata references

            for (idx, ix) in ixs.iter_mut().enumerate() {
                let is_lddw = ix.opcode == Opcode::Lddw;

                // Resolve jump targets
                if ix.is_jump()
                    && let Some(Either::Right(off)) = &ix.off
                {
                    let current_slot = idx_to_slot[idx] as i64;
                    let target_slot = current_slot + 1 + (*off as i64);
                    if target_slot >= 0
                        && let Some(&target_idx) = slot_to_idx.get(target_slot as usize)
                    {
                        let new_off = target_idx as i64 - (idx as i64 + 1);
                        ix.off = Some(Either::Right(new_off as i16));
                    }
                }

                // Resolve internal call targets
                if ix.opcode == Opcode::Call
                    && let Some(Either::Right(Number::Int(imm))) = &ix.imm
                {
                    let current_slot = idx_to_slot[idx] as i64;
                    let target_slot = current_slot + 1 + *imm;
                    if target_slot >= 0
                        && let Some(&target_idx) = slot_to_idx.get(target_slot as usize)
                    {
                        let new_rel = target_idx as i64 - (idx as i64 + 1);
                        ix.imm = Some(Either::Right(Number::Int(new_rel)));
                    }
                }

                // Collect rodata references
                if is_lddw && let Some(Either::Right(Number::Int(imm))) = &ix.imm {
                    let addr = *imm as u64;
                    if rodata_info.is_some() && addr >= rodata_base && addr < rodata_end {
                        rodata_refs.insert(addr);
                    } else if addr >= text_sh_addr && addr < text_end_addr {
                        // Convert text address to instruction index for callx.
                        let byte_offset = addr - text_sh_addr;
                        let target_slot = (byte_offset / 8) as usize;
                        if target_slot < slot_to_idx.len() {
                            let ix_idx = slot_to_idx[target_slot];
                            ix.imm = Some(Either::Right(Number::Int(ix_idx as i64)));
                        }
                    }
                }
            }
        }

        // Parse rodata section
        let rodata = if let Some((data, base_addr)) = rodata_info {
            let mut section = RodataSection::parse(data, base_addr, &rodata_refs);
            let (data_relocs, text_relocs) = self.classify_relocations(
                &section.data,
                base_addr,
                text_section_offset,
                text_section.data.len() as u64,
                text_sh_addr,
                &slot_to_idx,
            );
            section.data_relocations = data_relocs;
            section.text_relocations = text_relocs;
            Some(section)
        } else {
            None
        };

        // Calculate entrypoint instruction index from byte offset.
        let entrypoint_idx = self.get_entrypoint_offset().map(|byte_offset| {
            let entrypoint_slot = (byte_offset / 8) as usize;
            if entrypoint_slot < slot_to_idx.len() {
                slot_to_idx[entrypoint_slot]
            } else {
                0
            }
        });

        Ok((ixs, rodata, entrypoint_idx))
    }

    /// Build a hashmap where:
    /// - key: relative position within .text section
    /// - value: syscall name (sol_log_64_, sol_log_, etc.)
    fn build_syscall_map(&self, text_section_offset: u64) -> HashMap<u64, String> {
        self.relocations
            .iter()
            .filter(|r| r.is_syscall())
            .filter_map(|r| {
                r.symbol_name.as_ref().map(|name| {
                    // Convert absolute offset to relative position within .text
                    let relative_pos = r.relative_offset(text_section_offset);
                    (relative_pos, name.clone())
                })
            })
            .collect()
    }

    /// Get the raw rodata bytes and the virtual address where it's loaded in memory
    fn get_rodata_info(&self) -> Option<(Vec<u8>, u64)> {
        let rodata_entry = self
            .section_header_entries
            .iter()
            .find(|e| e.label.starts_with(".rodata"))?;

        // v3: use program header p_vaddr
        // v0: use section header sh_addr
        let vaddr = if self.is_v3() {
            self.program_headers
                .iter()
                .find(|ph| {
                    let rodata_offset = rodata_entry.offset as u64;
                    rodata_offset >= ph.p_offset && rodata_offset < ph.p_offset + ph.p_filesz
                })
                .map(|ph| ph.p_vaddr)
                .unwrap_or(0)
        } else {
            let rodata_header = self
                .section_headers
                .iter()
                .find(|h| h.sh_offset as usize == rodata_entry.offset)?;
            rodata_header.sh_addr
        };

        // Check for .data.rel.ro section and combine if present.
        if let Some(data_rel_ro_entry) = self
            .section_header_entries
            .iter()
            .find(|e| e.label.starts_with(".data.rel.ro"))
        {
            let data_rel_ro_header = self
                .section_headers
                .iter()
                .find(|h| h.sh_offset as usize == data_rel_ro_entry.offset);

            if let Some(drr_header) = data_rel_ro_header {
                let drr_end = drr_header.sh_addr + drr_header.sh_size;
                let total_size = (drr_end - vaddr) as usize;

                // Allocate combined buffer.
                let mut combined = vec![0u8; total_size];

                // Copy .rodata at offset 0.
                let rodata_len = rodata_entry.data.len().min(total_size);
                combined[..rodata_len].copy_from_slice(&rodata_entry.data[..rodata_len]);

                // Copy .data.rel.ro at its offset relative to rodata base.
                let drr_offset = (drr_header.sh_addr - vaddr) as usize;
                let drr_len = data_rel_ro_entry.data.len().min(total_size - drr_offset);
                combined[drr_offset..drr_offset + drr_len]
                    .copy_from_slice(&data_rel_ro_entry.data[..drr_len]);

                return Some((combined, vaddr));
            }
        }

        Some((rodata_entry.data.clone(), vaddr))
    }

    /// Classify relocations into data and text relocations.
    fn classify_relocations(
        &self,
        rodata_data: &[u8],
        rodata_base: u64,
        text_offset: u64,
        text_len: u64,
        text_sh_addr: u64,
        slot_to_idx: &[usize],
    ) -> (Vec<usize>, Vec<(usize, usize)>) {
        let rodata_len = rodata_data.len();
        let text_end_addr = text_sh_addr + text_len;
        let mut data_relocs = Vec::new();
        let mut text_relocs = Vec::new();

        for r in &self.relocations {
            if r.rel_type != crate::relocation::RelocationType::R_BPF_64_RELATIVE {
                continue;
            }
            if r.offset >= text_offset && r.offset < text_offset + text_len {
                continue;
            }
            if r.offset < rodata_base || r.offset + 8 > rodata_base + rodata_len as u64 {
                continue;
            }
            let offset_in_blob = (r.offset - rodata_base) as usize;
            data_relocs.push(offset_in_blob);

            let imm_offset = offset_in_blob + 4;
            if imm_offset + 4 <= rodata_len {
                let ptr =
                    u32::from_le_bytes(rodata_data[imm_offset..imm_offset + 4].try_into().unwrap())
                        as u64;
                if ptr >= text_sh_addr && ptr < text_end_addr {
                    let target_slot = ((ptr - text_sh_addr) / 8) as usize;
                    if target_slot < slot_to_idx.len() {
                        text_relocs.push((offset_in_blob, slot_to_idx[target_slot]));
                    }
                }
            }
        }

        (data_relocs, text_relocs)
    }

    /// Get the entrypoint offset
    pub fn get_entrypoint_offset(&self) -> Option<u64> {
        let e_entry = self.elf_header.e_entry;

        if self.is_v3() {
            const V3_BYTECODE_VADDR: u64 = 1 << 32;
            if e_entry >= V3_BYTECODE_VADDR {
                Some(e_entry - V3_BYTECODE_VADDR)
            } else {
                None
            }
        } else {
            let text_header = self.section_headers.iter().find(|h| {
                self.section_header_entries
                    .iter()
                    .any(|e| e.label.eq(".text\0") && e.offset == h.sh_offset as usize)
            })?;
            let text_sh_addr = text_header.sh_addr;

            if e_entry >= text_sh_addr {
                Some(e_entry - text_sh_addr)
            } else {
                None
            }
        }
    }

    fn is_v3(&self) -> bool {
        self.elf_header.e_flags == 0x03 && self.elf_header.e_machine == E_MACHINE
    }
}

#[cfg(test)]
mod tests {
    use {
        crate::{
            elf_header::{E_MACHINE_SBPF, ELFHeader},
            program::Program,
            section_header_entry::SectionHeaderEntry,
        },
        hex_literal::hex,
    };

    #[test]
    fn try_deserialize_program() {
        let program = Program::from_bytes(&hex!("7F454C460201010000000000000000000300F700010000002001000000000000400000000000000028020000000000000000000040003800030040000600050001000000050000002001000000000000200100000000000020010000000000003000000000000000300000000000000000100000000000000100000004000000C001000000000000C001000000000000C0010000000000003C000000000000003C000000000000000010000000000000020000000600000050010000000000005001000000000000500100000000000070000000000000007000000000000000080000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000007912A000000000007911182900000000B7000000010000002D21010000000000B70000000000000095000000000000001E0000000000000004000000000000000600000000000000C0010000000000000B0000000000000018000000000000000500000000000000F0010000000000000A000000000000000C00000000000000160000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001000000120001002001000000000000300000000000000000656E747279706F696E7400002E74657874002E64796E737472002E64796E73796D002E64796E616D6963002E73687374727461620000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001000000010000000600000000000000200100000000000020010000000000003000000000000000000000000000000008000000000000000000000000000000170000000600000003000000000000005001000000000000500100000000000070000000000000000400000000000000080000000000000010000000000000000F0000000B0000000200000000000000C001000000000000C001000000000000300000000000000004000000010000000800000000000000180000000000000007000000030000000200000000000000F001000000000000F0010000000000000C00000000000000000000000000000001000000000000000000000000000000200000000300000000000000000000000000000000000000FC010000000000002A00000000000000000000000000000001000000000000000000000000000000")).unwrap();
        println!("{:?}", program.section_header_entries);
    }

    #[test]
    fn test_to_ixs_invalid_data_length() {
        // Create program with .text section that has invalid length (not multiple of 8)
        let program = Program {
            elf_header: ELFHeader {
                ei_magic: [127, 69, 76, 70],
                ei_class: 2,
                ei_data: 1,
                ei_version: 1,
                ei_osabi: 0,
                ei_abiversion: 0,
                ei_pad: [0; 7],
                e_type: 0,
                e_machine: 0,
                e_version: 0,
                e_entry: 0,
                e_phoff: 0,
                e_shoff: 0,
                e_flags: 0,
                e_ehsize: 0,
                e_phentsize: 0,
                e_phnum: 0,
                e_shentsize: 0,
                e_shnum: 0,
                e_shstrndx: 0,
            },
            program_headers: vec![],
            section_headers: vec![],
            section_header_entries: vec![
                SectionHeaderEntry::new(".text\0".to_string(), 0, vec![0x95, 0x00, 0x00]).unwrap(), // Only 3 bytes
            ],
            relocations: vec![],
        };

        let result = program.to_ixs();
        assert!(result.is_err());
        assert!(matches!(
            result.unwrap_err(),
            crate::errors::DisassemblerError::InvalidDataLength
        ));
    }

    #[test]
    fn test_to_ixs_with_lddw() {
        // Test with 16 bytes lddw instruction

        let mut lddw_bytes = vec![0x18, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00];
        lddw_bytes.extend_from_slice(&[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]);
        lddw_bytes.extend_from_slice(&[0x95, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]); // exit

        let program = Program {
            elf_header: ELFHeader {
                ei_magic: [127, 69, 76, 70],
                ei_class: 2,
                ei_data: 1,
                ei_version: 1,
                ei_osabi: 0,
                ei_abiversion: 0,
                ei_pad: [0; 7],
                e_type: 0,
                e_machine: E_MACHINE_SBPF,
                e_version: 0,
                e_entry: 0,
                e_phoff: 0,
                e_shoff: 0,
                e_flags: 0,
                e_ehsize: 0,
                e_phentsize: 0,
                e_phnum: 0,
                e_shentsize: 0,
                e_shnum: 0,
                e_shstrndx: 0,
            },
            program_headers: vec![],
            section_headers: vec![],
            section_header_entries: vec![
                SectionHeaderEntry::new(".text\0".to_string(), 0, lddw_bytes).unwrap(),
            ],
            relocations: vec![],
        };

        let (ixs, _, _) = program.to_ixs().unwrap();
        assert_eq!(ixs.len(), 2); // lddw + exit
        assert_eq!(ixs[0].opcode, sbpf_common::opcode::Opcode::Lddw);
    }

    #[test]
    fn test_to_ixs_sbpf_v2() {
        // Use a v2 opcode (0x8C -> ldxw in v2)
        let v2_bytes = vec![0x8c, 0x12, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00];

        let program = Program {
            elf_header: ELFHeader {
                ei_magic: [127, 69, 76, 70],
                ei_class: 2,
                ei_data: 1,
                ei_version: 1,
                ei_osabi: 0,
                ei_abiversion: 0,
                ei_pad: [0; 7],
                e_type: 0,
                e_machine: E_MACHINE_SBPF,
                e_version: 0,
                e_entry: 0,
                e_phoff: 0,
                e_shoff: 0,
                e_flags: 0x02, // SBPF v2 flag
                e_ehsize: 0,
                e_phentsize: 0,
                e_phnum: 0,
                e_shentsize: 0,
                e_shnum: 0,
                e_shstrndx: 0,
            },
            program_headers: vec![],
            section_headers: vec![],
            section_header_entries: vec![
                SectionHeaderEntry::new(".text\0".to_string(), 0, v2_bytes).unwrap(),
            ],
            relocations: vec![],
        };

        let (ixs, _, _) = program.to_ixs().unwrap();
        assert_eq!(ixs.len(), 1);
        assert_eq!(ixs[0].opcode, sbpf_common::opcode::Opcode::Ldxw);
    }
}