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   raw_svector_ostream OS;
  73
  74 public:
  75   ContiguousBlobAccumulator(uint64_t InitialOffset_, SmallVectorImpl<char> &Buf)
  76       : InitialOffset(InitialOffset_), OS(Buf) {}
  77   raw_ostream &getOS() { return OS; }
  78   uint64_t currentOffset() const { return InitialOffset + OS.tell(); }
  79   void writeBlobToStream(raw_ostream &Out) { Out << OS.str(); }
  80 };
  81 } // end anonymous namespace
  82
  83 // Used to keep track of section names, so that in the YAML file sections
  84 // can be referenced by name instead of by index.
  85 namespace {
  86 class SectionNameToIdxMap {
  87   StringMap<int> Map;
  88 public:
  89   /// \returns true if name is already present in the map.
  90   bool addName(StringRef SecName, unsigned i) {
  91     StringMapEntry<int> &Entry = Map.GetOrCreateValue(SecName, -1);
  92     if (Entry.getValue() != -1)
  93       return true;
  94     Entry.setValue((int)i);
  95     return false;
  96   }
  97   /// \returns true if name is not present in the map
  98   bool lookupSection(StringRef SecName, unsigned &Idx) const {
  99     StringMap<int>::const_iterator I = Map.find(SecName);
 100     if (I == Map.end())
 101       return true;
 102     Idx = I->getValue();
 103     return false;
 104   }
 105 };
 106 } // end anonymous namespace
 107
 108 template <class T>
 109 static size_t vectorDataSize(const std::vector<T> &Vec) {
 110   return Vec.size() * sizeof(T);
 111 }
 112
 113 template <class T>
 114 static void writeVectorData(raw_ostream &OS, const std::vector<T> &Vec) {
 115   OS.write((const char *)Vec.data(), vectorDataSize(Vec));
 116 }
 117
 118 template <class T>
 119 static void zero(T &Obj) {
 120   memset(&Obj, 0, sizeof(Obj));
 121 }
 122
 123 /// \brief Create a string table in `SHeader`, which we assume is already
 124 /// zero'd.
 125 template <class Elf_Shdr>
 126 static void createStringTableSectionHeader(Elf_Shdr &SHeader,
 127                                            StringTableBuilder &STB,
 128                                            ContiguousBlobAccumulator &CBA) {
 129   SHeader.sh_type = ELF::SHT_STRTAB;
 130   SHeader.sh_offset = CBA.currentOffset();
 131   SHeader.sh_size = STB.size();
 132   STB.writeToStream(CBA.getOS());
 133   SHeader.sh_addralign = 1;
 134 }
 135
 136 // FIXME: This function is hideous. Between the sheer number of parameters
 137 // and the hideous ELF typenames, it's just a travesty. Factor the ELF
 138 // output into a class (templated on ELFT) and share some typedefs.
 139 template <class ELFT>
 140 static void handleSymtabSectionHeader(
 141     const ELFYAML::Section &Sec,
 142     const typename object::ELFObjectFile<ELFT>::Elf_Ehdr &Header,
 143     typename object::ELFObjectFile<ELFT>::Elf_Shdr &SHeader,
 144     StringTableBuilder &StrTab, ContiguousBlobAccumulator &CBA,
 145     unsigned DotStrtabSecNo) {
 146
 147   typedef typename object::ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
 148   // TODO: Ensure that a manually specified `Link` field is diagnosed as an
 149   // error for SHT_SYMTAB.
 150   SHeader.sh_link = DotStrtabSecNo;
 151   // TODO: Once we handle symbol binding, this should be one greater than
 152   // symbol table index of the last local symbol.
 153   SHeader.sh_info = 0;
 154   SHeader.sh_entsize = sizeof(Elf_Sym);
 155
 156   std::vector<Elf_Sym> Syms;
 157   {
 158     // Ensure STN_UNDEF is present
 159     Elf_Sym Sym;
 160     zero(Sym);
 161     Syms.push_back(Sym);
 162   }
 163   for (unsigned i = 0, e = Sec.Symbols.size(); i != e; ++i) {
 164     const ELFYAML::Symbol &Sym = Sec.Symbols[i];
 165     Elf_Sym Symbol;
 166     zero(Symbol);
 167     if (!Sym.Name.empty())
 168       Symbol.st_name = StrTab.addString(Sym.Name);
 169     Symbol.setBindingAndType(Sym.Binding, Sym.Type);
 170     Syms.push_back(Symbol);
 171   }
 172
 173   SHeader.sh_offset = CBA.currentOffset();
 174   SHeader.sh_size = vectorDataSize(Syms);
 175   writeVectorData(CBA.getOS(), Syms);
 176 }
 177
 178 template <class ELFT>
 179 static int writeELF(raw_ostream &OS, const ELFYAML::Object &Doc) {
 180   using namespace llvm::ELF;
 181   using namespace llvm::object;
 182   typedef typename ELFObjectFile<ELFT>::Elf_Ehdr Elf_Ehdr;
 183   typedef typename ELFObjectFile<ELFT>::Elf_Shdr Elf_Shdr;
 184
 185   const ELFYAML::FileHeader &Hdr = Doc.Header;
 186
 187   Elf_Ehdr Header;
 188   zero(Header);
 189   Header.e_ident[EI_MAG0] = 0x7f;
 190   Header.e_ident[EI_MAG1] = 'E';
 191   Header.e_ident[EI_MAG2] = 'L';
 192   Header.e_ident[EI_MAG3] = 'F';
 193   Header.e_ident[EI_CLASS] = ELFT::Is64Bits ? ELFCLASS64 : ELFCLASS32;
 194   bool IsLittleEndian = ELFT::TargetEndianness == support::little;
 195   Header.e_ident[EI_DATA] = IsLittleEndian ? ELFDATA2LSB : ELFDATA2MSB;
 196   Header.e_ident[EI_VERSION] = EV_CURRENT;
 197   // TODO: Implement ELF_ELFOSABI enum.
 198   Header.e_ident[EI_OSABI] = ELFOSABI_NONE;
 199   // TODO: Implement ELF_ABIVERSION enum.
 200   Header.e_ident[EI_ABIVERSION] = 0;
 201   Header.e_type = Hdr.Type;
 202   Header.e_machine = Hdr.Machine;
 203   Header.e_version = EV_CURRENT;
 204   Header.e_entry = Hdr.Entry;
 205   Header.e_ehsize = sizeof(Elf_Ehdr);
 206
 207   // TODO: Flesh out section header support.
 208   // TODO: Program headers.
 209
 210   Header.e_shentsize = sizeof(Elf_Shdr);
 211   // Immediately following the ELF header.
 212   Header.e_shoff = sizeof(Header);
 213   const std::vector<ELFYAML::Section> &Sections = Doc.Sections;
 214   // "+ 3" for
 215   // - SHT_NULL entry (placed first, i.e. 0'th entry)
 216   // - string table (.strtab) (placed second to last)
 217   // - section header string table. (placed last)
 218   Header.e_shnum = Sections.size() + 3;
 219   // Place section header string table last.
 220   Header.e_shstrndx = Header.e_shnum - 1;
 221   const unsigned DotStrtabSecNo = Header.e_shnum - 2;
 222
 223   SectionNameToIdxMap SN2I;
 224   for (unsigned i = 0, e = Sections.size(); i != e; ++i) {
 225     StringRef Name = Sections[i].Name;
 226     if (Name.empty())
 227       continue;
 228     // "+ 1" to take into account the SHT_NULL entry.
 229     if (SN2I.addName(Name, i + 1)) {
 230       errs() << "error: Repeated section name: '" << Name
 231              << "' at YAML section number " << i << ".\n";
 232       return 1;
 233     }
 234   }
 235
 236   StringTableBuilder SHStrTab;
 237   SmallVector<char, 128> Buf;
 238   // XXX: This offset is tightly coupled with the order that we write
 239   // things to `OS`.
 240   const size_t SectionContentBeginOffset =
 241       Header.e_ehsize + Header.e_shentsize * Header.e_shnum;
 242   ContiguousBlobAccumulator CBA(SectionContentBeginOffset, Buf);
 243   std::vector<Elf_Shdr> SHeaders;
 244   {
 245     // Ensure SHN_UNDEF entry is present. An all-zero section header is a
 246     // valid SHN_UNDEF entry since SHT_NULL == 0.
 247     Elf_Shdr SHdr;
 248     zero(SHdr);
 249     SHeaders.push_back(SHdr);
 250   }
 251   StringTableBuilder DotStrTab;
 252   for (unsigned i = 0, e = Sections.size(); i != e; ++i) {
 253     const ELFYAML::Section &Sec = Sections[i];
 254     Elf_Shdr SHeader;
 255     zero(SHeader);
 256     SHeader.sh_name = SHStrTab.addString(Sec.Name);
 257     SHeader.sh_type = Sec.Type;
 258     SHeader.sh_flags = Sec.Flags;
 259     SHeader.sh_addr = Sec.Address;
 260
 261     SHeader.sh_offset = CBA.currentOffset();
 262     SHeader.sh_size = Sec.Content.binary_size();
 263     Sec.Content.writeAsBinary(CBA.getOS());
 264
 265     if (!Sec.Link.empty()) {
 266       unsigned Index;
 267       if (SN2I.lookupSection(Sec.Link, Index)) {
 268         errs() << "error: Unknown section referenced: '" << Sec.Link
 269                << "' at YAML section number " << i << ".\n";
 270         return 1;
 271       }
 272       SHeader.sh_link = Index;
 273     }
 274     SHeader.sh_info = 0;
 275     SHeader.sh_addralign = Sec.AddressAlign;
 276     SHeader.sh_entsize = 0;
 277     // XXX: Really ugly right now. Need to put common state into a class.
 278     if (Sec.Type == ELFYAML::ELF_SHT(SHT_SYMTAB))
 279       handleSymtabSectionHeader<ELFT>(Sec, Header, SHeader, DotStrTab, CBA,
 280                                       DotStrtabSecNo);
 281     SHeaders.push_back(SHeader);
 282   }
 283
 284   // .strtab string table header.
 285   Elf_Shdr DotStrTabSHeader;
 286   zero(DotStrTabSHeader);
 287   DotStrTabSHeader.sh_name = SHStrTab.addString(StringRef(".strtab"));
 288   createStringTableSectionHeader(DotStrTabSHeader, DotStrTab, CBA);
 289
 290   // Section header string table header.
 291   Elf_Shdr SHStrTabSHeader;
 292   zero(SHStrTabSHeader);
 293   createStringTableSectionHeader(SHStrTabSHeader, SHStrTab, CBA);
 294
 295   OS.write((const char *)&Header, sizeof(Header));
 296   writeVectorData(OS, SHeaders);
 297   OS.write((const char *)&DotStrTabSHeader, sizeof(DotStrTabSHeader));
 298   OS.write((const char *)&SHStrTabSHeader, sizeof(SHStrTabSHeader));
 299   CBA.writeBlobToStream(OS);
 300   return 0;
 301 }
 302
 303 int yaml2elf(llvm::raw_ostream &Out, llvm::MemoryBuffer *Buf) {
 304   yaml::Input YIn(Buf->getBuffer());
 305   ELFYAML::Object Doc;
 306   YIn >> Doc;
 307   if (YIn.error()) {
 308     errs() << "yaml2obj: Failed to parse YAML file!\n";
 309     return 1;
 310   }
 311   if (Doc.Header.Class == ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64)) {
 312     if (Doc.Header.Data == ELFYAML::ELF_ELFDATA(ELF::ELFDATA2LSB))
 313       return writeELF<object::ELFType<support::little, 8, true> >(outs(), Doc);
 314     else
 315       return writeELF<object::ELFType<support::big, 8, true> >(outs(), Doc);
 316   } else {
 317     if (Doc.Header.Data == ELFYAML::ELF_ELFDATA(ELF::ELFDATA2LSB))
 318       return writeELF<object::ELFType<support::little, 4, false> >(outs(), Doc);
 319     else
 320       return writeELF<object::ELFType<support::big, 4, false> >(outs(), Doc);
 321   }
 322 }