1 /*
2  * Copyright (C) 2012 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef ART_RUNTIME_ELF_FILE_IMPL_H_
18 #define ART_RUNTIME_ELF_FILE_IMPL_H_
19 
20 #include <map>
21 #include <memory>
22 #include <type_traits>
23 #include <vector>
24 
25 #include "base/mem_map.h"
26 #include "elf/elf_utils.h"
27 
28 namespace art {
29 
30 template <typename ElfTypes>
31 class ElfFileImpl {
32  public:
33   using Elf_Addr = typename ElfTypes::Addr;
34   using Elf_Off = typename ElfTypes::Off;
35   using Elf_Half = typename ElfTypes::Half;
36   using Elf_Word = typename ElfTypes::Word;
37   using Elf_Sword = typename ElfTypes::Sword;
38   using Elf_Ehdr = typename ElfTypes::Ehdr;
39   using Elf_Shdr = typename ElfTypes::Shdr;
40   using Elf_Sym = typename ElfTypes::Sym;
41   using Elf_Rel = typename ElfTypes::Rel;
42   using Elf_Rela = typename ElfTypes::Rela;
43   using Elf_Phdr = typename ElfTypes::Phdr;
44   using Elf_Dyn = typename ElfTypes::Dyn;
45 
46   static ElfFileImpl* Open(File* file,
47                            bool writable,
48                            bool program_header_only,
49                            bool low_4gb,
50                            /*out*/std::string* error_msg);
51   static ElfFileImpl* Open(File* file,
52                            int mmap_prot,
53                            int mmap_flags,
54                            bool low_4gb,
55                            /*out*/std::string* error_msg);
56   ~ElfFileImpl();
57 
GetFilePath()58   const std::string& GetFilePath() const {
59     return file_path_;
60   }
61 
GetBaseAddress()62   uint8_t* GetBaseAddress() const {
63     return base_address_;
64   }
65 
Begin()66   uint8_t* Begin() const {
67     return map_.Begin();
68   }
69 
End()70   uint8_t* End() const {
71     return map_.End();
72   }
73 
Size()74   size_t Size() const {
75     return map_.Size();
76   }
77 
78   Elf_Ehdr& GetHeader() const;
79 
80   Elf_Word GetProgramHeaderNum() const;
81   Elf_Phdr* GetProgramHeader(Elf_Word) const;
82 
83   Elf_Word GetSectionHeaderNum() const;
84   Elf_Shdr* GetSectionHeader(Elf_Word) const;
85   Elf_Shdr* FindSectionByType(Elf_Word type) const;
86   Elf_Shdr* FindSectionByName(const std::string& name) const;
87 
88   Elf_Shdr* GetSectionNameStringSection() const;
89 
90   // Find .dynsym using .hash for more efficient lookup than FindSymbolAddress.
91   const uint8_t* FindDynamicSymbolAddress(const std::string& symbol_name) const;
92 
93   static bool IsSymbolSectionType(Elf_Word section_type);
94   Elf_Word GetSymbolNum(Elf_Shdr&) const;
95   Elf_Sym* GetSymbol(Elf_Word section_type, Elf_Word i) const;
96 
97   // Find address of symbol in specified table, returning 0 if it is
98   // not found. See FindSymbolByName for an explanation of build_map.
99   Elf_Addr FindSymbolAddress(Elf_Word section_type,
100                              const std::string& symbol_name,
101                              bool build_map);
102 
103   // Lookup a string given string section and offset. Returns null for special 0 offset.
104   const char* GetString(Elf_Shdr&, Elf_Word) const;
105 
106   Elf_Word GetDynamicNum() const;
107   Elf_Dyn& GetDynamic(Elf_Word) const;
108 
109   Elf_Word GetRelNum(Elf_Shdr&) const;
110   Elf_Rel& GetRel(Elf_Shdr&, Elf_Word) const;
111 
112   Elf_Word GetRelaNum(Elf_Shdr&) const;
113   Elf_Rela& GetRela(Elf_Shdr&, Elf_Word) const;
114 
115   // Retrieves the expected size when the file is loaded at runtime. Returns true if successful.
116   bool GetLoadedSize(size_t* size, std::string* error_msg) const;
117 
118   // Load segments into memory based on PT_LOAD program headers.
119   // executable is true at run time, false at compile time.
120   bool Load(File* file,
121             bool executable,
122             bool low_4gb,
123             /*inout*/MemMap* reservation,
124             /*out*/std::string* error_msg);
125 
126   bool Strip(File* file, std::string* error_msg);
127 
128  private:
129   ElfFileImpl(File* file, bool writable, bool program_header_only);
130 
131   bool GetLoadedAddressRange(/*out*/uint8_t** vaddr_begin,
132                              /*out*/size_t* vaddr_size,
133                              /*out*/std::string* error_msg) const;
134 
135   bool Setup(File* file, int prot, int flags, bool low_4gb, std::string* error_msg);
136 
137   bool SetMap(File* file, MemMap&& map, std::string* error_msg);
138 
139   uint8_t* GetProgramHeadersStart() const;
140   uint8_t* GetSectionHeadersStart() const;
141   Elf_Phdr& GetDynamicProgramHeader() const;
142   Elf_Dyn* GetDynamicSectionStart() const;
143   Elf_Sym* GetSymbolSectionStart(Elf_Word section_type) const;
144   const char* GetStringSectionStart(Elf_Word section_type) const;
145   Elf_Rel* GetRelSectionStart(Elf_Shdr&) const;
146   Elf_Rela* GetRelaSectionStart(Elf_Shdr&) const;
147   Elf_Word* GetHashSectionStart() const;
148   Elf_Word GetHashBucketNum() const;
149   Elf_Word GetHashChainNum() const;
150   Elf_Word GetHashBucket(size_t i, bool* ok) const;
151   Elf_Word GetHashChain(size_t i, bool* ok) const;
152 
153   typedef std::map<std::string, Elf_Sym*> SymbolTable;
154   SymbolTable** GetSymbolTable(Elf_Word section_type);
155 
156   bool ValidPointer(const uint8_t* start) const;
157 
158   const Elf_Sym* FindDynamicSymbol(const std::string& symbol_name) const;
159 
160   // Check that certain sections and their dependencies exist.
161   bool CheckSectionsExist(File* file, std::string* error_msg) const;
162 
163   // Check that the link of the first section links to the second section.
164   bool CheckSectionsLinked(const uint8_t* source, const uint8_t* target) const;
165 
166   // Check whether the offset is in range, and set to target to Begin() + offset if OK.
167   bool CheckAndSet(Elf32_Off offset, const char* label, uint8_t** target, std::string* error_msg);
168 
169   // Find symbol in specified table, returning null if it is not found.
170   //
171   // If build_map is true, builds a map to speed repeated access. The
172   // map does not included untyped symbol values (aka STT_NOTYPE)
173   // since they can contain duplicates. If build_map is false, the map
174   // will be used if it was already created. Typically build_map
175   // should be set unless only a small number of symbols will be
176   // looked up.
177   Elf_Sym* FindSymbolByName(Elf_Word section_type,
178                             const std::string& symbol_name,
179                             bool build_map);
180 
181   Elf_Phdr* FindProgamHeaderByType(Elf_Word type) const;
182 
183   Elf_Dyn* FindDynamicByType(Elf_Sword type) const;
184   Elf_Word FindDynamicValueByType(Elf_Sword type) const;
185 
186   // Lookup a string by section type. Returns null for special 0 offset.
187   const char* GetString(Elf_Word section_type, Elf_Word) const;
188 
189   const std::string file_path_;
190   const bool writable_;
191   const bool program_header_only_;
192 
193   // ELF header mapping. If program_header_only_ is false, will
194   // actually point to the entire elf file.
195   MemMap map_;
196   Elf_Ehdr* header_;
197   std::vector<MemMap> segments_;
198 
199   // Pointer to start of first PT_LOAD program segment after Load()
200   // when program_header_only_ is true.
201   uint8_t* base_address_;
202 
203   // The program header should always available but use GetProgramHeadersStart() to be sure.
204   uint8_t* program_headers_start_;
205 
206   // Conditionally available values. Use accessors to ensure they exist if they are required.
207   uint8_t* section_headers_start_;
208   Elf_Phdr* dynamic_program_header_;
209   Elf_Dyn* dynamic_section_start_;
210   Elf_Sym* symtab_section_start_;
211   Elf_Sym* dynsym_section_start_;
212   char* strtab_section_start_;
213   char* dynstr_section_start_;
214   Elf_Word* hash_section_start_;
215 
216   SymbolTable* symtab_symbol_table_;
217   SymbolTable* dynsym_symbol_table_;
218 
219   DISALLOW_COPY_AND_ASSIGN(ElfFileImpl);
220 };
221 
222 }  // namespace art
223 
224 #endif  // ART_RUNTIME_ELF_FILE_IMPL_H_
225