gem5  v22.1.0.0
object_file.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2022 Arm Limited
3  * All rights reserved
4  *
5  * The license below extends only to copyright in the software and shall
6  * not be construed as granting a license to any other intellectual
7  * property including but not limited to intellectual property relating
8  * to a hardware implementation of the functionality of the software
9  * licensed hereunder. You may use the software subject to the license
10  * terms below provided that you ensure that this notice is replicated
11  * unmodified and in its entirety in all distributions of the software,
12  * modified or unmodified, in source code or in binary form.
13  *
14  * Copyright (c) 2002-2004 The Regents of The University of Michigan
15  * All rights reserved.
16  *
17  * Redistribution and use in source and binary forms, with or without
18  * modification, are permitted provided that the following conditions are
19  * met: redistributions of source code must retain the above copyright
20  * notice, this list of conditions and the following disclaimer;
21  * redistributions in binary form must reproduce the above copyright
22  * notice, this list of conditions and the following disclaimer in the
23  * documentation and/or other materials provided with the distribution;
24  * neither the name of the copyright holders nor the names of its
25  * contributors may be used to endorse or promote products derived from
26  * this software without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39  */
40 
41 #ifndef __BASE_LOADER_OBJECT_FILE_HH__
42 #define __BASE_LOADER_OBJECT_FILE_HH__
43 
44 #include <string>
45 
46 #include "base/compiler.hh"
50 #include "base/loader/symtab.hh"
51 #include "base/logging.hh"
52 #include "base/types.hh"
53 #include "enums/ByteOrder.hh"
54 
55 namespace gem5
56 {
57 
58 GEM5_DEPRECATED_NAMESPACE(Loader, loader);
59 namespace loader
60 {
61 
62 enum Arch
63 {
71  Arm,
76  Riscv32
77 };
78 
79 const char *archToString(Arch arch);
80 
81 enum OpSys
82 {
90  FreeBSD
91 };
92 
93 const char *opSysToString(OpSys op_sys);
94 
95 class SymbolTable;
96 
97 class ObjectFile : public ImageFile
98 {
99  protected:
102  ByteOrder byteOrder = ByteOrder::little;
103 
105 
107 
108  public:
109  virtual ~ObjectFile() {};
110 
111  virtual ObjectFile *getInterpreter() const { return nullptr; }
112  virtual bool relocatable() const { return false; }
113  virtual Addr
114  mapSize() const
115  {
116  panic("mapSize() should only be called on relocatable objects\n");
117  }
118  virtual void
119  updateBias(Addr bias_addr)
120  {
121  panic("updateBias() should only be called on relocatable objects\n");
122  }
123  virtual Addr bias() const { return 0; }
124 
125  virtual bool hasTLS() { return false; }
126 
127  Arch getArch() const { return arch; }
128  OpSys getOpSys() const { return opSys; }
129  ByteOrder getByteOrder() const { return byteOrder; }
130 
131  const SymbolTable &symtab() const { return _symtab; }
132 
133  protected:
134  Addr entry = 0;
135 
136  public:
137  Addr entryPoint() const { return entry; }
138 };
139 
141 {
142  protected:
144 
145  public:
147  void operator=(const ObjectFileFormat &) = delete;
148 
150 };
151 
152 ObjectFile *createObjectFile(const std::string &fname, bool raw=false);
153 
155 bool
156 archIs64Bit(const Arch arch);
157 
158 } // namespace loader
159 } // namespace gem5
160 
161 #endif // __BASE_LOADER_OBJECT_FILE_HH__
Defines global host-dependent types: Counter, Tick, and (indirectly) {int,uint}{8,...
const char data[]
This class encapsulates the types, structures, constants, functions, and syscall-number mappings spec...
Definition: freebsd.hh:65
ObjectFileFormat(const ObjectFileFormat &)=delete
void operator=(const ObjectFileFormat &)=delete
virtual ObjectFile * load(ImageFileDataPtr data)=0
virtual Addr mapSize() const
Definition: object_file.hh:114
ObjectFile(ImageFileDataPtr ifd)
Definition: object_file.cc:55
virtual void updateBias(Addr bias_addr)
Definition: object_file.hh:119
virtual ObjectFile * getInterpreter() const
Definition: object_file.hh:111
ByteOrder getByteOrder() const
Definition: object_file.hh:129
virtual Addr bias() const
Definition: object_file.hh:123
const SymbolTable & symtab() const
Definition: object_file.hh:131
virtual bool relocatable() const
Definition: object_file.hh:112
#define panic(...)
This implements a cprintf based panic() function.
Definition: logging.hh:178
bool archIs64Bit(const loader::Arch arch)
Determine whether the loader::Arch is 64-bit or 32-bit.
Definition: object_file.cc:152
const char * archToString(Arch arch)
Definition: object_file.cc:58
ObjectFile * createObjectFile(const std::string &fname, bool raw)
Definition: object_file.cc:135
const char * opSysToString(OpSys op_sys)
Definition: object_file.cc:93
std::shared_ptr< ImageFileData > ImageFileDataPtr
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:147
GEM5_DEPRECATED_NAMESPACE(GuestABI, guest_abi)

Generated on Wed Dec 21 2022 10:22:29 for gem5 by doxygen 1.9.1