David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2016 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_debug_writer.h" |
| 18 | |
| 19 | #include <vector> |
David Srbecky | 56da23c | 2017-09-08 19:59:15 +0100 | [diff] [blame] | 20 | #include <unordered_map> |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 21 | |
David Brazdil | d9c9037 | 2016-09-14 16:53:55 +0100 | [diff] [blame] | 22 | #include "base/array_ref.h" |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 23 | #include "debug/dwarf/dwarf_constants.h" |
| 24 | #include "debug/elf_compilation_unit.h" |
| 25 | #include "debug/elf_debug_frame_writer.h" |
| 26 | #include "debug/elf_debug_info_writer.h" |
| 27 | #include "debug/elf_debug_line_writer.h" |
| 28 | #include "debug/elf_debug_loc_writer.h" |
| 29 | #include "debug/elf_gnu_debugdata_writer.h" |
| 30 | #include "debug/elf_symtab_writer.h" |
| 31 | #include "debug/method_debug_info.h" |
Vladimir Marko | 7452797 | 2016-11-29 15:57:32 +0000 | [diff] [blame] | 32 | #include "linker/elf_builder.h" |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 33 | #include "linker/vector_output_stream.h" |
Andreas Gampe | d490129 | 2017-05-30 18:41:34 -0700 | [diff] [blame] | 34 | #include "oat.h" |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 35 | |
| 36 | namespace art { |
| 37 | namespace debug { |
| 38 | |
| 39 | template <typename ElfTypes> |
Vladimir Marko | 7452797 | 2016-11-29 15:57:32 +0000 | [diff] [blame] | 40 | void WriteDebugInfo(linker::ElfBuilder<ElfTypes>* builder, |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 41 | const ArrayRef<const MethodDebugInfo>& method_infos, |
| 42 | dwarf::CFIFormat cfi_format, |
| 43 | bool write_oat_patches) { |
David Srbecky | 09c2a6b | 2016-03-11 17:11:44 +0000 | [diff] [blame] | 44 | // Write .strtab and .symtab. |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 45 | WriteDebugSymbols(builder, method_infos, true /* with_signature */); |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 46 | |
David Srbecky | 09c2a6b | 2016-03-11 17:11:44 +0000 | [diff] [blame] | 47 | // Write .debug_frame. |
| 48 | WriteCFISection(builder, method_infos, cfi_format, write_oat_patches); |
| 49 | |
David Srbecky | 56da23c | 2017-09-08 19:59:15 +0100 | [diff] [blame] | 50 | // Group the methods into compilation units based on class. |
| 51 | std::unordered_map<const DexFile::ClassDef*, ElfCompilationUnit> class_to_compilation_unit; |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 52 | for (const MethodDebugInfo& mi : method_infos) { |
David Srbecky | 09c2a6b | 2016-03-11 17:11:44 +0000 | [diff] [blame] | 53 | if (mi.dex_file != nullptr) { |
| 54 | auto& dex_class_def = mi.dex_file->GetClassDef(mi.class_def_index); |
David Srbecky | 56da23c | 2017-09-08 19:59:15 +0100 | [diff] [blame] | 55 | ElfCompilationUnit& cu = class_to_compilation_unit[&dex_class_def]; |
David Srbecky | 09c2a6b | 2016-03-11 17:11:44 +0000 | [diff] [blame] | 56 | cu.methods.push_back(&mi); |
| 57 | // All methods must have the same addressing mode otherwise the min/max below does not work. |
| 58 | DCHECK_EQ(cu.methods.front()->is_code_address_text_relative, mi.is_code_address_text_relative); |
| 59 | cu.is_code_address_text_relative = mi.is_code_address_text_relative; |
| 60 | cu.code_address = std::min(cu.code_address, mi.code_address); |
| 61 | cu.code_end = std::max(cu.code_end, mi.code_address + mi.code_size); |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 62 | } |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 63 | } |
| 64 | |
David Srbecky | 56da23c | 2017-09-08 19:59:15 +0100 | [diff] [blame] | 65 | // Sort compilation units to make the compiler output deterministic. |
| 66 | std::vector<ElfCompilationUnit> compilation_units; |
| 67 | compilation_units.reserve(class_to_compilation_unit.size()); |
| 68 | for (auto& it : class_to_compilation_unit) { |
| 69 | // The .debug_line section requires the methods to be sorted by code address. |
| 70 | std::stable_sort(it.second.methods.begin(), |
| 71 | it.second.methods.end(), |
| 72 | [](const MethodDebugInfo* a, const MethodDebugInfo* b) { |
| 73 | return a->code_address < b->code_address; |
| 74 | }); |
| 75 | compilation_units.push_back(std::move(it.second)); |
| 76 | } |
| 77 | std::sort(compilation_units.begin(), |
| 78 | compilation_units.end(), |
| 79 | [](ElfCompilationUnit& a, ElfCompilationUnit& b) { |
| 80 | // Sort by index of the first method within the method_infos array. |
| 81 | // This assumes that the order of method_infos is deterministic. |
| 82 | // Code address is not good for sorting due to possible duplicates. |
| 83 | return a.methods.front() < b.methods.front(); |
| 84 | }); |
| 85 | |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 86 | // Write .debug_line section. |
| 87 | if (!compilation_units.empty()) { |
| 88 | ElfDebugLineWriter<ElfTypes> line_writer(builder); |
| 89 | line_writer.Start(); |
| 90 | for (auto& compilation_unit : compilation_units) { |
| 91 | line_writer.WriteCompilationUnit(compilation_unit); |
| 92 | } |
| 93 | line_writer.End(write_oat_patches); |
| 94 | } |
| 95 | |
| 96 | // Write .debug_info section. |
| 97 | if (!compilation_units.empty()) { |
| 98 | ElfDebugInfoWriter<ElfTypes> info_writer(builder); |
| 99 | info_writer.Start(); |
| 100 | for (const auto& compilation_unit : compilation_units) { |
| 101 | ElfCompilationUnitWriter<ElfTypes> cu_writer(&info_writer); |
| 102 | cu_writer.Write(compilation_unit); |
| 103 | } |
| 104 | info_writer.End(write_oat_patches); |
| 105 | } |
| 106 | } |
| 107 | |
| 108 | std::vector<uint8_t> MakeMiniDebugInfo( |
| 109 | InstructionSet isa, |
David Srbecky | 5d81120 | 2016-03-08 13:21:22 +0000 | [diff] [blame] | 110 | const InstructionSetFeatures* features, |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 111 | size_t rodata_size, |
| 112 | size_t text_size, |
| 113 | const ArrayRef<const MethodDebugInfo>& method_infos) { |
| 114 | if (Is64BitInstructionSet(isa)) { |
David Srbecky | 5d81120 | 2016-03-08 13:21:22 +0000 | [diff] [blame] | 115 | return MakeMiniDebugInfoInternal<ElfTypes64>(isa, |
| 116 | features, |
| 117 | rodata_size, |
| 118 | text_size, |
| 119 | method_infos); |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 120 | } else { |
David Srbecky | 5d81120 | 2016-03-08 13:21:22 +0000 | [diff] [blame] | 121 | return MakeMiniDebugInfoInternal<ElfTypes32>(isa, |
| 122 | features, |
| 123 | rodata_size, |
| 124 | text_size, |
| 125 | method_infos); |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 126 | } |
| 127 | } |
| 128 | |
| 129 | template <typename ElfTypes> |
Vladimir Marko | 93205e3 | 2016-04-13 11:59:46 +0100 | [diff] [blame] | 130 | static std::vector<uint8_t> WriteDebugElfFileForMethodsInternal( |
David Srbecky | fe736b7 | 2016-03-09 11:44:44 +0000 | [diff] [blame] | 131 | InstructionSet isa, |
David Srbecky | 5d81120 | 2016-03-08 13:21:22 +0000 | [diff] [blame] | 132 | const InstructionSetFeatures* features, |
David Srbecky | fe736b7 | 2016-03-09 11:44:44 +0000 | [diff] [blame] | 133 | const ArrayRef<const MethodDebugInfo>& method_infos) { |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 134 | std::vector<uint8_t> buffer; |
| 135 | buffer.reserve(KB); |
Vladimir Marko | 7452797 | 2016-11-29 15:57:32 +0000 | [diff] [blame] | 136 | linker::VectorOutputStream out("Debug ELF file", &buffer); |
| 137 | std::unique_ptr<linker::ElfBuilder<ElfTypes>> builder( |
| 138 | new linker::ElfBuilder<ElfTypes>(isa, features, &out)); |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 139 | // No program headers since the ELF file is not linked and has no allocated sections. |
| 140 | builder->Start(false /* write_program_headers */); |
| 141 | WriteDebugInfo(builder.get(), |
David Srbecky | fe736b7 | 2016-03-09 11:44:44 +0000 | [diff] [blame] | 142 | method_infos, |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 143 | dwarf::DW_DEBUG_FRAME_FORMAT, |
| 144 | false /* write_oat_patches */); |
| 145 | builder->End(); |
| 146 | CHECK(builder->Good()); |
Vladimir Marko | 93205e3 | 2016-04-13 11:59:46 +0100 | [diff] [blame] | 147 | return buffer; |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 148 | } |
| 149 | |
Vladimir Marko | 93205e3 | 2016-04-13 11:59:46 +0100 | [diff] [blame] | 150 | std::vector<uint8_t> WriteDebugElfFileForMethods( |
David Srbecky | fe736b7 | 2016-03-09 11:44:44 +0000 | [diff] [blame] | 151 | InstructionSet isa, |
| 152 | const InstructionSetFeatures* features, |
| 153 | const ArrayRef<const MethodDebugInfo>& method_infos) { |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 154 | if (Is64BitInstructionSet(isa)) { |
David Srbecky | fe736b7 | 2016-03-09 11:44:44 +0000 | [diff] [blame] | 155 | return WriteDebugElfFileForMethodsInternal<ElfTypes64>(isa, features, method_infos); |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 156 | } else { |
David Srbecky | fe736b7 | 2016-03-09 11:44:44 +0000 | [diff] [blame] | 157 | return WriteDebugElfFileForMethodsInternal<ElfTypes32>(isa, features, method_infos); |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 158 | } |
| 159 | } |
| 160 | |
| 161 | template <typename ElfTypes> |
Vladimir Marko | 93205e3 | 2016-04-13 11:59:46 +0100 | [diff] [blame] | 162 | static std::vector<uint8_t> WriteDebugElfFileForClassesInternal( |
David Srbecky | fe736b7 | 2016-03-09 11:44:44 +0000 | [diff] [blame] | 163 | InstructionSet isa, |
David Srbecky | 5d81120 | 2016-03-08 13:21:22 +0000 | [diff] [blame] | 164 | const InstructionSetFeatures* features, |
| 165 | const ArrayRef<mirror::Class*>& types) |
Andreas Gampe | bdf7f1c | 2016-08-30 16:38:47 -0700 | [diff] [blame] | 166 | REQUIRES_SHARED(Locks::mutator_lock_) { |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 167 | std::vector<uint8_t> buffer; |
| 168 | buffer.reserve(KB); |
Vladimir Marko | 7452797 | 2016-11-29 15:57:32 +0000 | [diff] [blame] | 169 | linker::VectorOutputStream out("Debug ELF file", &buffer); |
| 170 | std::unique_ptr<linker::ElfBuilder<ElfTypes>> builder( |
| 171 | new linker::ElfBuilder<ElfTypes>(isa, features, &out)); |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 172 | // No program headers since the ELF file is not linked and has no allocated sections. |
| 173 | builder->Start(false /* write_program_headers */); |
| 174 | ElfDebugInfoWriter<ElfTypes> info_writer(builder.get()); |
| 175 | info_writer.Start(); |
| 176 | ElfCompilationUnitWriter<ElfTypes> cu_writer(&info_writer); |
| 177 | cu_writer.Write(types); |
| 178 | info_writer.End(false /* write_oat_patches */); |
| 179 | |
| 180 | builder->End(); |
| 181 | CHECK(builder->Good()); |
Vladimir Marko | 93205e3 | 2016-04-13 11:59:46 +0100 | [diff] [blame] | 182 | return buffer; |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 183 | } |
| 184 | |
Vladimir Marko | 93205e3 | 2016-04-13 11:59:46 +0100 | [diff] [blame] | 185 | std::vector<uint8_t> WriteDebugElfFileForClasses(InstructionSet isa, |
| 186 | const InstructionSetFeatures* features, |
| 187 | const ArrayRef<mirror::Class*>& types) { |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 188 | if (Is64BitInstructionSet(isa)) { |
David Srbecky | 5d81120 | 2016-03-08 13:21:22 +0000 | [diff] [blame] | 189 | return WriteDebugElfFileForClassesInternal<ElfTypes64>(isa, features, types); |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 190 | } else { |
David Srbecky | 5d81120 | 2016-03-08 13:21:22 +0000 | [diff] [blame] | 191 | return WriteDebugElfFileForClassesInternal<ElfTypes32>(isa, features, types); |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 192 | } |
| 193 | } |
| 194 | |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 195 | // Explicit instantiations |
| 196 | template void WriteDebugInfo<ElfTypes32>( |
Vladimir Marko | 7452797 | 2016-11-29 15:57:32 +0000 | [diff] [blame] | 197 | linker::ElfBuilder<ElfTypes32>* builder, |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 198 | const ArrayRef<const MethodDebugInfo>& method_infos, |
| 199 | dwarf::CFIFormat cfi_format, |
| 200 | bool write_oat_patches); |
| 201 | template void WriteDebugInfo<ElfTypes64>( |
Vladimir Marko | 7452797 | 2016-11-29 15:57:32 +0000 | [diff] [blame] | 202 | linker::ElfBuilder<ElfTypes64>* builder, |
David Srbecky | c5bfa97 | 2016-02-05 15:49:10 +0000 | [diff] [blame] | 203 | const ArrayRef<const MethodDebugInfo>& method_infos, |
| 204 | dwarf::CFIFormat cfi_format, |
| 205 | bool write_oat_patches); |
| 206 | |
| 207 | } // namespace debug |
| 208 | } // namespace art |