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