84b73b0a864ab2a2214b35a8fc046a247249ad7c
[gem5.git] / src / base / loader / elf_object.hh
1 /*
2 * Copyright (c) 2013 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 2003-2005 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Steve Reinhardt
41 */
42
43 #ifndef __ELF_OBJECT_HH__
44 #define __ELF_OBJECT_HH__
45
46 #include <set>
47 #include <vector>
48
49 #include "base/loader/object_file.hh"
50
51 class ElfObject : public ObjectFile
52 {
53 protected:
54
55 //The global definition of a "Section" is closest to elf's segments.
56 typedef ObjectFile::Section Segment;
57
58 //These values are provided to a linux process by the kernel, so we
59 //need to keep them around.
60 Addr _programHeaderTable;
61 uint16_t _programHeaderSize;
62 uint16_t _programHeaderCount;
63 std::set<std::string> sectionNames;
64
65 /// Helper functions for loadGlobalSymbols() and loadLocalSymbols().
66 bool loadSomeSymbols(SymbolTable *symtab, int binding, Addr mask);
67
68 ElfObject(const std::string &_filename, int _fd,
69 size_t _len, uint8_t *_data,
70 Arch _arch, OpSys _opSys);
71
72 void getSections();
73 bool sectionExists(std::string sec);
74
75 std::vector<Segment> extraSegments;
76
77 public:
78 virtual ~ElfObject() {}
79
80 bool loadSections(PortProxy& memProxy,
81 Addr addrMask = std::numeric_limits<Addr>::max(),
82 Addr offset = 0);
83 virtual bool loadGlobalSymbols(SymbolTable *symtab, Addr addrMask =
84 std::numeric_limits<Addr>::max());
85 virtual bool loadLocalSymbols(SymbolTable *symtab, Addr addrMask =
86 std::numeric_limits<Addr>::max());
87 virtual bool loadWeakSymbols(SymbolTable *symtab, Addr addrMask =
88 std::numeric_limits<Addr>::max());
89
90 virtual bool isDynamic() { return sectionExists(".interp"); }
91 virtual bool hasTLS() { return sectionExists(".tbss"); }
92
93 static ObjectFile *tryFile(const std::string &fname, int fd,
94 size_t len, uint8_t *data);
95 Addr programHeaderTable() {return _programHeaderTable;}
96 uint16_t programHeaderSize() {return _programHeaderSize;}
97 uint16_t programHeaderCount() {return _programHeaderCount;}
98 };
99
100 #endif // __ELF_OBJECT_HH__