object_file.hh revision 10880:61a56f76222b 
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    uint8_t *fileData;
73    size_t len;
74
75    Arch  arch;
76    OpSys opSys;
77
78    ObjectFile(const std::string &_filename, 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                              Addr offset = 0);
89    virtual bool loadGlobalSymbols(SymbolTable *symtab, Addr addrMask =
90            std::numeric_limits<Addr>::max()) = 0;
91    virtual bool loadLocalSymbols(SymbolTable *symtab, Addr addrMask =
92            std::numeric_limits<Addr>::max()) = 0;
93    virtual bool loadWeakSymbols(SymbolTable *symtab, Addr addrMask =
94            std::numeric_limits<Addr>::max())
95    { return false; }
96
97    virtual bool isDynamic() { return false; }
98    virtual bool hasTLS() { return false; }
99
100    Arch  getArch()  const { return arch; }
101    OpSys getOpSys() const { return opSys; }
102
103  protected:
104
105    struct Section {
106        Addr     baseAddr;
107        uint8_t *fileImage;
108        size_t   size;
109    };
110
111    Addr entry;
112    Addr globalPtr;
113
114    Section text;
115    Section data;
116    Section bss;
117
118    bool loadSection(Section *sec, PortProxy& memProxy, Addr addrMask,
119                     Addr offset = 0);
120    void setGlobalPointer(Addr global_ptr) { globalPtr = global_ptr; }
121
122  public:
123    Addr entryPoint() const { return entry; }
124
125    Addr globalPointer() const { return globalPtr; }
126
127    Addr textBase() const { return text.baseAddr; }
128    Addr dataBase() const { return data.baseAddr; }
129    Addr bssBase() const { return bss.baseAddr; }
130
131    size_t textSize() const { return text.size; }
132    size_t dataSize() const { return data.size; }
133    size_t bssSize() const { return bss.size; }
134
135    /* This function allows you to override the base address where
136     * a binary is going to be loaded or set it if the binary is just a
137     * blob that doesn't include an object header.
138     * @param a address to load the binary/text section at
139     */
140    void setTextBase(Addr a) { text.baseAddr = a; }
141};
142
143ObjectFile *createObjectFile(const std::string &fname, bool raw = false);
144
145
146#endif // __OBJECT_FILE_HH__
147