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