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 PortProxy;
  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         Arm64,
  56         Arm,
  57         Thumb,
  58         Power
  59     };
  60
  61     enum OpSys {
  62         UnknownOpSys,
  63         Tru64,
  64         Linux,
  65         Solaris,
  66         LinuxArmOABI
  67     };
  68
  69   protected:
  70     const std::string filename;
  71     int descriptor;
  72     uint8_t *fileData;
  73     size_t len;
  74
  75     Arch  arch;
  76     OpSys opSys;
  77
  78     ObjectFile(const std::string &_filename, int _fd,
  79                size_t _len, uint8_t *_data,
  80                Arch _arch, OpSys _opSys);
  81
  82   public:
  83     virtual ~ObjectFile();
  84
  85     void close();
  86
  87     virtual bool loadSections(PortProxy& memProxy, Addr addrMask =
  88                               std::numeric_limits<Addr>::max(),
  89                               Addr offset = 0);
  90     virtual bool loadGlobalSymbols(SymbolTable *symtab, Addr addrMask =
  91             std::numeric_limits<Addr>::max()) = 0;
  92     virtual bool loadLocalSymbols(SymbolTable *symtab, Addr addrMask =
  93             std::numeric_limits<Addr>::max()) = 0;
  94     virtual bool loadWeakSymbols(SymbolTable *symtab, Addr addrMask =
  95             std::numeric_limits<Addr>::max())
  96     { return false; }
  97
  98     virtual bool isDynamic() { return false; }
  99     virtual bool hasTLS() { return false; }
 100
 101     Arch  getArch()  const { return arch; }
 102     OpSys getOpSys() const { return opSys; }
 103
 104   protected:
 105
 106     struct Section {
 107         Addr     baseAddr;
 108         uint8_t *fileImage;
 109         size_t   size;
 110     };
 111
 112     Addr entry;
 113     Addr globalPtr;
 114
 115     Section text;
 116     Section data;
 117     Section bss;
 118
 119     bool loadSection(Section *sec, PortProxy& memProxy, Addr addrMask,
 120                      Addr offset = 0);
 121     void setGlobalPointer(Addr global_ptr) { globalPtr = global_ptr; }
 122
 123   public:
 124     Addr entryPoint() const { return entry; }
 125
 126     Addr globalPointer() const { return globalPtr; }
 127
 128     Addr textBase() const { return text.baseAddr; }
 129     Addr dataBase() const { return data.baseAddr; }
 130     Addr bssBase() const { return bss.baseAddr; }
 131
 132     size_t textSize() const { return text.size; }
 133     size_t dataSize() const { return data.size; }
 134     size_t bssSize() const { return bss.size; }
 135
 136     /* This function allows you to override the base address where
 137      * a binary is going to be loaded or set it if the binary is just a
 138      * blob that doesn't include an object header.
 139      * @param a address to load the binary/text section at
 140      */
 141     void setTextBase(Addr a) { text.baseAddr = a; }
 142 };
 143
 144 ObjectFile *createObjectFile(const std::string &fname, bool raw = false);
 145
 146
 147 #endif // __OBJECT_FILE_HH__