gem5  v21.1.0.2
elf_object.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013, 2019 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) 2003-2005 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_ELF_OBJECT_HH__
42 #define __BASE_LOADER_ELF_OBJECT_HH__
43 
44 #include <set>
45 #include <vector>
46 
47 #include "base/compiler.hh"
49 #include "gelf.h"
50 
51 namespace gem5
52 {
53 
54 GEM5_DEPRECATED_NAMESPACE(Loader, loader);
55 namespace loader
56 {
57 
59 {
60  public:
62 };
63 
64 class ElfObject : public ObjectFile
65 {
66  protected:
67  Elf *elf;
68  GElf_Ehdr ehdr;
69 
70  void determineArch();
71  void determineOpSys();
72  void determineByteOrder();
73  void handleLoadableSegment(GElf_Phdr phdr, int seg_num);
74 
75  // These values are provided to a linux process by the kernel, so we
76  // need to keep them around.
78  uint16_t _programHeaderSize = 0;
79  uint16_t _programHeaderCount = 0;
80  std::set<std::string> sectionNames;
81 
82  ElfObject *interpreter = nullptr;
83 
84  // An interpreter load bias is the location in the process address space
85  // where the interpreter is chosen to reside. Typically, this is carved
86  // out of the top of the mmap reserve section.
87  Addr ldBias = 0;
88 
89  // The interpreter is typically a relocatable shared library and will
90  // have a default value of zero which means that it does not care where
91  // it is placed. However, the loader can be compiled and linked so that
92  // it does care and needs a specific entry point.
93  bool relocate = true;
94 
95  // The ldMin and ldMax fields are required to know how large of an
96  // area is required to map the interpreter.
99 
101  bool loadSomeSymbols(SymbolTable *symtab, int binding, Addr mask,
102  Addr base, Addr offset);
103 
104  void getSections();
105  bool sectionExists(std::string sec);
106 
108 
109  public:
111  ~ElfObject();
112 
113  MemoryImage buildImage() const override { return image; }
114 
115  ObjectFile *getInterpreter() const override { return interpreter; }
116  std::string getInterpPath(const GElf_Phdr &phdr) const;
117 
118  Addr bias() const override { return ldBias; }
119  bool relocatable() const override { return relocate; }
120  Addr mapSize() const override { return ldMax - ldMin; }
121  void updateBias(Addr bias_addr) override;
122 
123  bool hasTLS() override { return sectionExists(".tbss"); }
124 
128 };
129 
137 void setInterpDir(const std::string &dirname);
138 
139 } // namespace loader
140 } // namespace gem5
141 
142 #endif // __BASE_LOADER_ELF_OBJECT_HH__
gem5::loader::ElfObject::getInterpPath
std::string getInterpPath(const GElf_Phdr &phdr) const
Definition: elf_object.cc:212
gem5::loader::ElfObject::loadSomeSymbols
bool loadSomeSymbols(SymbolTable *symtab, int binding, Addr mask, Addr base, Addr offset)
Helper functions for loadGlobalSymbols() and loadLocalSymbols().
gem5::loader::ObjectFile
Definition: object_file.hh:85
data
const char data[]
Definition: circlebuf.test.cc:48
gem5::loader::ElfObject::programHeaderTable
Addr programHeaderTable()
Definition: elf_object.hh:125
gem5::loader::ElfObject::sectionExists
bool sectionExists(std::string sec)
Definition: elf_object.cc:424
gem5::loader::ElfObject::determineOpSys
void determineOpSys()
Definition: elf_object.cc:263
gem5::loader::ElfObject::~ElfObject
~ElfObject()
Definition: elf_object.cc:382
gem5::loader::ElfObject
Definition: elf_object.hh:64
gem5::loader::ElfObject::_programHeaderSize
uint16_t _programHeaderSize
Definition: elf_object.hh:78
gem5::loader::ElfObject::ElfObject
ElfObject(ImageFileDataPtr ifd)
Definition: elf_object.cc:110
gem5::loader::ElfObject::getSections
void getSections()
Definition: elf_object.cc:388
gem5::loader::SymbolTable
Definition: symtab.hh:65
gem5::loader::setInterpDir
void setInterpDir(const std::string &dirname)
This is the interface for setting up a base path for the elf interpreter.
Definition: elf_object.cc:103
gem5::loader::ElfObject::image
MemoryImage image
Definition: elf_object.hh:107
gem5::X86ISA::base
Bitfield< 51, 12 > base
Definition: pagetable.hh:141
gem5::loader::ObjectFile::symtab
const SymbolTable & symtab() const
Definition: object_file.hh:119
gem5::mask
constexpr uint64_t mask(unsigned nbits)
Generate a 64-bit mask of 'nbits' 1s, right justified.
Definition: bitfield.hh:63
gem5::loader::ElfObject::_programHeaderCount
uint16_t _programHeaderCount
Definition: elf_object.hh:79
gem5::loader::ElfObjectFormat
Definition: elf_object.hh:58
gem5::loader::ElfObject::mapSize
Addr mapSize() const override
Definition: elf_object.hh:120
gem5::MaxAddr
const Addr MaxAddr
Definition: types.hh:171
gem5::loader::MemoryImage
Definition: memory_image.hh:53
gem5::loader::ElfObject::ldBias
Addr ldBias
Definition: elf_object.hh:87
gem5::loader::ElfObject::sectionNames
std::set< std::string > sectionNames
Definition: elf_object.hh:80
gem5::loader::ElfObject::ldMin
Addr ldMin
Definition: elf_object.hh:97
gem5::ArmISA::offset
Bitfield< 23, 0 > offset
Definition: types.hh:144
gem5::loader::ElfObject::ehdr
GElf_Ehdr ehdr
Definition: elf_object.hh:68
gem5::loader::ElfObject::updateBias
void updateBias(Addr bias_addr) override
Definition: elf_object.cc:434
compiler.hh
gem5::loader::ElfObject::determineByteOrder
void determineByteOrder()
Definition: elf_object.cc:341
gem5::loader::ElfObject::hasTLS
bool hasTLS() override
Definition: elf_object.hh:123
gem5::Addr
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:147
gem5::loader::ElfObject::determineArch
void determineArch()
Definition: elf_object.cc:223
gem5::GEM5_DEPRECATED_NAMESPACE
GEM5_DEPRECATED_NAMESPACE(GuestABI, guest_abi)
gem5::loader::ElfObject::getInterpreter
ObjectFile * getInterpreter() const override
Definition: elf_object.hh:115
gem5::loader::ElfObject::ldMax
Addr ldMax
Definition: elf_object.hh:98
gem5::loader::ElfObject::relocate
bool relocate
Definition: elf_object.hh:93
gem5::loader::ElfObject::programHeaderCount
uint16_t programHeaderCount()
Definition: elf_object.hh:127
gem5::loader::ObjectFileFormat
Definition: object_file.hh:128
gem5::loader::ElfObject::relocatable
bool relocatable() const override
Definition: elf_object.hh:119
gem5::loader::ElfObjectFormat::load
ObjectFile * load(ImageFileDataPtr data) override
Definition: elf_object.cc:69
gem5::loader::ElfObject::elf
Elf * elf
Definition: elf_object.hh:67
gem5::loader::ElfObject::_programHeaderTable
Addr _programHeaderTable
Definition: elf_object.hh:77
gem5::loader::ElfObject::bias
Addr bias() const override
Definition: elf_object.hh:118
gem5::loader::ElfObject::programHeaderSize
uint16_t programHeaderSize()
Definition: elf_object.hh:126
gem5::loader::ImageFileDataPtr
std::shared_ptr< ImageFileData > ImageFileDataPtr
Definition: image_file_data.hh:61
gem5::loader::ElfObject::interpreter
ElfObject * interpreter
Definition: elf_object.hh:82
gem5::loader::ElfObject::handleLoadableSegment
void handleLoadableSegment(GElf_Phdr phdr, int seg_num)
Definition: elf_object.cc:350
gem5::loader::ElfObject::buildImage
MemoryImage buildImage() const override
Definition: elf_object.hh:113
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
object_file.hh

Generated on Tue Sep 21 2021 12:24:57 for gem5 by doxygen 1.8.17