object_file.hh revision 11389:1e55f16160cb
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/misc.hh" 39#include "base/types.hh" 40 41class PortProxy; 42class SymbolTable; 43 44class ObjectFile 45{ 46 public: 47 48 enum Arch { 49 UnknownArch, 50 Alpha, 51 SPARC64, 52 SPARC32, 53 Mips, 54 X86_64, 55 I386, 56 Arm64, 57 Arm, 58 Thumb, 59 Power 60 }; 61 62 enum OpSys { 63 UnknownOpSys, 64 Tru64, 65 Linux, 66 Solaris, 67 LinuxArmOABI, 68 FreeBSD 69 }; 70 71 protected: 72 const std::string filename; 73 uint8_t *fileData; 74 size_t len; 75 76 Arch arch; 77 OpSys opSys; 78 79 ObjectFile(const std::string &_filename, 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 ObjectFile *getInterpreter() const { return nullptr; } 99 virtual bool relocatable() const { return false; } 100 virtual Addr mapSize() const 101 { panic("mapSize() should only be called on relocatable objects\n"); } 102 virtual void updateBias(Addr bias_addr) 103 { panic("updateBias() should only be called on relocatable objects\n"); } 104 virtual Addr bias() const { return 0; } 105 106 virtual bool hasTLS() { return false; } 107 108 Arch getArch() const { return arch; } 109 OpSys getOpSys() const { return opSys; } 110 111 protected: 112 113 struct Section { 114 Addr baseAddr; 115 uint8_t *fileImage; 116 size_t size; 117 }; 118 119 Addr entry; 120 Addr globalPtr; 121 122 Section text; 123 Section data; 124 Section bss; 125 126 bool loadSection(Section *sec, PortProxy& memProxy, Addr addrMask, 127 Addr offset = 0); 128 void setGlobalPointer(Addr global_ptr) { globalPtr = global_ptr; } 129 130 public: 131 Addr entryPoint() const { return entry; } 132 133 Addr globalPointer() const { return globalPtr; } 134 135 Addr textBase() const { return text.baseAddr; } 136 Addr dataBase() const { return data.baseAddr; } 137 Addr bssBase() const { return bss.baseAddr; } 138 139 size_t textSize() const { return text.size; } 140 size_t dataSize() const { return data.size; } 141 size_t bssSize() const { return bss.size; } 142 143 /* This function allows you to override the base address where 144 * a binary is going to be loaded or set it if the binary is just a 145 * blob that doesn't include an object header. 146 * @param a address to load the binary/text section at 147 */ 148 void setTextBase(Addr a) { text.baseAddr = a; } 149}; 150 151ObjectFile *createObjectFile(const std::string &fname, bool raw = false); 152 153 154#endif // __OBJECT_FILE_HH__ 155