elfio 0.3.3

/*
Copyright (C) 2021-present by Serge Lamikhov-Center

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/

use std::fs::File;
use std::io;
use std::io::{BufReader, Error};

use elfio::*;

#[test]
fn sym_le_32() -> io::Result<()> {
    let elf_file = File::open("tests/files/hello_32")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".symtab") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let symtab = SymbolSectionAccessor::new(&elf, &*section);
    assert_eq!(symtab.get_symbols_num(), 0x44);
    // Num:    Value  Size Type    Bind   Vis      Ndx Name
    //  30: 08049588     4 OBJECT  LOCAL  DEFAULT   23 dtor_idx.5805
    let sym = symtab.get_symbol(30).unwrap();
    assert_eq!(sym.value, 0x08049588);
    assert_eq!(sym.size, 4);
    assert_eq!(sym.bind, constant::STB_LOCAL);
    assert_eq!(sym.stype, constant::STT_OBJECT);
    assert_eq!(sym.shndx, 23);
    assert_eq!(sym.name, "dtor_idx.5805");

    Ok(())
}

#[test]
fn sym_le_64() -> io::Result<()> {
    let elf_file = File::open("tests/files/hello_64")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".symtab") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let symtab = SymbolSectionAccessor::new(&elf, &*section);
    assert_eq!(symtab.get_symbols_num(), 0x43);

    let sym = symtab.get_symbol(33).unwrap();
    // 33: 0000000000400410     0 FUNC    LOCAL  DEFAULT   12 __do_global_dtors_aux
    assert_eq!(sym.value, 0x400410);
    assert_eq!(sym.size, 0);
    assert_eq!(sym.bind, constant::STB_LOCAL);
    assert_eq!(sym.stype, constant::STT_FUNC);
    assert_eq!(sym.shndx, 12);
    assert_eq!(sym.name, "__do_global_dtors_aux");

    Ok(())
}

#[test]
fn sym_be_32() -> io::Result<()> {
    let elf_file = File::open("tests/files/hello_ppc")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".symtab") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let symtab = SymbolSectionAccessor::new(&elf, &*section);
    assert_eq!(symtab.get_symbols_num(), 0x50);

    let sym = symtab.get_symbol(34).unwrap();
    // 34: 10010c98     1 OBJECT  LOCAL  DEFAULT   24 completed.6348
    assert_eq!(sym.value, 0x10010c98);
    assert_eq!(sym.size, 1);
    assert_eq!(sym.bind, constant::STB_LOCAL);
    assert_eq!(sym.stype, constant::STT_OBJECT);
    assert_eq!(sym.shndx, 24);
    assert_eq!(sym.name, "completed.6348");

    Ok(())
}

#[test]
fn sym_be_64() -> io::Result<()> {
    let elf_file = File::open("tests/files/hello_ppc64")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".dynsym") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let symtab = SymbolSectionAccessor::new(&elf, &*section);
    assert_eq!(symtab.get_symbols_num(), 0x19);

    let sym = symtab.get_symbol(24).unwrap();
    // 24: 000000000001fc18   108 FUNC    GLOBAL DEFAULT   21 error
    assert_eq!(sym.value, 0x1fc18);
    assert_eq!(sym.size, 108);
    assert_eq!(sym.bind, constant::STB_GLOBAL);
    assert_eq!(sym.stype, constant::STT_FUNC);
    assert_eq!(sym.shndx, 21);
    assert_eq!(sym.name, "error");

    Ok(())
}

#[test]
fn note_le_32() -> io::Result<()> {
    let elf_file = File::open("tests/files/hello_32")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".note.ABI-tag") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let notes = NoteSectionAccessor::new(&elf, section);

    assert_eq!(notes.get_notes_num(), 1);

    let note = notes.get_note(0).unwrap();
    assert_eq!(note.ntype, 1);
    assert_eq!(note.name, "GNU");
    assert_eq!(
        note.description,
        vec![0u8, 0u8, 0u8, 0u8, 2u8, 0u8, 0u8, 0u8, 6u8, 0u8, 0u8, 0u8, 9u8, 0u8, 0u8, 0u8]
    );

    Ok(())
}

#[test]
fn note_le_64() -> io::Result<()> {
    let elf_file = File::open("tests/files/hello_64")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".note.ABI-tag") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let notes = NoteSectionAccessor::new(&elf, section);

    assert_eq!(notes.get_notes_num(), 1);

    let note = notes.get_note(0).unwrap();
    assert_eq!(note.ntype, 1);
    assert_eq!(note.name, "GNU");
    assert_eq!(
        note.description,
        vec![0, 0, 0, 0, 2, 0, 0, 0, 6, 0, 0, 0, 9, 0, 0, 0]
    );

    Ok(())
}

#[test]
fn note_be_32() -> io::Result<()> {
    let elf_file = File::open("tests/files/hello_ppc")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".note.ABI-tag") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let notes = NoteSectionAccessor::new(&elf, section);

    assert_eq!(notes.get_notes_num(), 1);

    let note = notes.get_note(0).unwrap();
    assert_eq!(note.ntype, 1);
    assert_eq!(note.name, "GNU");
    assert_eq!(
        note.description,
        vec![0, 0, 0, 0, 0, 0, 0, 2, 0, 0, 0, 6, 0, 0, 0, 10]
    );

    Ok(())
}

#[test]
fn note_be_64() -> io::Result<()> {
    let elf_file = File::open("tests/files/hello_ppc64")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".note.ABI-tag") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let notes = NoteSectionAccessor::new(&elf, section);

    assert_eq!(notes.get_notes_num(), 1);

    let note = notes.get_note(0).unwrap();
    assert_eq!(note.ntype, 1);
    assert_eq!(note.name, "GNU");
    assert_eq!(
        note.description,
        vec![0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 0, 2, 0, 0, 0, 0]
    );

    Ok(())
}

#[test]
fn rel_le_32() -> io::Result<()> {
    let elf_file = File::open("tests/files/hello_32")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".rel.plt") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let relocs = RelocationSectionAccessor::new(&elf, section);

    assert_eq!(relocs.get_entries_num(), 3);

    // 0804957c  00000207 R_386_JUMP_SLOT   00000000   __libc_start_main@GLIBC_2.0
    let rel = relocs.get_entry(1).unwrap();
    assert_eq!(rel.offset, 0x0804957C);
    assert_eq!(rel.symbol, 2);
    assert_eq!(rel.rtype, 7);
    assert_eq!(rel.addend, None);

    Ok(())
}

#[test]
fn rel_le_64() -> io::Result<()> {
    let elf_file = File::open("tests/files/hello_64")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".rela.plt") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let relocs = RelocationSectionAccessor::new(&elf, section);

    assert_eq!(relocs.get_entries_num(), 2);

    // 000000600850  000300000007 R_X86_64_JUMP_SLO 0000000000000000 __libc_start_main@GLIBC_2.2.5 + 0
    let rel = relocs.get_entry(1).unwrap();
    assert_eq!(rel.offset, 0x000000600850);
    assert_eq!(rel.symbol, 3);
    assert_eq!(rel.rtype, 7);
    assert_eq!(rel.addend, Some(0));

    Ok(())
}

#[test]
fn rel_be_32() -> io::Result<()> {
    let elf_file = File::open("tests/files/hello_ppc")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".rela.plt") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let relocs = RelocationSectionAccessor::new(&elf, section);

    assert_eq!(relocs.get_entries_num(), 9);

    // 10010bf4  00000615 R_PPC_JMP_SLOT    10000920   _ZNSt8ios_base4In[...]@GLIBCXX_3.4 + 0
    let rel = relocs.get_entry(4).unwrap();
    assert_eq!(rel.offset, 0x10010bf4);
    assert_eq!(rel.symbol, 6);
    assert_eq!(rel.rtype, 0x15);
    assert_eq!(rel.addend, Some(0));

    Ok(())
}

#[test]
fn rel_be_64() -> io::Result<()> {
    let elf_file = File::open("tests/files/hello_ppc64")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".rela.plt") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let relocs = RelocationSectionAccessor::new(&elf, section);

    assert_eq!(relocs.get_entries_num(), 17);

    // 0000001fee8  001700000015 R_PPC64_JMP_SLOT  0000000000000000 exit@GLIBC_2.3 + 0
    let rel = relocs.get_entry(16).unwrap();
    assert_eq!(rel.offset, 0x1fee8);
    assert_eq!(rel.symbol, 0x17);
    assert_eq!(rel.rtype, 0x15);
    assert_eq!(rel.addend, Some(0));

    Ok(())
}

#[test]
fn dyn_le_32() -> io::Result<()> {
    let elf_file = File::open("tests/files/hello_32")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".dynamic") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let dyns = DynamicSectionAccessor::new(&elf, section);

    assert_eq!(dyns.get_entries_num(), 20);

    // Dynamic section at offset 0x4a0 contains 20 entries:
    //   Tag        Type                         Name/Value
    //  0x00000001 (NEEDED)                     Shared library: [libc.so.6]
    //  0x0000000c (INIT)                       0x804824c
    //  0x0000000d (FINI)                       0x8048458
    //  0x6ffffef5 (GNU_HASH)                   0x8048148
    //  0x00000005 (STRTAB)                     0x80481b8
    let dynamic = dyns.get_entry(3).unwrap();
    assert_eq!(dynamic.tag, 0x6ffffef5);
    assert_eq!(dynamic.value, 0x8048148);

    let dynamic = dyns.get_entry(4).unwrap();
    assert_eq!(dynamic.tag, 0x00000005);
    assert_eq!(dynamic.value, 0x80481b8);

    Ok(())
}

#[test]
fn dyn_le_64() -> io::Result<()> {
    let elf_file = File::open("tests/files/hello_64")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".dynamic") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let dyns = DynamicSectionAccessor::new(&elf, section);

    assert_eq!(dyns.get_entries_num(), 20);

    // Dynamic section at offset 0x698 contains 20 entries:
    //   Tag        Type                         Name/Value
    //  0x0000000000000001 (NEEDED)             Shared library: [libc.so.6]
    //  0x000000000000000c (INIT)               0x400370
    //  0x000000000000000d (FINI)               0x400588
    //  0x000000006ffffef5 (GNU_HASH)           0x400240
    //  0x0000000000000005 (STRTAB)             0x4002c0
    let dynamic = dyns.get_entry(3).unwrap();
    assert_eq!(dynamic.tag, 0x6ffffef5);
    assert_eq!(dynamic.value, 0x400240);

    let dynamic = dyns.get_entry(4).unwrap();
    assert_eq!(dynamic.tag, 0x00000005);
    assert_eq!(dynamic.value, 0x4002c0);

    Ok(())
}

#[test]
fn dyn_be_32() -> io::Result<()> {
    let elf_file = File::open("tests/files/hello_ppc")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".dynamic") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let dyns = DynamicSectionAccessor::new(&elf, section);

    assert_eq!(dyns.get_entries_num(), 24);

    // Dynamic section at offset 0xaec contains 24 entries:
    //   Tag        Type                         Name/Value
    //  0x00000001 (NEEDED)                     Shared library: [libstdc++.so.6]
    //  0x00000001 (NEEDED)                     Shared library: [libm.so.6]
    //  0x00000001 (NEEDED)                     Shared library: [libgcc_s.so.1]
    //  0x00000001 (NEEDED)                     Shared library: [libc.so.6]
    //  0x0000000c (INIT)                       0x10000500
    let dynamic = dyns.get_entry(3).unwrap();
    assert_eq!(dynamic.tag, 0x00000001);
    let strsection = match elf.get_section_by_name(&".dynstr") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };
    let dynstr = StringSectionAccessor::new(&elf, strsection);
    assert_eq!(dynstr.get_string(dynamic.value as ElfWord), "libc.so.6");

    let dynamic = dyns.get_entry(4).unwrap();
    assert_eq!(dynamic.tag, 0x0000000c);
    assert_eq!(dynamic.value, 0x10000500);

    Ok(())
}

#[test]
fn dyn_be_64() -> io::Result<()> {
    let elf_file = File::open("tests/files/hello_ppc64")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".dynamic") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let dyns = DynamicSectionAccessor::new(&elf, section);

    assert_eq!(dyns.get_entries_num(), 28);

    // Dynamic section at offset 0xf880 contains 28 entries:
    //   Tag        Type                         Name/Value
    //  0x0000000000000001 (NEEDED)             Shared library: [libc.so.6]
    //  0x000000000000000c (INIT)               0x1fa98
    //  0x000000000000000d (FINI)               0x1fab0
    //  0x0000000000000019 (INIT_ARRAY)         0x1f850
    //  0x000000000000001b (INIT_ARRAYSZ)       8 (bytes)
    //  0x000000000000001a (FINI_ARRAY)         0x1f858
    let dynamic = dyns.get_entry(0).unwrap();
    assert_eq!(dynamic.tag, 0x00000001);
    let strsection = match elf.get_section_by_name(&".dynstr") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };
    let dynstr = StringSectionAccessor::new(&elf, strsection);
    assert_eq!(dynstr.get_string(dynamic.value as ElfWord), "libc.so.6");

    let dynamic = dyns.get_entry(4).unwrap();
    assert_eq!(dynamic.tag, 0x0000001b);
    assert_eq!(dynamic.value, 8);

    let dynamic = dyns.get_entry(5).unwrap();
    assert_eq!(dynamic.tag, 0x0000001a);
    assert_eq!(dynamic.value, 0x1f858);

    Ok(())
}

#[test]
fn array_le_32() -> io::Result<()> {
    let elf_file = File::open("tests/files/hello_32")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".ctors") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let array = ArraySectionAccessor::new(&elf, section);

    assert_eq!(array.get_entries_num(), 2);

    let element = array.get_entry(0).unwrap();
    assert_eq!(element.value, 0xFFFFFFFF);
    let element = array.get_entry(1).unwrap();
    assert_eq!(element.value, 0x00000000);

    Ok(())
}

#[test]
fn array_le_64() -> io::Result<()> {
    let elf_file = File::open("tests/files/hello_64")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".dtors") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let array = ArraySectionAccessor::new(&elf, section);

    assert_eq!(array.get_entries_num(), 2);

    let element = array.get_entry(0).unwrap();
    assert_eq!(element.value, 0xFFFFFFFFFFFFFFFF);
    let element = array.get_entry(1).unwrap();
    assert_eq!(element.value, 0x00000000);

    Ok(())
}

#[test]
fn array_be_32() -> io::Result<()> {
    let elf_file = File::open("tests/files/hello_ppc")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".ctors") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let array = ArraySectionAccessor::new(&elf, section);

    assert_eq!(array.get_entries_num(), 3);

    let element = array.get_entry(0).unwrap();
    assert_eq!(element.value, 0xFFFFFFFF);
    let element = array.get_entry(1).unwrap();
    assert_eq!(element.value, 0x10000778);
    let element = array.get_entry(2).unwrap();
    assert_eq!(element.value, 0x00000000);

    Ok(())
}

#[test]
fn array_be_64() -> io::Result<()> {
    let elf_file = File::open("tests/files/hello_ppc64")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".fini_array") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let array = ArraySectionAccessor::new(&elf, section);

    assert_eq!(array.get_entries_num(), 1);

    let element = array.get_entry(0).unwrap();
    assert_eq!(element.value, 0x000000000001faf8);

    Ok(())
}

#[test]
fn modinfo_le_32() -> io::Result<()> {
    let elf_file = File::open("tests/files/i2c-gpio.ko")?;
    let mut reader = BufReader::new(elf_file);

    let mut elf = Elfio::new();

    elf.load(&mut reader)?;

    let section = match elf.get_section_by_name(&".modinfo") {
        Some(s) => s,
        None => return Err(Error::new(io::ErrorKind::Other, "section not found")),
    };

    let modinfo = ModInfoSectionAccessor::new(&elf, section);

    assert_eq!(modinfo.get_entries_num(), 10);
    assert_eq!(modinfo.get(&"description".to_string()).unwrap(), "Platform-independent bitbanging I2C driver");

    Ok(())
}