| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 1 | //===--- ARMEHABIPrinter.h - ARM EHABI Unwind Information Printer ----------===// | 
|  | 2 | // | 
|  | 3 | //                     The LLVM Compiler Infrastructure | 
|  | 4 | // | 
|  | 5 | // This file is distributed under the University of Illinois Open Source | 
|  | 6 | // License. See LICENSE.TXT for details. | 
|  | 7 | // | 
|  | 8 | //===----------------------------------------------------------------------===// | 
|  | 9 |  | 
| Benjamin Kramer | a7c40ef | 2014-08-13 16:26:38 +0000 | [diff] [blame] | 10 | #ifndef LLVM_TOOLS_LLVM_READOBJ_ARMEHABIPRINTER_H | 
|  | 11 | #define LLVM_TOOLS_LLVM_READOBJ_ARMEHABIPRINTER_H | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 12 |  | 
| Chandler Carruth | 01e5037 | 2014-01-13 08:09:47 +0000 | [diff] [blame] | 13 | #include "Error.h" | 
| Benjamin Kramer | 391be79 | 2016-01-27 19:29:56 +0000 | [diff] [blame] | 14 | #include "llvm-readobj.h" | 
| Saleem Abdulrasool | 8cdb9df | 2014-04-12 18:04:27 +0000 | [diff] [blame] | 15 | #include "llvm/ADT/STLExtras.h" | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 16 | #include "llvm/Object/ELF.h" | 
|  | 17 | #include "llvm/Object/ELFTypes.h" | 
|  | 18 | #include "llvm/Support/ARMEHABI.h" | 
| Saleem Abdulrasool | 9f0a21e | 2014-01-21 02:33:15 +0000 | [diff] [blame] | 19 | #include "llvm/Support/Debug.h" | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 20 | #include "llvm/Support/Endian.h" | 
| Saleem Abdulrasool | 9f0a21e | 2014-01-21 02:33:15 +0000 | [diff] [blame] | 21 | #include "llvm/Support/Format.h" | 
| Zachary Turner | 88bb163 | 2016-05-03 00:28:04 +0000 | [diff] [blame] | 22 | #include "llvm/Support/ScopedPrinter.h" | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 23 | #include "llvm/Support/type_traits.h" | 
|  | 24 |  | 
|  | 25 | namespace llvm { | 
|  | 26 | namespace ARM { | 
|  | 27 | namespace EHABI { | 
| Saleem Abdulrasool | 9f0a21e | 2014-01-21 02:33:15 +0000 | [diff] [blame] | 28 |  | 
|  | 29 | class OpcodeDecoder { | 
| Zachary Turner | 88bb163 | 2016-05-03 00:28:04 +0000 | [diff] [blame] | 30 | ScopedPrinter &SW; | 
| Saleem Abdulrasool | 9f0a21e | 2014-01-21 02:33:15 +0000 | [diff] [blame] | 31 | raw_ostream &OS; | 
|  | 32 |  | 
|  | 33 | struct RingEntry { | 
|  | 34 | uint8_t Mask; | 
|  | 35 | uint8_t Value; | 
|  | 36 | void (OpcodeDecoder::*Routine)(const uint8_t *Opcodes, unsigned &OI); | 
|  | 37 | }; | 
|  | 38 | static const RingEntry Ring[]; | 
|  | 39 |  | 
|  | 40 | void Decode_00xxxxxx(const uint8_t *Opcodes, unsigned &OI); | 
|  | 41 | void Decode_01xxxxxx(const uint8_t *Opcodes, unsigned &OI); | 
|  | 42 | void Decode_1000iiii_iiiiiiii(const uint8_t *Opcodes, unsigned &OI); | 
|  | 43 | void Decode_10011101(const uint8_t *Opcodes, unsigned &OI); | 
|  | 44 | void Decode_10011111(const uint8_t *Opcodes, unsigned &OI); | 
|  | 45 | void Decode_1001nnnn(const uint8_t *Opcodes, unsigned &OI); | 
|  | 46 | void Decode_10100nnn(const uint8_t *Opcodes, unsigned &OI); | 
|  | 47 | void Decode_10101nnn(const uint8_t *Opcodes, unsigned &OI); | 
|  | 48 | void Decode_10110000(const uint8_t *Opcodes, unsigned &OI); | 
|  | 49 | void Decode_10110001_0000iiii(const uint8_t *Opcodes, unsigned &OI); | 
|  | 50 | void Decode_10110010_uleb128(const uint8_t *Opcodes, unsigned &OI); | 
|  | 51 | void Decode_10110011_sssscccc(const uint8_t *Opcodes, unsigned &OI); | 
|  | 52 | void Decode_101101nn(const uint8_t *Opcodes, unsigned &OI); | 
|  | 53 | void Decode_10111nnn(const uint8_t *Opcodes, unsigned &OI); | 
|  | 54 | void Decode_11000110_sssscccc(const uint8_t *Opcodes, unsigned &OI); | 
|  | 55 | void Decode_11000111_0000iiii(const uint8_t *Opcodes, unsigned &OI); | 
|  | 56 | void Decode_11001000_sssscccc(const uint8_t *Opcodes, unsigned &OI); | 
|  | 57 | void Decode_11001001_sssscccc(const uint8_t *Opcodes, unsigned &OI); | 
|  | 58 | void Decode_11001yyy(const uint8_t *Opcodes, unsigned &OI); | 
|  | 59 | void Decode_11000nnn(const uint8_t *Opcodes, unsigned &OI); | 
|  | 60 | void Decode_11010nnn(const uint8_t *Opcodes, unsigned &OI); | 
|  | 61 | void Decode_11xxxyyy(const uint8_t *Opcodes, unsigned &OI); | 
|  | 62 |  | 
|  | 63 | void PrintGPR(uint16_t GPRMask); | 
|  | 64 | void PrintRegisters(uint32_t Mask, StringRef Prefix); | 
|  | 65 |  | 
|  | 66 | public: | 
| Zachary Turner | 88bb163 | 2016-05-03 00:28:04 +0000 | [diff] [blame] | 67 | OpcodeDecoder(ScopedPrinter &SW) : SW(SW), OS(SW.getOStream()) {} | 
| Saleem Abdulrasool | 9f0a21e | 2014-01-21 02:33:15 +0000 | [diff] [blame] | 68 | void Decode(const uint8_t *Opcodes, off_t Offset, size_t Length); | 
|  | 69 | }; | 
|  | 70 |  | 
|  | 71 | const OpcodeDecoder::RingEntry OpcodeDecoder::Ring[] = { | 
|  | 72 | { 0xc0, 0x00, &OpcodeDecoder::Decode_00xxxxxx }, | 
|  | 73 | { 0xc0, 0x40, &OpcodeDecoder::Decode_01xxxxxx }, | 
|  | 74 | { 0xf0, 0x80, &OpcodeDecoder::Decode_1000iiii_iiiiiiii }, | 
|  | 75 | { 0xff, 0x9d, &OpcodeDecoder::Decode_10011101 }, | 
|  | 76 | { 0xff, 0x9f, &OpcodeDecoder::Decode_10011111 }, | 
|  | 77 | { 0xf0, 0x90, &OpcodeDecoder::Decode_1001nnnn }, | 
|  | 78 | { 0xf8, 0xa0, &OpcodeDecoder::Decode_10100nnn }, | 
|  | 79 | { 0xf8, 0xa8, &OpcodeDecoder::Decode_10101nnn }, | 
|  | 80 | { 0xff, 0xb0, &OpcodeDecoder::Decode_10110000 }, | 
|  | 81 | { 0xff, 0xb1, &OpcodeDecoder::Decode_10110001_0000iiii }, | 
|  | 82 | { 0xff, 0xb2, &OpcodeDecoder::Decode_10110010_uleb128 }, | 
|  | 83 | { 0xff, 0xb3, &OpcodeDecoder::Decode_10110011_sssscccc }, | 
|  | 84 | { 0xfc, 0xb4, &OpcodeDecoder::Decode_101101nn }, | 
|  | 85 | { 0xf8, 0xb8, &OpcodeDecoder::Decode_10111nnn }, | 
|  | 86 | { 0xff, 0xc6, &OpcodeDecoder::Decode_11000110_sssscccc }, | 
|  | 87 | { 0xff, 0xc7, &OpcodeDecoder::Decode_11000111_0000iiii }, | 
|  | 88 | { 0xff, 0xc8, &OpcodeDecoder::Decode_11001000_sssscccc }, | 
|  | 89 | { 0xff, 0xc9, &OpcodeDecoder::Decode_11001001_sssscccc }, | 
|  | 90 | { 0xc8, 0xc8, &OpcodeDecoder::Decode_11001yyy }, | 
|  | 91 | { 0xf8, 0xc0, &OpcodeDecoder::Decode_11000nnn }, | 
|  | 92 | { 0xf8, 0xd0, &OpcodeDecoder::Decode_11010nnn }, | 
|  | 93 | { 0xc0, 0xc0, &OpcodeDecoder::Decode_11xxxyyy }, | 
|  | 94 | }; | 
|  | 95 |  | 
|  | 96 | void OpcodeDecoder::Decode_00xxxxxx(const uint8_t *Opcodes, unsigned &OI) { | 
|  | 97 | uint8_t Opcode = Opcodes[OI++ ^ 3]; | 
|  | 98 | SW.startLine() << format("0x%02X      ; vsp = vsp + %u\n", Opcode, | 
|  | 99 | ((Opcode & 0x3f) << 2) + 4); | 
|  | 100 | } | 
|  | 101 | void OpcodeDecoder::Decode_01xxxxxx(const uint8_t *Opcodes, unsigned &OI) { | 
|  | 102 | uint8_t Opcode = Opcodes[OI++ ^ 3]; | 
|  | 103 | SW.startLine() << format("0x%02X      ; vsp = vsp - %u\n", Opcode, | 
|  | 104 | ((Opcode & 0x3f) << 2) + 4); | 
|  | 105 | } | 
|  | 106 | void OpcodeDecoder::Decode_1000iiii_iiiiiiii(const uint8_t *Opcodes, | 
|  | 107 | unsigned &OI) { | 
|  | 108 | uint8_t Opcode0 = Opcodes[OI++ ^ 3]; | 
|  | 109 | uint8_t Opcode1 = Opcodes[OI++ ^ 3]; | 
|  | 110 |  | 
|  | 111 | uint16_t GPRMask = (Opcode1 << 4) | ((Opcode0 & 0x0f) << 12); | 
|  | 112 | SW.startLine() | 
|  | 113 | << format("0x%02X 0x%02X ; %s", | 
|  | 114 | Opcode0, Opcode1, GPRMask ? "pop " : "refuse to unwind"); | 
|  | 115 | if (GPRMask) | 
|  | 116 | PrintGPR(GPRMask); | 
|  | 117 | OS << '\n'; | 
|  | 118 | } | 
|  | 119 | void OpcodeDecoder::Decode_10011101(const uint8_t *Opcodes, unsigned &OI) { | 
|  | 120 | uint8_t Opcode = Opcodes[OI++ ^ 3]; | 
|  | 121 | SW.startLine() << format("0x%02X      ; reserved (ARM MOVrr)\n", Opcode); | 
|  | 122 | } | 
|  | 123 | void OpcodeDecoder::Decode_10011111(const uint8_t *Opcodes, unsigned &OI) { | 
|  | 124 | uint8_t Opcode = Opcodes[OI++ ^ 3]; | 
|  | 125 | SW.startLine() << format("0x%02X      ; reserved (WiMMX MOVrr)\n", Opcode); | 
|  | 126 | } | 
|  | 127 | void OpcodeDecoder::Decode_1001nnnn(const uint8_t *Opcodes, unsigned &OI) { | 
|  | 128 | uint8_t Opcode = Opcodes[OI++ ^ 3]; | 
|  | 129 | SW.startLine() << format("0x%02X      ; vsp = r%u\n", Opcode, (Opcode & 0x0f)); | 
|  | 130 | } | 
|  | 131 | void OpcodeDecoder::Decode_10100nnn(const uint8_t *Opcodes, unsigned &OI) { | 
|  | 132 | uint8_t Opcode = Opcodes[OI++ ^ 3]; | 
|  | 133 | SW.startLine() << format("0x%02X      ; pop ", Opcode); | 
|  | 134 | PrintGPR((((1 << ((Opcode & 0x7) + 1)) - 1) << 4)); | 
|  | 135 | OS << '\n'; | 
|  | 136 | } | 
|  | 137 | void OpcodeDecoder::Decode_10101nnn(const uint8_t *Opcodes, unsigned &OI) { | 
|  | 138 | uint8_t Opcode = Opcodes[OI++ ^ 3]; | 
|  | 139 | SW.startLine() << format("0x%02X      ; pop ", Opcode); | 
|  | 140 | PrintGPR((((1 << ((Opcode & 0x7) + 1)) - 1) << 4) | (1 << 14)); | 
|  | 141 | OS << '\n'; | 
|  | 142 | } | 
|  | 143 | void OpcodeDecoder::Decode_10110000(const uint8_t *Opcodes, unsigned &OI) { | 
|  | 144 | uint8_t Opcode = Opcodes[OI++ ^ 3]; | 
|  | 145 | SW.startLine() << format("0x%02X      ; finish\n", Opcode); | 
|  | 146 | } | 
|  | 147 | void OpcodeDecoder::Decode_10110001_0000iiii(const uint8_t *Opcodes, | 
|  | 148 | unsigned &OI) { | 
|  | 149 | uint8_t Opcode0 = Opcodes[OI++ ^ 3]; | 
|  | 150 | uint8_t Opcode1 = Opcodes[OI++ ^ 3]; | 
|  | 151 |  | 
|  | 152 | SW.startLine() | 
|  | 153 | << format("0x%02X 0x%02X ; %s", Opcode0, Opcode1, | 
|  | 154 | ((Opcode1 & 0xf0) || Opcode1 == 0x00) ? "spare" : "pop "); | 
|  | 155 | if (((Opcode1 & 0xf0) == 0x00) && Opcode1) | 
|  | 156 | PrintGPR((Opcode1 & 0x0f)); | 
|  | 157 | OS << '\n'; | 
|  | 158 | } | 
|  | 159 | void OpcodeDecoder::Decode_10110010_uleb128(const uint8_t *Opcodes, | 
|  | 160 | unsigned &OI) { | 
|  | 161 | uint8_t Opcode = Opcodes[OI++ ^ 3]; | 
|  | 162 | SW.startLine() << format("0x%02X ", Opcode); | 
|  | 163 |  | 
|  | 164 | SmallVector<uint8_t, 4> ULEB; | 
|  | 165 | do { ULEB.push_back(Opcodes[OI ^ 3]); } while (Opcodes[OI++ ^ 3] & 0x80); | 
|  | 166 |  | 
|  | 167 | for (unsigned BI = 0, BE = ULEB.size(); BI != BE; ++BI) | 
|  | 168 | OS << format("0x%02X ", ULEB[BI]); | 
|  | 169 |  | 
|  | 170 | uint64_t Value = 0; | 
|  | 171 | for (unsigned BI = 0, BE = ULEB.size(); BI != BE; ++BI) | 
|  | 172 | Value = Value | ((ULEB[BI] & 0x7f) << (7 * BI)); | 
|  | 173 |  | 
| Saleem Abdulrasool | b28cec4d | 2014-01-21 04:31:29 +0000 | [diff] [blame] | 174 | OS << format("; vsp = vsp + %" PRIu64 "\n", 0x204 + (Value << 2)); | 
| Saleem Abdulrasool | 9f0a21e | 2014-01-21 02:33:15 +0000 | [diff] [blame] | 175 | } | 
|  | 176 | void OpcodeDecoder::Decode_10110011_sssscccc(const uint8_t *Opcodes, | 
|  | 177 | unsigned &OI) { | 
|  | 178 | uint8_t Opcode0 = Opcodes[OI++ ^ 3]; | 
|  | 179 | uint8_t Opcode1 = Opcodes[OI++ ^ 3]; | 
|  | 180 | SW.startLine() << format("0x%02X 0x%02X ; pop ", Opcode0, Opcode1); | 
|  | 181 | uint8_t Start = ((Opcode1 & 0xf0) >> 4); | 
|  | 182 | uint8_t Count = ((Opcode1 & 0x0f) >> 0); | 
|  | 183 | PrintRegisters((((1 << (Count + 1)) - 1) << Start), "d"); | 
|  | 184 | OS << '\n'; | 
|  | 185 | } | 
|  | 186 | void OpcodeDecoder::Decode_101101nn(const uint8_t *Opcodes, unsigned &OI) { | 
|  | 187 | uint8_t Opcode = Opcodes[OI++ ^ 3]; | 
|  | 188 | SW.startLine() << format("0x%02X      ; spare\n", Opcode); | 
|  | 189 | } | 
|  | 190 | void OpcodeDecoder::Decode_10111nnn(const uint8_t *Opcodes, unsigned &OI) { | 
|  | 191 | uint8_t Opcode = Opcodes[OI++ ^ 3]; | 
|  | 192 | SW.startLine() << format("0x%02X      ; pop ", Opcode); | 
|  | 193 | PrintRegisters((((1 << ((Opcode & 0x07) + 1)) - 1) << 8), "d"); | 
|  | 194 | OS << '\n'; | 
|  | 195 | } | 
|  | 196 | void OpcodeDecoder::Decode_11000110_sssscccc(const uint8_t *Opcodes, | 
|  | 197 | unsigned &OI) { | 
|  | 198 | uint8_t Opcode0 = Opcodes[OI++ ^ 3]; | 
|  | 199 | uint8_t Opcode1 = Opcodes[OI++ ^ 3]; | 
|  | 200 | SW.startLine() << format("0x%02X 0x%02X ; pop ", Opcode0, Opcode1); | 
|  | 201 | uint8_t Start = ((Opcode1 & 0xf0) >> 4); | 
|  | 202 | uint8_t Count = ((Opcode1 & 0x0f) >> 0); | 
|  | 203 | PrintRegisters((((1 << (Count + 1)) - 1) << Start), "wR"); | 
|  | 204 | OS << '\n'; | 
|  | 205 | } | 
|  | 206 | void OpcodeDecoder::Decode_11000111_0000iiii(const uint8_t *Opcodes, | 
|  | 207 | unsigned &OI) { | 
|  | 208 | uint8_t Opcode0 = Opcodes[OI++ ^ 3]; | 
|  | 209 | uint8_t Opcode1 = Opcodes[OI++ ^ 3]; | 
|  | 210 | SW.startLine() | 
|  | 211 | << format("0x%02X 0x%02X ; %s", Opcode0, Opcode1, | 
|  | 212 | ((Opcode1 & 0xf0) || Opcode1 == 0x00) ? "spare" : "pop "); | 
|  | 213 | if ((Opcode1 & 0xf0) == 0x00 && Opcode1) | 
|  | 214 | PrintRegisters(Opcode1 & 0x0f, "wCGR"); | 
|  | 215 | OS << '\n'; | 
|  | 216 | } | 
|  | 217 | void OpcodeDecoder::Decode_11001000_sssscccc(const uint8_t *Opcodes, | 
|  | 218 | unsigned &OI) { | 
|  | 219 | uint8_t Opcode0 = Opcodes[OI++ ^ 3]; | 
|  | 220 | uint8_t Opcode1 = Opcodes[OI++ ^ 3]; | 
|  | 221 | SW.startLine() << format("0x%02X 0x%02X ; pop ", Opcode0, Opcode1); | 
|  | 222 | uint8_t Start = 16 + ((Opcode1 & 0xf0) >> 4); | 
|  | 223 | uint8_t Count = ((Opcode1 & 0x0f) >> 0); | 
|  | 224 | PrintRegisters((((1 << (Count + 1)) - 1) << Start), "d"); | 
|  | 225 | OS << '\n'; | 
|  | 226 | } | 
|  | 227 | void OpcodeDecoder::Decode_11001001_sssscccc(const uint8_t *Opcodes, | 
|  | 228 | unsigned &OI) { | 
|  | 229 | uint8_t Opcode0 = Opcodes[OI++ ^ 3]; | 
|  | 230 | uint8_t Opcode1 = Opcodes[OI++ ^ 3]; | 
|  | 231 | SW.startLine() << format("0x%02X 0x%02X ; pop ", Opcode0, Opcode1); | 
|  | 232 | uint8_t Start = ((Opcode1 & 0xf0) >> 4); | 
|  | 233 | uint8_t Count = ((Opcode1 & 0x0f) >> 0); | 
|  | 234 | PrintRegisters((((1 << (Count + 1)) - 1) << Start), "d"); | 
|  | 235 | OS << '\n'; | 
|  | 236 | } | 
|  | 237 | void OpcodeDecoder::Decode_11001yyy(const uint8_t *Opcodes, unsigned &OI) { | 
|  | 238 | uint8_t Opcode = Opcodes[OI++ ^ 3]; | 
|  | 239 | SW.startLine() << format("0x%02X      ; spare\n", Opcode); | 
|  | 240 | } | 
|  | 241 | void OpcodeDecoder::Decode_11000nnn(const uint8_t *Opcodes, unsigned &OI) { | 
|  | 242 | uint8_t Opcode = Opcodes[OI++ ^ 3]; | 
|  | 243 | SW.startLine() << format("0x%02X      ; pop ", Opcode); | 
|  | 244 | PrintRegisters((((1 << ((Opcode & 0x07) + 1)) - 1) << 10), "wR"); | 
|  | 245 | OS << '\n'; | 
|  | 246 | } | 
|  | 247 | void OpcodeDecoder::Decode_11010nnn(const uint8_t *Opcodes, unsigned &OI) { | 
|  | 248 | uint8_t Opcode = Opcodes[OI++ ^ 3]; | 
|  | 249 | SW.startLine() << format("0x%02X      ; pop ", Opcode); | 
|  | 250 | PrintRegisters((((1 << ((Opcode & 0x07) + 1)) - 1) << 8), "d"); | 
|  | 251 | OS << '\n'; | 
|  | 252 | } | 
|  | 253 | void OpcodeDecoder::Decode_11xxxyyy(const uint8_t *Opcodes, unsigned &OI) { | 
|  | 254 | uint8_t Opcode = Opcodes[OI++ ^ 3]; | 
|  | 255 | SW.startLine() << format("0x%02X      ; spare\n", Opcode); | 
|  | 256 | } | 
|  | 257 |  | 
|  | 258 | void OpcodeDecoder::PrintGPR(uint16_t GPRMask) { | 
|  | 259 | static const char *GPRRegisterNames[16] = { | 
|  | 260 | "r0", "r1", "r2", "r3", "r4", "r5", "r6", "r7", "r8", "r9", "r10", | 
|  | 261 | "fp", "ip", "sp", "lr", "pc" | 
|  | 262 | }; | 
|  | 263 |  | 
|  | 264 | OS << '{'; | 
|  | 265 | bool Comma = false; | 
|  | 266 | for (unsigned RI = 0, RE = 17; RI < RE; ++RI) { | 
|  | 267 | if (GPRMask & (1 << RI)) { | 
|  | 268 | if (Comma) | 
|  | 269 | OS << ", "; | 
|  | 270 | OS << GPRRegisterNames[RI]; | 
|  | 271 | Comma = true; | 
|  | 272 | } | 
|  | 273 | } | 
|  | 274 | OS << '}'; | 
|  | 275 | } | 
|  | 276 |  | 
|  | 277 | void OpcodeDecoder::PrintRegisters(uint32_t VFPMask, StringRef Prefix) { | 
|  | 278 | OS << '{'; | 
|  | 279 | bool Comma = false; | 
|  | 280 | for (unsigned RI = 0, RE = 32; RI < RE; ++RI) { | 
|  | 281 | if (VFPMask & (1 << RI)) { | 
|  | 282 | if (Comma) | 
|  | 283 | OS << ", "; | 
|  | 284 | OS << Prefix << RI; | 
|  | 285 | Comma = true; | 
|  | 286 | } | 
|  | 287 | } | 
|  | 288 | OS << '}'; | 
|  | 289 | } | 
|  | 290 |  | 
|  | 291 | void OpcodeDecoder::Decode(const uint8_t *Opcodes, off_t Offset, size_t Length) { | 
|  | 292 | for (unsigned OCI = Offset; OCI < Length + Offset; ) { | 
|  | 293 | bool Decoded = false; | 
| Saleem Abdulrasool | 8cdb9df | 2014-04-12 18:04:27 +0000 | [diff] [blame] | 294 | for (unsigned REI = 0, REE = array_lengthof(Ring); | 
|  | 295 | REI != REE && !Decoded; ++REI) { | 
| Saleem Abdulrasool | 9f0a21e | 2014-01-21 02:33:15 +0000 | [diff] [blame] | 296 | if ((Opcodes[OCI ^ 3] & Ring[REI].Mask) == Ring[REI].Value) { | 
|  | 297 | (this->*Ring[REI].Routine)(Opcodes, OCI); | 
|  | 298 | Decoded = true; | 
|  | 299 | break; | 
|  | 300 | } | 
|  | 301 | } | 
|  | 302 | if (!Decoded) | 
|  | 303 | SW.startLine() << format("0x%02X      ; reserved\n", Opcodes[OCI++ ^ 3]); | 
|  | 304 | } | 
|  | 305 | } | 
|  | 306 |  | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 307 | template <typename ET> | 
|  | 308 | class PrinterContext { | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 309 | typedef typename object::ELFFile<ET>::Elf_Sym Elf_Sym; | 
|  | 310 | typedef typename object::ELFFile<ET>::Elf_Shdr Elf_Shdr; | 
| Rafael Espindola | 33f2509 | 2015-07-20 20:07:50 +0000 | [diff] [blame] | 311 | typedef typename object::ELFFile<ET>::Elf_Rel Elf_Rel; | 
| Rafael Espindola | aae5541 | 2015-08-10 21:29:35 +0000 | [diff] [blame] | 312 | typedef typename object::ELFFile<ET>::Elf_Word Elf_Word; | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 313 |  | 
| Zachary Turner | 88bb163 | 2016-05-03 00:28:04 +0000 | [diff] [blame] | 314 | ScopedPrinter &SW; | 
| Rafael Espindola | 821a64c | 2015-08-10 20:25:04 +0000 | [diff] [blame] | 315 | const object::ELFFile<ET> *ELF; | 
|  | 316 | const Elf_Shdr *Symtab; | 
| Rafael Espindola | aae5541 | 2015-08-10 21:29:35 +0000 | [diff] [blame] | 317 | ArrayRef<Elf_Word> ShndxTable; | 
| Rafael Espindola | 821a64c | 2015-08-10 20:25:04 +0000 | [diff] [blame] | 318 |  | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 319 | static const size_t IndexTableEntrySize; | 
|  | 320 |  | 
|  | 321 | static uint64_t PREL31(uint32_t Address, uint32_t Place) { | 
|  | 322 | uint64_t Location = Address & 0x7fffffff; | 
|  | 323 | if (Location & 0x04000000) | 
|  | 324 | Location |= (uint64_t) ~0x7fffffff; | 
|  | 325 | return Location + Place; | 
|  | 326 | } | 
|  | 327 |  | 
|  | 328 | ErrorOr<StringRef> FunctionAtAddress(unsigned Section, uint64_t Address) const; | 
|  | 329 | const Elf_Shdr *FindExceptionTable(unsigned IndexTableIndex, | 
|  | 330 | off_t IndexTableOffset) const; | 
|  | 331 |  | 
|  | 332 | void PrintIndexTable(unsigned SectionIndex, const Elf_Shdr *IT) const; | 
|  | 333 | void PrintExceptionTable(const Elf_Shdr *IT, const Elf_Shdr *EHT, | 
|  | 334 | uint64_t TableEntryOffset) const; | 
| Saleem Abdulrasool | 5b060a9 | 2014-01-09 04:31:18 +0000 | [diff] [blame] | 335 | void PrintOpcodes(const uint8_t *Entry, size_t Length, off_t Offset) const; | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 336 |  | 
|  | 337 | public: | 
| Zachary Turner | 88bb163 | 2016-05-03 00:28:04 +0000 | [diff] [blame] | 338 | PrinterContext(ScopedPrinter &SW, const object::ELFFile<ET> *ELF, | 
| Rafael Espindola | 821a64c | 2015-08-10 20:25:04 +0000 | [diff] [blame] | 339 | const Elf_Shdr *Symtab) | 
|  | 340 | : SW(SW), ELF(ELF), Symtab(Symtab) {} | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 341 |  | 
|  | 342 | void PrintUnwindInformation() const; | 
|  | 343 | }; | 
|  | 344 |  | 
|  | 345 | template <typename ET> | 
|  | 346 | const size_t PrinterContext<ET>::IndexTableEntrySize = 8; | 
|  | 347 |  | 
|  | 348 | template <typename ET> | 
| Rafael Espindola | 719dc7c | 2015-06-29 12:38:31 +0000 | [diff] [blame] | 349 | ErrorOr<StringRef> | 
|  | 350 | PrinterContext<ET>::FunctionAtAddress(unsigned Section, | 
|  | 351 | uint64_t Address) const { | 
| Davide Italiano | 6cf0926 | 2016-11-16 05:10:28 +0000 | [diff] [blame] | 352 | auto StrTableOrErr = ELF->getStringTableForSymtab(*Symtab); | 
|  | 353 | if (!StrTableOrErr) | 
|  | 354 | error(StrTableOrErr.takeError()); | 
| Rafael Espindola | 8e54b3e | 2015-07-21 16:26:21 +0000 | [diff] [blame] | 355 | StringRef StrTable = *StrTableOrErr; | 
|  | 356 |  | 
| Rafael Espindola | 9ea6834 | 2016-11-03 13:43:30 +0000 | [diff] [blame] | 357 | for (const Elf_Sym &Sym : unwrapOrError(ELF->symbols(Symtab))) | 
| Rafael Espindola | 719dc7c | 2015-06-29 12:38:31 +0000 | [diff] [blame] | 358 | if (Sym.st_shndx == Section && Sym.st_value == Address && | 
| Kevin Enderby | 81e8b7d | 2016-04-20 21:24:34 +0000 | [diff] [blame] | 359 | Sym.getType() == ELF::STT_FUNC) { | 
|  | 360 | auto NameOrErr = Sym.getName(StrTable); | 
|  | 361 | if (!NameOrErr) { | 
|  | 362 | // TODO: Actually report errors helpfully. | 
|  | 363 | consumeError(NameOrErr.takeError()); | 
|  | 364 | return readobj_error::unknown_symbol; | 
|  | 365 | } | 
|  | 366 | return *NameOrErr; | 
|  | 367 | } | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 368 | return readobj_error::unknown_symbol; | 
|  | 369 | } | 
|  | 370 |  | 
|  | 371 | template <typename ET> | 
|  | 372 | const typename object::ELFFile<ET>::Elf_Shdr * | 
|  | 373 | PrinterContext<ET>::FindExceptionTable(unsigned IndexSectionIndex, | 
|  | 374 | off_t IndexTableOffset) const { | 
|  | 375 | /// Iterate through the sections, searching for the relocation section | 
|  | 376 | /// associated with the unwind index table section specified by | 
|  | 377 | /// IndexSectionIndex.  Iterate the associated section searching for the | 
|  | 378 | /// relocation associated with the index table entry specified by | 
|  | 379 | /// IndexTableOffset.  The symbol is the section symbol for the exception | 
|  | 380 | /// handling table.  Use this symbol to recover the actual exception handling | 
|  | 381 | /// table. | 
|  | 382 |  | 
| Rafael Espindola | 25be8c8 | 2016-11-02 14:10:57 +0000 | [diff] [blame] | 383 | for (const Elf_Shdr &Sec : unwrapOrError(ELF->sections())) { | 
| Rafael Espindola | fc2b6fa | 2015-08-10 18:57:42 +0000 | [diff] [blame] | 384 | if (Sec.sh_type != ELF::SHT_REL || Sec.sh_info != IndexSectionIndex) | 
|  | 385 | continue; | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 386 |  | 
| Davide Italiano | 6cf0926 | 2016-11-16 05:10:28 +0000 | [diff] [blame] | 387 | auto SymTabOrErr = ELF->getSection(Sec.sh_link); | 
|  | 388 | if (!SymTabOrErr) | 
|  | 389 | error(SymTabOrErr.takeError()); | 
| Rafael Espindola | 7d250f7 | 2015-09-02 15:07:39 +0000 | [diff] [blame] | 390 | const Elf_Shdr *SymTab = *SymTabOrErr; | 
|  | 391 |  | 
| Rafael Espindola | 354680a | 2016-11-03 19:07:15 +0000 | [diff] [blame] | 392 | for (const Elf_Rel &R : unwrapOrError(ELF->rels(&Sec))) { | 
| Rafael Espindola | fc2b6fa | 2015-08-10 18:57:42 +0000 | [diff] [blame] | 393 | if (R.r_offset != static_cast<unsigned>(IndexTableOffset)) | 
|  | 394 | continue; | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 395 |  | 
| Rafael Espindola | fc2b6fa | 2015-08-10 18:57:42 +0000 | [diff] [blame] | 396 | typename object::ELFFile<ET>::Elf_Rela RelA; | 
|  | 397 | RelA.r_offset = R.r_offset; | 
|  | 398 | RelA.r_info = R.r_info; | 
|  | 399 | RelA.r_addend = 0; | 
|  | 400 |  | 
| Rafael Espindola | ed1395a | 2016-11-03 18:05:33 +0000 | [diff] [blame] | 401 | const Elf_Sym *Symbol = | 
|  | 402 | unwrapOrError(ELF->getRelocationSymbol(&RelA, SymTab)); | 
| Rafael Espindola | fc2b6fa | 2015-08-10 18:57:42 +0000 | [diff] [blame] | 403 |  | 
| Davide Italiano | 6cf0926 | 2016-11-16 05:10:28 +0000 | [diff] [blame] | 404 | auto Ret = ELF->getSection(Symbol, SymTab, ShndxTable); | 
|  | 405 | if (!Ret) | 
|  | 406 | report_fatal_error(errorToErrorCode(Ret.takeError()).message()); | 
| Rafael Espindola | fc2b6fa | 2015-08-10 18:57:42 +0000 | [diff] [blame] | 407 | return *Ret; | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 408 | } | 
|  | 409 | } | 
| Craig Topper | e73658d | 2014-04-28 04:05:08 +0000 | [diff] [blame] | 410 | return nullptr; | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 411 | } | 
|  | 412 |  | 
|  | 413 | template <typename ET> | 
|  | 414 | void PrinterContext<ET>::PrintExceptionTable(const Elf_Shdr *IT, | 
|  | 415 | const Elf_Shdr *EHT, | 
|  | 416 | uint64_t TableEntryOffset) const { | 
| Davide Italiano | 6cf0926 | 2016-11-16 05:10:28 +0000 | [diff] [blame] | 417 | Expected<ArrayRef<uint8_t>> Contents = ELF->getSectionContents(EHT); | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 418 | if (!Contents) | 
|  | 419 | return; | 
|  | 420 |  | 
|  | 421 | /// ARM EHABI Section 6.2 - The generic model | 
|  | 422 | /// | 
|  | 423 | /// An exception-handling table entry for the generic model is laid out as: | 
|  | 424 | /// | 
|  | 425 | ///  3 3 | 
|  | 426 | ///  1 0                            0 | 
|  | 427 | /// +-+------------------------------+ | 
|  | 428 | /// |0|  personality routine offset  | | 
|  | 429 | /// +-+------------------------------+ | 
|  | 430 | /// |  personality routine data ...  | | 
|  | 431 | /// | 
|  | 432 | /// | 
|  | 433 | /// ARM EHABI Section 6.3 - The ARM-defined compact model | 
|  | 434 | /// | 
|  | 435 | /// An exception-handling table entry for the compact model looks like: | 
|  | 436 | /// | 
|  | 437 | ///  3 3 2 2  2 2 | 
|  | 438 | ///  1 0 8 7  4 3                     0 | 
|  | 439 | /// +-+---+----+-----------------------+ | 
|  | 440 | /// |1| 0 | Ix | data for pers routine | | 
|  | 441 | /// +-+---+----+-----------------------+ | 
|  | 442 | /// |  more personality routine data   | | 
|  | 443 |  | 
| Saleem Abdulrasool | b7b8a8f | 2014-01-09 04:31:14 +0000 | [diff] [blame] | 444 | const support::ulittle32_t Word = | 
|  | 445 | *reinterpret_cast<const support::ulittle32_t *>(Contents->data() + TableEntryOffset); | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 446 |  | 
|  | 447 | if (Word & 0x80000000) { | 
|  | 448 | SW.printString("Model", StringRef("Compact")); | 
|  | 449 |  | 
|  | 450 | unsigned PersonalityIndex = (Word & 0x0f000000) >> 24; | 
|  | 451 | SW.printNumber("PersonalityIndex", PersonalityIndex); | 
|  | 452 |  | 
|  | 453 | switch (PersonalityIndex) { | 
|  | 454 | case AEABI_UNWIND_CPP_PR0: | 
| Saleem Abdulrasool | a7053cb | 2014-02-08 23:17:08 +0000 | [diff] [blame] | 455 | PrintOpcodes(Contents->data() + TableEntryOffset, 3, 1); | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 456 | break; | 
|  | 457 | case AEABI_UNWIND_CPP_PR1: | 
|  | 458 | case AEABI_UNWIND_CPP_PR2: | 
|  | 459 | unsigned AdditionalWords = (Word & 0x00ff0000) >> 16; | 
| Saleem Abdulrasool | 5b060a9 | 2014-01-09 04:31:18 +0000 | [diff] [blame] | 460 | PrintOpcodes(Contents->data() + TableEntryOffset, 2 + 4 * AdditionalWords, | 
|  | 461 | 2); | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 462 | break; | 
|  | 463 | } | 
|  | 464 | } else { | 
|  | 465 | SW.printString("Model", StringRef("Generic")); | 
|  | 466 |  | 
|  | 467 | uint64_t Address = PREL31(Word, EHT->sh_addr); | 
|  | 468 | SW.printHex("PersonalityRoutineAddress", Address); | 
|  | 469 | if (ErrorOr<StringRef> Name = FunctionAtAddress(EHT->sh_link, Address)) | 
|  | 470 | SW.printString("PersonalityRoutineName", *Name); | 
|  | 471 | } | 
|  | 472 | } | 
|  | 473 |  | 
|  | 474 | template <typename ET> | 
| Saleem Abdulrasool | 5b060a9 | 2014-01-09 04:31:18 +0000 | [diff] [blame] | 475 | void PrinterContext<ET>::PrintOpcodes(const uint8_t *Entry, | 
|  | 476 | size_t Length, off_t Offset) const { | 
|  | 477 | ListScope OCC(SW, "Opcodes"); | 
| Saleem Abdulrasool | 9f0a21e | 2014-01-21 02:33:15 +0000 | [diff] [blame] | 478 | OpcodeDecoder(OCC.W).Decode(Entry, Offset, Length); | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 479 | } | 
|  | 480 |  | 
|  | 481 | template <typename ET> | 
|  | 482 | void PrinterContext<ET>::PrintIndexTable(unsigned SectionIndex, | 
|  | 483 | const Elf_Shdr *IT) const { | 
| Davide Italiano | 6cf0926 | 2016-11-16 05:10:28 +0000 | [diff] [blame] | 484 | Expected<ArrayRef<uint8_t>> Contents = ELF->getSectionContents(IT); | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 485 | if (!Contents) | 
|  | 486 | return; | 
|  | 487 |  | 
|  | 488 | /// ARM EHABI Section 5 - Index Table Entries | 
|  | 489 | /// * The first word contains a PREL31 offset to the start of a function with | 
|  | 490 | ///   bit 31 clear | 
|  | 491 | /// * The second word contains one of: | 
|  | 492 | ///   - The PREL31 offset of the start of the table entry for the function, | 
|  | 493 | ///     with bit 31 clear | 
|  | 494 | ///   - The exception-handling table entry itself with bit 31 set | 
|  | 495 | ///   - The special bit pattern EXIDX_CANTUNWIND, indicating that associated | 
|  | 496 | ///     frames cannot be unwound | 
|  | 497 |  | 
| Saleem Abdulrasool | b7b8a8f | 2014-01-09 04:31:14 +0000 | [diff] [blame] | 498 | const support::ulittle32_t *Data = | 
|  | 499 | reinterpret_cast<const support::ulittle32_t *>(Contents->data()); | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 500 | const unsigned Entries = IT->sh_size / IndexTableEntrySize; | 
|  | 501 |  | 
|  | 502 | ListScope E(SW, "Entries"); | 
|  | 503 | for (unsigned Entry = 0; Entry < Entries; ++Entry) { | 
|  | 504 | DictScope E(SW, "Entry"); | 
|  | 505 |  | 
| Saleem Abdulrasool | b7b8a8f | 2014-01-09 04:31:14 +0000 | [diff] [blame] | 506 | const support::ulittle32_t Word0 = | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 507 | Data[Entry * (IndexTableEntrySize / sizeof(*Data)) + 0]; | 
| Saleem Abdulrasool | b7b8a8f | 2014-01-09 04:31:14 +0000 | [diff] [blame] | 508 | const support::ulittle32_t Word1 = | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 509 | Data[Entry * (IndexTableEntrySize / sizeof(*Data)) + 1]; | 
|  | 510 |  | 
|  | 511 | if (Word0 & 0x80000000) { | 
|  | 512 | errs() << "corrupt unwind data in section " << SectionIndex << "\n"; | 
|  | 513 | continue; | 
|  | 514 | } | 
|  | 515 |  | 
|  | 516 | const uint64_t Offset = PREL31(Word0, IT->sh_addr); | 
|  | 517 | SW.printHex("FunctionAddress", Offset); | 
|  | 518 | if (ErrorOr<StringRef> Name = FunctionAtAddress(IT->sh_link, Offset)) | 
|  | 519 | SW.printString("FunctionName", *Name); | 
|  | 520 |  | 
|  | 521 | if (Word1 == EXIDX_CANTUNWIND) { | 
|  | 522 | SW.printString("Model", StringRef("CantUnwind")); | 
|  | 523 | continue; | 
|  | 524 | } | 
|  | 525 |  | 
|  | 526 | if (Word1 & 0x80000000) { | 
|  | 527 | SW.printString("Model", StringRef("Compact (Inline)")); | 
|  | 528 |  | 
|  | 529 | unsigned PersonalityIndex = (Word1 & 0x0f000000) >> 24; | 
|  | 530 | SW.printNumber("PersonalityIndex", PersonalityIndex); | 
|  | 531 |  | 
| Saleem Abdulrasool | 5b060a9 | 2014-01-09 04:31:18 +0000 | [diff] [blame] | 532 | PrintOpcodes(Contents->data() + Entry * IndexTableEntrySize + 4, 3, 1); | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 533 | } else { | 
|  | 534 | const Elf_Shdr *EHT = | 
|  | 535 | FindExceptionTable(SectionIndex, Entry * IndexTableEntrySize + 4); | 
|  | 536 |  | 
| Davide Italiano | 6cf0926 | 2016-11-16 05:10:28 +0000 | [diff] [blame] | 537 | if (auto Name = ELF->getSectionName(EHT)) | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 538 | SW.printString("ExceptionHandlingTable", *Name); | 
|  | 539 |  | 
|  | 540 | uint64_t TableEntryOffset = PREL31(Word1, IT->sh_addr); | 
|  | 541 | SW.printHex("TableEntryOffset", TableEntryOffset); | 
|  | 542 |  | 
|  | 543 | PrintExceptionTable(IT, EHT, TableEntryOffset); | 
|  | 544 | } | 
|  | 545 | } | 
|  | 546 | } | 
|  | 547 |  | 
|  | 548 | template <typename ET> | 
|  | 549 | void PrinterContext<ET>::PrintUnwindInformation() const { | 
|  | 550 | DictScope UI(SW, "UnwindInformation"); | 
|  | 551 |  | 
|  | 552 | int SectionIndex = 0; | 
| Rafael Espindola | 25be8c8 | 2016-11-02 14:10:57 +0000 | [diff] [blame] | 553 | for (const Elf_Shdr &Sec : unwrapOrError(ELF->sections())) { | 
| Rafael Espindola | cf08fb7 | 2015-06-30 19:13:25 +0000 | [diff] [blame] | 554 | if (Sec.sh_type == ELF::SHT_ARM_EXIDX) { | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 555 | DictScope UIT(SW, "UnwindIndexTable"); | 
|  | 556 |  | 
|  | 557 | SW.printNumber("SectionIndex", SectionIndex); | 
| Davide Italiano | 6cf0926 | 2016-11-16 05:10:28 +0000 | [diff] [blame] | 558 | if (auto SectionName = ELF->getSectionName(&Sec)) | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 559 | SW.printString("SectionName", *SectionName); | 
| Rafael Espindola | cf08fb7 | 2015-06-30 19:13:25 +0000 | [diff] [blame] | 560 | SW.printHex("SectionOffset", Sec.sh_offset); | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 561 |  | 
| Rafael Espindola | cf08fb7 | 2015-06-30 19:13:25 +0000 | [diff] [blame] | 562 | PrintIndexTable(SectionIndex, &Sec); | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 563 | } | 
| Rafael Espindola | cf08fb7 | 2015-06-30 19:13:25 +0000 | [diff] [blame] | 564 | ++SectionIndex; | 
| Saleem Abdulrasool | be981ebc | 2014-01-08 03:28:09 +0000 | [diff] [blame] | 565 | } | 
|  | 566 | } | 
|  | 567 | } | 
|  | 568 | } | 
|  | 569 | } | 
|  | 570 |  | 
|  | 571 | #endif | 
|  | 572 |  |