Brian Carlstrom | 7940e44 | 2013-07-12 13:46:57 -0700 | [diff] [blame] | 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 | #include "elf_writer_quick.h" |
| 18 | |
Yevgeny Rouban | e3ea838 | 2014-08-08 16:29:38 +0700 | [diff] [blame] | 19 | #include <unordered_map> |
| 20 | |
Brian Carlstrom | 7940e44 | 2013-07-12 13:46:57 -0700 | [diff] [blame] | 21 | #include "base/logging.h" |
| 22 | #include "base/unix_file/fd_file.h" |
Brian Carlstrom | c6dfdac | 2013-08-26 18:57:31 -0700 | [diff] [blame] | 23 | #include "buffered_output_stream.h" |
Vladimir Marko | 20f8559 | 2015-03-19 10:07:02 +0000 | [diff] [blame] | 24 | #include "compiled_method.h" |
David Srbecky | 0df9e1f | 2015-04-07 19:02:58 +0100 | [diff] [blame] | 25 | #include "dex_file-inl.h" |
Brian Carlstrom | 7940e44 | 2013-07-12 13:46:57 -0700 | [diff] [blame] | 26 | #include "driver/compiler_driver.h" |
Vladimir Marko | 20f8559 | 2015-03-19 10:07:02 +0000 | [diff] [blame] | 27 | #include "driver/compiler_options.h" |
Andreas Gampe | 54fc26c | 2014-09-04 21:47:42 -0700 | [diff] [blame] | 28 | #include "elf_builder.h" |
Yevgeny Rouban | e3ea838 | 2014-08-08 16:29:38 +0700 | [diff] [blame] | 29 | #include "elf_file.h" |
Nicolas Geoffray | 50cfe74 | 2014-02-19 13:27:42 +0000 | [diff] [blame] | 30 | #include "elf_utils.h" |
David Srbecky | 3b9d57a | 2015-04-10 00:22:14 +0100 | [diff] [blame] | 31 | #include "elf_writer_debug.h" |
Brian Carlstrom | c50d8e1 | 2013-07-23 22:35:16 -0700 | [diff] [blame] | 32 | #include "file_output_stream.h" |
Brian Carlstrom | 7940e44 | 2013-07-12 13:46:57 -0700 | [diff] [blame] | 33 | #include "globals.h" |
Andreas Gampe | 7927380 | 2014-08-05 20:21:05 -0700 | [diff] [blame] | 34 | #include "leb128.h" |
Brian Carlstrom | 7940e44 | 2013-07-12 13:46:57 -0700 | [diff] [blame] | 35 | #include "oat.h" |
Brian Carlstrom | c50d8e1 | 2013-07-23 22:35:16 -0700 | [diff] [blame] | 36 | #include "oat_writer.h" |
Brian Carlstrom | 7940e44 | 2013-07-12 13:46:57 -0700 | [diff] [blame] | 37 | #include "utils.h" |
| 38 | |
| 39 | namespace art { |
| 40 | |
Nicolas Geoffray | f9b87b1 | 2014-09-02 08:12:09 +0000 | [diff] [blame] | 41 | template <typename Elf_Word, typename Elf_Sword, typename Elf_Addr, |
| 42 | typename Elf_Dyn, typename Elf_Sym, typename Elf_Ehdr, |
| 43 | typename Elf_Phdr, typename Elf_Shdr> |
| 44 | bool ElfWriterQuick<Elf_Word, Elf_Sword, Elf_Addr, Elf_Dyn, |
Nicolas Geoffray | f9b87b1 | 2014-09-02 08:12:09 +0000 | [diff] [blame] | 45 | Elf_Sym, Elf_Ehdr, Elf_Phdr, Elf_Shdr>::Create(File* elf_file, |
Brian Carlstrom | b12f347 | 2014-06-11 14:54:46 -0700 | [diff] [blame] | 46 | OatWriter* oat_writer, |
| 47 | const std::vector<const DexFile*>& dex_files, |
| 48 | const std::string& android_root, |
| 49 | bool is_host, |
| 50 | const CompilerDriver& driver) { |
| 51 | ElfWriterQuick elf_writer(driver, elf_file); |
| 52 | return elf_writer.Write(oat_writer, dex_files, android_root, is_host); |
| 53 | } |
| 54 | |
Ian Rogers | 0279ebb | 2014-10-08 17:27:48 -0700 | [diff] [blame] | 55 | class OatWriterWrapper FINAL : public CodeOutput { |
Andreas Gampe | 54fc26c | 2014-09-04 21:47:42 -0700 | [diff] [blame] | 56 | public: |
| 57 | explicit OatWriterWrapper(OatWriter* oat_writer) : oat_writer_(oat_writer) {} |
| 58 | |
Vladimir Marko | f4da675 | 2014-08-01 19:04:18 +0100 | [diff] [blame] | 59 | void SetCodeOffset(size_t offset) { |
| 60 | oat_writer_->SetOatDataOffset(offset); |
| 61 | } |
Andreas Gampe | 54fc26c | 2014-09-04 21:47:42 -0700 | [diff] [blame] | 62 | bool Write(OutputStream* out) OVERRIDE { |
| 63 | return oat_writer_->Write(out); |
| 64 | } |
| 65 | private: |
Ian Rogers | 0279ebb | 2014-10-08 17:27:48 -0700 | [diff] [blame] | 66 | OatWriter* const oat_writer_; |
Andreas Gampe | 54fc26c | 2014-09-04 21:47:42 -0700 | [diff] [blame] | 67 | }; |
| 68 | |
| 69 | template <typename Elf_Word, typename Elf_Sword, typename Elf_Addr, |
| 70 | typename Elf_Dyn, typename Elf_Sym, typename Elf_Ehdr, |
| 71 | typename Elf_Phdr, typename Elf_Shdr> |
| 72 | static void WriteDebugSymbols(const CompilerDriver* compiler_driver, |
| 73 | ElfBuilder<Elf_Word, Elf_Sword, Elf_Addr, Elf_Dyn, |
| 74 | Elf_Sym, Elf_Ehdr, Elf_Phdr, Elf_Shdr>* builder, |
| 75 | OatWriter* oat_writer); |
| 76 | |
David Srbecky | 2f6cdb0 | 2015-04-11 00:17:53 +0100 | [diff] [blame] | 77 | // Encode patch locations in .oat_patches format. |
| 78 | template <typename Elf_Word, typename Elf_Sword, typename Elf_Addr, |
| 79 | typename Elf_Dyn, typename Elf_Sym, typename Elf_Ehdr, |
| 80 | typename Elf_Phdr, typename Elf_Shdr> |
| 81 | void ElfWriterQuick<Elf_Word, Elf_Sword, Elf_Addr, Elf_Dyn, Elf_Sym, Elf_Ehdr, |
| 82 | Elf_Phdr, Elf_Shdr>::EncodeOatPatches(const OatWriter::PatchLocationsMap& sections, |
| 83 | std::vector<uint8_t>* buffer) { |
| 84 | for (const auto& section : sections) { |
| 85 | const std::string& name = section.first; |
| 86 | std::vector<uintptr_t>* locations = section.second.get(); |
| 87 | DCHECK(!name.empty()); |
| 88 | std::sort(locations->begin(), locations->end()); |
| 89 | // Reserve buffer space - guess 2 bytes per ULEB128. |
| 90 | buffer->reserve(buffer->size() + name.size() + locations->size() * 2); |
| 91 | // Write null-terminated section name. |
| 92 | const uint8_t* name_data = reinterpret_cast<const uint8_t*>(name.c_str()); |
| 93 | buffer->insert(buffer->end(), name_data, name_data + name.size() + 1); |
| 94 | // Write placeholder for data length. |
| 95 | size_t length_pos = buffer->size(); |
| 96 | EncodeUnsignedLeb128(buffer, UINT32_MAX); |
| 97 | // Write LEB128 encoded list of advances (deltas between consequtive addresses). |
| 98 | size_t data_pos = buffer->size(); |
| 99 | uintptr_t address = 0; // relative to start of section. |
| 100 | for (uintptr_t location : *locations) { |
| 101 | DCHECK_LT(location - address, UINT32_MAX) << "Large gap between patch locations"; |
| 102 | EncodeUnsignedLeb128(buffer, location - address); |
| 103 | address = location; |
| 104 | } |
| 105 | // Update length. |
| 106 | UpdateUnsignedLeb128(buffer->data() + length_pos, buffer->size() - data_pos); |
| 107 | } |
| 108 | buffer->push_back(0); // End of sections. |
| 109 | } |
| 110 | |
Nicolas Geoffray | f9b87b1 | 2014-09-02 08:12:09 +0000 | [diff] [blame] | 111 | template <typename Elf_Word, typename Elf_Sword, typename Elf_Addr, |
| 112 | typename Elf_Dyn, typename Elf_Sym, typename Elf_Ehdr, |
| 113 | typename Elf_Phdr, typename Elf_Shdr> |
| 114 | bool ElfWriterQuick<Elf_Word, Elf_Sword, Elf_Addr, Elf_Dyn, |
| 115 | Elf_Sym, Elf_Ehdr, Elf_Phdr, Elf_Shdr>::Write(OatWriter* oat_writer, |
Ian Rogers | 6a3c1fc | 2014-10-31 00:33:20 -0700 | [diff] [blame] | 116 | const std::vector<const DexFile*>& dex_files_unused ATTRIBUTE_UNUSED, |
| 117 | const std::string& android_root_unused ATTRIBUTE_UNUSED, |
| 118 | bool is_host_unused ATTRIBUTE_UNUSED) { |
Andreas Gampe | 7927380 | 2014-08-05 20:21:05 -0700 | [diff] [blame] | 119 | constexpr bool debug = false; |
Brian Carlstrom | b12f347 | 2014-06-11 14:54:46 -0700 | [diff] [blame] | 120 | const OatHeader& oat_header = oat_writer->GetOatHeader(); |
Nicolas Geoffray | f9b87b1 | 2014-09-02 08:12:09 +0000 | [diff] [blame] | 121 | Elf_Word oat_data_size = oat_header.GetExecutableOffset(); |
Brian Carlstrom | b12f347 | 2014-06-11 14:54:46 -0700 | [diff] [blame] | 122 | uint32_t oat_exec_size = oat_writer->GetSize() - oat_data_size; |
Vladimir Marko | 5c42c29 | 2015-02-25 12:02:49 +0000 | [diff] [blame] | 123 | uint32_t oat_bss_size = oat_writer->GetBssSize(); |
Brian Carlstrom | b12f347 | 2014-06-11 14:54:46 -0700 | [diff] [blame] | 124 | |
Andreas Gampe | 54fc26c | 2014-09-04 21:47:42 -0700 | [diff] [blame] | 125 | OatWriterWrapper wrapper(oat_writer); |
| 126 | |
| 127 | std::unique_ptr<ElfBuilder<Elf_Word, Elf_Sword, Elf_Addr, Elf_Dyn, |
| 128 | Elf_Sym, Elf_Ehdr, Elf_Phdr, Elf_Shdr> > builder( |
| 129 | new ElfBuilder<Elf_Word, Elf_Sword, Elf_Addr, Elf_Dyn, |
| 130 | Elf_Sym, Elf_Ehdr, Elf_Phdr, Elf_Shdr>( |
| 131 | &wrapper, |
| 132 | elf_file_, |
| 133 | compiler_driver_->GetInstructionSet(), |
| 134 | 0, |
| 135 | oat_data_size, |
| 136 | oat_data_size, |
| 137 | oat_exec_size, |
Vladimir Marko | 5c42c29 | 2015-02-25 12:02:49 +0000 | [diff] [blame] | 138 | RoundUp(oat_data_size + oat_exec_size, kPageSize), |
| 139 | oat_bss_size, |
Andreas Gampe | 54fc26c | 2014-09-04 21:47:42 -0700 | [diff] [blame] | 140 | compiler_driver_->GetCompilerOptions().GetIncludeDebugSymbols(), |
| 141 | debug)); |
Alex Light | 78382fa | 2014-06-06 15:45:32 -0700 | [diff] [blame] | 142 | |
Brian Carlstrom | 18a49cc | 2014-08-29 16:20:48 -0700 | [diff] [blame] | 143 | if (!builder->Init()) { |
Yevgeny Rouban | e3ea838 | 2014-08-08 16:29:38 +0700 | [diff] [blame] | 144 | return false; |
| 145 | } |
| 146 | |
David Srbecky | 8dc7324 | 2015-04-12 11:40:39 +0100 | [diff] [blame^] | 147 | if (compiler_driver_->GetCompilerOptions().GetIncludeCFI() && |
| 148 | !oat_writer->GetMethodDebugInfo().empty()) { |
| 149 | ElfRawSectionBuilder<Elf_Word, Elf_Sword, Elf_Shdr> eh_frame( |
| 150 | ".eh_frame", SHT_PROGBITS, SHF_ALLOC, nullptr, 0, 4, 0); |
| 151 | dwarf::WriteEhFrame(compiler_driver_, oat_writer, |
| 152 | builder->GetTextBuilder().GetSection()->sh_addr, |
| 153 | eh_frame.GetBuffer()); |
| 154 | builder->RegisterRawSection(eh_frame); |
| 155 | } |
| 156 | |
David Srbecky | 3b9d57a | 2015-04-10 00:22:14 +0100 | [diff] [blame] | 157 | if (compiler_driver_->GetCompilerOptions().GetIncludeDebugSymbols() && |
| 158 | !oat_writer->GetMethodDebugInfo().empty()) { |
Andreas Gampe | 54fc26c | 2014-09-04 21:47:42 -0700 | [diff] [blame] | 159 | WriteDebugSymbols(compiler_driver_, builder.get(), oat_writer); |
Brian Carlstrom | b12f347 | 2014-06-11 14:54:46 -0700 | [diff] [blame] | 160 | } |
| 161 | |
David Srbecky | 2f6cdb0 | 2015-04-11 00:17:53 +0100 | [diff] [blame] | 162 | if (compiler_driver_->GetCompilerOptions().GetIncludePatchInformation() || |
| 163 | // ElfWriter::Fixup will be called regardless and it needs to be able |
| 164 | // to patch debug sections so we have to include patches for them. |
| 165 | compiler_driver_->GetCompilerOptions().GetIncludeDebugSymbols()) { |
Andreas Gampe | 54fc26c | 2014-09-04 21:47:42 -0700 | [diff] [blame] | 166 | ElfRawSectionBuilder<Elf_Word, Elf_Sword, Elf_Shdr> oat_patches( |
David Srbecky | 2f6cdb0 | 2015-04-11 00:17:53 +0100 | [diff] [blame] | 167 | ".oat_patches", SHT_OAT_PATCH, 0, NULL, 0, 1, 0); |
| 168 | EncodeOatPatches(oat_writer->GetAbsolutePatchLocations(), oat_patches.GetBuffer()); |
Brian Carlstrom | 18a49cc | 2014-08-29 16:20:48 -0700 | [diff] [blame] | 169 | builder->RegisterRawSection(oat_patches); |
Alex Light | 53cb16b | 2014-06-12 11:26:29 -0700 | [diff] [blame] | 170 | } |
| 171 | |
Brian Carlstrom | 18a49cc | 2014-08-29 16:20:48 -0700 | [diff] [blame] | 172 | return builder->Write(); |
Brian Carlstrom | b12f347 | 2014-06-11 14:54:46 -0700 | [diff] [blame] | 173 | } |
Mark Mendell | ae9fd93 | 2014-02-10 16:14:35 -0800 | [diff] [blame] | 174 | |
Andreas Gampe | 54fc26c | 2014-09-04 21:47:42 -0700 | [diff] [blame] | 175 | template <typename Elf_Word, typename Elf_Sword, typename Elf_Addr, |
| 176 | typename Elf_Dyn, typename Elf_Sym, typename Elf_Ehdr, |
| 177 | typename Elf_Phdr, typename Elf_Shdr> |
Andreas Gampe | 8683038 | 2014-12-12 21:41:29 -0800 | [diff] [blame] | 178 | // Do not inline to avoid Clang stack frame problems. b/18738594 |
| 179 | NO_INLINE |
Andreas Gampe | 54fc26c | 2014-09-04 21:47:42 -0700 | [diff] [blame] | 180 | static void WriteDebugSymbols(const CompilerDriver* compiler_driver, |
| 181 | ElfBuilder<Elf_Word, Elf_Sword, Elf_Addr, Elf_Dyn, |
| 182 | Elf_Sym, Elf_Ehdr, Elf_Phdr, Elf_Shdr>* builder, |
| 183 | OatWriter* oat_writer) { |
Andreas Gampe | 54fc26c | 2014-09-04 21:47:42 -0700 | [diff] [blame] | 184 | // Iterate over the compiled methods. |
David Srbecky | 3b9d57a | 2015-04-10 00:22:14 +0100 | [diff] [blame] | 185 | const std::vector<OatWriter::DebugInfo>& method_info = oat_writer->GetMethodDebugInfo(); |
Ian Rogers | 0279ebb | 2014-10-08 17:27:48 -0700 | [diff] [blame] | 186 | ElfSymtabBuilder<Elf_Word, Elf_Sword, Elf_Addr, Elf_Sym, Elf_Shdr>* symtab = |
| 187 | builder->GetSymtabBuilder(); |
Andreas Gampe | 54fc26c | 2014-09-04 21:47:42 -0700 | [diff] [blame] | 188 | for (auto it = method_info.begin(); it != method_info.end(); ++it) { |
David Srbecky | 0df9e1f | 2015-04-07 19:02:58 +0100 | [diff] [blame] | 189 | std::string name = PrettyMethod(it->dex_method_index_, *it->dex_file_, true); |
| 190 | if (it->deduped_) { |
| 191 | // TODO We should place the DEDUPED tag on the first instance of a deduplicated symbol |
| 192 | // so that it will show up in a debuggerd crash report. |
| 193 | name += " [ DEDUPED ]"; |
| 194 | } |
| 195 | |
David Srbecky | 6f71589 | 2015-03-30 14:21:42 +0100 | [diff] [blame] | 196 | uint32_t low_pc = it->low_pc_; |
| 197 | // Add in code delta, e.g., thumb bit 0 for Thumb2 code. |
| 198 | low_pc += it->compiled_method_->CodeDelta(); |
David Srbecky | 0df9e1f | 2015-04-07 19:02:58 +0100 | [diff] [blame] | 199 | symtab->AddSymbol(name, &builder->GetTextBuilder(), low_pc, |
David Srbecky | 6f71589 | 2015-03-30 14:21:42 +0100 | [diff] [blame] | 200 | true, it->high_pc_ - it->low_pc_, STB_GLOBAL, STT_FUNC); |
Andreas Gampe | 54fc26c | 2014-09-04 21:47:42 -0700 | [diff] [blame] | 201 | |
Ningsheng Jian | f973455 | 2014-10-27 14:56:34 +0800 | [diff] [blame] | 202 | // Conforming to aaelf, add $t mapping symbol to indicate start of a sequence of thumb2 |
| 203 | // instructions, so that disassembler tools can correctly disassemble. |
| 204 | if (it->compiled_method_->GetInstructionSet() == kThumb2) { |
| 205 | symtab->AddSymbol("$t", &builder->GetTextBuilder(), it->low_pc_ & ~1, true, |
| 206 | 0, STB_LOCAL, STT_NOTYPE); |
| 207 | } |
Andreas Gampe | 54fc26c | 2014-09-04 21:47:42 -0700 | [diff] [blame] | 208 | } |
| 209 | |
David Srbecky | 3b9d57a | 2015-04-10 00:22:14 +0100 | [diff] [blame] | 210 | typedef ElfRawSectionBuilder<Elf_Word, Elf_Sword, Elf_Shdr> Section; |
David Srbecky | 3b9d57a | 2015-04-10 00:22:14 +0100 | [diff] [blame] | 211 | Section debug_info(".debug_info", SHT_PROGBITS, 0, nullptr, 0, 1, 0); |
| 212 | Section debug_abbrev(".debug_abbrev", SHT_PROGBITS, 0, nullptr, 0, 1, 0); |
| 213 | Section debug_str(".debug_str", SHT_PROGBITS, 0, nullptr, 0, 1, 0); |
| 214 | Section debug_line(".debug_line", SHT_PROGBITS, 0, nullptr, 0, 1, 0); |
Andreas Gampe | 54fc26c | 2014-09-04 21:47:42 -0700 | [diff] [blame] | 215 | |
David Srbecky | 3b9d57a | 2015-04-10 00:22:14 +0100 | [diff] [blame] | 216 | dwarf::WriteDebugSections(compiler_driver, |
| 217 | oat_writer, |
| 218 | builder->GetTextBuilder().GetSection()->sh_addr, |
David Srbecky | 3b9d57a | 2015-04-10 00:22:14 +0100 | [diff] [blame] | 219 | debug_info.GetBuffer(), |
| 220 | debug_abbrev.GetBuffer(), |
| 221 | debug_str.GetBuffer(), |
| 222 | debug_line.GetBuffer()); |
Andreas Gampe | 54fc26c | 2014-09-04 21:47:42 -0700 | [diff] [blame] | 223 | |
David Srbecky | 3b9d57a | 2015-04-10 00:22:14 +0100 | [diff] [blame] | 224 | builder->RegisterRawSection(debug_info); |
| 225 | builder->RegisterRawSection(debug_abbrev); |
| 226 | builder->RegisterRawSection(debug_str); |
| 227 | builder->RegisterRawSection(debug_line); |
Andreas Gampe | 54fc26c | 2014-09-04 21:47:42 -0700 | [diff] [blame] | 228 | } |
| 229 | |
Nicolas Geoffray | f9b87b1 | 2014-09-02 08:12:09 +0000 | [diff] [blame] | 230 | // Explicit instantiations |
| 231 | template class ElfWriterQuick<Elf32_Word, Elf32_Sword, Elf32_Addr, Elf32_Dyn, |
| 232 | Elf32_Sym, Elf32_Ehdr, Elf32_Phdr, Elf32_Shdr>; |
| 233 | template class ElfWriterQuick<Elf64_Word, Elf64_Sword, Elf64_Addr, Elf64_Dyn, |
| 234 | Elf64_Sym, Elf64_Ehdr, Elf64_Phdr, Elf64_Shdr>; |
| 235 | |
Brian Carlstrom | 7940e44 | 2013-07-12 13:46:57 -0700 | [diff] [blame] | 236 | } // namespace art |