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