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