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 template <class ELFT>
 124 static int writeELF(raw_ostream &OS, const ELFYAML::Object &Doc) {
 125   using namespace llvm::ELF;
 126   using namespace llvm::object;
 127   typedef typename ELFObjectFile<ELFT>::Elf_Ehdr Elf_Ehdr;
 128   typedef typename ELFObjectFile<ELFT>::Elf_Shdr Elf_Shdr;
 129
 130   const ELFYAML::FileHeader &Hdr = Doc.Header;
 131
 132   Elf_Ehdr Header;
 133   zero(Header);
 134   Header.e_ident[EI_MAG0] = 0x7f;
 135   Header.e_ident[EI_MAG1] = 'E';
 136   Header.e_ident[EI_MAG2] = 'L';
 137   Header.e_ident[EI_MAG3] = 'F';
 138   Header.e_ident[EI_CLASS] = ELFT::Is64Bits ? ELFCLASS64 : ELFCLASS32;
 139   bool IsLittleEndian = ELFT::TargetEndianness == support::little;
 140   Header.e_ident[EI_DATA] = IsLittleEndian ? ELFDATA2LSB : ELFDATA2MSB;
 141   Header.e_ident[EI_VERSION] = EV_CURRENT;
 142   // TODO: Implement ELF_ELFOSABI enum.
 143   Header.e_ident[EI_OSABI] = ELFOSABI_NONE;
 144   // TODO: Implement ELF_ABIVERSION enum.
 145   Header.e_ident[EI_ABIVERSION] = 0;
 146   Header.e_type = Hdr.Type;
 147   Header.e_machine = Hdr.Machine;
 148   Header.e_version = EV_CURRENT;
 149   Header.e_entry = Hdr.Entry;
 150   Header.e_ehsize = sizeof(Elf_Ehdr);
 151
 152   // TODO: Flesh out section header support.
 153   // TODO: Program headers.
 154
 155   Header.e_shentsize = sizeof(Elf_Shdr);
 156   // Immediately following the ELF header.
 157   Header.e_shoff = sizeof(Header);
 158   std::vector<ELFYAML::Section> Sections = Doc.Sections;
 159   if (Sections.empty() || Sections.front().Type != SHT_NULL) {
 160     ELFYAML::Section S;
 161     S.Type = SHT_NULL;
 162     zero(S.Flags);
 163     zero(S.Address);
 164     zero(S.AddressAlign);
 165     Sections.insert(Sections.begin(), S);
 166   }
 167   // "+ 1" for string table.
 168   Header.e_shnum = Sections.size() + 1;
 169   // Place section header string table last.
 170   Header.e_shstrndx = Sections.size();
 171
 172   SectionNameToIdxMap SN2I;
 173   for (unsigned i = 0, e = Sections.size(); i != e; ++i) {
 174     StringRef Name = Sections[i].Name;
 175     if (Name.empty())
 176       continue;
 177     if (SN2I.addName(Name, i)) {
 178       errs() << "error: Repeated section name: '" << Name
 179              << "' at YAML section number " << i << ".\n";
 180       return 1;
 181     }
 182   }
 183
 184   StringTableBuilder StrTab;
 185   SmallVector<char, 128> Buf;
 186   // XXX: This offset is tightly coupled with the order that we write
 187   // things to `OS`.
 188   const size_t SectionContentBeginOffset =
 189       Header.e_ehsize + Header.e_shentsize * Header.e_shnum;
 190   ContiguousBlobAccumulator CBA(SectionContentBeginOffset, Buf);
 191   std::vector<Elf_Shdr> SHeaders;
 192   for (unsigned i = 0, e = Sections.size(); i != e; ++i) {
 193     const ELFYAML::Section &Sec = Sections[i];
 194     Elf_Shdr SHeader;
 195     zero(SHeader);
 196     SHeader.sh_name = StrTab.addString(Sec.Name);
 197     SHeader.sh_type = Sec.Type;
 198     SHeader.sh_flags = Sec.Flags;
 199     SHeader.sh_addr = Sec.Address;
 200
 201     SHeader.sh_offset = CBA.currentOffset();
 202     SHeader.sh_size = Sec.Content.binary_size();
 203     Sec.Content.writeAsBinary(CBA.getOS());
 204
 205     if (!Sec.Link.empty()) {
 206       unsigned Index;
 207       if (SN2I.lookupSection(Sec.Link, Index)) {
 208         errs() << "error: Unknown section referenced: '" << Sec.Link
 209                << "' at YAML section number " << i << ".\n";
 210         return 1;
 211       }
 212       SHeader.sh_link = Index;
 213     }
 214     SHeader.sh_info = 0;
 215     SHeader.sh_addralign = Sec.AddressAlign;
 216     SHeader.sh_entsize = 0;
 217     SHeaders.push_back(SHeader);
 218   }
 219
 220   // String table header.
 221   Elf_Shdr StrTabSHeader;
 222   zero(StrTabSHeader);
 223   StrTabSHeader.sh_name = 0;
 224   StrTabSHeader.sh_type = SHT_STRTAB;
 225   StrTabSHeader.sh_flags = 0;
 226   StrTabSHeader.sh_addr = 0;
 227   StrTabSHeader.sh_offset = CBA.currentOffset();
 228   StrTabSHeader.sh_size = StrTab.size();
 229   StrTab.writeToStream(CBA.getOS());
 230   StrTabSHeader.sh_link = 0;
 231   StrTabSHeader.sh_info = 0;
 232   StrTabSHeader.sh_addralign = 1;
 233   StrTabSHeader.sh_entsize = 0;
 234
 235   OS.write((const char *)&Header, sizeof(Header));
 236   writeVectorData(OS, SHeaders);
 237   OS.write((const char *)&StrTabSHeader, sizeof(StrTabSHeader));
 238   CBA.writeBlobToStream(OS);
 239   return 0;
 240 }
 241
 242 int yaml2elf(llvm::raw_ostream &Out, llvm::MemoryBuffer *Buf) {
 243   yaml::Input YIn(Buf->getBuffer());
 244   ELFYAML::Object Doc;
 245   YIn >> Doc;
 246   if (YIn.error()) {
 247     errs() << "yaml2obj: Failed to parse YAML file!\n";
 248     return 1;
 249   }
 250   if (Doc.Header.Class == ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64)) {
 251     if (Doc.Header.Data == ELFYAML::ELF_ELFDATA(ELF::ELFDATA2LSB))
 252       return writeELF<object::ELFType<support::little, 8, true> >(outs(), Doc);
 253     else
 254       return writeELF<object::ELFType<support::big, 8, true> >(outs(), Doc);
 255   } else {
 256     if (Doc.Header.Data == ELFYAML::ELF_ELFDATA(ELF::ELFDATA2LSB))
 257       return writeELF<object::ELFType<support::little, 4, false> >(outs(), Doc);
 258     else
 259       return writeELF<object::ELFType<support::big, 4, false> >(outs(), Doc);
 260   }
 261 }