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
|
/*
* Copyright (c) 2002-2004 The Regents of The University of Michigan
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met: redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer;
* redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution;
* neither the name of the copyright holders nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* Authors: Nathan Binkert
* Steve Reinhardt
*/
#ifndef __OBJECT_FILE_HH__
#define __OBJECT_FILE_HH__
#include <limits>
#include <string>
#include "base/logging.hh"
#include "base/types.hh"
class PortProxy;
class Process;
class ProcessParams;
class SymbolTable;
class ObjectFile
{
public:
enum Arch {
UnknownArch,
Alpha,
SPARC64,
SPARC32,
Mips,
X86_64,
I386,
Arm64,
Arm,
Thumb,
Power,
Riscv64,
Riscv32
};
enum OpSys {
UnknownOpSys,
Tru64,
Linux,
Solaris,
LinuxArmOABI,
FreeBSD
};
protected:
const std::string filename;
uint8_t *fileData;
size_t len;
Arch arch;
OpSys opSys;
ObjectFile(const std::string &_filename, size_t _len, uint8_t *_data,
Arch _arch, OpSys _opSys);
public:
virtual ~ObjectFile();
static const Addr maxAddr = std::numeric_limits<Addr>::max();
virtual bool loadSections(const PortProxy& mem_proxy,
Addr mask = maxAddr, Addr offset = 0);
virtual bool loadAllSymbols(SymbolTable *symtab, Addr base = 0,
Addr offset = 0, Addr mask = maxAddr) = 0;
virtual bool loadGlobalSymbols(SymbolTable *symtab, Addr base = 0,
Addr offset = 0, Addr mask = maxAddr) = 0;
virtual bool loadLocalSymbols(SymbolTable *symtab, Addr base = 0,
Addr offset = 0, Addr mask = maxAddr) = 0;
virtual bool loadWeakSymbols(SymbolTable *symtab, Addr base = 0,
Addr offset = 0, Addr mask = maxAddr)
{ return false; }
virtual ObjectFile *getInterpreter() const { return nullptr; }
virtual bool relocatable() const { return false; }
virtual Addr mapSize() const
{ panic("mapSize() should only be called on relocatable objects\n"); }
virtual void updateBias(Addr bias_addr)
{ panic("updateBias() should only be called on relocatable objects\n"); }
virtual Addr bias() const { return 0; }
virtual bool hasTLS() { return false; }
Arch getArch() const { return arch; }
OpSys getOpSys() const { return opSys; }
protected:
struct Section {
Addr baseAddr;
uint8_t *fileImage;
size_t size;
};
Addr entry;
Section text;
Section data;
Section bss;
bool loadSection(Section *sec, const PortProxy& mem_proxy, Addr mask,
Addr offset = 0);
public:
Addr entryPoint() const { return entry; }
Addr textBase() const { return text.baseAddr; }
Addr dataBase() const { return data.baseAddr; }
Addr bssBase() const { return bss.baseAddr; }
size_t textSize() const { return text.size; }
size_t dataSize() const { return data.size; }
size_t bssSize() const { return bss.size; }
/* This function allows you to override the base address where
* a binary is going to be loaded or set it if the binary is just a
* blob that doesn't include an object header.
* @param a address to load the binary/text section at
*/
void setTextBase(Addr a) { text.baseAddr = a; }
/**
* Each instance of a Loader subclass will have a chance to try to load
* an object file when tryLoaders is called. If they can't because they
* aren't compatible with it (wrong arch, wrong OS, etc), then they
* silently fail by returning nullptr so other loaders can try.
*/
class Loader
{
public:
Loader();
/* Loader instances are singletons. */
Loader(const Loader &) = delete;
void operator=(const Loader &) = delete;
virtual ~Loader() {}
/**
* Each subclass needs to implement this method. If the loader is
* compatible with the passed in object file, it should return the
* created Process object corresponding to it. If not, it should fail
* silently and return nullptr. If there's a non-compatibliity related
* error like file IO errors, etc., those should fail non-silently
* with a panic or fail as normal.
*/
virtual Process *load(ProcessParams *params, ObjectFile *obj_file) = 0;
};
// Try all the Loader instance's "load" methods one by one until one is
// successful. If none are, complain and fail.
static Process *tryLoaders(ProcessParams *params, ObjectFile *obj_file);
};
ObjectFile *createObjectFile(const std::string &fname, bool raw = false);
#endif // __OBJECT_FILE_HH__
|
