object 0.22.0

A unified interface for reading and writing object file formats.
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

use core::fmt::Debug;
use core::{iter, slice, str};

use crate::elf;
use crate::endian::{Endianness, U32Bytes};
use crate::pod::Bytes;
use crate::read::{self, ComdatKind, ObjectComdat, ReadError, SectionIndex, SymbolIndex};

use super::{ElfFile, FileHeader, SectionHeader, Sym};

/// An iterator over the COMDAT section groups of an `ElfFile32`.
pub type ElfComdatIterator32<'data, 'file, Endian = Endianness> =
    ElfComdatIterator<'data, 'file, elf::FileHeader32<Endian>>;
/// An iterator over the COMDAT section groups of an `ElfFile64`.
pub type ElfComdatIterator64<'data, 'file, Endian = Endianness> =
    ElfComdatIterator<'data, 'file, elf::FileHeader64<Endian>>;

/// An iterator over the COMDAT section groups of an `ElfFile`.
#[derive(Debug)]
pub struct ElfComdatIterator<'data, 'file, Elf>
where
    'data: 'file,
    Elf: FileHeader,
{
    pub(super) file: &'file ElfFile<'data, Elf>,
    pub(super) iter: iter::Enumerate<slice::Iter<'data, Elf::SectionHeader>>,
}

impl<'data, 'file, Elf: FileHeader> Iterator for ElfComdatIterator<'data, 'file, Elf> {
    type Item = ElfComdat<'data, 'file, Elf>;

    fn next(&mut self) -> Option<Self::Item> {
        while let Some((index, section)) = self.iter.next() {
            if let Some(comdat) = ElfComdat::parse(self.file, index, section) {
                return Some(comdat);
            }
        }
        None
    }
}

/// A COMDAT section group of an `ElfFile32`.
pub type ElfComdat32<'data, 'file, Endian = Endianness> =
    ElfComdat<'data, 'file, elf::FileHeader32<Endian>>;
/// A COMDAT section group of an `ElfFile64`.
pub type ElfComdat64<'data, 'file, Endian = Endianness> =
    ElfComdat<'data, 'file, elf::FileHeader64<Endian>>;

/// A COMDAT section group of an `ElfFile`.
#[derive(Debug)]
pub struct ElfComdat<'data, 'file, Elf>
where
    'data: 'file,
    Elf: FileHeader,
{
    file: &'file ElfFile<'data, Elf>,
    index: SectionIndex,
    section: &'data Elf::SectionHeader,
    data: Bytes<'data>,
}

impl<'data, 'file, Elf: FileHeader> ElfComdat<'data, 'file, Elf> {
    fn parse(
        file: &'file ElfFile<'data, Elf>,
        index: usize,
        section: &'data Elf::SectionHeader,
    ) -> Option<ElfComdat<'data, 'file, Elf>> {
        if section.sh_type(file.endian) != elf::SHT_GROUP {
            return None;
        }
        let mut data = section.data(file.endian, file.data).ok()?;
        let flags = data.read::<U32Bytes<_>>().ok()?;
        if flags.get(file.endian) != elf::GRP_COMDAT {
            return None;
        }
        Some(ElfComdat {
            file,
            index: SectionIndex(index),
            section,
            data,
        })
    }
}

impl<'data, 'file, Elf: FileHeader> read::private::Sealed for ElfComdat<'data, 'file, Elf> {}

impl<'data, 'file, Elf: FileHeader> ObjectComdat<'data> for ElfComdat<'data, 'file, Elf> {
    type SectionIterator = ElfComdatSectionIterator<'data, 'file, Elf>;

    #[inline]
    fn kind(&self) -> ComdatKind {
        ComdatKind::Any
    }

    #[inline]
    fn symbol(&self) -> SymbolIndex {
        SymbolIndex(self.section.sh_info(self.file.endian) as usize)
    }

    fn name(&self) -> read::Result<&str> {
        // FIXME: check sh_link
        let index = self.section.sh_info(self.file.endian) as usize;
        let symbol = self.file.symbols.symbol(index)?;
        let name = symbol.name(self.file.endian, self.file.symbols.strings())?;
        str::from_utf8(name)
            .ok()
            .read_error("Non UTF-8 ELF COMDAT name")
    }

    fn sections(&self) -> Self::SectionIterator {
        ElfComdatSectionIterator {
            file: self.file,
            data: self.data,
        }
    }
}

/// An iterator over the sections in a COMDAT section group of an `ElfFile32`.
pub type ElfComdatSectionIterator32<'data, 'file, Endian = Endianness> =
    ElfComdatSectionIterator<'data, 'file, elf::FileHeader32<Endian>>;
/// An iterator over the sections in a COMDAT section group of an `ElfFile64`.
pub type ElfComdatSectionIterator64<'data, 'file, Endian = Endianness> =
    ElfComdatSectionIterator<'data, 'file, elf::FileHeader64<Endian>>;

/// An iterator over the sections in a COMDAT section group of an `ElfFile`.
#[derive(Debug)]
pub struct ElfComdatSectionIterator<'data, 'file, Elf>
where
    'data: 'file,
    Elf: FileHeader,
{
    file: &'file ElfFile<'data, Elf>,
    data: Bytes<'data>,
}

impl<'data, 'file, Elf: FileHeader> Iterator for ElfComdatSectionIterator<'data, 'file, Elf> {
    type Item = SectionIndex;

    fn next(&mut self) -> Option<Self::Item> {
        if self.data.is_empty() {
            None
        } else {
            let index = self.data.read::<U32Bytes<_>>().ok()?;
            Some(SectionIndex(index.get(self.file.endian) as usize))
        }
    }
}