object_file.hh revision 10810 
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/types.hh"
39
40class PortProxy;
41class SymbolTable;
42
43class ObjectFile
44{
45  public:
46
47    enum Arch {
48        UnknownArch,
49        Alpha,
50        SPARC64,
51        SPARC32,
52        Mips,
53        X86_64,
54        I386,
55        Arm64,
56        Arm,
57        Thumb,
58        Power
59    };
60
61    enum OpSys {
62        UnknownOpSys,
63        Tru64,
64        Linux,
65        Solaris,
66        LinuxArmOABI,
67        FreeBSD
68    };
69
70  protected:
71    const std::string filename;
72    int descriptor;
73    uint8_t *fileData;
74    size_t len;
75
76    Arch  arch;
77    OpSys opSys;
78
79    ObjectFile(const std::string &_filename, int _fd,
80               size_t _len, uint8_t *_data,
81               Arch _arch, OpSys _opSys);
82
83  public:
84    virtual ~ObjectFile();
85
86    void close();
87
88    virtual bool loadSections(PortProxy& memProxy, Addr addrMask =
89                              std::numeric_limits<Addr>::max(),
90                              Addr offset = 0);
91    virtual bool loadGlobalSymbols(SymbolTable *symtab, Addr addrMask =
92            std::numeric_limits<Addr>::max()) = 0;
93    virtual bool loadLocalSymbols(SymbolTable *symtab, Addr addrMask =
94            std::numeric_limits<Addr>::max()) = 0;
95    virtual bool loadWeakSymbols(SymbolTable *symtab, Addr addrMask =
96            std::numeric_limits<Addr>::max())
97    { return false; }
98
99    virtual bool isDynamic() { return false; }
100    virtual bool hasTLS() { return false; }
101
102    Arch  getArch()  const { return arch; }
103    OpSys getOpSys() const { return opSys; }
104
105  protected:
106
107    struct Section {
108        Addr     baseAddr;
109        uint8_t *fileImage;
110        size_t   size;
111    };
112
113    Addr entry;
114    Addr globalPtr;
115
116    Section text;
117    Section data;
118    Section bss;
119
120    bool loadSection(Section *sec, PortProxy& memProxy, Addr addrMask,
121                     Addr offset = 0);
122    void setGlobalPointer(Addr global_ptr) { globalPtr = global_ptr; }
123
124  public:
125    Addr entryPoint() const { return entry; }
126
127    Addr globalPointer() const { return globalPtr; }
128
129    Addr textBase() const { return text.baseAddr; }
130    Addr dataBase() const { return data.baseAddr; }
131    Addr bssBase() const { return bss.baseAddr; }
132
133    size_t textSize() const { return text.size; }
134    size_t dataSize() const { return data.size; }
135    size_t bssSize() const { return bss.size; }
136
137    /* This function allows you to override the base address where
138     * a binary is going to be loaded or set it if the binary is just a
139     * blob that doesn't include an object header.
140     * @param a address to load the binary/text section at
141     */
142    void setTextBase(Addr a) { text.baseAddr = a; }
143};
144
145ObjectFile *createObjectFile(const std::string &fname, bool raw = false);
146
147
148#endif // __OBJECT_FILE_HH__
149