tools/llvm-readobj/ARMEHABIPrinter.h

   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
  10 #ifndef LLVM_READOBJ_ARMEHABI_PRINTER_H
  11 #define LLVM_READOBJ_ARMEHABI_PRINTER_H
  12
  13 #include "Error.h"
  14 #include "StreamWriter.h"
  15 #include "llvm/Object/ELF.h"
  16 #include "llvm/Object/ELFTypes.h"
  17 #include "llvm/Support/ARMEHABI.h"
  18 #include "llvm/Support/Endian.h"
  19 #include "llvm/Support/type_traits.h"
  20
  21 namespace llvm {
  22 namespace ARM {
  23 namespace EHABI {
  24 template <typename ET>
  25 class PrinterContext {
  26   StreamWriter &SW;
  27   const object::ELFFile<ET> *ELF;
  28
  29   typedef typename object::ELFFile<ET>::Elf_Sym Elf_Sym;
  30   typedef typename object::ELFFile<ET>::Elf_Shdr Elf_Shdr;
  31
  32   typedef typename object::ELFFile<ET>::Elf_Rel_Iter Elf_Rel_iterator;
  33   typedef typename object::ELFFile<ET>::Elf_Sym_Iter Elf_Sym_iterator;
  34   typedef typename object::ELFFile<ET>::Elf_Shdr_Iter Elf_Shdr_iterator;
  35
  36   static const size_t IndexTableEntrySize;
  37
  38   static uint64_t PREL31(uint32_t Address, uint32_t Place) {
  39     uint64_t Location = Address & 0x7fffffff;
  40     if (Location & 0x04000000)
  41       Location |= (uint64_t) ~0x7fffffff;
  42     return Location + Place;
  43   }
  44
  45   ErrorOr<StringRef> FunctionAtAddress(unsigned Section, uint64_t Address) const;
  46   const Elf_Shdr *FindExceptionTable(unsigned IndexTableIndex,
  47                                      off_t IndexTableOffset) const;
  48
  49   void PrintIndexTable(unsigned SectionIndex, const Elf_Shdr *IT) const;
  50   void PrintExceptionTable(const Elf_Shdr *IT, const Elf_Shdr *EHT,
  51                            uint64_t TableEntryOffset) const;
  52   void PrintOpcodes(const uint8_t *Entry, size_t Length, off_t Offset) const;
  53
  54 public:
  55   PrinterContext(StreamWriter &Writer, const object::ELFFile<ET> *File)
  56     : SW(Writer), ELF(File) {}
  57
  58   void PrintUnwindInformation() const;
  59 };
  60
  61 template <typename ET>
  62 const size_t PrinterContext<ET>::IndexTableEntrySize = 8;
  63
  64 template <typename ET>
  65 ErrorOr<StringRef> PrinterContext<ET>::FunctionAtAddress(unsigned Section,
  66                                                          uint64_t Address) const {
  67   for (Elf_Sym_iterator SI = ELF->begin_symbols(), SE = ELF->end_symbols();
  68        SI != SE; ++SI)
  69     if (SI->st_shndx == Section && SI->st_value == Address &&
  70         SI->getType() == ELF::STT_FUNC)
  71       return ELF->getSymbolName(SI);
  72   return readobj_error::unknown_symbol;
  73 }
  74
  75 template <typename ET>
  76 const typename object::ELFFile<ET>::Elf_Shdr *
  77 PrinterContext<ET>::FindExceptionTable(unsigned IndexSectionIndex,
  78                                        off_t IndexTableOffset) const {
  79   /// Iterate through the sections, searching for the relocation section
  80   /// associated with the unwind index table section specified by
  81   /// IndexSectionIndex.  Iterate the associated section searching for the
  82   /// relocation associated with the index table entry specified by
  83   /// IndexTableOffset.  The symbol is the section symbol for the exception
  84   /// handling table.  Use this symbol to recover the actual exception handling
  85   /// table.
  86
  87   for (Elf_Shdr_iterator SI = ELF->begin_sections(), SE = ELF->end_sections();
  88        SI != SE; ++SI) {
  89     if (SI->sh_type == ELF::SHT_REL && SI->sh_info == IndexSectionIndex) {
  90       for (Elf_Rel_iterator RI = ELF->begin_rel(&*SI), RE = ELF->end_rel(&*SI);
  91            RI != RE; ++RI) {
  92         if (RI->r_offset == IndexTableOffset) {
  93           typename object::ELFFile<ET>::Elf_Rela RelA;
  94           RelA.r_offset = RI->r_offset;
  95           RelA.r_info = RI->r_info;
  96           RelA.r_addend = 0;
  97
  98           std::pair<const Elf_Shdr *, const Elf_Sym *> Symbol =
  99             ELF->getRelocationSymbol(&(*SI), &RelA);
 100
 101           return ELF->getSection(Symbol.second);
 102         }
 103       }
 104     }
 105   }
 106   return NULL;
 107 }
 108
 109 template <typename ET>
 110 void PrinterContext<ET>::PrintExceptionTable(const Elf_Shdr *IT,
 111                                              const Elf_Shdr *EHT,
 112                                              uint64_t TableEntryOffset) const {
 113   ErrorOr<ArrayRef<uint8_t> > Contents = ELF->getSectionContents(EHT);
 114   if (!Contents)
 115     return;
 116
 117   /// ARM EHABI Section 6.2 - The generic model
 118   ///
 119   /// An exception-handling table entry for the generic model is laid out as:
 120   ///
 121   ///  3 3
 122   ///  1 0                            0
 123   /// +-+------------------------------+
 124   /// |0|  personality routine offset  |
 125   /// +-+------------------------------+
 126   /// |  personality routine data ...  |
 127   ///
 128   ///
 129   /// ARM EHABI Section 6.3 - The ARM-defined compact model
 130   ///
 131   /// An exception-handling table entry for the compact model looks like:
 132   ///
 133   ///  3 3 2 2  2 2
 134   ///  1 0 8 7  4 3                     0
 135   /// +-+---+----+-----------------------+
 136   /// |1| 0 | Ix | data for pers routine |
 137   /// +-+---+----+-----------------------+
 138   /// |  more personality routine data   |
 139
 140   const support::ulittle32_t Word =
 141     *reinterpret_cast<const support::ulittle32_t *>(Contents->data() + TableEntryOffset);
 142
 143   if (Word & 0x80000000) {
 144     SW.printString("Model", StringRef("Compact"));
 145
 146     unsigned PersonalityIndex = (Word & 0x0f000000) >> 24;
 147     SW.printNumber("PersonalityIndex", PersonalityIndex);
 148
 149     switch (PersonalityIndex) {
 150     case AEABI_UNWIND_CPP_PR0:
 151       llvm_unreachable("Personality 0 should be compact inline!");
 152       break;
 153     case AEABI_UNWIND_CPP_PR1:
 154     case AEABI_UNWIND_CPP_PR2:
 155       unsigned AdditionalWords = (Word & 0x00ff0000) >> 16;
 156       PrintOpcodes(Contents->data() + TableEntryOffset, 2 + 4 * AdditionalWords,
 157                    2);
 158       break;
 159     }
 160   } else {
 161     SW.printString("Model", StringRef("Generic"));
 162
 163     uint64_t Address = PREL31(Word, EHT->sh_addr);
 164     SW.printHex("PersonalityRoutineAddress", Address);
 165     if (ErrorOr<StringRef> Name = FunctionAtAddress(EHT->sh_link, Address))
 166       SW.printString("PersonalityRoutineName", *Name);
 167   }
 168 }
 169
 170 template <typename ET>
 171 void PrinterContext<ET>::PrintOpcodes(const uint8_t *Entry,
 172                                       size_t Length, off_t Offset) const {
 173   ListScope OCC(SW, "Opcodes");
 174   for (unsigned OCI = Offset; OCI < Length + Offset; OCI++)
 175     SW.printHex("Opcode", Entry[OCI ^ 0x3]);
 176 }
 177
 178 template <typename ET>
 179 void PrinterContext<ET>::PrintIndexTable(unsigned SectionIndex,
 180                                          const Elf_Shdr *IT) const {
 181   ErrorOr<ArrayRef<uint8_t> > Contents = ELF->getSectionContents(IT);
 182   if (!Contents)
 183     return;
 184
 185   /// ARM EHABI Section 5 - Index Table Entries
 186   /// * The first word contains a PREL31 offset to the start of a function with
 187   ///   bit 31 clear
 188   /// * The second word contains one of:
 189   ///   - The PREL31 offset of the start of the table entry for the function,
 190   ///     with bit 31 clear
 191   ///   - The exception-handling table entry itself with bit 31 set
 192   ///   - The special bit pattern EXIDX_CANTUNWIND, indicating that associated
 193   ///     frames cannot be unwound
 194
 195   const support::ulittle32_t *Data =
 196     reinterpret_cast<const support::ulittle32_t *>(Contents->data());
 197   const unsigned Entries = IT->sh_size / IndexTableEntrySize;
 198
 199   ListScope E(SW, "Entries");
 200   for (unsigned Entry = 0; Entry < Entries; ++Entry) {
 201     DictScope E(SW, "Entry");
 202
 203     const support::ulittle32_t Word0 =
 204       Data[Entry * (IndexTableEntrySize / sizeof(*Data)) + 0];
 205     const support::ulittle32_t Word1 =
 206       Data[Entry * (IndexTableEntrySize / sizeof(*Data)) + 1];
 207
 208     if (Word0 & 0x80000000) {
 209       errs() << "corrupt unwind data in section " << SectionIndex << "\n";
 210       continue;
 211     }
 212
 213     const uint64_t Offset = PREL31(Word0, IT->sh_addr);
 214     SW.printHex("FunctionAddress", Offset);
 215     if (ErrorOr<StringRef> Name = FunctionAtAddress(IT->sh_link, Offset))
 216       SW.printString("FunctionName", *Name);
 217
 218     if (Word1 == EXIDX_CANTUNWIND) {
 219       SW.printString("Model", StringRef("CantUnwind"));
 220       continue;
 221     }
 222
 223     if (Word1 & 0x80000000) {
 224       SW.printString("Model", StringRef("Compact (Inline)"));
 225
 226       unsigned PersonalityIndex = (Word1 & 0x0f000000) >> 24;
 227       SW.printNumber("PersonalityIndex", PersonalityIndex);
 228
 229       PrintOpcodes(Contents->data() + Entry * IndexTableEntrySize + 4, 3, 1);
 230     } else {
 231       const Elf_Shdr *EHT =
 232         FindExceptionTable(SectionIndex, Entry * IndexTableEntrySize + 4);
 233
 234       if (ErrorOr<StringRef> Name = ELF->getSectionName(EHT))
 235         SW.printString("ExceptionHandlingTable", *Name);
 236
 237       uint64_t TableEntryOffset = PREL31(Word1, IT->sh_addr);
 238       SW.printHex("TableEntryOffset", TableEntryOffset);
 239
 240       PrintExceptionTable(IT, EHT, TableEntryOffset);
 241     }
 242   }
 243 }
 244
 245 template <typename ET>
 246 void PrinterContext<ET>::PrintUnwindInformation() const {
 247   DictScope UI(SW, "UnwindInformation");
 248
 249   int SectionIndex = 0;
 250   for (Elf_Shdr_iterator SI = ELF->begin_sections(), SE = ELF->end_sections();
 251        SI != SE; ++SI, ++SectionIndex) {
 252     if (SI->sh_type == ELF::SHT_ARM_EXIDX) {
 253       const Elf_Shdr *IT = &(*SI);
 254
 255       DictScope UIT(SW, "UnwindIndexTable");
 256
 257       SW.printNumber("SectionIndex", SectionIndex);
 258       if (ErrorOr<StringRef> SectionName = ELF->getSectionName(IT))
 259         SW.printString("SectionName", *SectionName);
 260       SW.printHex("SectionOffset", IT->sh_offset);
 261
 262       PrintIndexTable(SectionIndex, IT);
 263     }
 264   }
 265 }
 266 }
 267 }
 268 }
 269
 270 #endif
 271