tools/yaml2obj/yaml2elf.cpp

   1 //===- yaml2elf - Convert YAML to a ELF object file -----------------------===//
   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 /// \file
  11 /// \brief The ELF component of yaml2obj.
  12 ///
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "yaml2obj.h"
  16 #include "llvm/Object/ELF.h"
  17 #include "llvm/Object/ELFYAML.h"
  18 #include "llvm/Support/ELF.h"
  19 #include "llvm/Support/MemoryBuffer.h"
  20 #include "llvm/Support/YAMLTraits.h"
  21 #include "llvm/Support/raw_ostream.h"
  22
  23 using namespace llvm;
  24
  25 // There is similar code in yaml2coff, but with some slight COFF-specific
  26 // variations like different initial state. Might be able to deduplicate
  27 // some day, but also want to make sure that the Mach-O use case is served.
  28 //
  29 // This class has a deliberately small interface, since a lot of
  30 // implementation variation is possible.
  31 //
  32 // TODO: Use an ordered container with a suffix-based comparison in order
  33 // to deduplicate suffixes. std::map<> with a custom comparator is likely
  34 // to be the simplest implementation, but a suffix trie could be more
  35 // suitable for the job.
  36 namespace {
  37 class StringTableBuilder {
  38   /// \brief Indices of strings currently present in `Buf`.
  39   StringMap<unsigned> StringIndices;
  40   /// \brief The contents of the string table as we build it.
  41   std::string Buf;
  42 public:
  43   StringTableBuilder() {
  44     Buf.push_back('\0');
  45   }
  46   /// \returns Index of string in string table.
  47   unsigned addString(StringRef S) {
  48     StringMapEntry<unsigned> &Entry = StringIndices.GetOrCreateValue(S);
  49     unsigned &I = Entry.getValue();
  50     if (I != 0)
  51       return I;
  52     I = Buf.size();
  53     Buf.append(S.begin(), S.end());
  54     Buf.push_back('\0');
  55     return I;
  56   }
  57   size_t size() const {
  58     return Buf.size();
  59   }
  60   void writeToStream(raw_ostream &OS) {
  61     OS.write(Buf.data(), Buf.size());
  62   }
  63 };
  64 } // end anonymous namespace
  65
  66 // This class is used to build up a contiguous binary blob while keeping
  67 // track of an offset in the output (which notionally begins at
  68 // `InitialOffset`).
  69 namespace {
  70 class ContiguousBlobAccumulator {
  71   const uint64_t InitialOffset;
  72   SmallVector<char, 128> Buf;
  73   raw_svector_ostream OS;
  74
  75 public:
  76   ContiguousBlobAccumulator(uint64_t InitialOffset_)
  77       : InitialOffset(InitialOffset_), Buf(), OS(Buf) {}
  78   raw_ostream &getOS() { return OS; }
  79   uint64_t currentOffset() const { return InitialOffset + OS.tell(); }
  80   void writeBlobToStream(raw_ostream &Out) { Out << OS.str(); }
  81 };
  82 } // end anonymous namespace
  83
  84 // Used to keep track of section names, so that in the YAML file sections
  85 // can be referenced by name instead of by index.
  86 namespace {
  87 class SectionNameToIdxMap {
  88   StringMap<int> Map;
  89 public:
  90   /// \returns true if name is already present in the map.
  91   bool addName(StringRef SecName, unsigned i) {
  92     StringMapEntry<int> &Entry = Map.GetOrCreateValue(SecName, -1);
  93     if (Entry.getValue() != -1)
  94       return true;
  95     Entry.setValue((int)i);
  96     return false;
  97   }
  98   /// \returns true if name is not present in the map
  99   bool lookupSection(StringRef SecName, unsigned &Idx) const {
 100     StringMap<int>::const_iterator I = Map.find(SecName);
 101     if (I == Map.end())
 102       return true;
 103     Idx = I->getValue();
 104     return false;
 105   }
 106 };
 107 } // end anonymous namespace
 108
 109 template <class T>
 110 static size_t vectorDataSize(const std::vector<T> &Vec) {
 111   return Vec.size() * sizeof(T);
 112 }
 113
 114 template <class T>
 115 static void writeVectorData(raw_ostream &OS, const std::vector<T> &Vec) {
 116   OS.write((const char *)Vec.data(), vectorDataSize(Vec));
 117 }
 118
 119 template <class T>
 120 static void zero(T &Obj) {
 121   memset(&Obj, 0, sizeof(Obj));
 122 }
 123
 124 /// \brief Create a string table in `SHeader`, which we assume is already
 125 /// zero'd.
 126 template <class Elf_Shdr>
 127 static void createStringTableSectionHeader(Elf_Shdr &SHeader,
 128                                            StringTableBuilder &STB,
 129                                            ContiguousBlobAccumulator &CBA) {
 130   SHeader.sh_type = ELF::SHT_STRTAB;
 131   SHeader.sh_offset = CBA.currentOffset();
 132   SHeader.sh_size = STB.size();
 133   STB.writeToStream(CBA.getOS());
 134   SHeader.sh_addralign = 1;
 135 }
 136
 137 namespace {
 138 /// \brief "Single point of truth" for the ELF file construction.
 139 /// TODO: This class still has a ways to go before it is truly a "single
 140 /// point of truth".
 141 template <class ELFT>
 142 class ELFState {
 143   /// \brief The future ".strtab" section.
 144   StringTableBuilder DotStrtab;
 145   /// \brief The section number of the ".strtab" section.
 146   unsigned DotStrtabSecNo;
 147   /// \brief The accumulated contents of all sections so far.
 148   ContiguousBlobAccumulator &SectionContentAccum;
 149   typedef typename object::ELFObjectFile<ELFT>::Elf_Ehdr Elf_Ehdr;
 150   /// \brief The ELF file header.
 151   Elf_Ehdr &Header;
 152
 153 public:
 154
 155   ELFState(Elf_Ehdr &Header_, ContiguousBlobAccumulator &Accum,
 156            unsigned DotStrtabSecNo_)
 157       : DotStrtab(), DotStrtabSecNo(DotStrtabSecNo_),
 158         SectionContentAccum(Accum), Header(Header_) {}
 159
 160   unsigned getDotStrTabSecNo() const { return DotStrtabSecNo; }
 161   StringTableBuilder &getStringTable() { return DotStrtab; }
 162   ContiguousBlobAccumulator &getSectionContentAccum() {
 163     return SectionContentAccum;
 164   }
 165 };
 166 } // end anonymous namespace
 167
 168 // FIXME: This function is hideous. The hideous ELF type names are hideous.
 169 // Factor the ELF output into a class (templated on ELFT) and share some
 170 // typedefs.
 171 template <class ELFT>
 172 static void handleSymtabSectionHeader(
 173     const ELFYAML::Section &Sec, ELFState<ELFT> &State,
 174     typename object::ELFObjectFile<ELFT>::Elf_Shdr &SHeader) {
 175
 176   typedef typename object::ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
 177   // TODO: Ensure that a manually specified `Link` field is diagnosed as an
 178   // error for SHT_SYMTAB.
 179   SHeader.sh_link = State.getDotStrTabSecNo();
 180   // TODO: Once we handle symbol binding, this should be one greater than
 181   // symbol table index of the last local symbol.
 182   SHeader.sh_info = 0;
 183   SHeader.sh_entsize = sizeof(Elf_Sym);
 184
 185   std::vector<Elf_Sym> Syms;
 186   {
 187     // Ensure STN_UNDEF is present
 188     Elf_Sym Sym;
 189     zero(Sym);
 190     Syms.push_back(Sym);
 191   }
 192   for (unsigned i = 0, e = Sec.Symbols.size(); i != e; ++i) {
 193     const ELFYAML::Symbol &Sym = Sec.Symbols[i];
 194     Elf_Sym Symbol;
 195     zero(Symbol);
 196     if (!Sym.Name.empty())
 197       Symbol.st_name = State.getStringTable().addString(Sym.Name);
 198     Symbol.setBindingAndType(Sym.Binding, Sym.Type);
 199     Syms.push_back(Symbol);
 200   }
 201
 202   ContiguousBlobAccumulator &CBA = State.getSectionContentAccum();
 203   SHeader.sh_offset = CBA.currentOffset();
 204   SHeader.sh_size = vectorDataSize(Syms);
 205   writeVectorData(CBA.getOS(), Syms);
 206 }
 207
 208 template <class ELFT>
 209 static int writeELF(raw_ostream &OS, const ELFYAML::Object &Doc) {
 210   using namespace llvm::ELF;
 211   typedef typename object::ELFObjectFile<ELFT>::Elf_Ehdr Elf_Ehdr;
 212   typedef typename object::ELFObjectFile<ELFT>::Elf_Shdr Elf_Shdr;
 213
 214   const ELFYAML::FileHeader &Hdr = Doc.Header;
 215
 216   Elf_Ehdr Header;
 217   zero(Header);
 218   Header.e_ident[EI_MAG0] = 0x7f;
 219   Header.e_ident[EI_MAG1] = 'E';
 220   Header.e_ident[EI_MAG2] = 'L';
 221   Header.e_ident[EI_MAG3] = 'F';
 222   Header.e_ident[EI_CLASS] = ELFT::Is64Bits ? ELFCLASS64 : ELFCLASS32;
 223   bool IsLittleEndian = ELFT::TargetEndianness == support::little;
 224   Header.e_ident[EI_DATA] = IsLittleEndian ? ELFDATA2LSB : ELFDATA2MSB;
 225   Header.e_ident[EI_VERSION] = EV_CURRENT;
 226   Header.e_ident[EI_OSABI] = Hdr.OSABI;
 227   Header.e_ident[EI_ABIVERSION] = 0;
 228   Header.e_type = Hdr.Type;
 229   Header.e_machine = Hdr.Machine;
 230   Header.e_version = EV_CURRENT;
 231   Header.e_entry = Hdr.Entry;
 232   Header.e_ehsize = sizeof(Elf_Ehdr);
 233
 234   // TODO: Flesh out section header support.
 235   // TODO: Program headers.
 236
 237   Header.e_shentsize = sizeof(Elf_Shdr);
 238   // Immediately following the ELF header.
 239   Header.e_shoff = sizeof(Header);
 240   const std::vector<ELFYAML::Section> &Sections = Doc.Sections;
 241   // "+ 3" for
 242   // - SHT_NULL entry (placed first, i.e. 0'th entry)
 243   // - string table (.strtab) (placed second to last)
 244   // - section header string table. (placed last)
 245   Header.e_shnum = Sections.size() + 3;
 246   // Place section header string table last.
 247   Header.e_shstrndx = Header.e_shnum - 1;
 248   const unsigned DotStrtabSecNo = Header.e_shnum - 2;
 249
 250   // XXX: This offset is tightly coupled with the order that we write
 251   // things to `OS`.
 252   const size_t SectionContentBeginOffset =
 253       Header.e_ehsize + Header.e_shentsize * Header.e_shnum;
 254   ContiguousBlobAccumulator CBA(SectionContentBeginOffset);
 255   ELFState<ELFT> State(Header, CBA, DotStrtabSecNo);
 256
 257   SectionNameToIdxMap SN2I;
 258   for (unsigned i = 0, e = Sections.size(); i != e; ++i) {
 259     StringRef Name = Sections[i].Name;
 260     if (Name.empty())
 261       continue;
 262     // "+ 1" to take into account the SHT_NULL entry.
 263     if (SN2I.addName(Name, i + 1)) {
 264       errs() << "error: Repeated section name: '" << Name
 265              << "' at YAML section number " << i << ".\n";
 266       return 1;
 267     }
 268   }
 269
 270   StringTableBuilder SHStrTab;
 271   std::vector<Elf_Shdr> SHeaders;
 272   {
 273     // Ensure SHN_UNDEF entry is present. An all-zero section header is a
 274     // valid SHN_UNDEF entry since SHT_NULL == 0.
 275     Elf_Shdr SHdr;
 276     zero(SHdr);
 277     SHeaders.push_back(SHdr);
 278   }
 279   for (unsigned i = 0, e = Sections.size(); i != e; ++i) {
 280     const ELFYAML::Section &Sec = Sections[i];
 281     Elf_Shdr SHeader;
 282     zero(SHeader);
 283     SHeader.sh_name = SHStrTab.addString(Sec.Name);
 284     SHeader.sh_type = Sec.Type;
 285     SHeader.sh_flags = Sec.Flags;
 286     SHeader.sh_addr = Sec.Address;
 287
 288     SHeader.sh_offset = CBA.currentOffset();
 289     SHeader.sh_size = Sec.Content.binary_size();
 290     Sec.Content.writeAsBinary(CBA.getOS());
 291
 292     if (!Sec.Link.empty()) {
 293       unsigned Index;
 294       if (SN2I.lookupSection(Sec.Link, Index)) {
 295         errs() << "error: Unknown section referenced: '" << Sec.Link
 296                << "' at YAML section number " << i << ".\n";
 297         return 1;
 298       }
 299       SHeader.sh_link = Index;
 300     }
 301     SHeader.sh_info = 0;
 302     SHeader.sh_addralign = Sec.AddressAlign;
 303     SHeader.sh_entsize = 0;
 304     // XXX: Really ugly right now. Should not be writing to `CBA` above
 305     // (and setting sh_offset and sh_size) when going through this branch
 306     // here.
 307     if (Sec.Type == ELFYAML::ELF_SHT(SHT_SYMTAB))
 308       handleSymtabSectionHeader<ELFT>(Sec, State, SHeader);
 309     SHeaders.push_back(SHeader);
 310   }
 311
 312   // .strtab string table header.
 313   Elf_Shdr DotStrTabSHeader;
 314   zero(DotStrTabSHeader);
 315   DotStrTabSHeader.sh_name = SHStrTab.addString(StringRef(".strtab"));
 316   createStringTableSectionHeader(DotStrTabSHeader, State.getStringTable(), CBA);
 317
 318   // Section header string table header.
 319   Elf_Shdr SHStrTabSHeader;
 320   zero(SHStrTabSHeader);
 321   createStringTableSectionHeader(SHStrTabSHeader, SHStrTab, CBA);
 322
 323   OS.write((const char *)&Header, sizeof(Header));
 324   writeVectorData(OS, SHeaders);
 325   OS.write((const char *)&DotStrTabSHeader, sizeof(DotStrTabSHeader));
 326   OS.write((const char *)&SHStrTabSHeader, sizeof(SHStrTabSHeader));
 327   CBA.writeBlobToStream(OS);
 328   return 0;
 329 }
 330
 331 int yaml2elf(llvm::raw_ostream &Out, llvm::MemoryBuffer *Buf) {
 332   yaml::Input YIn(Buf->getBuffer());
 333   ELFYAML::Object Doc;
 334   YIn >> Doc;
 335   if (YIn.error()) {
 336     errs() << "yaml2obj: Failed to parse YAML file!\n";
 337     return 1;
 338   }
 339   if (Doc.Header.Class == ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64)) {
 340     if (Doc.Header.Data == ELFYAML::ELF_ELFDATA(ELF::ELFDATA2LSB))
 341       return writeELF<object::ELFType<support::little, 8, true> >(outs(), Doc);
 342     else
 343       return writeELF<object::ELFType<support::big, 8, true> >(outs(), Doc);
 344   } else {
 345     if (Doc.Header.Data == ELFYAML::ELF_ELFDATA(ELF::ELFDATA2LSB))
 346       return writeELF<object::ELFType<support::little, 4, false> >(outs(), Doc);
 347     else
 348       return writeELF<object::ELFType<support::big, 4, false> >(outs(), Doc);
 349   }
 350 }