object_file.hh revision 5335 
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 "sim/host.hh"	// for Addr
39
40class Port;
41class SymbolTable;
42
43class ObjectFile
44{
45  public:
46
47    enum Arch {
48        UnknownArch,
49        Alpha,
50        SPARC64,
51        SPARC32,
52        Mips,
53        X86,
54        Arm
55    };
56
57    enum OpSys {
58        UnknownOpSys,
59        Tru64,
60        Linux,
61        Solaris
62    };
63
64  protected:
65    const std::string filename;
66    int descriptor;
67    uint8_t *fileData;
68    size_t len;
69
70    Arch  arch;
71    OpSys opSys;
72
73    ObjectFile(const std::string &_filename, int _fd,
74               size_t _len, uint8_t *_data,
75               Arch _arch, OpSys _opSys);
76
77  public:
78    virtual ~ObjectFile();
79
80    void close();
81
82    virtual bool loadSections(Port *memPort, Addr addrMask =
83            std::numeric_limits<Addr>::max());
84    virtual bool loadGlobalSymbols(SymbolTable *symtab, Addr addrMask =
85            std::numeric_limits<Addr>::max()) = 0;
86    virtual bool loadLocalSymbols(SymbolTable *symtab, Addr addrMask =
87            std::numeric_limits<Addr>::max()) = 0;
88
89    virtual bool isDynamic() { return false; }
90    virtual bool hasTLS() { return false; }
91
92    Arch  getArch()  const { return arch; }
93    OpSys getOpSys() const { return opSys; }
94
95  protected:
96
97    struct Section {
98        Addr     baseAddr;
99        uint8_t *fileImage;
100        size_t   size;
101    };
102
103    Addr entry;
104    Addr globalPtr;
105
106    Section text;
107    Section data;
108    Section bss;
109
110    bool loadSection(Section *sec, Port *memPort, Addr addrMask);
111    void setGlobalPointer(Addr global_ptr) { globalPtr = global_ptr; }
112
113  public:
114    Addr entryPoint() const { return entry; }
115
116    Addr globalPointer() const { return globalPtr; }
117
118    Addr textBase() const { return text.baseAddr; }
119    Addr dataBase() const { return data.baseAddr; }
120    Addr bssBase() const { return bss.baseAddr; }
121
122    size_t textSize() const { return text.size; }
123    size_t dataSize() const { return data.size; }
124    size_t bssSize() const { return bss.size; }
125
126    void setTextBase(Addr a) { text.baseAddr = a; }
127};
128
129ObjectFile *createObjectFile(const std::string &fname, bool raw = false);
130
131
132#endif // __OBJECT_FILE_HH__
133