src/base/loader/object_file.hh

   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
  40 class Port;
  41 class SymbolTable;
  42
  43 class 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, Addr addrMask =
  82             std::numeric_limits<Addr>::max()) = 0;
  83     virtual bool loadLocalSymbols(SymbolTable *symtab, Addr addrMask =
  84             std::numeric_limits<Addr>::max()) = 0;
  85
  86     Arch  getArch()  const { return arch; }
  87     OpSys getOpSys() const { return opSys; }
  88
  89   protected:
  90
  91     struct Section {
  92         Addr     baseAddr;
  93         uint8_t *fileImage;
  94         size_t   size;
  95     };
  96
  97     Addr entry;
  98     Addr globalPtr;
  99
 100     Section text;
 101     Section data;
 102     Section bss;
 103
 104     bool loadSection(Section *sec, Port *memPort, Addr addrMask);
 105     void setGlobalPointer(Addr global_ptr) { globalPtr = global_ptr; }
 106
 107   public:
 108     Addr entryPoint() const { return entry; }
 109
 110     Addr globalPointer() const { return globalPtr; }
 111
 112     Addr textBase() const { return text.baseAddr; }
 113     Addr dataBase() const { return data.baseAddr; }
 114     Addr bssBase() const { return bss.baseAddr; }
 115
 116     size_t textSize() const { return text.size; }
 117     size_t dataSize() const { return data.size; }
 118     size_t bssSize() const { return bss.size; }
 119
 120     void setTextBase(Addr a) { text.baseAddr = a; }
 121 };
 122
 123 ObjectFile *createObjectFile(const std::string &fname, bool raw = false);
 124
 125
 126 #endif // __OBJECT_FILE_HH__