1/*
2 * Copyright (c) 2002-2004 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Nathan Binkert
29 * Steve Reinhardt
30 */
31
32#ifndef __OBJECT_FILE_HH__
33#define __OBJECT_FILE_HH__
34
35#include <limits>
36#include <string>
37
38#include "base/logging.hh"
39#include "base/types.hh"
40
41class PortProxy;
42class SymbolTable;
43
44class ObjectFile
45{
46 public:
47
48 enum Arch {
49 UnknownArch,
50 Alpha,
51 SPARC64,
52 SPARC32,
53 Mips,
54 X86_64,
55 I386,
56 Arm64,
57 Arm,
58 Thumb,
59 Power,
60 Riscv64,
61 Riscv32
62 };
63
64 enum OpSys {
65 UnknownOpSys,
66 Tru64,
67 Linux,
68 Solaris,
69 LinuxArmOABI,
70 FreeBSD
71 };
72
73 protected:
74 const std::string filename;
75 uint8_t *fileData;
76 size_t len;
77
78 Arch arch;
79 OpSys opSys;
80
81 ObjectFile(const std::string &_filename, size_t _len, uint8_t *_data,
82 Arch _arch, OpSys _opSys);
83
84 public:
85 virtual ~ObjectFile();
86
87 static const Addr maxAddr = std::numeric_limits<Addr>::max();
88
89 virtual bool loadSections(PortProxy& mem_proxy,
90 Addr mask = maxAddr, Addr offset = 0);
91
92 virtual bool loadAllSymbols(SymbolTable *symtab, Addr base = 0,
93 Addr offset = 0, Addr mask = maxAddr) = 0;
94 virtual bool loadGlobalSymbols(SymbolTable *symtab, Addr base = 0,
95 Addr offset = 0, Addr mask = maxAddr) = 0;
96 virtual bool loadLocalSymbols(SymbolTable *symtab, Addr base = 0,
97 Addr offset = 0, Addr mask = maxAddr) = 0;
98 virtual bool loadWeakSymbols(SymbolTable *symtab, Addr base = 0,
99 Addr offset = 0, Addr mask = maxAddr)
100 { return false; }
101
102 virtual ObjectFile *getInterpreter() const { return nullptr; }
103 virtual bool relocatable() const { return false; }
104 virtual Addr mapSize() const
105 { panic("mapSize() should only be called on relocatable objects\n"); }
106 virtual void updateBias(Addr bias_addr)
107 { panic("updateBias() should only be called on relocatable objects\n"); }
108 virtual Addr bias() const { return 0; }
109
110 virtual bool hasTLS() { return false; }
111
112 Arch getArch() const { return arch; }
113 OpSys getOpSys() const { return opSys; }
114
115 protected:
116
117 struct Section {
118 Addr baseAddr;
119 uint8_t *fileImage;
120 size_t size;
121 };
122
123 Addr entry;
124 Addr globalPtr;
125
126 Section text;
127 Section data;
128 Section bss;
129
130 bool loadSection(Section *sec, PortProxy& mem_proxy, Addr mask,
131 Addr offset = 0);
132 void setGlobalPointer(Addr global_ptr) { globalPtr = global_ptr; }
133
134 public:
135 Addr entryPoint() const { return entry; }
136
137 Addr globalPointer() const { return globalPtr; }
138
139 Addr textBase() const { return text.baseAddr; }
140 Addr dataBase() const { return data.baseAddr; }
141 Addr bssBase() const { return bss.baseAddr; }
142
143 size_t textSize() const { return text.size; }
144 size_t dataSize() const { return data.size; }
145 size_t bssSize() const { return bss.size; }
146
147 /* This function allows you to override the base address where
148 * a binary is going to be loaded or set it if the binary is just a
149 * blob that doesn't include an object header.
150 * @param a address to load the binary/text section at
151 */
152 void setTextBase(Addr a) { text.baseAddr = a; }
153};
154
155ObjectFile *createObjectFile(const std::string &fname, bool raw = false);
156
157
158#endif // __OBJECT_FILE_HH__