aboutsummaryrefslogtreecommitdiff
path: root/paludis/util/elf.hh
blob: ee002622094bbdbd5b153c6c5c668b0b6515e786 (plain)
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
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2007 Tiziano Müller
 * Copyright (c) 2007 David Leverton
 *
 * This file is part of the Paludis package manager. Paludis is free software;
 * you can redistribute it and/or modify it under the terms of the GNU General
 * Public License version 2, as published by the Free Software Foundation.
 *
 * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef PALUDIS_GUARD_PALUDIS_UTIL_ELF_HH
#define PALUDIS_GUARD_PALUDIS_UTIL_ELF_HH 1

#include <paludis/util/elf_sections.hh>
#include <paludis/util/exception.hh>
#include <paludis/util/iterator_range.hh>
#include <paludis/util/pimp.hh>
#include <paludis/util/wrapped_forward_iterator-fwd.hh>
#include <iosfwd>

#include <elf.h>

namespace paludis
{
    class InvalidElfFileError :
        public paludis::Exception
    {
        public:
            InvalidElfFileError(const InvalidElfFileError &) = default;
            InvalidElfFileError(const std::string &) noexcept;
    };

    template <typename ElfType_>
    struct ElfObjectSectionIteratorTag;

    template <typename ElfType_>
    class PALUDIS_VISIBLE ElfObject
    {
        private:
            Pimp<ElfObject> _imp;

            typename ElfType_::Header _hdr;

        public:
            static bool is_valid_elf(std::istream & stream);
            ElfObject(std::istream & stream);
            ~ElfObject();

            /**
             * Returns e_type from the ELF header
             */
            unsigned int get_type() const
            {
                return _hdr.e_type;
            }

            /**
             * Returns e_machine from the ELF header
             */
            unsigned int get_arch() const
            {
                return _hdr.e_machine;
            }

            /**
             * Returns the OS ABI field from the ident field
             */
            unsigned char get_os_abi() const
            {
                return _hdr.e_ident[EI_OSABI];
            }

            /**
             * Returns the OS ABI Version field from the ident field
             */
            unsigned char get_os_abi_version() const
            {
                return _hdr.e_ident[EI_ABIVERSION];
            }

            /**
             * Returns the processor-specific flags
             */
            unsigned int get_flags() const
            {
                return _hdr.e_flags;
            }

            /**
             * Returns whether this ELF file uses big-endian or little-endian
             * Please note: If you didn't use is_valid_elf(...) to check whether
             * this is an ELF object, this might be wrong
             */
            unsigned int is_big_endian() const
            {
                // We already checked in is_valid_elf_type whether it's valid or not
                return (_hdr.e_ident[EI_DATA] == ELFDATA2MSB);
            }

            unsigned int get_number_of_sections() const
            {
                return _hdr.e_shnum;
            }

            typedef ElfObjectSectionIteratorTag<ElfType_> SectionIteratorTag;
            typedef paludis::WrappedForwardIterator<SectionIteratorTag, Section<ElfType_> > SectionIterator;
            SectionIterator section_begin() const;
            SectionIterator section_end() const;
            IteratorRange<SectionIterator> sections() const noexcept
            {
                return {section_begin(), section_end()};
            }

            SectionIterator get_section_by_index(unsigned int index) const;

            void resolve_all_strings();
    };
}

#endif